Add tls_dh_max_bits to OptionLists.txt
[exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing. Remember that
45 . the <bookinfo> element must also be updated for each new edition.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.75"
49 .set version "4.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 .new
1651 .section "PCRE library" "SECTpcre"
1652 .cindex "PCRE library"
1653 Exim no longer has an embedded PCRE library as the vast majority of
1654 modern systems include PCRE as a system library, although you may need
1655 to install the PCRE or PCRE development package for your operating
1656 system. If your system has a normal PCRE installation the Exim build
1657 process will need no further configuration. If the library or the
1658 headers are in an unusual location you will need to either set the PCRE_LIBS
1659 and INCLUDE directives appropriately,
1660 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1661 If your operating system has no
1662 PCRE support then you will need to obtain and build the current PCRE
1663 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1664 More information on PCRE is available at &url(http://www.pcre.org/).
1665 .wen
1666
1667 .section "DBM libraries" "SECTdb"
1668 .cindex "DBM libraries" "discussion of"
1669 .cindex "hints database" "DBM files used for"
1670 Even if you do not use any DBM files in your configuration, Exim still needs a
1671 DBM library in order to operate, because it uses indexed files for its hints
1672 databases. Unfortunately, there are a number of DBM libraries in existence, and
1673 different operating systems often have different ones installed.
1674
1675 .cindex "Solaris" "DBM library for"
1676 .cindex "IRIX, DBM library for"
1677 .cindex "BSD, DBM library for"
1678 .cindex "Linux, DBM library for"
1679 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1680 Linux distribution, the DBM configuration should happen automatically, and you
1681 may be able to ignore this section. Otherwise, you may have to learn more than
1682 you would like about DBM libraries from what follows.
1683
1684 .cindex "&'ndbm'& DBM library"
1685 Licensed versions of Unix normally contain a library of DBM functions operating
1686 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1687 versions of Unix seem to vary in what they contain as standard. In particular,
1688 some early versions of Linux have no default DBM library, and different
1689 distributors have chosen to bundle different libraries with their packaged
1690 versions. However, the more recent releases seem to have standardized on the
1691 Berkeley DB library.
1692
1693 Different DBM libraries have different conventions for naming the files they
1694 use. When a program opens a file called &_dbmfile_&, there are several
1695 possibilities:
1696
1697 .olist
1698 A traditional &'ndbm'& implementation, such as that supplied as part of
1699 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1700 .next
1701 .cindex "&'gdbm'& DBM library"
1702 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1703 compatibility interface it makes two different hard links to it with names
1704 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1705 file name is used unmodified.
1706 .next
1707 .cindex "Berkeley DB library"
1708 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1709 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1710 programmer exactly the same as the traditional &'ndbm'& implementation.
1711 .next
1712 If the Berkeley package is used in its native mode, it operates on a single
1713 file called &_dbmfile_&; the programmer's interface is somewhat different to
1714 the traditional &'ndbm'& interface.
1715 .next
1716 To complicate things further, there are several very different versions of the
1717 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1718 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1719 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1720 versions of Berkeley DB can be obtained from
1721 &url(http://www.sleepycat.com/).
1722 .next
1723 .cindex "&'tdb'& DBM library"
1724 Yet another DBM library, called &'tdb'&, is available from
1725 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1726 operates on a single file.
1727 .endlist
1728
1729 .cindex "USE_DB"
1730 .cindex "DBM libraries" "configuration for building"
1731 Exim and its utilities can be compiled to use any of these interfaces. In order
1732 to use any version of the Berkeley DB package in native mode, you must set
1733 USE_DB in an appropriate configuration file (typically
1734 &_Local/Makefile_&). For example:
1735 .code
1736 USE_DB=yes
1737 .endd
1738 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1739 error is diagnosed if you set more than one of these.
1740
1741 At the lowest level, the build-time configuration sets none of these options,
1742 thereby assuming an interface of type (1). However, some operating system
1743 configuration files (for example, those for the BSD operating systems and
1744 Linux) assume type (4) by setting USE_DB as their default, and the
1745 configuration files for Cygwin set USE_GDBM. Anything you set in
1746 &_Local/Makefile_&, however, overrides these system defaults.
1747
1748 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1749 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1750 in one of these lines:
1751 .code
1752 DBMLIB = -ldb
1753 DBMLIB = -ltdb
1754 .endd
1755 Settings like that will work if the DBM library is installed in the standard
1756 place. Sometimes it is not, and the library's header file may also not be in
1757 the default path. You may need to set INCLUDE to specify where the header
1758 file is, and to specify the path to the library more fully in DBMLIB, as in
1759 this example:
1760 .code
1761 INCLUDE=-I/usr/local/include/db-4.1
1762 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1763 .endd
1764 There is further detailed discussion about the various DBM libraries in the
1765 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1766
1767
1768
1769 .section "Pre-building configuration" "SECID25"
1770 .cindex "building Exim" "pre-building configuration"
1771 .cindex "configuration for building Exim"
1772 .cindex "&_Local/Makefile_&"
1773 .cindex "&_src/EDITME_&"
1774 Before building Exim, a local configuration file that specifies options
1775 independent of any operating system has to be created with the name
1776 &_Local/Makefile_&. A template for this file is supplied as the file
1777 &_src/EDITME_&, and it contains full descriptions of all the option settings
1778 therein. These descriptions are therefore not repeated here. If you are
1779 building Exim for the first time, the simplest thing to do is to copy
1780 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1781
1782 There are three settings that you must supply, because Exim will not build
1783 without them. They are the location of the run time configuration file
1784 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1785 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1786 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1787 a colon-separated list of file names; Exim uses the first of them that exists.
1788
1789 There are a few other parameters that can be specified either at build time or
1790 at run time, to enable the same binary to be used on a number of different
1791 machines. However, if the locations of Exim's spool directory and log file
1792 directory (if not within the spool directory) are fixed, it is recommended that
1793 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1794 detected early in Exim's execution (such as a malformed configuration file) can
1795 be logged.
1796
1797 .cindex "content scanning" "specifying at build time"
1798 Exim's interfaces for calling virus and spam scanning software directly from
1799 access control lists are not compiled by default. If you want to include these
1800 facilities, you need to set
1801 .code
1802 WITH_CONTENT_SCAN=yes
1803 .endd
1804 in your &_Local/Makefile_&. For details of the facilities themselves, see
1805 chapter &<<CHAPexiscan>>&.
1806
1807
1808 .cindex "&_Local/eximon.conf_&"
1809 .cindex "&_exim_monitor/EDITME_&"
1810 If you are going to build the Exim monitor, a similar configuration process is
1811 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1812 your installation and saved under the name &_Local/eximon.conf_&. If you are
1813 happy with the default settings described in &_exim_monitor/EDITME_&,
1814 &_Local/eximon.conf_& can be empty, but it must exist.
1815
1816 This is all the configuration that is needed in straightforward cases for known
1817 operating systems. However, the building process is set up so that it is easy
1818 to override options that are set by default or by operating-system-specific
1819 configuration files, for example to change the name of the C compiler, which
1820 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1821 do this.
1822
1823
1824
1825 .section "Support for iconv()" "SECID26"
1826 .cindex "&[iconv()]& support"
1827 .cindex "RFC 2047"
1828 The contents of header lines in messages may be encoded according to the rules
1829 described RFC 2047. This makes it possible to transmit characters that are not
1830 in the ASCII character set, and to label them as being in a particular
1831 character set. When Exim is inspecting header lines by means of the &%$h_%&
1832 mechanism, it decodes them, and translates them into a specified character set
1833 (default ISO-8859-1). The translation is possible only if the operating system
1834 supports the &[iconv()]& function.
1835
1836 However, some of the operating systems that supply &[iconv()]& do not support
1837 very many conversions. The GNU &%libiconv%& library (available from
1838 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1839 systems to remedy this deficiency, as well as on systems that do not supply
1840 &[iconv()]& at all. After installing &%libiconv%&, you should add
1841 .code
1842 HAVE_ICONV=yes
1843 .endd
1844 to your &_Local/Makefile_& and rebuild Exim.
1845
1846
1847
1848 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1849 .cindex "TLS" "including support for TLS"
1850 .cindex "encryption" "including support for"
1851 .cindex "SUPPORT_TLS"
1852 .cindex "OpenSSL" "building Exim with"
1853 .cindex "GnuTLS" "building Exim with"
1854 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1855 command as per RFC 2487. It can also support legacy clients that expect to
1856 start a TLS session immediately on connection to a non-standard port (see the
1857 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1858 line option).
1859
1860 If you want to build Exim with TLS support, you must first install either the
1861 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1862 implementing SSL.
1863
1864 If OpenSSL is installed, you should set
1865 .code
1866 SUPPORT_TLS=yes
1867 TLS_LIBS=-lssl -lcrypto
1868 .endd
1869 in &_Local/Makefile_&. You may also need to specify the locations of the
1870 OpenSSL library and include files. For example:
1871 .code
1872 SUPPORT_TLS=yes
1873 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1874 TLS_INCLUDE=-I/usr/local/openssl/include/
1875 .endd
1876 .new
1877 .cindex "pkg-config" "OpenSSL"
1878 If you have &'pkg-config'& available, then instead you can just use:
1879 .code
1880 SUPPORT_TLS=yes
1881 USE_OPENSSL_PC=openssl
1882 .endd
1883 .wen
1884 .cindex "USE_GNUTLS"
1885 If GnuTLS is installed, you should set
1886 .code
1887 SUPPORT_TLS=yes
1888 USE_GNUTLS=yes
1889 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1890 .endd
1891 in &_Local/Makefile_&, and again you may need to specify the locations of the
1892 library and include files. For example:
1893 .code
1894 SUPPORT_TLS=yes
1895 USE_GNUTLS=yes
1896 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1897 TLS_INCLUDE=-I/usr/gnu/include
1898 .endd
1899 .new
1900 .cindex "pkg-config" "GnuTLS"
1901 If you have &'pkg-config'& available, then instead you can just use:
1902 .code
1903 SUPPORT_TLS=yes
1904 USE_GNUTLS=yes
1905 USE_GNUTLS_PC=gnutls
1906 .endd
1907 .wen
1908
1909 You do not need to set TLS_INCLUDE if the relevant directory is already
1910 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1911 given in chapter &<<CHAPTLS>>&.
1912
1913
1914
1915
1916 .section "Use of tcpwrappers" "SECID27"
1917
1918 .cindex "tcpwrappers, building Exim to support"
1919 .cindex "USE_TCP_WRAPPERS"
1920 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1921 .cindex "tcp_wrappers_daemon_name"
1922 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1923 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1924 alternative to Exim's own checking facilities for installations that are
1925 already making use of &'tcpwrappers'& for other purposes. To do this, you
1926 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1927 &_tcpd.h_& to be available at compile time, and also ensure that the library
1928 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1929 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1930 you might have
1931 .code
1932 USE_TCP_WRAPPERS=yes
1933 CFLAGS=-O -I/usr/local/include
1934 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1935 .endd
1936 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1937 files is &"exim"&. For example, the line
1938 .code
1939 exim : LOCAL  192.168.1.  .friendly.domain.example
1940 .endd
1941 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1942 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1943 All other connections are denied. The daemon name used by &'tcpwrappers'&
1944 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1945 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1946 configure file. Consult the &'tcpwrappers'& documentation for
1947 further details.
1948
1949
1950 .section "Including support for IPv6" "SECID28"
1951 .cindex "IPv6" "including support for"
1952 Exim contains code for use on systems that have IPv6 support. Setting
1953 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1954 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1955 where the IPv6 support is not fully integrated into the normal include and
1956 library files.
1957
1958 Two different types of DNS record for handling IPv6 addresses have been
1959 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1960 currently seen as the mainstream. Another record type called A6 was proposed
1961 as better than AAAA because it had more flexibility. However, it was felt to be
1962 over-complex, and its status was reduced to &"experimental"&. It is not known
1963 if anyone is actually using A6 records. Exim has support for A6 records, but
1964 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1965 support has not been tested for some time.
1966
1967
1968
1969 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1970 .cindex "lookup modules"
1971 .cindex "dynamic modules"
1972 .cindex ".so building"
1973 On some platforms, Exim supports not compiling all lookup types directly into
1974 the main binary, instead putting some into external modules which can be loaded
1975 on demand.
1976 This permits packagers to build Exim with support for lookups with extensive
1977 library dependencies without requiring all users to install all of those
1978 dependencies.
1979 Most, but not all, lookup types can be built this way.
1980
1981 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1982 installed; Exim will only load modules from that directory, as a security
1983 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1984 for your OS; see &_OS/Makefile-Linux_& for an example.
1985 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1986 see &_src/EDITME_& for details.
1987
1988 Then, for each module to be loaded dynamically, define the relevant
1989 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1990 For example, this will build in lsearch but load sqlite and mysql support
1991 on demand:
1992 .code
1993 LOOKUP_LSEARCH=yes
1994 LOOKUP_SQLITE=2
1995 LOOKUP_MYSQL=2
1996 .endd
1997
1998
1999 .section "The building process" "SECID29"
2000 .cindex "build directory"
2001 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2002 created, run &'make'& at the top level. It determines the architecture and
2003 operating system types, and creates a build directory if one does not exist.
2004 For example, on a Sun system running Solaris 8, the directory
2005 &_build-SunOS5-5.8-sparc_& is created.
2006 .cindex "symbolic link" "to source files"
2007 Symbolic links to relevant source files are installed in the build directory.
2008
2009 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2010 building process fails if it is set.
2011
2012 If this is the first time &'make'& has been run, it calls a script that builds
2013 a make file inside the build directory, using the configuration files from the
2014 &_Local_& directory. The new make file is then passed to another instance of
2015 &'make'&. This does the real work, building a number of utility scripts, and
2016 then compiling and linking the binaries for the Exim monitor (if configured), a
2017 number of utility programs, and finally Exim itself. The command &`make
2018 makefile`& can be used to force a rebuild of the make file in the build
2019 directory, should this ever be necessary.
2020
2021 If you have problems building Exim, check for any comments there may be in the
2022 &_README_& file concerning your operating system, and also take a look at the
2023 FAQ, where some common problems are covered.
2024
2025
2026
2027 .section 'Output from &"make"&' "SECID283"
2028 The output produced by the &'make'& process for compile lines is often very
2029 unreadable, because these lines can be very long. For this reason, the normal
2030 output is suppressed by default, and instead output similar to that which
2031 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2032 each module that is being compiled or linked. However, it is still possible to
2033 get the full output, by calling &'make'& like this:
2034 .code
2035 FULLECHO='' make -e
2036 .endd
2037 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2038 command reflection in &'make'&. When you ask for the full output, it is
2039 given in addition to the short output.
2040
2041
2042
2043 .section "Overriding build-time options for Exim" "SECToverride"
2044 .cindex "build-time options, overriding"
2045 The main make file that is created at the beginning of the building process
2046 consists of the concatenation of a number of files which set configuration
2047 values, followed by a fixed set of &'make'& instructions. If a value is set
2048 more than once, the last setting overrides any previous ones. This provides a
2049 convenient way of overriding defaults. The files that are concatenated are, in
2050 order:
2051 .display
2052 &_OS/Makefile-Default_&
2053 &_OS/Makefile-_&<&'ostype'&>
2054 &_Local/Makefile_&
2055 &_Local/Makefile-_&<&'ostype'&>
2056 &_Local/Makefile-_&<&'archtype'&>
2057 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2058 &_OS/Makefile-Base_&
2059 .endd
2060 .cindex "&_Local/Makefile_&"
2061 .cindex "building Exim" "operating system type"
2062 .cindex "building Exim" "architecture type"
2063 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2064 architecture type. &_Local/Makefile_& is required to exist, and the building
2065 process fails if it is absent. The other three &_Local_& files are optional,
2066 and are often not needed.
2067
2068 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2069 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2070 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2071 values are used, thereby providing a means of forcing particular settings.
2072 Otherwise, the scripts try to get values from the &%uname%& command. If this
2073 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2074 of &'ad hoc'& transformations are then applied, to produce the standard names
2075 that Exim expects. You can run these scripts directly from the shell in order
2076 to find out what values are being used on your system.
2077
2078
2079 &_OS/Makefile-Default_& contains comments about the variables that are set
2080 therein. Some (but not all) are mentioned below. If there is something that
2081 needs changing, review the contents of this file and the contents of the make
2082 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2083 default values are.
2084
2085
2086 .cindex "building Exim" "overriding default settings"
2087 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2088 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2089 need to change the original files. Instead, you should make the changes by
2090 putting the new values in an appropriate &_Local_& file. For example,
2091 .cindex "Tru64-Unix build-time settings"
2092 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2093 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2094 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2095 called with the option &%-std1%&, to make it recognize some of the features of
2096 Standard C that Exim uses. (Most other compilers recognize Standard C by
2097 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2098 containing the lines
2099 .code
2100 CC=cc
2101 CFLAGS=-std1
2102 .endd
2103 If you are compiling for just one operating system, it may be easier to put
2104 these lines directly into &_Local/Makefile_&.
2105
2106 Keeping all your local configuration settings separate from the distributed
2107 files makes it easy to transfer them to new versions of Exim simply by copying
2108 the contents of the &_Local_& directory.
2109
2110
2111 .cindex "NIS lookup type" "including support for"
2112 .cindex "NIS+ lookup type" "including support for"
2113 .cindex "LDAP" "including support for"
2114 .cindex "lookup" "inclusion in binary"
2115 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2116 lookup, but not all systems have these components installed, so the default is
2117 not to include the relevant code in the binary. All the different kinds of file
2118 and database lookup that Exim supports are implemented as separate code modules
2119 which are included only if the relevant compile-time options are set. In the
2120 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2121 .code
2122 LOOKUP_LDAP=yes
2123 LOOKUP_NIS=yes
2124 LOOKUP_NISPLUS=yes
2125 .endd
2126 and similar settings apply to the other lookup types. They are all listed in
2127 &_src/EDITME_&. In many cases the relevant include files and interface
2128 libraries need to be installed before compiling Exim.
2129 .cindex "cdb" "including support for"
2130 However, there are some optional lookup types (such as cdb) for which
2131 the code is entirely contained within Exim, and no external include
2132 files or libraries are required. When a lookup type is not included in the
2133 binary, attempts to configure Exim to use it cause run time configuration
2134 errors.
2135
2136 .new
2137 .cindex "pkg-config" "lookups"
2138 .cindex "pkg-config" "authenticators"
2139 Many systems now use a tool called &'pkg-config'& to encapsulate information
2140 about how to compile against a library; Exim has some initial support for
2141 being able to use pkg-config for lookups and authenticators.  For any given
2142 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2143 variable with the &`_PC`& suffix in the name and assign as the value the
2144 name of the package to be queried.  The results of querying via the
2145 &'pkg-config'& command will be added to the appropriate Makefile variables
2146 with &`+=`& directives, so your version of &'make'& will need to support that
2147 syntax.  For instance:
2148 .code
2149 LOOKUP_SQLITE=yes
2150 LOOKUP_SQLITE_PC=sqlite3
2151 AUTH_GSASL=yes
2152 AUTH_GSASL_PC=libgsasl
2153 AUTH_HEIMDAL_GSSAPI=yes
2154 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2155 .endd
2156 .wen
2157
2158 .cindex "Perl" "including support for"
2159 Exim can be linked with an embedded Perl interpreter, allowing Perl
2160 subroutines to be called during string expansion. To enable this facility,
2161 .code
2162 EXIM_PERL=perl.o
2163 .endd
2164 must be defined in &_Local/Makefile_&. Details of this facility are given in
2165 chapter &<<CHAPperl>>&.
2166
2167 .cindex "X11 libraries, location of"
2168 The location of the X11 libraries is something that varies a lot between
2169 operating systems, and there may be different versions of X11 to cope
2170 with. Exim itself makes no use of X11, but if you are compiling the Exim
2171 monitor, the X11 libraries must be available.
2172 The following three variables are set in &_OS/Makefile-Default_&:
2173 .code
2174 X11=/usr/X11R6
2175 XINCLUDE=-I$(X11)/include
2176 XLFLAGS=-L$(X11)/lib
2177 .endd
2178 These are overridden in some of the operating-system configuration files. For
2179 example, in &_OS/Makefile-SunOS5_& there is
2180 .code
2181 X11=/usr/openwin
2182 XINCLUDE=-I$(X11)/include
2183 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2184 .endd
2185 If you need to override the default setting for your operating system, place a
2186 definition of all three of these variables into your
2187 &_Local/Makefile-<ostype>_& file.
2188
2189 .cindex "EXTRALIBS"
2190 If you need to add any extra libraries to the link steps, these can be put in a
2191 variable called EXTRALIBS, which appears in all the link commands, but by
2192 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2193 command for linking the main Exim binary, and not for any associated utilities.
2194
2195 .cindex "DBM libraries" "configuration for building"
2196 There is also DBMLIB, which appears in the link commands for binaries that
2197 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2198 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2199 binary, and which can be used, for example, to include additional X11
2200 libraries.
2201
2202 .cindex "configuration file" "editing"
2203 The make file copes with rebuilding Exim correctly if any of the configuration
2204 files are edited. However, if an optional configuration file is deleted, it is
2205 necessary to touch the associated non-optional file (that is,
2206 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2207
2208
2209 .section "OS-specific header files" "SECID30"
2210 .cindex "&_os.h_&"
2211 .cindex "building Exim" "OS-specific C header files"
2212 The &_OS_& directory contains a number of files with names of the form
2213 &_os.h-<ostype>_&. These are system-specific C header files that should not
2214 normally need to be changed. There is a list of macro settings that are
2215 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2216 are porting Exim to a new operating system.
2217
2218
2219
2220 .section "Overriding build-time options for the monitor" "SECID31"
2221 .cindex "building Eximon"
2222 A similar process is used for overriding things when building the Exim monitor,
2223 where the files that are involved are
2224 .display
2225 &_OS/eximon.conf-Default_&
2226 &_OS/eximon.conf-_&<&'ostype'&>
2227 &_Local/eximon.conf_&
2228 &_Local/eximon.conf-_&<&'ostype'&>
2229 &_Local/eximon.conf-_&<&'archtype'&>
2230 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2231 .endd
2232 .cindex "&_Local/eximon.conf_&"
2233 As with Exim itself, the final three files need not exist, and in this case the
2234 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2235 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2236 variables of the same name, preceded by EXIMON_. For example, setting
2237 EXIMON_LOG_DEPTH in the environment overrides the value of
2238 LOG_DEPTH at run time.
2239 .ecindex IIDbuex
2240
2241
2242 .section "Installing Exim binaries and scripts" "SECID32"
2243 .cindex "installing Exim"
2244 .cindex "BIN_DIRECTORY"
2245 The command &`make install`& runs the &(exim_install)& script with no
2246 arguments. The script copies binaries and utility scripts into the directory
2247 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2248 .cindex "setuid" "installing Exim with"
2249 The install script copies files only if they are newer than the files they are
2250 going to replace. The Exim binary is required to be owned by root and have the
2251 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2252 install`& as root so that it can set up the Exim binary in this way. However, in
2253 some special situations (for example, if a host is doing no local deliveries)
2254 it may be possible to run Exim without making the binary setuid root (see
2255 chapter &<<CHAPsecurity>>& for details).
2256
2257 .cindex "CONFIGURE_FILE"
2258 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2259 in &_Local/Makefile_&. If this names a single file, and the file does not
2260 exist, the default configuration file &_src/configure.default_& is copied there
2261 by the installation script. If a run time configuration file already exists, it
2262 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2263 alternative files, no default is installed.
2264
2265 .cindex "system aliases file"
2266 .cindex "&_/etc/aliases_&"
2267 One change is made to the default configuration file when it is installed: the
2268 default configuration contains a router that references a system aliases file.
2269 The path to this file is set to the value specified by
2270 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2271 If the system aliases file does not exist, the installation script creates it,
2272 and outputs a comment to the user.
2273
2274 The created file contains no aliases, but it does contain comments about the
2275 aliases a site should normally have. Mail aliases have traditionally been
2276 kept in &_/etc/aliases_&. However, some operating systems are now using
2277 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2278 Exim's configuration if necessary.
2279
2280 The default configuration uses the local host's name as the only local domain,
2281 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2282 running as the local user. System aliases and &_.forward_& files in users' home
2283 directories are supported, but no NIS or NIS+ support is configured. Domains
2284 other than the name of the local host are routed using the DNS, with delivery
2285 over SMTP.
2286
2287 It is possible to install Exim for special purposes (such as building a binary
2288 distribution) in a private part of the file system. You can do this by a
2289 command such as
2290 .code
2291 make DESTDIR=/some/directory/ install
2292 .endd
2293 This has the effect of pre-pending the specified directory to all the file
2294 paths, except the name of the system aliases file that appears in the default
2295 configuration. (If a default alias file is created, its name &'is'& modified.)
2296 For backwards compatibility, ROOT is used if DESTDIR is not set,
2297 but this usage is deprecated.
2298
2299 .cindex "installing Exim" "what is not installed"
2300 Running &'make install'& does not copy the Exim 4 conversion script
2301 &'convert4r4'&. You will probably run this only once if you are
2302 upgrading from Exim 3. None of the documentation files in the &_doc_&
2303 directory are copied, except for the info files when you have set
2304 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2305
2306 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2307 to their names. The Exim binary itself, however, is handled differently. It is
2308 installed under a name that includes the version number and the compile number,
2309 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2310 called &_exim_& to point to the binary. If you are updating a previous version
2311 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2312 from the directory (as seen by other processes).
2313
2314 .cindex "installing Exim" "testing the script"
2315 If you want to see what the &'make install'& will do before running it for
2316 real, you can pass the &%-n%& option to the installation script by this
2317 command:
2318 .code
2319 make INSTALL_ARG=-n install
2320 .endd
2321 The contents of the variable INSTALL_ARG are passed to the installation
2322 script. You do not need to be root to run this test. Alternatively, you can run
2323 the installation script directly, but this must be from within the build
2324 directory. For example, from the top-level Exim directory you could use this
2325 command:
2326 .code
2327 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2328 .endd
2329 .cindex "installing Exim" "install script options"
2330 There are two other options that can be supplied to the installation script.
2331
2332 .ilist
2333 &%-no_chown%& bypasses the call to change the owner of the installed binary
2334 to root, and the call to make it a setuid binary.
2335 .next
2336 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2337 installed binary.
2338 .endlist
2339
2340 INSTALL_ARG can be used to pass these options to the script. For example:
2341 .code
2342 make INSTALL_ARG=-no_symlink install
2343 .endd
2344 The installation script can also be given arguments specifying which files are
2345 to be copied. For example, to install just the Exim binary, and nothing else,
2346 without creating the symbolic link, you could use:
2347 .code
2348 make INSTALL_ARG='-no_symlink exim' install
2349 .endd
2350
2351
2352
2353 .section "Installing info documentation" "SECTinsinfdoc"
2354 .cindex "installing Exim" "&'info'& documentation"
2355 Not all systems use the GNU &'info'& system for documentation, and for this
2356 reason, the Texinfo source of Exim's documentation is not included in the main
2357 distribution. Instead it is available separately from the ftp site (see section
2358 &<<SECTavail>>&).
2359
2360 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2361 source of the documentation is found in the source tree, running &`make
2362 install`& automatically builds the info files and installs them.
2363
2364
2365
2366 .section "Setting up the spool directory" "SECID33"
2367 .cindex "spool directory" "creating"
2368 When it starts up, Exim tries to create its spool directory if it does not
2369 exist. The Exim uid and gid are used for the owner and group of the spool
2370 directory. Sub-directories are automatically created in the spool directory as
2371 necessary.
2372
2373
2374
2375
2376 .section "Testing" "SECID34"
2377 .cindex "testing" "installation"
2378 Having installed Exim, you can check that the run time configuration file is
2379 syntactically valid by running the following command, which assumes that the
2380 Exim binary directory is within your PATH environment variable:
2381 .code
2382 exim -bV
2383 .endd
2384 If there are any errors in the configuration file, Exim outputs error messages.
2385 Otherwise it outputs the version number and build date,
2386 the DBM library that is being used, and information about which drivers and
2387 other optional code modules are included in the binary.
2388 Some simple routing tests can be done by using the address testing option. For
2389 example,
2390 .display
2391 &`exim -bt`& <&'local username'&>
2392 .endd
2393 should verify that it recognizes a local mailbox, and
2394 .display
2395 &`exim -bt`& <&'remote address'&>
2396 .endd
2397 a remote one. Then try getting it to deliver mail, both locally and remotely.
2398 This can be done by passing messages directly to Exim, without going through a
2399 user agent. For example:
2400 .code
2401 exim -v postmaster@your.domain.example
2402 From: user@your.domain.example
2403 To: postmaster@your.domain.example
2404 Subject: Testing Exim
2405
2406 This is a test message.
2407 ^D
2408 .endd
2409 The &%-v%& option causes Exim to output some verification of what it is doing.
2410 In this case you should see copies of three log lines, one for the message's
2411 arrival, one for its delivery, and one containing &"Completed"&.
2412
2413 .cindex "delivery" "problems with"
2414 If you encounter problems, look at Exim's log files (&'mainlog'& and
2415 &'paniclog'&) to see if there is any relevant information there. Another source
2416 of information is running Exim with debugging turned on, by specifying the
2417 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2418 with debugging turned on by a command of the form
2419 .display
2420 &`exim -d -M`& <&'exim-message-id'&>
2421 .endd
2422 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2423 produces rather a lot of output, but you can cut this down to specific areas.
2424 For example, if you use &%-d-all+route%& only the debugging information
2425 relevant to routing is included. (See the &%-d%& option in chapter
2426 &<<CHAPcommandline>>& for more details.)
2427
2428 .cindex '&"sticky"& bit'
2429 .cindex "lock files"
2430 One specific problem that has shown up on some sites is the inability to do
2431 local deliveries into a shared mailbox directory, because it does not have the
2432 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2433 writing to a mailbox file, and if it cannot create the lock file, the delivery
2434 is deferred. You can get round this either by setting the &"sticky bit"& on the
2435 directory, or by setting a specific group for local deliveries and allowing
2436 that group to create files in the directory (see the comments above the
2437 &(local_delivery)& transport in the default configuration file). Another
2438 approach is to configure Exim not to use lock files, but just to rely on
2439 &[fcntl()]& locking instead. However, you should do this only if all user
2440 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2441 see chapter &<<CHAPappendfile>>&.
2442
2443 One thing that cannot be tested on a system that is already running an MTA is
2444 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2445 &%-oX%& option can be used to run an Exim daemon that listens on some other
2446 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2447 &'exim_checkaccess'& utility can be used to check out policy controls on
2448 incoming SMTP mail.
2449
2450 Testing a new version on a system that is already running Exim can most easily
2451 be done by building a binary with a different CONFIGURE_FILE setting. From
2452 within the run time configuration, all other file and directory names
2453 that Exim uses can be altered, in order to keep it entirely clear of the
2454 production version.
2455
2456
2457 .section "Replacing another MTA with Exim" "SECID35"
2458 .cindex "replacing another MTA"
2459 Building and installing Exim for the first time does not of itself put it in
2460 general use. The name by which the system's MTA is called by mail user agents
2461 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2462 operating system), and it is necessary to make this name point to the &'exim'&
2463 binary in order to get the user agents to pass messages to Exim. This is
2464 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2465 or &_/usr/lib/sendmail_&
2466 .cindex "symbolic link" "to &'exim'& binary"
2467 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2468 privilege and executable status from the old MTA. It is then necessary to stop
2469 and restart the mailer daemon, if one is running.
2470
2471 .cindex "FreeBSD, MTA indirection"
2472 .cindex "&_/etc/mail/mailer.conf_&"
2473 Some operating systems have introduced alternative ways of switching MTAs. For
2474 example, if you are running FreeBSD, you need to edit the file
2475 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2476 described. A typical example of the contents of this file for running Exim is
2477 as follows:
2478 .code
2479 sendmail            /usr/exim/bin/exim
2480 send-mail           /usr/exim/bin/exim
2481 mailq               /usr/exim/bin/exim -bp
2482 newaliases          /usr/bin/true
2483 .endd
2484 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2485 your Exim installation is &"live"&. Check it by sending a message from your
2486 favourite user agent.
2487
2488 You should consider what to tell your users about the change of MTA. Exim may
2489 have different capabilities to what was previously running, and there are
2490 various operational differences such as the text of messages produced by
2491 command line options and in bounce messages. If you allow your users to make
2492 use of Exim's filtering capabilities, you should make the document entitled
2493 &'Exim's interface to mail filtering'& available to them.
2494
2495
2496
2497 .section "Upgrading Exim" "SECID36"
2498 .cindex "upgrading Exim"
2499 If you are already running Exim on your host, building and installing a new
2500 version automatically makes it available to MUAs, or any other programs that
2501 call the MTA directly. However, if you are running an Exim daemon, you do need
2502 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2503 new binary. You do not need to stop processing mail in order to install a new
2504 version of Exim. The install script does not modify an existing runtime
2505 configuration file.
2506
2507
2508
2509
2510 .section "Stopping the Exim daemon on Solaris" "SECID37"
2511 .cindex "Solaris" "stopping Exim on"
2512 The standard command for stopping the mailer daemon on Solaris is
2513 .code
2514 /etc/init.d/sendmail stop
2515 .endd
2516 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2517 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2518 for the text &"sendmail"&; this is not present because the actual program name
2519 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2520 solution is to replace the line that finds the process id with something like
2521 .code
2522 pid=`cat /var/spool/exim/exim-daemon.pid`
2523 .endd
2524 to obtain the daemon's pid directly from the file that Exim saves it in.
2525
2526 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2527 still be received from local processes, and if automatic delivery is configured
2528 (the normal case), deliveries will still occur.
2529
2530
2531
2532
2533 . ////////////////////////////////////////////////////////////////////////////
2534 . ////////////////////////////////////////////////////////////////////////////
2535
2536 .chapter "The Exim command line" "CHAPcommandline"
2537 .scindex IIDclo1 "command line" "options"
2538 .scindex IIDclo2 "options" "command line"
2539 Exim's command line takes the standard Unix form of a sequence of options,
2540 each starting with a hyphen character, followed by a number of arguments. The
2541 options are compatible with the main options of Sendmail, and there are also
2542 some additional options, some of which are compatible with Smail 3. Certain
2543 combinations of options do not make sense, and provoke an error if used.
2544 The form of the arguments depends on which options are set.
2545
2546
2547 .section "Setting options by program name" "SECID38"
2548 .cindex "&'mailq'&"
2549 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2550 were present before any other options.
2551 The &%-bp%& option requests a listing of the contents of the mail queue on the
2552 standard output.
2553 This feature is for compatibility with some systems that contain a command of
2554 that name in one of the standard libraries, symbolically linked to
2555 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2556
2557 .cindex "&'rsmtp'&"
2558 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2559 were present before any other options, for compatibility with Smail. The
2560 &%-bS%& option is used for reading in a number of messages in batched SMTP
2561 format.
2562
2563 .cindex "&'rmail'&"
2564 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2565 &%-oee%& options were present before any other options, for compatibility with
2566 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2567
2568 .cindex "&'runq'&"
2569 .cindex "queue runner"
2570 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2571 were present before any other options, for compatibility with Smail. The &%-q%&
2572 option causes a single queue runner process to be started.
2573
2574 .cindex "&'newaliases'&"
2575 .cindex "alias file" "building"
2576 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2577 If Exim is called under the name &'newaliases'& it behaves as if the option
2578 &%-bi%& were present before any other options, for compatibility with Sendmail.
2579 This option is used for rebuilding Sendmail's alias file. Exim does not have
2580 the concept of a single alias file, but can be configured to run a given
2581 command if called with the &%-bi%& option.
2582
2583
2584 .section "Trusted and admin users" "SECTtrustedadmin"
2585 Some Exim options are available only to &'trusted users'& and others are
2586 available only to &'admin users'&. In the description below, the phrases &"Exim
2587 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2588 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2589 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2590
2591 .ilist
2592 .cindex "trusted users" "definition of"
2593 .cindex "user" "trusted definition of"
2594 The trusted users are root, the Exim user, any user listed in the
2595 &%trusted_users%& configuration option, and any user whose current group or any
2596 supplementary group is one of those listed in the &%trusted_groups%&
2597 configuration option. Note that the Exim group is not automatically trusted.
2598
2599 .cindex '&"From"& line'
2600 .cindex "envelope sender"
2601 Trusted users are always permitted to use the &%-f%& option or a leading
2602 &"From&~"& line to specify the envelope sender of a message that is passed to
2603 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2604 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2605 users to set envelope senders.
2606
2607 .cindex "&'From:'& header line"
2608 .cindex "&'Sender:'& header line"
2609 For a trusted user, there is never any check on the contents of the &'From:'&
2610 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2611 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2612
2613 Trusted users may also specify a host name, host address, interface address,
2614 protocol name, ident value, and authentication data when submitting a message
2615 locally. Thus, they are able to insert messages into Exim's queue locally that
2616 have the characteristics of messages received from a remote host. Untrusted
2617 users may in some circumstances use &%-f%&, but can never set the other values
2618 that are available to trusted users.
2619 .next
2620 .cindex "user" "admin definition of"
2621 .cindex "admin user" "definition of"
2622 The admin users are root, the Exim user, and any user that is a member of the
2623 Exim group or of any group listed in the &%admin_groups%& configuration option.
2624 The current group does not have to be one of these groups.
2625
2626 Admin users are permitted to list the queue, and to carry out certain
2627 operations on messages, for example, to force delivery failures. It is also
2628 necessary to be an admin user in order to see the full information provided by
2629 the Exim monitor, and full debugging output.
2630
2631 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2632 Exim to attempt delivery of messages on its queue is restricted to admin users.
2633 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2634 option false (that is, specifying &%no_prod_requires_admin%&).
2635
2636 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2637 is restricted to admin users unless &%queue_list_requires_admin%& is set
2638 false.
2639 .endlist
2640
2641
2642 &*Warning*&: If you configure your system so that admin users are able to
2643 edit Exim's configuration file, you are giving those users an easy way of
2644 getting root. There is further discussion of this issue at the start of chapter
2645 &<<CHAPconf>>&.
2646
2647
2648
2649
2650 .section "Command line options" "SECID39"
2651 Exim's command line options are described in alphabetical order below. If none
2652 of the options that specifies a specific action (such as starting the daemon or
2653 a queue runner, or testing an address, or receiving a message in a specific
2654 format, or listing the queue) are present, and there is at least one argument
2655 on the command line, &%-bm%& (accept a local message on the standard input,
2656 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2657 outputs a brief message about itself and exits.
2658
2659 . ////////////////////////////////////////////////////////////////////////////
2660 . Insert a stylized XML comment here, to identify the start of the command line
2661 . options. This is for the benefit of the Perl script that automatically
2662 . creates a man page for the options.
2663 . ////////////////////////////////////////////////////////////////////////////
2664
2665 .literal xml
2666 <!-- === Start of command line options === -->
2667 .literal off
2668
2669
2670 .vlist
2671 .vitem &%--%&
2672 .oindex "--"
2673 .cindex "options" "command line; terminating"
2674 This is a pseudo-option whose only purpose is to terminate the options and
2675 therefore to cause subsequent command line items to be treated as arguments
2676 rather than options, even if they begin with hyphens.
2677
2678 .vitem &%--help%&
2679 .oindex "&%--help%&"
2680 This option causes Exim to output a few sentences stating what it is.
2681 The same output is generated if the Exim binary is called with no options and
2682 no arguments.
2683
2684 .vitem &%--version%&
2685 .oindex "&%--version%&"
2686 This option is an alias for &%-bV%& and causes version information to be
2687 displayed.
2688
2689 .vitem &%-B%&<&'type'&>
2690 .oindex "&%-B%&"
2691 .cindex "8-bit characters"
2692 .cindex "Sendmail compatibility" "8-bit characters"
2693 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2694 clean; it ignores this option.
2695
2696 .vitem &%-bd%&
2697 .oindex "&%-bd%&"
2698 .cindex "daemon"
2699 .cindex "SMTP" "listener"
2700 .cindex "queue runner"
2701 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2702 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2703 that the daemon should also initiate periodic queue runs.
2704
2705 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2706 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2707 disconnect from the controlling terminal. When running this way, it can be
2708 stopped by pressing ctrl-C.
2709
2710 By default, Exim listens for incoming connections to the standard SMTP port on
2711 all the host's running interfaces. However, it is possible to listen on other
2712 ports, on multiple ports, and only on specific interfaces. Chapter
2713 &<<CHAPinterfaces>>& contains a description of the options that control this.
2714
2715 When a listening daemon
2716 .cindex "daemon" "process id (pid)"
2717 .cindex "pid (process id)" "of daemon"
2718 is started without the use of &%-oX%& (that is, without overriding the normal
2719 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2720 in Exim's spool directory. This location can be overridden by setting
2721 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2722 running as root.
2723
2724 When &%-oX%& is used on the command line to start a listening daemon, the
2725 process id is not written to the normal pid file path. However, &%-oP%& can be
2726 used to specify a path on the command line if a pid file is required.
2727
2728 The SIGHUP signal
2729 .cindex "SIGHUP"
2730 .cindex "daemon" "restarting"
2731 can be used to cause the daemon to re-execute itself. This should be done
2732 whenever Exim's configuration file, or any file that is incorporated into it by
2733 means of the &%.include%& facility, is changed, and also whenever a new version
2734 of Exim is installed. It is not necessary to do this when other files that are
2735 referenced from the configuration (for example, alias files) are changed,
2736 because these are reread each time they are used.
2737
2738 .vitem &%-bdf%&
2739 .oindex "&%-bdf%&"
2740 This option has the same effect as &%-bd%& except that it never disconnects
2741 from the controlling terminal, even when no debugging is specified.
2742
2743 .vitem &%-be%&
2744 .oindex "&%-be%&"
2745 .cindex "testing" "string expansion"
2746 .cindex "expansion" "testing"
2747 Run Exim in expansion testing mode. Exim discards its root privilege, to
2748 prevent ordinary users from using this mode to read otherwise inaccessible
2749 files. If no arguments are given, Exim runs interactively, prompting for lines
2750 of data. Otherwise, it processes each argument in turn.
2751
2752 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2753 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2754 used without command line arguments. If successful, it uses the &[readline()]&
2755 function, which provides extensive line-editing facilities, for reading the
2756 test data. A line history is supported.
2757
2758 Long expansion expressions can be split over several lines by using backslash
2759 continuations. As in Exim's run time configuration, white space at the start of
2760 continuation lines is ignored. Each argument or data line is passed through the
2761 string expansion mechanism, and the result is output. Variable values from the
2762 configuration file (for example, &$qualify_domain$&) are available, but no
2763 message-specific values (such as &$sender_domain$&) are set, because no message
2764 is being processed (but see &%-bem%& and &%-Mset%&).
2765
2766 &*Note*&: If you use this mechanism to test lookups, and you change the data
2767 files or databases you are using, you must exit and restart Exim before trying
2768 the same lookup again. Otherwise, because each Exim process caches the results
2769 of lookups, you will just get the same result as before.
2770
2771 .vitem &%-bem%&&~<&'filename'&>
2772 .oindex "&%-bem%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 This option operates like &%-be%& except that it must be followed by the name
2776 of a file. For example:
2777 .code
2778 exim -bem /tmp/testmessage
2779 .endd
2780 The file is read as a message (as if receiving a locally-submitted non-SMTP
2781 message) before any of the test expansions are done. Thus, message-specific
2782 variables such as &$message_size$& and &$header_from:$& are available. However,
2783 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2784 recipients are read from the headers in the normal way, and are shown in the
2785 &$recipients$& variable. Note that recipients cannot be given on the command
2786 line, because further arguments are taken as strings to expand (just like
2787 &%-be%&).
2788
2789 .vitem &%-bF%&&~<&'filename'&>
2790 .oindex "&%-bF%&"
2791 .cindex "system filter" "testing"
2792 .cindex "testing" "system filter"
2793 This option is the same as &%-bf%& except that it assumes that the filter being
2794 tested is a system filter. The additional commands that are available only in
2795 system filters are recognized.
2796
2797 .vitem &%-bf%&&~<&'filename'&>
2798 .oindex "&%-bf%&"
2799 .cindex "filter" "testing"
2800 .cindex "testing" "filter file"
2801 .cindex "forward file" "testing"
2802 .cindex "testing" "forward file"
2803 .cindex "Sieve filter" "testing"
2804 This option runs Exim in user filter testing mode; the file is the filter file
2805 to be tested, and a test message must be supplied on the standard input. If
2806 there are no message-dependent tests in the filter, an empty file can be
2807 supplied.
2808
2809 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2810 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2811 filter and a user filter in the same run. For example:
2812 .code
2813 exim -bF /system/filter -bf /user/filter </test/message
2814 .endd
2815 This is helpful when the system filter adds header lines or sets filter
2816 variables that are used by the user filter.
2817
2818 If the test filter file does not begin with one of the special lines
2819 .code
2820 # Exim filter
2821 # Sieve filter
2822 .endd
2823 it is taken to be a normal &_.forward_& file, and is tested for validity under
2824 that interpretation. See sections &<<SECTitenonfilred>>& to
2825 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2826 redirection lists.
2827
2828 The result of an Exim command that uses &%-bf%&, provided no errors are
2829 detected, is a list of the actions that Exim would try to take if presented
2830 with the message for real. More details of filter testing are given in the
2831 separate document entitled &'Exim's interfaces to mail filtering'&.
2832
2833 When testing a filter file,
2834 .cindex "&""From""& line"
2835 .cindex "envelope sender"
2836 .oindex "&%-f%&" "for filter testing"
2837 the envelope sender can be set by the &%-f%& option,
2838 or by a &"From&~"& line at the start of the test message. Various parameters
2839 that would normally be taken from the envelope recipient address of the message
2840 can be set by means of additional command line options (see the next four
2841 options).
2842
2843 .vitem &%-bfd%&&~<&'domain'&>
2844 .oindex "&%-bfd%&"
2845 .vindex "&$qualify_domain$&"
2846 This sets the domain of the recipient address when a filter file is being
2847 tested by means of the &%-bf%& option. The default is the value of
2848 &$qualify_domain$&.
2849
2850 .vitem &%-bfl%&&~<&'local&~part'&>
2851 .oindex "&%-bfl%&"
2852 This sets the local part of the recipient address when a filter file is being
2853 tested by means of the &%-bf%& option. The default is the username of the
2854 process that calls Exim. A local part should be specified with any prefix or
2855 suffix stripped, because that is how it appears to the filter when a message is
2856 actually being delivered.
2857
2858 .vitem &%-bfp%&&~<&'prefix'&>
2859 .oindex "&%-bfp%&"
2860 This sets the prefix of the local part of the recipient address when a filter
2861 file is being tested by means of the &%-bf%& option. The default is an empty
2862 prefix.
2863
2864 .vitem &%-bfs%&&~<&'suffix'&>
2865 .oindex "&%-bfs%&"
2866 This sets the suffix of the local part of the recipient address when a filter
2867 file is being tested by means of the &%-bf%& option. The default is an empty
2868 suffix.
2869
2870 .vitem &%-bh%&&~<&'IP&~address'&>
2871 .oindex "&%-bh%&"
2872 .cindex "testing" "incoming SMTP"
2873 .cindex "SMTP" "testing incoming"
2874 .cindex "testing" "relay control"
2875 .cindex "relaying" "testing configuration"
2876 .cindex "policy control" "testing"
2877 .cindex "debugging" "&%-bh%& option"
2878 This option runs a fake SMTP session as if from the given IP address, using the
2879 standard input and output. The IP address may include a port number at the end,
2880 after a full stop. For example:
2881 .code
2882 exim -bh 10.9.8.7.1234
2883 exim -bh fe80::a00:20ff:fe86:a061.5678
2884 .endd
2885 When an IPv6 address is given, it is converted into canonical form. In the case
2886 of the second example above, the value of &$sender_host_address$& after
2887 conversion to the canonical form is
2888 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2889
2890 Comments as to what is going on are written to the standard error file. These
2891 include lines beginning with &"LOG"& for anything that would have been logged.
2892 This facility is provided for testing configuration options for incoming
2893 messages, to make sure they implement the required policy. For example, you can
2894 test your relay controls using &%-bh%&.
2895
2896 &*Warning 1*&:
2897 .cindex "RFC 1413"
2898 You can test features of the configuration that rely on ident (RFC 1413)
2899 information by using the &%-oMt%& option. However, Exim cannot actually perform
2900 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2901 connection.
2902
2903 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2904 are also skipped when testing using &%-bh%&. If you want these callouts to
2905 occur, use &%-bhc%& instead.
2906
2907 Messages supplied during the testing session are discarded, and nothing is
2908 written to any of the real log files. There may be pauses when DNS (and other)
2909 lookups are taking place, and of course these may time out. The &%-oMi%& option
2910 can be used to specify a specific IP interface and port if this is important,
2911 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2912 session were authenticated.
2913
2914 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2915 output just states whether a given recipient address from a given host is
2916 acceptable or not. See section &<<SECTcheckaccess>>&.
2917
2918 Features such as authentication and encryption, where the client input is not
2919 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2920 specialized SMTP test program such as
2921 &url(http://jetmore.org/john/code/#swaks,swaks).
2922
2923 .vitem &%-bhc%&&~<&'IP&~address'&>
2924 .oindex "&%-bhc%&"
2925 This option operates in the same way as &%-bh%&, except that address
2926 verification callouts are performed if required. This includes consulting and
2927 updating the callout cache database.
2928
2929 .vitem &%-bi%&
2930 .oindex "&%-bi%&"
2931 .cindex "alias file" "building"
2932 .cindex "building alias file"
2933 .cindex "Sendmail compatibility" "&%-bi%& option"
2934 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2935 Exim does not have the concept of a single alias file, and so it cannot mimic
2936 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2937 tend to appear in various scripts such as NIS make files, so the option must be
2938 recognized.
2939
2940 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2941 configuration option is run, under the uid and gid of the caller of Exim. If
2942 the &%-oA%& option is used, its value is passed to the command as an argument.
2943 The command set by &%bi_command%& may not contain arguments. The command can
2944 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2945 if this is required. If the &%bi_command%& option is not set, calling Exim with
2946 &%-bi%& is a no-op.
2947
2948 .vitem &%-bm%&
2949 .oindex "&%-bm%&"
2950 .cindex "local message reception"
2951 This option runs an Exim receiving process that accepts an incoming,
2952 locally-generated message on the current input. The recipients are given as the
2953 command arguments (except when &%-t%& is also present &-- see below). Each
2954 argument can be a comma-separated list of RFC 2822 addresses. This is the
2955 default option for selecting the overall action of an Exim call; it is assumed
2956 if no other conflicting option is present.
2957
2958 If any addresses in the message are unqualified (have no domain), they are
2959 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2960 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2961 suppressing this for special cases.
2962
2963 Policy checks on the contents of local messages can be enforced by means of
2964 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2965
2966 .cindex "return code" "for &%-bm%&"
2967 The return code is zero if the message is successfully accepted. Otherwise, the
2968 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2969
2970 The format
2971 .cindex "message" "format"
2972 .cindex "format" "message"
2973 .cindex "&""From""& line"
2974 .cindex "UUCP" "&""From""& line"
2975 .cindex "Sendmail compatibility" "&""From""& line"
2976 of the message must be as defined in RFC 2822, except that, for
2977 compatibility with Sendmail and Smail, a line in one of the forms
2978 .code
2979 From sender Fri Jan  5 12:55 GMT 1997
2980 From sender Fri, 5 Jan 97 12:55:01
2981 .endd
2982 (with the weekday optional, and possibly with additional text after the date)
2983 is permitted to appear at the start of the message. There appears to be no
2984 authoritative specification of the format of this line. Exim recognizes it by
2985 matching against the regular expression defined by the &%uucp_from_pattern%&
2986 option, which can be changed if necessary.
2987
2988 .oindex "&%-f%&" "overriding &""From""& line"
2989 The specified sender is treated as if it were given as the argument to the
2990 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2991 preference to the address taken from the message. The caller of Exim must be a
2992 trusted user for the sender of a message to be set in this way.
2993
2994 .vitem &%-bnq%&
2995 .oindex "&%-bnq%&"
2996 .cindex "address qualification, suppressing"
2997 By default, Exim automatically qualifies unqualified addresses (those
2998 without domains) that appear in messages that are submitted locally (that
2999 is, not over TCP/IP). This qualification applies both to addresses in
3000 envelopes, and addresses in header lines. Sender addresses are qualified using
3001 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3002 defaults to the value of &%qualify_domain%&).
3003
3004 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3005 being used to re-submit messages that originally came from remote hosts after
3006 content scanning, you probably do not want to qualify unqualified addresses in
3007 header lines. (Such lines will be present only if you have not enabled a header
3008 syntax check in the appropriate ACL.)
3009
3010 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3011 messages that originate on the local host. When this is used, unqualified
3012 addresses in the envelope provoke errors (causing message rejection) and
3013 unqualified addresses in header lines are left alone.
3014
3015
3016 .vitem &%-bP%&
3017 .oindex "&%-bP%&"
3018 .cindex "configuration options" "extracting"
3019 .cindex "options" "configuration &-- extracting"
3020 If this option is given with no arguments, it causes the values of all Exim's
3021 main configuration options to be written to the standard output. The values
3022 of one or more specific options can be requested by giving their names as
3023 arguments, for example:
3024 .code
3025 exim -bP qualify_domain hold_domains
3026 .endd
3027 .cindex "hiding configuration option values"
3028 .cindex "configuration options" "hiding value of"
3029 .cindex "options" "hiding value of"
3030 However, any option setting that is preceded by the word &"hide"& in the
3031 configuration file is not shown in full, except to an admin user. For other
3032 users, the output is as in this example:
3033 .code
3034 mysql_servers = <value not displayable>
3035 .endd
3036 If &%configure_file%& is given as an argument, the name of the run time
3037 configuration file is output.
3038 If a list of configuration files was supplied, the value that is output here
3039 is the name of the file that was actually used.
3040
3041 .cindex "daemon" "process id (pid)"
3042 .cindex "pid (process id)" "of daemon"
3043 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3044 directories where log files and daemon pid files are written are output,
3045 respectively. If these values are unset, log files are written in a
3046 sub-directory of the spool directory called &%log%&, and the pid file is
3047 written directly into the spool directory.
3048
3049 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3050 .code
3051 exim -bP +local_domains
3052 .endd
3053 it searches for a matching named list of any type (domain, host, address, or
3054 local part) and outputs what it finds.
3055
3056 .cindex "options" "router &-- extracting"
3057 .cindex "options" "transport &-- extracting"
3058 .cindex "options" "authenticator &-- extracting"
3059 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3060 followed by the name of an appropriate driver instance, the option settings for
3061 that driver are output. For example:
3062 .code
3063 exim -bP transport local_delivery
3064 .endd
3065 The generic driver options are output first, followed by the driver's private
3066 options. A list of the names of drivers of a particular type can be obtained by
3067 using one of the words &%router_list%&, &%transport_list%&, or
3068 &%authenticator_list%&, and a complete list of all drivers with their option
3069 settings can be obtained by using &%routers%&, &%transports%&, or
3070 &%authenticators%&.
3071
3072 .cindex "options" "macro &-- extracting"
3073 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3074 are available, similarly to the drivers.  Because macros are sometimes used
3075 for storing passwords, this option is restricted.
3076 The output format is one item per line.
3077
3078 .vitem &%-bp%&
3079 .oindex "&%-bp%&"
3080 .cindex "queue" "listing messages on"
3081 .cindex "listing" "messages on the queue"
3082 This option requests a listing of the contents of the mail queue on the
3083 standard output. If the &%-bp%& option is followed by a list of message ids,
3084 just those messages are listed. By default, this option can be used only by an
3085 admin user. However, the &%queue_list_requires_admin%& option can be set false
3086 to allow any user to see the queue.
3087
3088 Each message on the queue is displayed as in the following example:
3089 .code
3090 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3091           red.king@looking-glass.fict.example
3092           <other addresses>
3093 .endd
3094 .cindex "message" "size in queue listing"
3095 .cindex "size" "of message"
3096 The first line contains the length of time the message has been on the queue
3097 (in this case 25 minutes), the size of the message (2.9K), the unique local
3098 identifier for the message, and the message sender, as contained in the
3099 envelope. For bounce messages, the sender address is empty, and appears as
3100 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3101 the default sender address, the user's login name is shown in parentheses
3102 before the sender address.
3103
3104 .cindex "frozen messages" "in queue listing"
3105 If the message is frozen (attempts to deliver it are suspended) then the text
3106 &"*** frozen ***"& is displayed at the end of this line.
3107
3108 The recipients of the message (taken from the envelope, not the headers) are
3109 displayed on subsequent lines. Those addresses to which the message has already
3110 been delivered are marked with the letter D. If an original address gets
3111 expanded into several addresses via an alias or forward file, the original is
3112 displayed with a D only when deliveries for all of its child addresses are
3113 complete.
3114
3115
3116 .vitem &%-bpa%&
3117 .oindex "&%-bpa%&"
3118 This option operates like &%-bp%&, but in addition it shows delivered addresses
3119 that were generated from the original top level address(es) in each message by
3120 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3121 of just &"D"&.
3122
3123
3124 .vitem &%-bpc%&
3125 .oindex "&%-bpc%&"
3126 .cindex "queue" "count of messages on"
3127 This option counts the number of messages on the queue, and writes the total
3128 to the standard output. It is restricted to admin users, unless
3129 &%queue_list_requires_admin%& is set false.
3130
3131
3132 .vitem &%-bpr%&
3133 .oindex "&%-bpr%&"
3134 This option operates like &%-bp%&, but the output is not sorted into
3135 chronological order of message arrival. This can speed it up when there are
3136 lots of messages on the queue, and is particularly useful if the output is
3137 going to be post-processed in a way that doesn't need the sorting.
3138
3139 .vitem &%-bpra%&
3140 .oindex "&%-bpra%&"
3141 This option is a combination of &%-bpr%& and &%-bpa%&.
3142
3143 .vitem &%-bpru%&
3144 .oindex "&%-bpru%&"
3145 This option is a combination of &%-bpr%& and &%-bpu%&.
3146
3147
3148 .vitem &%-bpu%&
3149 .oindex "&%-bpu%&"
3150 This option operates like &%-bp%& but shows only undelivered top-level
3151 addresses for each message displayed. Addresses generated by aliasing or
3152 forwarding are not shown, unless the message was deferred after processing by a
3153 router with the &%one_time%& option set.
3154
3155
3156 .vitem &%-brt%&
3157 .oindex "&%-brt%&"
3158 .cindex "testing" "retry configuration"
3159 .cindex "retry" "configuration testing"
3160 This option is for testing retry rules, and it must be followed by up to three
3161 arguments. It causes Exim to look for a retry rule that matches the values
3162 and to write it to the standard output. For example:
3163 .code
3164 exim -brt bach.comp.mus.example
3165 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3166 .endd
3167 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3168 argument, which is required, can be a complete address in the form
3169 &'local_part@domain'&, or it can be just a domain name. If the second argument
3170 contains a dot, it is interpreted as an optional second domain name; if no
3171 retry rule is found for the first argument, the second is tried. This ties in
3172 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3173 rule is found that matches the host, one that matches the mail domain is
3174 sought. Finally, an argument that is the name of a specific delivery error, as
3175 used in setting up retry rules, can be given. For example:
3176 .code
3177 exim -brt haydn.comp.mus.example quota_3d
3178 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3179 .endd
3180
3181 .vitem &%-brw%&
3182 .oindex "&%-brw%&"
3183 .cindex "testing" "rewriting"
3184 .cindex "rewriting" "testing"
3185 This option is for testing address rewriting rules, and it must be followed by
3186 a single argument, consisting of either a local part without a domain, or a
3187 complete address with a fully qualified domain. Exim outputs how this address
3188 would be rewritten for each possible place it might appear. See chapter
3189 &<<CHAPrewrite>>& for further details.
3190
3191 .vitem &%-bS%&
3192 .oindex "&%-bS%&"
3193 .cindex "SMTP" "batched incoming"
3194 .cindex "batched SMTP input"
3195 This option is used for batched SMTP input, which is an alternative interface
3196 for non-interactive local message submission. A number of messages can be
3197 submitted in a single run. However, despite its name, this is not really SMTP
3198 input. Exim reads each message's envelope from SMTP commands on the standard
3199 input, but generates no responses. If the caller is trusted, or
3200 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3201 believed; otherwise the sender is always the caller of Exim.
3202
3203 The message itself is read from the standard input, in SMTP format (leading
3204 dots doubled), terminated by a line containing just a single dot. An error is
3205 provoked if the terminating dot is missing. A further message may then follow.
3206
3207 As for other local message submissions, the contents of incoming batch SMTP
3208 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3209 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3210 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3211
3212 Some other SMTP commands are recognized in the input. HELO and EHLO act
3213 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3214 QUIT quits, ignoring the rest of the standard input.
3215
3216 .cindex "return code" "for &%-bS%&"
3217 If any error is encountered, reports are written to the standard output and
3218 error streams, and Exim gives up immediately. The return code is 0 if no error
3219 was detected; it is 1 if one or more messages were accepted before the error
3220 was detected; otherwise it is 2.
3221
3222 More details of input using batched SMTP are given in section
3223 &<<SECTincomingbatchedSMTP>>&.
3224
3225 .vitem &%-bs%&
3226 .oindex "&%-bs%&"
3227 .cindex "SMTP" "local input"
3228 .cindex "local SMTP input"
3229 This option causes Exim to accept one or more messages by reading SMTP commands
3230 on the standard input, and producing SMTP replies on the standard output. SMTP
3231 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3232 Some user agents use this interface as a way of passing locally-generated
3233 messages to the MTA.
3234
3235 In
3236 .cindex "sender" "source of"
3237 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3238 set, the senders of messages are taken from the SMTP MAIL commands.
3239 Otherwise the content of these commands is ignored and the sender is set up as
3240 the calling user. Unqualified addresses are automatically qualified using
3241 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3242 &%-bnq%& option is used.
3243
3244 .cindex "inetd"
3245 The
3246 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3247 using a listening daemon. Exim can distinguish the two cases by checking
3248 whether the standard input is a TCP/IP socket. When Exim is called from
3249 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3250 above concerning senders and qualification do not apply. In this situation,
3251 Exim behaves in exactly the same way as it does when receiving a message via
3252 the listening daemon.
3253
3254 .vitem &%-bmalware%&&~<&'filename'&>
3255 .oindex "&%-bmalware%&"
3256 .cindex "testing", "malware"
3257 .cindex "malware scan test"
3258 This debugging option causes Exim to scan the given file,
3259 using the malware scanning framework.  The option of &%av_scanner%& influences
3260 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3261 the expansion should have defaults which apply to this invocation.  ACLs are
3262 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3263 will never be populated and &%-bmalware%& will fail.
3264
3265 Exim will have changed working directory before resolving the filename, so
3266 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3267 user when it tries to open the file, rather than as the invoking user.
3268 This option requires admin privileges.
3269
3270 The &%-bmalware%& option will not be extended to be more generally useful,
3271 there are better tools for file-scanning.  This option exists to help
3272 administrators verify their Exim and AV scanner configuration.
3273
3274 .vitem &%-bt%&
3275 .oindex "&%-bt%&"
3276 .cindex "testing" "addresses"
3277 .cindex "address" "testing"
3278 This option runs Exim in address testing mode, in which each argument is taken
3279 as a recipient address to be tested for deliverability. The results are
3280 written to the standard output. If a test fails, and the caller is not an admin
3281 user, no details of the failure are output, because these might contain
3282 sensitive information such as usernames and passwords for database lookups.
3283
3284 If no arguments are given, Exim runs in an interactive manner, prompting with a
3285 right angle bracket for addresses to be tested.
3286
3287 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3288 &[readline()]& function, because it is running as &'root'& and there are
3289 security issues.
3290
3291 Each address is handled as if it were the recipient address of a message
3292 (compare the &%-bv%& option). It is passed to the routers and the result is
3293 written to the standard output. However, any router that has
3294 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3295 genuine routing tests if your first router passes everything to a scanner
3296 program.
3297
3298 .cindex "return code" "for &%-bt%&"
3299 The return code is 2 if any address failed outright; it is 1 if no address
3300 failed outright but at least one could not be resolved for some reason. Return
3301 code 0 is given only when all addresses succeed.
3302
3303 .cindex "duplicate addresses"
3304 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3305 addresses after routing is complete, so that only one delivery takes place.
3306 This does not happen when testing with &%-bt%&; the full results of routing are
3307 always shown.
3308
3309 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3310 routers in the configuration makes any tests on the sender address of a
3311 message,
3312 .oindex "&%-f%&" "for address testing"
3313 you can use the &%-f%& option to set an appropriate sender when running
3314 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3315 default qualifying domain. However, if you have set up (for example) routers
3316 whose behaviour depends on the contents of an incoming message, you cannot test
3317 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3318 doing such tests.
3319
3320 .vitem &%-bV%&
3321 .oindex "&%-bV%&"
3322 .cindex "version number of Exim"
3323 This option causes Exim to write the current version number, compilation
3324 number, and compilation date of the &'exim'& binary to the standard output.
3325 It also lists the DBM library that is being used, the optional modules (such as
3326 specific lookup types), the drivers that are included in the binary, and the
3327 name of the run time configuration file that is in use.
3328
3329 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3330 configuration file. However, this is a static check only. It cannot check
3331 values that are to be expanded. For example, although a misspelt ACL verb is
3332 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3333 alone to discover (for example) all the typos in the configuration; some
3334 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3335 dynamic testing facilities.
3336
3337 .vitem &%-bv%&
3338 .oindex "&%-bv%&"
3339 .cindex "verifying address" "using &%-bv%&"
3340 .cindex "address" "verification"
3341 This option runs Exim in address verification mode, in which each argument is
3342 taken as a recipient address to be verified by the routers. (This does
3343 not involve any verification callouts). During normal operation, verification
3344 happens mostly as a consequence processing a &%verify%& condition in an ACL
3345 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3346 including callouts, see the &%-bh%& and &%-bhc%& options.
3347
3348 If verification fails, and the caller is not an admin user, no details of the
3349 failure are output, because these might contain sensitive information such as
3350 usernames and passwords for database lookups.
3351
3352 If no arguments are given, Exim runs in an interactive manner, prompting with a
3353 right angle bracket for addresses to be verified.
3354
3355 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3356 &[readline()]& function, because it is running as &'exim'& and there are
3357 security issues.
3358
3359 Verification differs from address testing (the &%-bt%& option) in that routers
3360 that have &%no_verify%& set are skipped, and if the address is accepted by a
3361 router that has &%fail_verify%& set, verification fails. The address is
3362 verified as a recipient if &%-bv%& is used; to test verification for a sender
3363 address, &%-bvs%& should be used.
3364
3365 If the &%-v%& option is not set, the output consists of a single line for each
3366 address, stating whether it was verified or not, and giving a reason in the
3367 latter case. Without &%-v%&, generating more than one address by redirection
3368 causes verification to end successfully, without considering the generated
3369 addresses. However, if just one address is generated, processing continues,
3370 and the generated address must verify successfully for the overall verification
3371 to succeed.
3372
3373 When &%-v%& is set, more details are given of how the address has been handled,
3374 and in the case of address redirection, all the generated addresses are also
3375 considered. Verification may succeed for some and fail for others.
3376
3377 The
3378 .cindex "return code" "for &%-bv%&"
3379 return code is 2 if any address failed outright; it is 1 if no address
3380 failed outright but at least one could not be resolved for some reason. Return
3381 code 0 is given only when all addresses succeed.
3382
3383 If any of the routers in the configuration makes any tests on the sender
3384 address of a message, you should use the &%-f%& option to set an appropriate
3385 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3386 calling user at the default qualifying domain.
3387
3388 .vitem &%-bvs%&
3389 .oindex "&%-bvs%&"
3390 This option acts like &%-bv%&, but verifies the address as a sender rather
3391 than a recipient address. This affects any rewriting and qualification that
3392 might happen.
3393
3394 .vitem &%-bw%&
3395 .oindex "&%-bw%&"
3396 .cindex "daemon"
3397 .cindex "inetd"
3398 .cindex "inetd" "wait mode"
3399 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3400 similarly to the &%-bd%& option.  All port specifications on the command-line
3401 and in the configuration file are ignored.  Queue-running may not be specified.
3402
3403 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3404 listening for connections.  This permits the system to start up and have
3405 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3406 each port only when the first connection is received.
3407
3408 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3409 which the daemon will exit, which should cause inetd to listen once more.
3410
3411 .vitem &%-C%&&~<&'filelist'&>
3412 .oindex "&%-C%&"
3413 .cindex "configuration file" "alternate"
3414 .cindex "CONFIGURE_FILE"
3415 .cindex "alternate configuration file"
3416 This option causes Exim to find the run time configuration file from the given
3417 list instead of from the list specified by the CONFIGURE_FILE
3418 compile-time setting. Usually, the list will consist of just a single file
3419 name, but it can be a colon-separated list of names. In this case, the first
3420 file that exists is used. Failure to open an existing file stops Exim from
3421 proceeding any further along the list, and an error is generated.
3422
3423 When this option is used by a caller other than root, and the list is different
3424 from the compiled-in list, Exim gives up its root privilege immediately, and
3425 runs with the real and effective uid and gid set to those of the caller.
3426 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3427 file contains a list of full pathnames, one per line, for configuration files
3428 which are trusted. Root privilege is retained for any configuration file so
3429 listed, as long as the caller is the Exim user (or the user specified in the
3430 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3431 not writeable by inappropriate users or groups.
3432
3433 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3434 configuration using &%-C%& right through message reception and delivery,
3435 even if the caller is root. The reception works, but by that time, Exim is
3436 running as the Exim user, so when it re-executes to regain privilege for the
3437 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3438 test reception and delivery using two separate commands (one to put a message
3439 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3440
3441 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3442 prefix string with which any file named in a &%-C%& command line option
3443 must start. In addition, the file name must not contain the sequence &`/../`&.
3444 However, if the value of the &%-C%& option is identical to the value of
3445 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3446 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3447 unset, any file name can be used with &%-C%&.
3448
3449 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3450 to a directory to which only root has access. This prevents someone who has
3451 broken into the Exim account from running a privileged Exim with an arbitrary
3452 configuration file.
3453
3454 The &%-C%& facility is useful for ensuring that configuration files are
3455 syntactically correct, but cannot be used for test deliveries, unless the
3456 caller is privileged, or unless it is an exotic configuration that does not
3457 require privilege. No check is made on the owner or group of the files
3458 specified by this option.
3459
3460
3461 .vitem &%-D%&<&'macro'&>=<&'value'&>
3462 .oindex "&%-D%&"
3463 .cindex "macro" "setting on command line"
3464 This option can be used to override macro definitions in the configuration file
3465 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3466 unprivileged caller, it causes Exim to give up its root privilege.
3467 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3468 completely disabled, and its use causes an immediate error exit.
3469
3470 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3471 colon-separated list of macros which are considered safe and, if &%-D%& only
3472 supplies macros from this list, and the values are acceptable, then Exim will
3473 not give up root privilege if the caller is root, the Exim run-time user, or
3474 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3475 to be removed in the future.  Acceptable values for the macros satisfy the
3476 regexp: &`^[A-Za-z0-9_/.-]*$`&
3477
3478 The entire option (including equals sign if present) must all be within one
3479 command line item. &%-D%& can be used to set the value of a macro to the empty
3480 string, in which case the equals sign is optional. These two commands are
3481 synonymous:
3482 .code
3483 exim -DABC  ...
3484 exim -DABC= ...
3485 .endd
3486 To include spaces in a macro definition item, quotes must be used. If you use
3487 quotes, spaces are permitted around the macro name and the equals sign. For
3488 example:
3489 .code
3490 exim '-D ABC = something' ...
3491 .endd
3492 &%-D%& may be repeated up to 10 times on a command line.
3493
3494
3495 .vitem &%-d%&<&'debug&~options'&>
3496 .oindex "&%-d%&"
3497 .cindex "debugging" "list of selectors"
3498 .cindex "debugging" "&%-d%& option"
3499 This option causes debugging information to be written to the standard
3500 error stream. It is restricted to admin users because debugging output may show
3501 database queries that contain password information. Also, the details of users'
3502 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3503 writes an error message to the standard error stream and exits with a non-zero
3504 return code.
3505
3506 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3507 standard debugging data is output. This can be reduced, or increased to include
3508 some more rarely needed information, by directly following &%-d%& with a string
3509 made up of names preceded by plus or minus characters. These add or remove sets
3510 of debugging data, respectively. For example, &%-d+filter%& adds filter
3511 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3512 no spaces are allowed in the debug setting. The available debugging categories
3513 are:
3514 .display
3515 &`acl            `& ACL interpretation
3516 &`auth           `& authenticators
3517 &`deliver        `& general delivery logic
3518 &`dns            `& DNS lookups (see also resolver)
3519 &`dnsbl          `& DNS black list (aka RBL) code
3520 &`exec           `& arguments for &[execv()]& calls
3521 &`expand         `& detailed debugging for string expansions
3522 &`filter         `& filter handling
3523 &`hints_lookup   `& hints data lookups
3524 &`host_lookup    `& all types of name-to-IP address handling
3525 &`ident          `& ident lookup
3526 &`interface      `& lists of local interfaces
3527 &`lists          `& matching things in lists
3528 &`load           `& system load checks
3529 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3530                     &<<CHAPlocalscan>>&)
3531 &`lookup         `& general lookup code and all lookups
3532 &`memory         `& memory handling
3533 &`pid            `& add pid to debug output lines
3534 &`process_info   `& setting info for the process log
3535 &`queue_run      `& queue runs
3536 &`receive        `& general message reception logic
3537 &`resolver       `& turn on the DNS resolver's debugging output
3538 &`retry          `& retry handling
3539 &`rewrite        `& address rewriting
3540 &`route          `& address routing
3541 &`timestamp      `& add timestamp to debug output lines
3542 &`tls            `& TLS logic
3543 &`transport      `& transports
3544 &`uid            `& changes of uid/gid and looking up uid/gid
3545 &`verify         `& address verification logic
3546 &`all            `& almost all of the above (see below), and also &%-v%&
3547 .endd
3548 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3549 for &`-all`&. The reason for this is that &`+all`& is something that people
3550 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3551 is included, an awful lot of output that is very rarely of interest is
3552 generated, so it now has to be explicitly requested. However, &`-all`& does
3553 turn everything off.
3554
3555 .cindex "resolver, debugging output"
3556 .cindex "DNS resolver, debugging output"
3557 The &`resolver`& option produces output only if the DNS resolver was compiled
3558 with DEBUG enabled. This is not the case in some operating systems. Also,
3559 unfortunately, debugging output from the DNS resolver is written to stdout
3560 rather than stderr.
3561
3562 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3563 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3564 However, the &`pid`& selector is forced when debugging is turned on for a
3565 daemon, which then passes it on to any re-executed Exims. Exim also
3566 automatically adds the pid to debug lines when several remote deliveries are
3567 run in parallel.
3568
3569 The &`timestamp`& selector causes the current time to be inserted at the start
3570 of all debug output lines. This can be useful when trying to track down delays
3571 in processing.
3572
3573 If the &%debug_print%& option is set in any driver, it produces output whenever
3574 any debugging is selected, or if &%-v%& is used.
3575
3576 .vitem &%-dd%&<&'debug&~options'&>
3577 .oindex "&%-dd%&"
3578 This option behaves exactly like &%-d%& except when used on a command that
3579 starts a daemon process. In that case, debugging is turned off for the
3580 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3581 behaviour of the daemon without creating as much output as full debugging does.
3582
3583 .vitem &%-dropcr%&
3584 .oindex "&%-dropcr%&"
3585 This is an obsolete option that is now a no-op. It used to affect the way Exim
3586 handled CR and LF characters in incoming messages. What happens now is
3587 described in section &<<SECTlineendings>>&.
3588
3589 .vitem &%-E%&
3590 .oindex "&%-E%&"
3591 .cindex "bounce message" "generating"
3592 This option specifies that an incoming message is a locally-generated delivery
3593 failure report. It is used internally by Exim when handling delivery failures
3594 and is not intended for external use. Its only effect is to stop Exim
3595 generating certain messages to the postmaster, as otherwise message cascades
3596 could occur in some situations. As part of the same option, a message id may
3597 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3598 new message contains the id, following &"R="&, as a cross-reference.
3599
3600 .vitem &%-e%&&'x'&
3601 .oindex "&%-e%&&'x'&"
3602 There are a number of Sendmail options starting with &%-oe%& which seem to be
3603 called by various programs without the leading &%o%& in the option. For
3604 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3605 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3606
3607 .vitem &%-F%&&~<&'string'&>
3608 .oindex "&%-F%&"
3609 .cindex "sender" "name"
3610 .cindex "name" "of sender"
3611 This option sets the sender's full name for use when a locally-generated
3612 message is being accepted. In the absence of this option, the user's &'gecos'&
3613 entry from the password data is used. As users are generally permitted to alter
3614 their &'gecos'& entries, no security considerations are involved. White space
3615 between &%-F%& and the <&'string'&> is optional.
3616
3617 .vitem &%-f%&&~<&'address'&>
3618 .oindex "&%-f%&"
3619 .cindex "sender" "address"
3620 .cindex "address" "sender"
3621 .cindex "trusted users"
3622 .cindex "envelope sender"
3623 .cindex "user" "trusted"
3624 This option sets the address of the envelope sender of a locally-generated
3625 message (also known as the return path). The option can normally be used only
3626 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3627 users to use it.
3628
3629 Processes running as root or the Exim user are always trusted. Other
3630 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3631 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3632 of a local message is set to the caller's login name at the default qualify
3633 domain.
3634
3635 There is one exception to the restriction on the use of &%-f%&: an empty sender
3636 can be specified by any user, trusted or not, to create a message that can
3637 never provoke a bounce. An empty sender can be specified either as an empty
3638 string, or as a pair of angle brackets with nothing between them, as in these
3639 examples of shell commands:
3640 .code
3641 exim -f '<>' user@domain
3642 exim -f "" user@domain
3643 .endd
3644 In addition, the use of &%-f%& is not restricted when testing a filter file
3645 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3646 &%-bv%& options.
3647
3648 Allowing untrusted users to change the sender address does not of itself make
3649 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3650 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3651 though this can be overridden by setting &%no_local_from_check%&.
3652
3653 White
3654 .cindex "&""From""& line"
3655 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3656 given as two arguments or one combined argument). The sender of a
3657 locally-generated message can also be set (when permitted) by an initial
3658 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3659 if &%-f%& is also present, it overrides &"From&~"&.
3660
3661 .vitem &%-G%&
3662 .oindex "&%-G%&"
3663 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3664 This is a Sendmail option which is ignored by Exim.
3665
3666 .vitem &%-h%&&~<&'number'&>
3667 .oindex "&%-h%&"
3668 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3669 This option is accepted for compatibility with Sendmail, but has no effect. (In
3670 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3671 headers.)
3672
3673 .vitem &%-i%&
3674 .oindex "&%-i%&"
3675 .cindex "Solaris" "&'mail'& command"
3676 .cindex "dot" "in incoming non-SMTP message"
3677 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3678 line by itself should not terminate an incoming, non-SMTP message. I can find
3679 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3680 command in Solaris 2.4 uses it. See also &%-ti%&.
3681
3682 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3683 .oindex "&%-M%&"
3684 .cindex "forcing delivery"
3685 .cindex "delivery" "forcing attempt"
3686 .cindex "frozen messages" "forcing delivery"
3687 This option requests Exim to run a delivery attempt on each message in turn. If
3688 any of the messages are frozen, they are automatically thawed before the
3689 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3690 and &%hold_domains%& are ignored.
3691
3692 Retry
3693 .cindex "hints database" "overriding retry hints"
3694 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3695 the normal retry time has not yet been reached. This option requires the caller
3696 to be an admin user. However, there is an option called &%prod_requires_admin%&
3697 which can be set false to relax this restriction (and also the same requirement
3698 for the &%-q%&, &%-R%&, and &%-S%& options).
3699
3700 The deliveries happen synchronously, that is, the original Exim process does
3701 not terminate until all the delivery attempts have finished. No output is
3702 produced unless there is a serious error. If you want to see what is happening,
3703 use the &%-v%& option as well, or inspect Exim's main log.
3704
3705 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3706 .oindex "&%-Mar%&"
3707 .cindex "message" "adding recipients"
3708 .cindex "recipient" "adding"
3709 This option requests Exim to add the addresses to the list of recipients of the
3710 message (&"ar"& for &"add recipients"&). The first argument must be a message
3711 id, and the remaining ones must be email addresses. However, if the message is
3712 active (in the middle of a delivery attempt), it is not altered. This option
3713 can be used only by an admin user.
3714
3715 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3716         &~<&'message&~id'&>"
3717 .oindex "&%-MC%&"
3718 .cindex "SMTP" "passed connection"
3719 .cindex "SMTP" "multiple deliveries"
3720 .cindex "multiple SMTP deliveries"
3721 This option is not intended for use by external callers. It is used internally
3722 by Exim to invoke another instance of itself to deliver a waiting message using
3723 an existing SMTP connection, which is passed as the standard input. Details are
3724 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3725 must be root or the Exim user in order to use it.
3726
3727 .vitem &%-MCA%&
3728 .oindex "&%-MCA%&"
3729 This option is not intended for use by external callers. It is used internally
3730 by Exim in conjunction with the &%-MC%& option. It signifies that the
3731 connection to the remote host has been authenticated.
3732
3733 .vitem &%-MCP%&
3734 .oindex "&%-MCP%&"
3735 This option is not intended for use by external callers. It is used internally
3736 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3737 which Exim is connected supports pipelining.
3738
3739 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3740 .oindex "&%-MCQ%&"
3741 This option is not intended for use by external callers. It is used internally
3742 by Exim in conjunction with the &%-MC%& option when the original delivery was
3743 started by a queue runner. It passes on the process id of the queue runner,
3744 together with the file descriptor number of an open pipe. Closure of the pipe
3745 signals the final completion of the sequence of processes that are passing
3746 messages through the same SMTP connection.
3747
3748 .vitem &%-MCS%&
3749 .oindex "&%-MCS%&"
3750 This option is not intended for use by external callers. It is used internally
3751 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3752 SMTP SIZE option should be used on messages delivered down the existing
3753 connection.
3754
3755 .vitem &%-MCT%&
3756 .oindex "&%-MCT%&"
3757 This option is not intended for use by external callers. It is used internally
3758 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3759 host to which Exim is connected supports TLS encryption.
3760
3761 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3762 .oindex "&%-Mc%&"
3763 .cindex "hints database" "not overridden by &%-Mc%&"
3764 .cindex "delivery" "manually started &-- not forced"
3765 This option requests Exim to run a delivery attempt on each message in turn,
3766 but unlike the &%-M%& option, it does check for retry hints, and respects any
3767 that are found. This option is not very useful to external callers. It is
3768 provided mainly for internal use by Exim when it needs to re-invoke itself in
3769 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3770 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3771 respects retry times and other options such as &%hold_domains%& that are
3772 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3773 If you want to run a specific delivery as if in a queue run, you should use
3774 &%-q%& with a message id argument. A distinction between queue run deliveries
3775 and other deliveries is made in one or two places.
3776
3777 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3778 .oindex "&%-Mes%&"
3779 .cindex "message" "changing sender"
3780 .cindex "sender" "changing"
3781 This option requests Exim to change the sender address in the message to the
3782 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3783 &"edit sender"&). There must be exactly two arguments. The first argument must
3784 be a message id, and the second one an email address. However, if the message
3785 is active (in the middle of a delivery attempt), its status is not altered.
3786 This option can be used only by an admin user.
3787
3788 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3789 .oindex "&%-Mf%&"
3790 .cindex "freezing messages"
3791 .cindex "message" "manually freezing"
3792 This option requests Exim to mark each listed message as &"frozen"&. This
3793 prevents any delivery attempts taking place until the message is &"thawed"&,
3794 either manually or as a result of the &%auto_thaw%& configuration option.
3795 However, if any of the messages are active (in the middle of a delivery
3796 attempt), their status is not altered. This option can be used only by an admin
3797 user.
3798
3799 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3800 .oindex "&%-Mg%&"
3801 .cindex "giving up on messages"
3802 .cindex "message" "abandoning delivery attempts"
3803 .cindex "delivery" "abandoning further attempts"
3804 This option requests Exim to give up trying to deliver the listed messages,
3805 including any that are frozen. However, if any of the messages are active,
3806 their status is not altered. For non-bounce messages, a delivery error message
3807 is sent to the sender, containing the text &"cancelled by administrator"&.
3808 Bounce messages are just discarded. This option can be used only by an admin
3809 user.
3810
3811 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3812 .oindex "&%-Mmad%&"
3813 .cindex "delivery" "cancelling all"
3814 This option requests Exim to mark all the recipient addresses in the messages
3815 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3816 message is active (in the middle of a delivery attempt), its status is not
3817 altered. This option can be used only by an admin user.
3818
3819 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3820 .oindex "&%-Mmd%&"
3821 .cindex "delivery" "cancelling by address"
3822 .cindex "recipient" "removing"
3823 .cindex "removing recipients"
3824 This option requests Exim to mark the given addresses as already delivered
3825 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3826 the remaining ones must be email addresses. These are matched to recipient
3827 addresses in the message in a case-sensitive manner. If the message is active
3828 (in the middle of a delivery attempt), its status is not altered. This option
3829 can be used only by an admin user.
3830
3831 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3832 .oindex "&%-Mrm%&"
3833 .cindex "removing messages"
3834 .cindex "abandoning mail"
3835 .cindex "message" "manually discarding"
3836 This option requests Exim to remove the given messages from the queue. No
3837 bounce messages are sent; each message is simply forgotten. However, if any of
3838 the messages are active, their status is not altered. This option can be used
3839 only by an admin user or by the user who originally caused the message to be
3840 placed on the queue.
3841
3842 .vitem &%-Mset%&&~<&'message&~id'&>
3843 .oindex "&%-Mset%&
3844 .cindex "testing" "string expansion"
3845 .cindex "expansion" "testing"
3846 This option is useful only in conjunction with &%-be%& (that is, when testing
3847 string expansions). Exim loads the given message from its spool before doing
3848 the test expansions, thus setting message-specific variables such as
3849 &$message_size$& and the header variables. The &$recipients$& variable is made
3850 available. This feature is provided to make it easier to test expansions that
3851 make use of these variables. However, this option can be used only by an admin
3852 user. See also &%-bem%&.
3853
3854 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3855 .oindex "&%-Mt%&"
3856 .cindex "thawing messages"
3857 .cindex "unfreezing messages"
3858 .cindex "frozen messages" "thawing"
3859 .cindex "message" "thawing frozen"
3860 This option requests Exim to &"thaw"& any of the listed messages that are
3861 &"frozen"&, so that delivery attempts can resume. However, if any of the
3862 messages are active, their status is not altered. This option can be used only
3863 by an admin user.
3864
3865 .vitem &%-Mvb%&&~<&'message&~id'&>
3866 .oindex "&%-Mvb%&"
3867 .cindex "listing" "message body"
3868 .cindex "message" "listing body of"
3869 This option causes the contents of the message body (-D) spool file to be
3870 written to the standard output. This option can be used only by an admin user.
3871
3872 .vitem &%-Mvc%&&~<&'message&~id'&>
3873 .oindex "&%-Mvc%&"
3874 .cindex "message" "listing in RFC 2822 format"
3875 .cindex "listing" "message in RFC 2822 format"
3876 This option causes a copy of the complete message (header lines plus body) to
3877 be written to the standard output in RFC 2822 format. This option can be used
3878 only by an admin user.
3879
3880 .vitem &%-Mvh%&&~<&'message&~id'&>
3881 .oindex "&%-Mvh%&"
3882 .cindex "listing" "message headers"
3883 .cindex "header lines" "listing"
3884 .cindex "message" "listing header lines"
3885 This option causes the contents of the message headers (-H) spool file to be
3886 written to the standard output. This option can be used only by an admin user.
3887
3888 .vitem &%-Mvl%&&~<&'message&~id'&>
3889 .oindex "&%-Mvl%&"
3890 .cindex "listing" "message log"
3891 .cindex "message" "listing message log"
3892 This option causes the contents of the message log spool file to be written to
3893 the standard output. This option can be used only by an admin user.
3894
3895 .vitem &%-m%&
3896 .oindex "&%-m%&"
3897 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3898 treats it that way too.
3899
3900 .vitem &%-N%&
3901 .oindex "&%-N%&"
3902 .cindex "debugging" "&%-N%& option"
3903 .cindex "debugging" "suppressing delivery"
3904 This is a debugging option that inhibits delivery of a message at the transport
3905 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3906 it just doesn't actually transport the message, but instead behaves as if it
3907 had successfully done so. However, it does not make any updates to the retry
3908 database, and the log entries for deliveries are flagged with &"*>"& rather
3909 than &"=>"&.
3910
3911 Because &%-N%& discards any message to which it applies, only root or the Exim
3912 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3913 words, an ordinary user can use it only when supplying an incoming message to
3914 which it will apply. Although transportation never fails when &%-N%& is set, an
3915 address may be deferred because of a configuration problem on a transport, or a
3916 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3917 the message, and applies to any subsequent delivery attempts that may happen
3918 for that message.
3919
3920 .vitem &%-n%&
3921 .oindex "&%-n%&"
3922 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3923 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3924 by Exim.
3925
3926 .vitem &%-O%&&~<&'data'&>
3927 .oindex "&%-O%&"
3928 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3929 Exim.
3930
3931 .vitem &%-oA%&&~<&'file&~name'&>
3932 .oindex "&%-oA%&"
3933 .cindex "Sendmail compatibility" "&%-oA%& option"
3934 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3935 alternative alias file name. Exim handles &%-bi%& differently; see the
3936 description above.
3937
3938 .vitem &%-oB%&&~<&'n'&>
3939 .oindex "&%-oB%&"
3940 .cindex "SMTP" "passed connection"
3941 .cindex "SMTP" "multiple deliveries"
3942 .cindex "multiple SMTP deliveries"
3943 This is a debugging option which limits the maximum number of messages that can
3944 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3945 transport. If <&'n'&> is omitted, the limit is set to 1.
3946
3947 .vitem &%-odb%&
3948 .oindex "&%-odb%&"
3949 .cindex "background delivery"
3950 .cindex "delivery" "in the background"
3951 This option applies to all modes in which Exim accepts incoming messages,
3952 including the listening daemon. It requests &"background"& delivery of such
3953 messages, which means that the accepting process automatically starts a
3954 delivery process for each message received, but does not wait for the delivery
3955 processes to finish.
3956
3957 When all the messages have been received, the reception process exits,
3958 leaving the delivery processes to finish in their own time. The standard output
3959 and error streams are closed at the start of each delivery process.
3960 This is the default action if none of the &%-od%& options are present.
3961
3962 If one of the queueing options in the configuration file
3963 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3964 overrides it if &%queue_only_override%& is set true, which is the default
3965 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3966
3967 .vitem &%-odf%&
3968 .oindex "&%-odf%&"
3969 .cindex "foreground delivery"
3970 .cindex "delivery" "in the foreground"
3971 This option requests &"foreground"& (synchronous) delivery when Exim has
3972 accepted a locally-generated message. (For the daemon it is exactly the same as
3973 &%-odb%&.) A delivery process is automatically started to deliver the message,
3974 and Exim waits for it to complete before proceeding.
3975
3976 The original Exim reception process does not finish until the delivery
3977 process for the final message has ended. The standard error stream is left open
3978 during deliveries.
3979
3980 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3981 false and one of the queueing options in the configuration file is in effect.
3982
3983 If there is a temporary delivery error during foreground delivery, the
3984 message is left on the queue for later delivery, and the original reception
3985 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3986 restricted configuration that never queues messages.
3987
3988
3989 .vitem &%-odi%&
3990 .oindex "&%-odi%&"
3991 This option is synonymous with &%-odf%&. It is provided for compatibility with
3992 Sendmail.
3993
3994 .vitem &%-odq%&
3995 .oindex "&%-odq%&"
3996 .cindex "non-immediate delivery"
3997 .cindex "delivery" "suppressing immediate"
3998 .cindex "queueing incoming messages"
3999 This option applies to all modes in which Exim accepts incoming messages,
4000 including the listening daemon. It specifies that the accepting process should
4001 not automatically start a delivery process for each message received. Messages
4002 are placed on the queue, and remain there until a subsequent queue runner
4003 process encounters them. There are several configuration options (such as
4004 &%queue_only%&) that can be used to queue incoming messages under certain
4005 conditions. This option overrides all of them and also &%-odqs%&. It always
4006 forces queueing.
4007
4008 .vitem &%-odqs%&
4009 .oindex "&%-odqs%&"
4010 .cindex "SMTP" "delaying delivery"
4011 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4012 However, like &%-odb%& and &%-odi%&, this option has no effect if
4013 &%queue_only_override%& is false and one of the queueing options in the
4014 configuration file is in effect.
4015
4016 When &%-odqs%& does operate, a delivery process is started for each incoming
4017 message, in the background by default, but in the foreground if &%-odi%& is
4018 also present. The recipient addresses are routed, and local deliveries are done
4019 in the normal way. However, if any SMTP deliveries are required, they are not
4020 done at this time, so the message remains on the queue until a subsequent queue
4021 runner process encounters it. Because routing was done, Exim knows which
4022 messages are waiting for which hosts, and so a number of messages for the same
4023 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4024 configuration option has the same effect for specific domains. See also the
4025 &%-qq%& option.
4026
4027 .vitem &%-oee%&
4028 .oindex "&%-oee%&"
4029 .cindex "error" "reporting"
4030 If an error is detected while a non-SMTP message is being received (for
4031 example, a malformed address), the error is reported to the sender in a mail
4032 message.
4033
4034 .cindex "return code" "for &%-oee%&"
4035 Provided
4036 this error message is successfully sent, the Exim receiving process
4037 exits with a return code of zero. If not, the return code is 2 if the problem
4038 is that the original message has no recipients, or 1 any other error. This is
4039 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4040
4041 .vitem &%-oem%&
4042 .oindex "&%-oem%&"
4043 .cindex "error" "reporting"
4044 .cindex "return code" "for &%-oem%&"
4045 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4046 return code, whether or not the error message was successfully sent.
4047 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4048
4049 .vitem &%-oep%&
4050 .oindex "&%-oep%&"
4051 .cindex "error" "reporting"
4052 If an error is detected while a non-SMTP message is being received, the
4053 error is reported by writing a message to the standard error file (stderr).
4054 .cindex "return code" "for &%-oep%&"
4055 The return code is 1 for all errors.
4056
4057 .vitem &%-oeq%&
4058 .oindex "&%-oeq%&"
4059 .cindex "error" "reporting"
4060 This option is supported for compatibility with Sendmail, but has the same
4061 effect as &%-oep%&.
4062
4063 .vitem &%-oew%&
4064 .oindex "&%-oew%&"
4065 .cindex "error" "reporting"
4066 This option is supported for compatibility with Sendmail, but has the same
4067 effect as &%-oem%&.
4068
4069 .vitem &%-oi%&
4070 .oindex "&%-oi%&"
4071 .cindex "dot" "in incoming non-SMTP message"
4072 This option, which has the same effect as &%-i%&, specifies that a dot on a
4073 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4074 single dot does terminate, though Exim does no special processing for other
4075 lines that start with a dot. This option is set by default if Exim is called as
4076 &'rmail'&. See also &%-ti%&.
4077
4078 .vitem &%-oitrue%&
4079 .oindex "&%-oitrue%&"
4080 This option is treated as synonymous with &%-oi%&.
4081
4082 .vitem &%-oMa%&&~<&'host&~address'&>
4083 .oindex "&%-oMa%&"
4084 .cindex "sender" "host address, specifying for local message"
4085 A number of options starting with &%-oM%& can be used to set values associated
4086 with remote hosts on locally-submitted messages (that is, messages not received
4087 over TCP/IP). These options can be used by any caller in conjunction with the
4088 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4089 other circumstances, they are ignored unless the caller is trusted.
4090
4091 The &%-oMa%& option sets the sender host address. This may include a port
4092 number at the end, after a full stop (period). For example:
4093 .code
4094 exim -bs -oMa 10.9.8.7.1234
4095 .endd
4096 An alternative syntax is to enclose the IP address in square brackets,
4097 followed by a colon and the port number:
4098 .code
4099 exim -bs -oMa [10.9.8.7]:1234
4100 .endd
4101 The IP address is placed in the &$sender_host_address$& variable, and the
4102 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4103 are present on the command line, the sender host IP address is taken from
4104 whichever one is last.
4105
4106 .vitem &%-oMaa%&&~<&'name'&>
4107 .oindex "&%-oMaa%&"
4108 .cindex "authentication" "name, specifying for local message"
4109 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4110 option sets the value of &$sender_host_authenticated$& (the authenticator
4111 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4112 This option can be used with &%-bh%& and &%-bs%& to set up an
4113 authenticated SMTP session without actually using the SMTP AUTH command.
4114
4115 .vitem &%-oMai%&&~<&'string'&>
4116 .oindex "&%-oMai%&"
4117 .cindex "authentication" "id, specifying for local message"
4118 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4119 option sets the value of &$authenticated_id$& (the id that was authenticated).
4120 This overrides the default value (the caller's login id, except with &%-bh%&,
4121 where there is no default) for messages from local sources. See chapter
4122 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4123
4124 .vitem &%-oMas%&&~<&'address'&>
4125 .oindex "&%-oMas%&"
4126 .cindex "authentication" "sender, specifying for local message"
4127 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4128 option sets the authenticated sender value in &$authenticated_sender$&. It
4129 overrides the sender address that is created from the caller's login id for
4130 messages from local sources, except when &%-bh%& is used, when there is no
4131 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4132 specified on a MAIL command overrides this value. See chapter
4133 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4134
4135 .vitem &%-oMi%&&~<&'interface&~address'&>
4136 .oindex "&%-oMi%&"
4137 .cindex "interface" "address, specifying for local message"
4138 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4139 option sets the IP interface address value. A port number may be included,
4140 using the same syntax as for &%-oMa%&. The interface address is placed in
4141 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4142
4143 .vitem &%-oMr%&&~<&'protocol&~name'&>
4144 .oindex "&%-oMr%&"
4145 .cindex "protocol, specifying for local message"
4146 .vindex "&$received_protocol$&"
4147 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4148 option sets the received protocol value that is stored in
4149 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4150 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4151 SMTP protocol names (see the description of &$received_protocol$& in section
4152 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4153 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4154 be set by &%-oMr%&.
4155
4156 .vitem &%-oMs%&&~<&'host&~name'&>
4157 .oindex "&%-oMs%&"
4158 .cindex "sender" "host name, specifying for local message"
4159 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4160 option sets the sender host name in &$sender_host_name$&. When this option is
4161 present, Exim does not attempt to look up a host name from an IP address; it
4162 uses the name it is given.
4163
4164 .vitem &%-oMt%&&~<&'ident&~string'&>
4165 .oindex "&%-oMt%&"
4166 .cindex "sender" "ident string, specifying for local message"
4167 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4168 option sets the sender ident value in &$sender_ident$&. The default setting for
4169 local callers is the login id of the calling process, except when &%-bh%& is
4170 used, when there is no default.
4171
4172 .vitem &%-om%&
4173 .oindex "&%-om%&"
4174 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4175 In Sendmail, this option means &"me too"&, indicating that the sender of a
4176 message should receive a copy of the message if the sender appears in an alias
4177 expansion. Exim always does this, so the option does nothing.
4178
4179 .vitem &%-oo%&
4180 .oindex "&%-oo%&"
4181 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4182 This option is ignored. In Sendmail it specifies &"old style headers"&,
4183 whatever that means.
4184
4185 .vitem &%-oP%&&~<&'path'&>
4186 .oindex "&%-oP%&"
4187 .cindex "pid (process id)" "of daemon"
4188 .cindex "daemon" "process id (pid)"
4189 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4190 value. The option specifies the file to which the process id of the daemon is
4191 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4192 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4193 because in those cases, the normal pid file is not used.
4194
4195 .vitem &%-or%&&~<&'time'&>
4196 .oindex "&%-or%&"
4197 .cindex "timeout" "for non-SMTP input"
4198 This option sets a timeout value for incoming non-SMTP messages. If it is not
4199 set, Exim will wait forever for the standard input. The value can also be set
4200 by the &%receive_timeout%& option. The format used for specifying times is
4201 described in section &<<SECTtimeformat>>&.
4202
4203 .vitem &%-os%&&~<&'time'&>
4204 .oindex "&%-os%&"
4205 .cindex "timeout" "for SMTP input"
4206 .cindex "SMTP" "input timeout"
4207 This option sets a timeout value for incoming SMTP messages. The timeout
4208 applies to each SMTP command and block of data. The value can also be set by
4209 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4210 for specifying times is described in section &<<SECTtimeformat>>&.
4211
4212 .vitem &%-ov%&
4213 .oindex "&%-ov%&"
4214 This option has exactly the same effect as &%-v%&.
4215
4216 .vitem &%-oX%&&~<&'number&~or&~string'&>
4217 .oindex "&%-oX%&"
4218 .cindex "TCP/IP" "setting listening ports"
4219 .cindex "TCP/IP" "setting listening interfaces"
4220 .cindex "port" "receiving TCP/IP"
4221 This option is relevant only when the &%-bd%& (start listening daemon) option
4222 is also given. It controls which ports and interfaces the daemon uses. Details
4223 of the syntax, and how it interacts with configuration file options, are given
4224 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4225 file is written unless &%-oP%& is also present to specify a pid file name.
4226
4227 .vitem &%-pd%&
4228 .oindex "&%-pd%&"
4229 .cindex "Perl" "starting the interpreter"
4230 This option applies when an embedded Perl interpreter is linked with Exim (see
4231 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4232 option, forcing the starting of the interpreter to be delayed until it is
4233 needed.
4234
4235 .vitem &%-ps%&
4236 .oindex "&%-ps%&"
4237 .cindex "Perl" "starting the interpreter"
4238 This option applies when an embedded Perl interpreter is linked with Exim (see
4239 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4240 option, forcing the starting of the interpreter to occur as soon as Exim is
4241 started.
4242
4243 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4244 .oindex "&%-p%&"
4245 For compatibility with Sendmail, this option is equivalent to
4246 .display
4247 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4248 .endd
4249 It sets the incoming protocol and host name (for trusted callers). The
4250 host name and its colon can be omitted when only the protocol is to be set.
4251 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4252 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4253 or &`s`& using this option (but that does not seem a real limitation).
4254
4255 .vitem &%-q%&
4256 .oindex "&%-q%&"
4257 .cindex "queue runner" "starting manually"
4258 This option is normally restricted to admin users. However, there is a
4259 configuration option called &%prod_requires_admin%& which can be set false to
4260 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4261 and &%-S%& options).
4262
4263 .cindex "queue runner" "description of operation"
4264 The &%-q%& option starts one queue runner process. This scans the queue of
4265 waiting messages, and runs a delivery process for each one in turn. It waits
4266 for each delivery process to finish before starting the next one. A delivery
4267 process may not actually do any deliveries if the retry times for the addresses
4268 have not been reached. Use &%-qf%& (see below) if you want to override this.
4269
4270 If
4271 .cindex "SMTP" "passed connection"
4272 .cindex "SMTP" "multiple deliveries"
4273 .cindex "multiple SMTP deliveries"
4274 the delivery process spawns other processes to deliver other messages down
4275 passed SMTP connections, the queue runner waits for these to finish before
4276 proceeding.
4277
4278 When all the queued messages have been considered, the original queue runner
4279 process terminates. In other words, a single pass is made over the waiting
4280 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4281 this to be repeated periodically.
4282
4283 Exim processes the waiting messages in an unpredictable order. It isn't very
4284 random, but it is likely to be different each time, which is all that matters.
4285 If one particular message screws up a remote MTA, other messages to the same
4286 MTA have a chance of getting through if they get tried first.
4287
4288 It is possible to cause the messages to be processed in lexical message id
4289 order, which is essentially the order in which they arrived, by setting the
4290 &%queue_run_in_order%& option, but this is not recommended for normal use.
4291
4292 .vitem &%-q%&<&'qflags'&>
4293 The &%-q%& option may be followed by one or more flag letters that change its
4294 behaviour. They are all optional, but if more than one is present, they must
4295 appear in the correct order. Each flag is described in a separate item below.
4296
4297 .vitem &%-qq...%&
4298 .oindex "&%-qq%&"
4299 .cindex "queue" "double scanning"
4300 .cindex "queue" "routing"
4301 .cindex "routing" "whole queue before delivery"
4302 An option starting with &%-qq%& requests a two-stage queue run. In the first
4303 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4304 every domain. Addresses are routed, local deliveries happen, but no remote
4305 transports are run.
4306
4307 .cindex "hints database" "remembering routing"
4308 The hints database that remembers which messages are waiting for specific hosts
4309 is updated, as if delivery to those hosts had been deferred. After this is
4310 complete, a second, normal queue scan happens, with routing and delivery taking
4311 place as normal. Messages that are routed to the same host should mostly be
4312 delivered down a single SMTP
4313 .cindex "SMTP" "passed connection"
4314 .cindex "SMTP" "multiple deliveries"
4315 .cindex "multiple SMTP deliveries"
4316 connection because of the hints that were set up during the first queue scan.
4317 This option may be useful for hosts that are connected to the Internet
4318 intermittently.
4319
4320 .vitem &%-q[q]i...%&
4321 .oindex "&%-qi%&"
4322 .cindex "queue" "initial delivery"
4323 If the &'i'& flag is present, the queue runner runs delivery processes only for
4324 those messages that haven't previously been tried. (&'i'& stands for &"initial
4325 delivery"&.) This can be helpful if you are putting messages on the queue using
4326 &%-odq%& and want a queue runner just to process the new messages.
4327
4328 .vitem &%-q[q][i]f...%&
4329 .oindex "&%-qf%&"
4330 .cindex "queue" "forcing delivery"
4331 .cindex "delivery" "forcing in queue run"
4332 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4333 message, whereas without &'f'& only those non-frozen addresses that have passed
4334 their retry times are tried.
4335
4336 .vitem &%-q[q][i]ff...%&
4337 .oindex "&%-qff%&"
4338 .cindex "frozen messages" "forcing delivery"
4339 If &'ff'& is present, a delivery attempt is forced for every message, whether
4340 frozen or not.
4341
4342 .vitem &%-q[q][i][f[f]]l%&
4343 .oindex "&%-ql%&"
4344 .cindex "queue" "local deliveries only"
4345 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4346 be done. If a message requires any remote deliveries, it remains on the queue
4347 for later delivery.
4348
4349 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4350 .cindex "queue" "delivering specific messages"
4351 When scanning the queue, Exim can be made to skip over messages whose ids are
4352 lexically less than a given value by following the &%-q%& option with a
4353 starting message id. For example:
4354 .code
4355 exim -q 0t5C6f-0000c8-00
4356 .endd
4357 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4358 second message id is given, messages whose ids are lexically greater than it
4359 are also skipped. If the same id is given twice, for example,
4360 .code
4361 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4362 .endd
4363 just one delivery process is started, for that message. This differs from
4364 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4365 that it counts as a delivery from a queue run. Note that the selection
4366 mechanism does not affect the order in which the messages are scanned. There
4367 are also other ways of selecting specific sets of messages for delivery in a
4368 queue run &-- see &%-R%& and &%-S%&.
4369
4370 .vitem &%-q%&<&'qflags'&><&'time'&>
4371 .cindex "queue runner" "starting periodically"
4372 .cindex "periodic queue running"
4373 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4374 starting a queue runner process at intervals specified by the given time value
4375 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4376 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4377 single daemon process handles both functions. A common way of starting up a
4378 combined daemon at system boot time is to use a command such as
4379 .code
4380 /usr/exim/bin/exim -bd -q30m
4381 .endd
4382 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4383 process every 30 minutes.
4384
4385 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4386 pid file is written unless one is explicitly requested by the &%-oP%& option.
4387
4388 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4389 .oindex "&%-qR%&"
4390 This option is synonymous with &%-R%&. It is provided for Sendmail
4391 compatibility.
4392
4393 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4394 .oindex "&%-qS%&"
4395 This option is synonymous with &%-S%&.
4396
4397 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4398 .oindex "&%-R%&"
4399 .cindex "queue runner" "for specific recipients"
4400 .cindex "delivery" "to given domain"
4401 .cindex "domain" "delivery to"
4402 The <&'rsflags'&> may be empty, in which case the white space before the string
4403 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4404 which are the possible values for <&'rsflags'&>. White space is required if
4405 <&'rsflags'&> is not empty.
4406
4407 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4408 perform a single queue run, except that, when scanning the messages on the
4409 queue, Exim processes only those that have at least one undelivered recipient
4410 address containing the given string, which is checked in a case-independent
4411 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4412 regular expression; otherwise it is a literal string.
4413
4414 If you want to do periodic queue runs for messages with specific recipients,
4415 you can combine &%-R%& with &%-q%& and a time value. For example:
4416 .code
4417 exim -q25m -R @special.domain.example
4418 .endd
4419 This example does a queue run for messages with recipients in the given domain
4420 every 25 minutes. Any additional flags that are specified with &%-q%& are
4421 applied to each queue run.
4422
4423 Once a message is selected for delivery by this mechanism, all its addresses
4424 are processed. For the first selected message, Exim overrides any retry
4425 information and forces a delivery attempt for each undelivered address. This
4426 means that if delivery of any address in the first message is successful, any
4427 existing retry information is deleted, and so delivery attempts for that
4428 address in subsequently selected messages (which are processed without forcing)
4429 will run. However, if delivery of any address does not succeed, the retry
4430 information is updated, and in subsequently selected messages, the failing
4431 address will be skipped.
4432
4433 .cindex "frozen messages" "forcing delivery"
4434 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4435 all selected messages, not just the first; frozen messages are included when
4436 &'ff'& is present.
4437
4438 The &%-R%& option makes it straightforward to initiate delivery of all messages
4439 to a given domain after a host has been down for some time. When the SMTP
4440 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4441 effect is to run Exim with the &%-R%& option, but it can be configured to run
4442 an arbitrary command instead.
4443
4444 .vitem &%-r%&
4445 .oindex "&%-r%&"
4446 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4447
4448 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4449 .oindex "&%-S%&"
4450 .cindex "delivery" "from given sender"
4451 .cindex "queue runner" "for specific senders"
4452 This option acts like &%-R%& except that it checks the string against each
4453 message's sender instead of against the recipients. If &%-R%& is also set, both
4454 conditions must be met for a message to be selected. If either of the options
4455 has &'f'& or &'ff'& in its flags, the associated action is taken.
4456
4457 .vitem &%-Tqt%&&~<&'times'&>
4458 .oindex "&%-Tqt%&"
4459 This an option that is exclusively for use by the Exim testing suite. It is not
4460 recognized when Exim is run normally. It allows for the setting up of explicit
4461 &"queue times"& so that various warning/retry features can be tested.
4462
4463 .vitem &%-t%&
4464 .oindex "&%-t%&"
4465 .cindex "recipient" "extracting from header lines"
4466 .cindex "&'Bcc:'& header line"
4467 .cindex "&'Cc:'& header line"
4468 .cindex "&'To:'& header line"
4469 When Exim is receiving a locally-generated, non-SMTP message on its standard
4470 input, the &%-t%& option causes the recipients of the message to be obtained
4471 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4472 from the command arguments. The addresses are extracted before any rewriting
4473 takes place and the &'Bcc:'& header line, if present, is then removed.
4474
4475 .cindex "Sendmail compatibility" "&%-t%& option"
4476 If the command has any arguments, they specify addresses to which the message
4477 is &'not'& to be delivered. That is, the argument addresses are removed from
4478 the recipients list obtained from the headers. This is compatible with Smail 3
4479 and in accordance with the documented behaviour of several versions of
4480 Sendmail, as described in man pages on a number of operating systems (e.g.
4481 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4482 argument addresses to those obtained from the headers, and the O'Reilly
4483 Sendmail book documents it that way. Exim can be made to add argument addresses
4484 instead of subtracting them by setting the option
4485 &%extract_addresses_remove_arguments%& false.
4486
4487 .cindex "&%Resent-%& header lines" "with &%-t%&"
4488 If there are any &%Resent-%& header lines in the message, Exim extracts
4489 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4490 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4491 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4492 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4493
4494 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4495 message is resent several times). The RFC also specifies that they should be
4496 added at the front of the message, and separated by &'Received:'& lines. It is
4497 not at all clear how &%-t%& should operate in the present of multiple sets,
4498 nor indeed exactly what constitutes a &"set"&.
4499 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4500 are often added at the end of the header, and if a message is resent more than
4501 once, it is common for the original set of &%Resent-%& headers to be renamed as
4502 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4503
4504 .vitem &%-ti%&
4505 .oindex "&%-ti%&"
4506 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4507 compatibility with Sendmail.
4508
4509 .vitem &%-tls-on-connect%&
4510 .oindex "&%-tls-on-connect%&"
4511 .cindex "TLS" "use without STARTTLS"
4512 .cindex "TLS" "automatic start"
4513 This option is available when Exim is compiled with TLS support. It forces all
4514 incoming SMTP connections to behave as if the incoming port is listed in the
4515 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4516 &<<CHAPTLS>>& for further details.
4517
4518
4519 .vitem &%-U%&
4520 .oindex "&%-U%&"
4521 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4522 Sendmail uses this option for &"initial message submission"&, and its
4523 documentation states that in future releases, it may complain about
4524 syntactically invalid messages rather than fixing them when this flag is not
4525 set. Exim ignores this option.
4526
4527 .vitem &%-v%&
4528 .oindex "&%-v%&"
4529 This option causes Exim to write information to the standard error stream,
4530 describing what it is doing. In particular, it shows the log lines for
4531 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4532 dialogue is shown. Some of the log lines shown may not actually be written to
4533 the log if the setting of &%log_selector%& discards them. Any relevant
4534 selectors are shown with each log line. If none are shown, the logging is
4535 unconditional.
4536
4537 .vitem &%-x%&
4538 .oindex "&%-x%&"
4539 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4540 National Language Support extended characters in the body of the mail item"&).
4541 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4542 this option.
4543 .endlist
4544
4545 .ecindex IIDclo1
4546 .ecindex IIDclo2
4547
4548
4549 . ////////////////////////////////////////////////////////////////////////////
4550 . Insert a stylized DocBook comment here, to identify the end of the command
4551 . line options. This is for the benefit of the Perl script that automatically
4552 . creates a man page for the options.
4553 . ////////////////////////////////////////////////////////////////////////////
4554
4555 .literal xml
4556 <!-- === End of command line options === -->
4557 .literal off
4558
4559
4560
4561
4562
4563 . ////////////////////////////////////////////////////////////////////////////
4564 . ////////////////////////////////////////////////////////////////////////////
4565
4566
4567 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4568          "The runtime configuration file"
4569
4570 .cindex "run time configuration"
4571 .cindex "configuration file" "general description"
4572 .cindex "CONFIGURE_FILE"
4573 .cindex "configuration file" "errors in"
4574 .cindex "error" "in configuration file"
4575 .cindex "return code" "for bad configuration"
4576 Exim uses a single run time configuration file that is read whenever an Exim
4577 binary is executed. Note that in normal operation, this happens frequently,
4578 because Exim is designed to operate in a distributed manner, without central
4579 control.
4580
4581 If a syntax error is detected while reading the configuration file, Exim
4582 writes a message on the standard error, and exits with a non-zero return code.
4583 The message is also written to the panic log. &*Note*&: Only simple syntax
4584 errors can be detected at this time. The values of any expanded options are
4585 not checked until the expansion happens, even when the expansion does not
4586 actually alter the string.
4587
4588 The name of the configuration file is compiled into the binary for security
4589 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4590 most configurations, this specifies a single file. However, it is permitted to
4591 give a colon-separated list of file names, in which case Exim uses the first
4592 existing file in the list.
4593
4594 .cindex "EXIM_USER"
4595 .cindex "EXIM_GROUP"
4596 .cindex "CONFIGURE_OWNER"
4597 .cindex "CONFIGURE_GROUP"
4598 .cindex "configuration file" "ownership"
4599 .cindex "ownership" "configuration file"
4600 The run time configuration file must be owned by root or by the user that is
4601 specified at compile time by the CONFIGURE_OWNER option (if set). The
4602 configuration file must not be world-writeable, or group-writeable unless its
4603 group is the root group or the one specified at compile time by the
4604 CONFIGURE_GROUP option.
4605
4606 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4607 to root, anybody who is able to edit the run time configuration file has an
4608 easy way to run commands as root. If you specify a user or group in the
4609 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4610 who are members of that group will trivially be able to obtain root privileges.
4611
4612 Up to Exim version 4.72, the run time configuration file was also permitted to
4613 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4614 since it offered a simple privilege escalation for any attacker who managed to
4615 compromise the Exim user account.
4616
4617 A default configuration file, which will work correctly in simple situations,
4618 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4619 defines just one file name, the installation process copies the default
4620 configuration to a new file of that name if it did not previously exist. If
4621 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4622 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4623 configuration.
4624
4625
4626
4627 .section "Using a different configuration file" "SECID40"
4628 .cindex "configuration file" "alternate"
4629 A one-off alternate configuration can be specified by the &%-C%& command line
4630 option, which may specify a single file or a list of files. However, when
4631 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4632 unless the argument for &%-C%& is identical to the built-in value from
4633 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4634 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4635 is useful mainly for checking the syntax of configuration files before
4636 installing them. No owner or group checks are done on a configuration file
4637 specified by &%-C%&, if root privilege has been dropped.
4638
4639 Even the Exim user is not trusted to specify an arbitrary configuration file
4640 with the &%-C%& option to be used with root privileges, unless that file is
4641 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4642 testing a configuration using &%-C%& right through message reception and
4643 delivery, even if the caller is root. The reception works, but by that time,
4644 Exim is running as the Exim user, so when it re-execs to regain privilege for
4645 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4646 can test reception and delivery using two separate commands (one to put a
4647 message on the queue, using &%-odq%&, and another to do the delivery, using
4648 &%-M%&).
4649
4650 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4651 prefix string with which any file named in a &%-C%& command line option must
4652 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4653 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4654 name can be used with &%-C%&.
4655
4656 One-off changes to a configuration can be specified by the &%-D%& command line
4657 option, which defines and overrides values for macros used inside the
4658 configuration file. However, like &%-C%&, the use of this option by a
4659 non-privileged user causes Exim to discard its root privilege.
4660 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4661 completely disabled, and its use causes an immediate error exit.
4662
4663 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4664 to declare certain macro names trusted, such that root privilege will not
4665 necessarily be discarded.
4666 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4667 considered safe and, if &%-D%& only supplies macros from this list, and the
4668 values are acceptable, then Exim will not give up root privilege if the caller
4669 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4670 transition mechanism and is expected to be removed in the future.  Acceptable
4671 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4672
4673 Some sites may wish to use the same Exim binary on different machines that
4674 share a file system, but to use different configuration files on each machine.
4675 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4676 looks for a file whose name is the configuration file name followed by a dot
4677 and the machine's node name, as obtained from the &[uname()]& function. If this
4678 file does not exist, the standard name is tried. This processing occurs for
4679 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4680
4681 In some esoteric situations different versions of Exim may be run under
4682 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4683 help with this. See the comments in &_src/EDITME_& for details.
4684
4685
4686
4687 .section "Configuration file format" "SECTconffilfor"
4688 .cindex "configuration file" "format of"
4689 .cindex "format" "configuration file"
4690 Exim's configuration file is divided into a number of different parts. General
4691 option settings must always appear at the start of the file. The other parts
4692 are all optional, and may appear in any order. Each part other than the first
4693 is introduced by the word &"begin"& followed by the name of the part. The
4694 optional parts are:
4695
4696 .ilist
4697 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4698 &<<CHAPACL>>&).
4699 .next
4700 .cindex "AUTH" "configuration"
4701 &'authenticators'&: Configuration settings for the authenticator drivers. These
4702 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4703 .next
4704 &'routers'&: Configuration settings for the router drivers. Routers process
4705 addresses and determine how the message is to be delivered (see chapters
4706 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4707 .next
4708 &'transports'&: Configuration settings for the transport drivers. Transports
4709 define mechanisms for copying messages to destinations (see chapters
4710 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4711 .next
4712 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4713 If there is no retry section, or if it is empty (that is, no retry rules are
4714 defined), Exim will not retry deliveries. In this situation, temporary errors
4715 are treated the same as permanent errors. Retry rules are discussed in chapter
4716 &<<CHAPretry>>&.
4717 .next
4718 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4719 when new addresses are generated during delivery. Rewriting is discussed in
4720 chapter &<<CHAPrewrite>>&.
4721 .next
4722 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4723 want to use this feature, you must set
4724 .code
4725 LOCAL_SCAN_HAS_OPTIONS=yes
4726 .endd
4727 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4728 facility are given in chapter &<<CHAPlocalscan>>&.
4729 .endlist
4730
4731 .cindex "configuration file" "leading white space in"
4732 .cindex "configuration file" "trailing white space in"
4733 .cindex "white space" "in configuration file"
4734 Leading and trailing white space in configuration lines is always ignored.
4735
4736 Blank lines in the file, and lines starting with a # character (ignoring
4737 leading white space) are treated as comments and are ignored. &*Note*&: A
4738 # character other than at the beginning of a line is not treated specially,
4739 and does not introduce a comment.
4740
4741 Any non-comment line can be continued by ending it with a backslash. Note that
4742 the general rule for white space means that trailing white space after the
4743 backslash and leading white space at the start of continuation
4744 lines is ignored. Comment lines beginning with # (but not empty lines) may
4745 appear in the middle of a sequence of continuation lines.
4746
4747 A convenient way to create a configuration file is to start from the
4748 default, which is supplied in &_src/configure.default_&, and add, delete, or
4749 change settings as required.
4750
4751 The ACLs, retry rules, and rewriting rules have their own syntax which is
4752 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4753 respectively. The other parts of the configuration file have some syntactic
4754 items in common, and these are described below, from section &<<SECTcos>>&
4755 onwards. Before that, the inclusion, macro, and conditional facilities are
4756 described.
4757
4758
4759
4760 .section "File inclusions in the configuration file" "SECID41"
4761 .cindex "inclusions in configuration file"
4762 .cindex "configuration file" "including other files"
4763 .cindex "&`.include`& in configuration file"
4764 .cindex "&`.include_if_exists`& in configuration file"
4765 You can include other files inside Exim's run time configuration file by
4766 using this syntax:
4767 .display
4768 &`.include`& <&'file name'&>
4769 &`.include_if_exists`& <&'file name'&>
4770 .endd
4771 on a line by itself. Double quotes round the file name are optional. If you use
4772 the first form, a configuration error occurs if the file does not exist; the
4773 second form does nothing for non-existent files. In all cases, an absolute file
4774 name is required.
4775
4776 Includes may be nested to any depth, but remember that Exim reads its
4777 configuration file often, so it is a good idea to keep them to a minimum.
4778 If you change the contents of an included file, you must HUP the daemon,
4779 because an included file is read only when the configuration itself is read.
4780
4781 The processing of inclusions happens early, at a physical line level, so, like
4782 comment lines, an inclusion can be used in the middle of an option setting,
4783 for example:
4784 .code
4785 hosts_lookup = a.b.c \
4786                .include /some/file
4787 .endd
4788 Include processing happens after macro processing (see below). Its effect is to
4789 process the lines of the included file as if they occurred inline where the
4790 inclusion appears.
4791
4792
4793
4794 .section "Macros in the configuration file" "SECTmacrodefs"
4795 .cindex "macro" "description of"
4796 .cindex "configuration file" "macros"
4797 If a line in the main part of the configuration (that is, before the first
4798 &"begin"& line) begins with an upper case letter, it is taken as a macro
4799 definition, and must be of the form
4800 .display
4801 <&'name'&> = <&'rest of line'&>
4802 .endd
4803 The name must consist of letters, digits, and underscores, and need not all be
4804 in upper case, though that is recommended. The rest of the line, including any
4805 continuations, is the replacement text, and has leading and trailing white
4806 space removed. Quotes are not removed. The replacement text can never end with
4807 a backslash character, but this doesn't seem to be a serious limitation.
4808
4809 Macros may also be defined between router, transport, authenticator, or ACL
4810 definitions. They may not, however, be defined within an individual driver or
4811 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4812
4813 .section "Macro substitution" "SECID42"
4814 Once a macro is defined, all subsequent lines in the file (and any included
4815 files) are scanned for the macro name; if there are several macros, the line is
4816 scanned for each in turn, in the order in which the macros are defined. The
4817 replacement text is not re-scanned for the current macro, though it is scanned
4818 for subsequently defined macros. For this reason, a macro name may not contain
4819 the name of a previously defined macro as a substring. You could, for example,
4820 define
4821 .display
4822 &`ABCD_XYZ = `&<&'something'&>
4823 &`ABCD = `&<&'something else'&>
4824 .endd
4825 but putting the definitions in the opposite order would provoke a configuration
4826 error. Macro expansion is applied to individual physical lines from the file,
4827 before checking for line continuation or file inclusion (see above). If a line
4828 consists solely of a macro name, and the expansion of the macro is empty, the
4829 line is ignored. A macro at the start of a line may turn the line into a
4830 comment line or a &`.include`& line.
4831
4832
4833 .section "Redefining macros" "SECID43"
4834 Once defined, the value of a macro can be redefined later in the configuration
4835 (or in an included file). Redefinition is specified by using &'=='& instead of
4836 &'='&. For example:
4837 .code
4838 MAC =  initial value
4839 ...
4840 MAC == updated value
4841 .endd
4842 Redefinition does not alter the order in which the macros are applied to the
4843 subsequent lines of the configuration file. It is still the same order in which
4844 the macros were originally defined. All that changes is the macro's value.
4845 Redefinition makes it possible to accumulate values. For example:
4846 .code
4847 MAC =  initial value
4848 ...
4849 MAC == MAC and something added
4850 .endd
4851 This can be helpful in situations where the configuration file is built
4852 from a number of other files.
4853
4854 .section "Overriding macro values" "SECID44"
4855 The values set for macros in the configuration file can be overridden by the
4856 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4857 used, unless called by root or the Exim user. A definition on the command line
4858 using the &%-D%& option causes all definitions and redefinitions within the
4859 file to be ignored.
4860
4861
4862
4863 .section "Example of macro usage" "SECID45"
4864 As an example of macro usage, consider a configuration where aliases are looked
4865 up in a MySQL database. It helps to keep the file less cluttered if long
4866 strings such as SQL statements are defined separately as macros, for example:
4867 .code
4868 ALIAS_QUERY = select mailbox from user where \
4869               login='${quote_mysql:$local_part}';
4870 .endd
4871 This can then be used in a &(redirect)& router setting like this:
4872 .code
4873 data = ${lookup mysql{ALIAS_QUERY}}
4874 .endd
4875 In earlier versions of Exim macros were sometimes used for domain, host, or
4876 address lists. In Exim 4 these are handled better by named lists &-- see
4877 section &<<SECTnamedlists>>&.
4878
4879
4880 .section "Conditional skips in the configuration file" "SECID46"
4881 .cindex "configuration file" "conditional skips"
4882 .cindex "&`.ifdef`&"
4883 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4884 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4885 portions of the configuration file. The processing happens whenever the file is
4886 read (that is, when an Exim binary starts to run).
4887
4888 The implementation is very simple. Instances of the first four directives must
4889 be followed by text that includes the names of one or macros. The condition
4890 that is tested is whether or not any macro substitution has taken place in the
4891 line. Thus:
4892 .code
4893 .ifdef AAA
4894 message_size_limit = 50M
4895 .else
4896 message_size_limit = 100M
4897 .endif
4898 .endd
4899 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4900 otherwise. If there is more than one macro named on the line, the condition
4901 is true if any of them are defined. That is, it is an &"or"& condition. To
4902 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4903
4904 Although you can use a macro expansion to generate one of these directives,
4905 it is not very useful, because the condition &"there was a macro substitution
4906 in this line"& will always be true.
4907
4908 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4909 to clarify complicated nestings.
4910
4911
4912
4913 .section "Common option syntax" "SECTcos"
4914 .cindex "common option syntax"
4915 .cindex "syntax of common options"
4916 .cindex "configuration file" "common option syntax"
4917 For the main set of options, driver options, and &[local_scan()]& options,
4918 each setting is on a line by itself, and starts with a name consisting of
4919 lower-case letters and underscores. Many options require a data value, and in
4920 these cases the name must be followed by an equals sign (with optional white
4921 space) and then the value. For example:
4922 .code
4923 qualify_domain = mydomain.example.com
4924 .endd
4925 .cindex "hiding configuration option values"
4926 .cindex "configuration options" "hiding value of"
4927 .cindex "options" "hiding value of"
4928 Some option settings may contain sensitive data, for example, passwords for
4929 accessing databases. To stop non-admin users from using the &%-bP%& command
4930 line option to read these values, you can precede the option settings with the
4931 word &"hide"&. For example:
4932 .code
4933 hide mysql_servers = localhost/users/admin/secret-password
4934 .endd
4935 For non-admin users, such options are displayed like this:
4936 .code
4937 mysql_servers = <value not displayable>
4938 .endd
4939 If &"hide"& is used on a driver option, it hides the value of that option on
4940 all instances of the same driver.
4941
4942 The following sections describe the syntax used for the different data types
4943 that are found in option settings.
4944
4945
4946 .section "Boolean options" "SECID47"
4947 .cindex "format" "boolean"
4948 .cindex "boolean configuration values"
4949 .oindex "&%no_%&&'xxx'&"
4950 .oindex "&%not_%&&'xxx'&"
4951 Options whose type is given as boolean are on/off switches. There are two
4952 different ways of specifying such options: with and without a data value. If
4953 the option name is specified on its own without data, the switch is turned on;
4954 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4955 boolean options may be followed by an equals sign and one of the words
4956 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4957 the following two settings have exactly the same effect:
4958 .code
4959 queue_only
4960 queue_only = true
4961 .endd
4962 The following two lines also have the same (opposite) effect:
4963 .code
4964 no_queue_only
4965 queue_only = false
4966 .endd
4967 You can use whichever syntax you prefer.
4968
4969
4970
4971
4972 .section "Integer values" "SECID48"
4973 .cindex "integer configuration values"
4974 .cindex "format" "integer"
4975 If an option's type is given as &"integer"&, the value can be given in decimal,
4976 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4977 number is assumed. Otherwise, it is treated as an octal number unless it starts
4978 with the characters &"0x"&, in which case the remainder is interpreted as a
4979 hexadecimal number.
4980
4981 If an integer value is followed by the letter K, it is multiplied by 1024; if
4982 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4983 of integer option settings are output, values which are an exact multiple of
4984 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4985 and M. The printing style is independent of the actual input format that was
4986 used.
4987
4988
4989 .section "Octal integer values" "SECID49"
4990 .cindex "integer format"
4991 .cindex "format" "octal integer"
4992 If an option's type is given as &"octal integer"&, its value is always
4993 interpreted as an octal number, whether or not it starts with the digit zero.
4994 Such options are always output in octal.
4995
4996
4997 .section "Fixed point numbers" "SECID50"
4998 .cindex "fixed point configuration values"
4999 .cindex "format" "fixed point"
5000 If an option's type is given as &"fixed-point"&, its value must be a decimal
5001 integer, optionally followed by a decimal point and up to three further digits.
5002
5003
5004
5005 .section "Time intervals" "SECTtimeformat"
5006 .cindex "time interval" "specifying in configuration"
5007 .cindex "format" "time interval"
5008 A time interval is specified as a sequence of numbers, each followed by one of
5009 the following letters, with no intervening white space:
5010
5011 .table2 30pt
5012 .irow &%s%& seconds
5013 .irow &%m%& minutes
5014 .irow &%h%& hours
5015 .irow &%d%& days
5016 .irow &%w%& weeks
5017 .endtable
5018
5019 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5020 intervals are output in the same format. Exim does not restrict the values; it
5021 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5022
5023
5024
5025 .section "String values" "SECTstrings"
5026 .cindex "string" "format of configuration values"
5027 .cindex "format" "string"
5028 If an option's type is specified as &"string"&, the value can be specified with
5029 or without double-quotes. If it does not start with a double-quote, the value
5030 consists of the remainder of the line plus any continuation lines, starting at
5031 the first character after any leading white space, with trailing white space
5032 removed, and with no interpretation of the characters in the string. Because
5033 Exim removes comment lines (those beginning with #) at an early stage, they can
5034 appear in the middle of a multi-line string. The following two settings are
5035 therefore equivalent:
5036 .code
5037 trusted_users = uucp:mail
5038 trusted_users = uucp:\
5039                 # This comment line is ignored
5040                 mail
5041 .endd
5042 .cindex "string" "quoted"
5043 .cindex "escape characters in quoted strings"
5044 If a string does start with a double-quote, it must end with a closing
5045 double-quote, and any backslash characters other than those used for line
5046 continuation are interpreted as escape characters, as follows:
5047
5048 .table2 100pt
5049 .irow &`\\`&                     "single backslash"
5050 .irow &`\n`&                     "newline"
5051 .irow &`\r`&                     "carriage return"
5052 .irow &`\t`&                     "tab"
5053 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5054 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5055                                    character"
5056 .endtable
5057
5058 If a backslash is followed by some other character, including a double-quote
5059 character, that character replaces the pair.
5060
5061 Quoting is necessary only if you want to make use of the backslash escapes to
5062 insert special characters, or if you need to specify a value with leading or
5063 trailing spaces. These cases are rare, so quoting is almost never needed in
5064 current versions of Exim. In versions of Exim before 3.14, quoting was required
5065 in order to continue lines, so you may come across older configuration files
5066 and examples that apparently quote unnecessarily.
5067
5068
5069 .section "Expanded strings" "SECID51"
5070 .cindex "expansion" "definition of"
5071 Some strings in the configuration file are subjected to &'string expansion'&,
5072 by which means various parts of the string may be changed according to the
5073 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5074 is as just described; in particular, the handling of backslashes in quoted
5075 strings is done as part of the input process, before expansion takes place.
5076 However, backslash is also an escape character for the expander, so any
5077 backslashes that are required for that reason must be doubled if they are
5078 within a quoted configuration string.
5079
5080
5081 .section "User and group names" "SECID52"
5082 .cindex "user name" "format of"
5083 .cindex "format" "user name"
5084 .cindex "groups" "name format"
5085 .cindex "format" "group name"
5086 User and group names are specified as strings, using the syntax described
5087 above, but the strings are interpreted specially. A user or group name must
5088 either consist entirely of digits, or be a name that can be looked up using the
5089 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5090
5091
5092 .section "List construction" "SECTlistconstruct"
5093 .cindex "list" "syntax of in configuration"
5094 .cindex "format" "list item in configuration"
5095 .cindex "string" "list, definition of"
5096 The data for some configuration options is a list of items, with colon as the
5097 default separator. Many of these options are shown with type &"string list"& in
5098 the descriptions later in this document. Others are listed as &"domain list"&,
5099 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5100 are all the same; however, those other than &"string list"& are subject to
5101 particular kinds of interpretation, as described in chapter
5102 &<<CHAPdomhosaddlists>>&.
5103
5104 In all these cases, the entire list is treated as a single string as far as the
5105 input syntax is concerned. The &%trusted_users%& setting in section
5106 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5107 in a list, it must be entered as two colons. Leading and trailing white space
5108 on each item in a list is ignored. This makes it possible to include items that
5109 start with a colon, and in particular, certain forms of IPv6 address. For
5110 example, the list
5111 .code
5112 local_interfaces = 127.0.0.1 : ::::1
5113 .endd
5114 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5115
5116 &*Note*&: Although leading and trailing white space is ignored in individual
5117 list items, it is not ignored when parsing the list. The space after the first
5118 colon in the example above is necessary. If it were not there, the list would
5119 be interpreted as the two items 127.0.0.1:: and 1.
5120
5121 .section "Changing list separators" "SECID53"
5122 .cindex "list separator" "changing"
5123 .cindex "IPv6" "addresses in lists"
5124 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5125 introduced to allow the separator character to be changed. If a list begins
5126 with a left angle bracket, followed by any punctuation character, that
5127 character is used instead of colon as the list separator. For example, the list
5128 above can be rewritten to use a semicolon separator like this:
5129 .code
5130 local_interfaces = <; 127.0.0.1 ; ::1
5131 .endd
5132 This facility applies to all lists, with the exception of the list in
5133 &%log_file_path%&. It is recommended that the use of non-colon separators be
5134 confined to circumstances where they really are needed.
5135
5136 .cindex "list separator" "newline as"
5137 .cindex "newline" "as list separator"
5138 It is also possible to use newline and other control characters (those with
5139 code values less than 32, plus DEL) as separators in lists. Such separators
5140 must be provided literally at the time the list is processed. For options that
5141 are string-expanded, you can write the separator using a normal escape
5142 sequence. This will be processed by the expander before the string is
5143 interpreted as a list. For example, if a newline-separated list of domains is
5144 generated by a lookup, you can process it directly by a line such as this:
5145 .code
5146 domains = <\n ${lookup mysql{.....}}
5147 .endd
5148 This avoids having to change the list separator in such data. You are unlikely
5149 to want to use a control character as a separator in an option that is not
5150 expanded, because the value is literal text. However, it can be done by giving
5151 the value in quotes. For example:
5152 .code
5153 local_interfaces = "<\n 127.0.0.1 \n ::1"
5154 .endd
5155 Unlike printing character separators, which can be included in list items by
5156 doubling, it is not possible to include a control character as data when it is
5157 set as the separator. Two such characters in succession are interpreted as
5158 enclosing an empty list item.
5159
5160
5161
5162 .section "Empty items in lists" "SECTempitelis"
5163 .cindex "list" "empty item in"
5164 An empty item at the end of a list is always ignored. In other words, trailing
5165 separator characters are ignored. Thus, the list in
5166 .code
5167 senders = user@domain :
5168 .endd
5169 contains only a single item. If you want to include an empty string as one item
5170 in a list, it must not be the last item. For example, this list contains three
5171 items, the second of which is empty:
5172 .code
5173 senders = user1@domain : : user2@domain
5174 .endd
5175 &*Note*&: There must be white space between the two colons, as otherwise they
5176 are interpreted as representing a single colon data character (and the list
5177 would then contain just one item). If you want to specify a list that contains
5178 just one, empty item, you can do it as in this example:
5179 .code
5180 senders = :
5181 .endd
5182 In this case, the first item is empty, and the second is discarded because it
5183 is at the end of the list.
5184
5185
5186
5187
5188 .section "Format of driver configurations" "SECTfordricon"
5189 .cindex "drivers" "configuration format"
5190 There are separate parts in the configuration for defining routers, transports,
5191 and authenticators. In each part, you are defining a number of driver
5192 instances, each with its own set of options. Each driver instance is defined by
5193 a sequence of lines like this:
5194 .display
5195 <&'instance name'&>:
5196   <&'option'&>
5197   ...
5198   <&'option'&>
5199 .endd
5200 In the following example, the instance name is &(localuser)&, and it is
5201 followed by three options settings:
5202 .code
5203 localuser:
5204   driver = accept
5205   check_local_user
5206   transport = local_delivery
5207 .endd
5208 For each driver instance, you specify which Exim code module it uses &-- by the
5209 setting of the &%driver%& option &-- and (optionally) some configuration
5210 settings. For example, in the case of transports, if you want a transport to
5211 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5212 a local file you would use the &(appendfile)& driver. Each of the drivers is
5213 described in detail in its own separate chapter later in this manual.
5214
5215 You can have several routers, transports, or authenticators that are based on
5216 the same underlying driver (each must have a different instance name).
5217
5218 The order in which routers are defined is important, because addresses are
5219 passed to individual routers one by one, in order. The order in which
5220 transports are defined does not matter at all. The order in which
5221 authenticators are defined is used only when Exim, as a client, is searching
5222 them to find one that matches an authentication mechanism offered by the
5223 server.
5224
5225 .cindex "generic options"
5226 .cindex "options" "generic &-- definition of"
5227 Within a driver instance definition, there are two kinds of option: &'generic'&
5228 and &'private'&. The generic options are those that apply to all drivers of the
5229 same type (that is, all routers, all transports or all authenticators). The
5230 &%driver%& option is a generic option that must appear in every definition.
5231 .cindex "private options"
5232 The private options are special for each driver, and none need appear, because
5233 they all have default values.
5234
5235 The options may appear in any order, except that the &%driver%& option must
5236 precede any private options, since these depend on the particular driver. For
5237 this reason, it is recommended that &%driver%& always be the first option.
5238
5239 Driver instance names, which are used for reference in log entries and
5240 elsewhere, can be any sequence of letters, digits, and underscores (starting
5241 with a letter) and must be unique among drivers of the same type. A router and
5242 a transport (for example) can each have the same name, but no two router
5243 instances can have the same name. The name of a driver instance should not be
5244 confused with the name of the underlying driver module. For example, the
5245 configuration lines:
5246 .code
5247 remote_smtp:
5248   driver = smtp
5249 .endd
5250 create an instance of the &(smtp)& transport driver whose name is
5251 &(remote_smtp)&. The same driver code can be used more than once, with
5252 different instance names and different option settings each time. A second
5253 instance of the &(smtp)& transport, with different options, might be defined
5254 thus:
5255 .code
5256 special_smtp:
5257   driver = smtp
5258   port = 1234
5259   command_timeout = 10s
5260 .endd
5261 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5262 these transport instances from routers, and these names would appear in log
5263 lines.
5264
5265 Comment lines may be present in the middle of driver specifications. The full
5266 list of option settings for any particular driver instance, including all the
5267 defaulted values, can be extracted by making use of the &%-bP%& command line
5268 option.
5269
5270
5271
5272
5273
5274
5275 . ////////////////////////////////////////////////////////////////////////////
5276 . ////////////////////////////////////////////////////////////////////////////
5277
5278 .chapter "The default configuration file" "CHAPdefconfil"
5279 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5280 .cindex "default" "configuration file &""walk through""&"
5281 The default configuration file supplied with Exim as &_src/configure.default_&
5282 is sufficient for a host with simple mail requirements. As an introduction to
5283 the way Exim is configured, this chapter &"walks through"& the default
5284 configuration, giving brief explanations of the settings. Detailed descriptions
5285 of the options are given in subsequent chapters. The default configuration file
5286 itself contains extensive comments about ways you might want to modify the
5287 initial settings. However, note that there are many options that are not
5288 mentioned at all in the default configuration.
5289
5290
5291
5292 .section "Main configuration settings" "SECTdefconfmain"
5293 The main (global) configuration option settings must always come first in the
5294 file. The first thing you'll see in the file, after some initial comments, is
5295 the line
5296 .code
5297 # primary_hostname =
5298 .endd
5299 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5300 to know the official, fully qualified name of your host, and this is where you
5301 can specify it. However, in most cases you do not need to set this option. When
5302 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5303
5304 The first three non-comment configuration lines are as follows:
5305 .code
5306 domainlist local_domains = @
5307 domainlist relay_to_domains =
5308 hostlist   relay_from_hosts = 127.0.0.1
5309 .endd
5310 These are not, in fact, option settings. They are definitions of two named
5311 domain lists and one named host list. Exim allows you to give names to lists of
5312 domains, hosts, and email addresses, in order to make it easier to manage the
5313 configuration file (see section &<<SECTnamedlists>>&).
5314
5315 The first line defines a domain list called &'local_domains'&; this is used
5316 later in the configuration to identify domains that are to be delivered
5317 on the local host.
5318
5319 .cindex "@ in a domain list"
5320 There is just one item in this list, the string &"@"&. This is a special form
5321 of entry which means &"the name of the local host"&. Thus, if the local host is
5322 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5323 be delivered locally. Because the local host's name is referenced indirectly,
5324 the same configuration file can be used on different hosts.
5325
5326 The second line defines a domain list called &'relay_to_domains'&, but the
5327 list itself is empty. Later in the configuration we will come to the part that
5328 controls mail relaying through the local host; it allows relaying to any
5329 domains in this list. By default, therefore, no relaying on the basis of a mail
5330 domain is permitted.
5331
5332 The third line defines a host list called &'relay_from_hosts'&. This list is
5333 used later in the configuration to permit relaying from any host or IP address
5334 that matches the list. The default contains just the IP address of the IPv4
5335 loopback interface, which means that processes on the local host are able to
5336 submit mail for relaying by sending it over TCP/IP to that interface. No other
5337 hosts are permitted to submit messages for relaying.
5338
5339 Just to be sure there's no misunderstanding: at this point in the configuration
5340 we aren't actually setting up any controls. We are just defining some domains
5341 and hosts that will be used in the controls that are specified later.
5342
5343 The next two configuration lines are genuine option settings:
5344 .code
5345 acl_smtp_rcpt = acl_check_rcpt
5346 acl_smtp_data = acl_check_data
5347 .endd
5348 These options specify &'Access Control Lists'& (ACLs) that are to be used
5349 during an incoming SMTP session for every recipient of a message (every RCPT
5350 command), and after the contents of the message have been received,
5351 respectively. The names of the lists are &'acl_check_rcpt'& and
5352 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5353 section of the configuration. The RCPT ACL controls which recipients are
5354 accepted for an incoming message &-- if a configuration does not provide an ACL
5355 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5356 contents of a message to be checked.
5357
5358 Two commented-out option settings are next:
5359 .code
5360 # av_scanner = clamd:/tmp/clamd
5361 # spamd_address = 127.0.0.1 783
5362 .endd
5363 These are example settings that can be used when Exim is compiled with the
5364 content-scanning extension. The first specifies the interface to the virus
5365 scanner, and the second specifies the interface to SpamAssassin. Further
5366 details are given in chapter &<<CHAPexiscan>>&.
5367
5368 Three more commented-out option settings follow:
5369 .code
5370 # tls_advertise_hosts = *
5371 # tls_certificate = /etc/ssl/exim.crt
5372 # tls_privatekey = /etc/ssl/exim.pem
5373 .endd
5374 These are example settings that can be used when Exim is compiled with
5375 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5376 first one specifies the list of clients that are allowed to use TLS when
5377 connecting to this server; in this case the wildcard means all clients. The
5378 other options specify where Exim should find its TLS certificate and private
5379 key, which together prove the server's identity to any clients that connect.
5380 More details are given in chapter &<<CHAPTLS>>&.
5381
5382 Another two commented-out option settings follow:
5383 .code
5384 # daemon_smtp_ports = 25 : 465 : 587
5385 # tls_on_connect_ports = 465
5386 .endd
5387 .cindex "port" "465 and 587"
5388 .cindex "port" "for message submission"
5389 .cindex "message" "submission, ports for"
5390 .cindex "ssmtp protocol"
5391 .cindex "smtps protocol"
5392 .cindex "SMTP" "ssmtp protocol"
5393 .cindex "SMTP" "smtps protocol"
5394 These options provide better support for roaming users who wish to use this
5395 server for message submission. They are not much use unless you have turned on
5396 TLS (as described in the previous paragraph) and authentication (about which
5397 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5398 on end-user networks, so RFC 4409 specifies that message submission should use
5399 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5400 configured to use port 587 correctly, so these settings also enable the
5401 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5402 &<<SECTsupobssmt>>&).
5403
5404 Two more commented-out options settings follow:
5405 .code
5406 # qualify_domain =
5407 # qualify_recipient =
5408 .endd
5409 The first of these specifies a domain that Exim uses when it constructs a
5410 complete email address from a local login name. This is often needed when Exim
5411 receives a message from a local process. If you do not set &%qualify_domain%&,
5412 the value of &%primary_hostname%& is used. If you set both of these options,
5413 you can have different qualification domains for sender and recipient
5414 addresses. If you set only the first one, its value is used in both cases.
5415
5416 .cindex "domain literal" "recognizing format"
5417 The following line must be uncommented if you want Exim to recognize
5418 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5419 (an IP address within square brackets) instead of a named domain.
5420 .code
5421 # allow_domain_literals
5422 .endd
5423 The RFCs still require this form, but many people think that in the modern
5424 Internet it makes little sense to permit mail to be sent to specific hosts by
5425 quoting their IP addresses. This ancient format has been used by people who
5426 try to abuse hosts by using them for unwanted relaying. However, some
5427 people believe there are circumstances (for example, messages addressed to
5428 &'postmaster'&) where domain literals are still useful.
5429
5430 The next configuration line is a kind of trigger guard:
5431 .code
5432 never_users = root
5433 .endd
5434 It specifies that no delivery must ever be run as the root user. The normal
5435 convention is to set up &'root'& as an alias for the system administrator. This
5436 setting is a guard against slips in the configuration.
5437 The list of users specified by &%never_users%& is not, however, the complete
5438 list; the build-time configuration in &_Local/Makefile_& has an option called
5439 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5440 contents of &%never_users%& are added to this list. By default
5441 FIXED_NEVER_USERS also specifies root.
5442
5443 When a remote host connects to Exim in order to send mail, the only information
5444 Exim has about the host's identity is its IP address. The next configuration
5445 line,
5446 .code
5447 host_lookup = *
5448 .endd
5449 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5450 in order to get a host name. This improves the quality of the logging
5451 information, but if you feel it is too expensive, you can remove it entirely,
5452 or restrict the lookup to hosts on &"nearby"& networks.
5453 Note that it is not always possible to find a host name from an IP address,
5454 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5455 unreachable.
5456
5457 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5458 1413 (hence their names):
5459 .code
5460 rfc1413_hosts = *
5461 rfc1413_query_timeout = 5s
5462 .endd
5463 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5464 You can limit the hosts to which these calls are made, or change the timeout
5465 that is used. If you set the timeout to zero, all ident calls are disabled.
5466 Although they are cheap and can provide useful information for tracing problem
5467 messages, some hosts and firewalls have problems with ident calls. This can
5468 result in a timeout instead of an immediate refused connection, leading to
5469 delays on starting up an incoming SMTP session.
5470
5471 When Exim receives messages over SMTP connections, it expects all addresses to
5472 be fully qualified with a domain, as required by the SMTP definition. However,
5473 if you are running a server to which simple clients submit messages, you may
5474 find that they send unqualified addresses. The two commented-out options:
5475 .code
5476 # sender_unqualified_hosts =
5477 # recipient_unqualified_hosts =
5478 .endd
5479 show how you can specify hosts that are permitted to send unqualified sender
5480 and recipient addresses, respectively.
5481
5482 The &%percent_hack_domains%& option is also commented out:
5483 .code
5484 # percent_hack_domains =
5485 .endd
5486 It provides a list of domains for which the &"percent hack"& is to operate.
5487 This is an almost obsolete form of explicit email routing. If you do not know
5488 anything about it, you can safely ignore this topic.
5489
5490 The last two settings in the main part of the default configuration are
5491 concerned with messages that have been &"frozen"& on Exim's queue. When a
5492 message is frozen, Exim no longer continues to try to deliver it. Freezing
5493 occurs when a bounce message encounters a permanent failure because the sender
5494 address of the original message that caused the bounce is invalid, so the
5495 bounce cannot be delivered. This is probably the most common case, but there
5496 are also other conditions that cause freezing, and frozen messages are not
5497 always bounce messages.
5498 .code
5499 ignore_bounce_errors_after = 2d
5500 timeout_frozen_after = 7d
5501 .endd
5502 The first of these options specifies that failing bounce messages are to be
5503 discarded after 2 days on the queue. The second specifies that any frozen
5504 message (whether a bounce message or not) is to be timed out (and discarded)
5505 after a week. In this configuration, the first setting ensures that no failing
5506 bounce message ever lasts a week.
5507
5508
5509
5510 .section "ACL configuration" "SECID54"
5511 .cindex "default" "ACLs"
5512 .cindex "&ACL;" "default configuration"
5513 In the default configuration, the ACL section follows the main configuration.
5514 It starts with the line
5515 .code
5516 begin acl
5517 .endd
5518 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5519 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5520 and &%acl_smtp_data%& above.
5521
5522 .cindex "RCPT" "ACL for"
5523 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5524 RCPT command specifies one of the message's recipients. The ACL statements
5525 are considered in order, until the recipient address is either accepted or
5526 rejected. The RCPT command is then accepted or rejected, according to the
5527 result of the ACL processing.
5528 .code
5529 acl_check_rcpt:
5530 .endd
5531 This line, consisting of a name terminated by a colon, marks the start of the
5532 ACL, and names it.
5533 .code
5534 accept  hosts = :
5535 .endd
5536 This ACL statement accepts the recipient if the sending host matches the list.
5537 But what does that strange list mean? It doesn't actually contain any host
5538 names or IP addresses. The presence of the colon puts an empty item in the
5539 list; Exim matches this only if the incoming message did not come from a remote
5540 host, because in that case, the remote hostname is empty. The colon is
5541 important. Without it, the list itself is empty, and can never match anything.
5542
5543 What this statement is doing is to accept unconditionally all recipients in
5544 messages that are submitted by SMTP from local processes using the standard
5545 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5546 manner.
5547 .code
5548 deny    message       = Restricted characters in address
5549         domains       = +local_domains
5550         local_parts   = ^[.] : ^.*[@%!/|]
5551
5552 deny    message       = Restricted characters in address
5553         domains       = !+local_domains
5554         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5555 .endd
5556 These statements are concerned with local parts that contain any of the
5557 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5558 Although these characters are entirely legal in local parts (in the case of
5559 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5560 in Internet mail addresses.
5561
5562 The first three have in the past been associated with explicitly routed
5563 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5564 option). Addresses containing these characters are regularly tried by spammers
5565 in an attempt to bypass relaying restrictions, and also by open relay testing
5566 programs. Unless you really need them it is safest to reject these characters
5567 at this early stage. This configuration is heavy-handed in rejecting these
5568 characters for all messages it accepts from remote hosts. This is a deliberate
5569 policy of being as safe as possible.
5570
5571 The first rule above is stricter, and is applied to messages that are addressed
5572 to one of the local domains handled by this host. This is implemented by the
5573 first condition, which restricts it to domains that are listed in the
5574 &'local_domains'& domain list. The &"+"& character is used to indicate a
5575 reference to a named list. In this configuration, there is just one domain in
5576 &'local_domains'&, but in general there may be many.
5577
5578 The second condition on the first statement uses two regular expressions to
5579 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5580 or &"|"&. If you have local accounts that include these characters, you will
5581 have to modify this rule.
5582
5583 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5584 allows them because they have been encountered in practice. (Consider the
5585 common convention of local parts constructed as
5586 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5587 the author of Exim, who has no second initial.) However, a local part starting
5588 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5589 file name (for example, for a mailing list). This is also true for local parts
5590 that contain slashes. A pipe symbol can also be troublesome if the local part
5591 is incorporated unthinkingly into a shell command line.
5592
5593 The second rule above applies to all other domains, and is less strict. This
5594 allows your own users to send outgoing messages to sites that use slashes
5595 and vertical bars in their local parts. It blocks local parts that begin
5596 with a dot, slash, or vertical bar, but allows these characters within the
5597 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5598 and &"!"& is blocked, as before. The motivation here is to prevent your users
5599 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5600 .code
5601 accept  local_parts   = postmaster
5602         domains       = +local_domains
5603 .endd
5604 This statement, which has two conditions, accepts an incoming address if the
5605 local part is &'postmaster'& and the domain is one of those listed in the
5606 &'local_domains'& domain list. The &"+"& character is used to indicate a
5607 reference to a named list. In this configuration, there is just one domain in
5608 &'local_domains'&, but in general there may be many.
5609
5610 The presence of this statement means that mail to postmaster is never blocked
5611 by any of the subsequent tests. This can be helpful while sorting out problems
5612 in cases where the subsequent tests are incorrectly denying access.
5613 .code
5614 require verify        = sender
5615 .endd
5616 This statement requires the sender address to be verified before any subsequent
5617 ACL statement can be used. If verification fails, the incoming recipient
5618 address is refused. Verification consists of trying to route the address, to
5619 see if a bounce message could be delivered to it. In the case of remote
5620 addresses, basic verification checks only the domain, but &'callouts'& can be
5621 used for more verification if required. Section &<<SECTaddressverification>>&
5622 discusses the details of address verification.
5623 .code
5624 accept  hosts         = +relay_from_hosts
5625         control       = submission
5626 .endd
5627 This statement accepts the address if the message is coming from one of the
5628 hosts that are defined as being allowed to relay through this host. Recipient
5629 verification is omitted here, because in many cases the clients are dumb MUAs
5630 that do not cope well with SMTP error responses. For the same reason, the
5631 second line specifies &"submission mode"& for messages that are accepted. This
5632 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5633 messages that are deficient in some way, for example, because they lack a
5634 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5635 probably add recipient verification here, and disable submission mode.
5636 .code
5637 accept  authenticated = *
5638         control       = submission
5639 .endd
5640 This statement accepts the address if the client host has authenticated itself.
5641 Submission mode is again specified, on the grounds that such messages are most
5642 likely to come from MUAs. The default configuration does not define any
5643 authenticators, though it does include some nearly complete commented-out
5644 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5645 fact authenticate until you complete the authenticator definitions.
5646 .code
5647 require message = relay not permitted
5648         domains = +local_domains : +relay_domains
5649 .endd
5650 This statement rejects the address if its domain is neither a local domain nor
5651 one of the domains for which this host is a relay.
5652 .code
5653 require verify = recipient
5654 .endd
5655 This statement requires the recipient address to be verified; if verification
5656 fails, the address is rejected.
5657 .code
5658 # deny    message     = rejected because $sender_host_address \
5659 #                       is in a black list at $dnslist_domain\n\
5660 #                       $dnslist_text
5661 #         dnslists    = black.list.example
5662 #
5663 # warn    dnslists    = black.list.example
5664 #         add_header  = X-Warning: $sender_host_address is in \
5665 #                       a black list at $dnslist_domain
5666 #         log_message = found in $dnslist_domain
5667 .endd
5668 These commented-out lines are examples of how you could configure Exim to check
5669 sending hosts against a DNS black list. The first statement rejects messages
5670 from blacklisted hosts, whereas the second just inserts a warning header
5671 line.
5672 .code
5673 # require verify = csa
5674 .endd
5675 This commented-out line is an example of how you could turn on client SMTP
5676 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5677 records.
5678 .code
5679 accept
5680 .endd
5681 The final statement in the first ACL unconditionally accepts any recipient
5682 address that has successfully passed all the previous tests.
5683 .code
5684 acl_check_data:
5685 .endd
5686 This line marks the start of the second ACL, and names it. Most of the contents
5687 of this ACL are commented out:
5688 .code
5689 # deny    malware   = *
5690 #         message   = This message contains a virus \
5691 #                     ($malware_name).
5692 .endd
5693 These lines are examples of how to arrange for messages to be scanned for
5694 viruses when Exim has been compiled with the content-scanning extension, and a
5695 suitable virus scanner is installed. If the message is found to contain a
5696 virus, it is rejected with the given custom error message.
5697 .code
5698 # warn    spam      = nobody
5699 #         message   = X-Spam_score: $spam_score\n\
5700 #                     X-Spam_score_int: $spam_score_int\n\
5701 #                     X-Spam_bar: $spam_bar\n\
5702 #                     X-Spam_report: $spam_report
5703 .endd
5704 These lines are an example of how to arrange for messages to be scanned by
5705 SpamAssassin when Exim has been compiled with the content-scanning extension,
5706 and SpamAssassin has been installed. The SpamAssassin check is run with
5707 &`nobody`& as its user parameter, and the results are added to the message as a
5708 series of extra header line. In this case, the message is not rejected,
5709 whatever the spam score.
5710 .code
5711 accept
5712 .endd
5713 This final line in the DATA ACL accepts the message unconditionally.
5714
5715
5716 .section "Router configuration" "SECID55"
5717 .cindex "default" "routers"
5718 .cindex "routers" "default"
5719 The router configuration comes next in the default configuration, introduced
5720 by the line
5721 .code
5722 begin routers
5723 .endd
5724 Routers are the modules in Exim that make decisions about where to send
5725 messages. An address is passed to each router in turn, until it is either
5726 accepted, or failed. This means that the order in which you define the routers
5727 matters. Each router is fully described in its own chapter later in this
5728 manual. Here we give only brief overviews.
5729 .code
5730 # domain_literal:
5731 #   driver = ipliteral
5732 #   domains = !+local_domains
5733 #   transport = remote_smtp
5734 .endd
5735 .cindex "domain literal" "default router"
5736 This router is commented out because the majority of sites do not want to
5737 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5738 you uncomment this router, you also need to uncomment the setting of
5739 &%allow_domain_literals%& in the main part of the configuration.
5740 .code
5741 dnslookup:
5742   driver = dnslookup
5743   domains = ! +local_domains
5744   transport = remote_smtp
5745   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5746   no_more
5747 .endd
5748 The first uncommented router handles addresses that do not involve any local
5749 domains. This is specified by the line
5750 .code
5751 domains = ! +local_domains
5752 .endd
5753 The &%domains%& option lists the domains to which this router applies, but the
5754 exclamation mark is a negation sign, so the router is used only for domains
5755 that are not in the domain list called &'local_domains'& (which was defined at
5756 the start of the configuration). The plus sign before &'local_domains'&
5757 indicates that it is referring to a named list. Addresses in other domains are
5758 passed on to the following routers.
5759
5760 The name of the router driver is &(dnslookup)&,
5761 and is specified by the &%driver%& option. Do not be confused by the fact that
5762 the name of this router instance is the same as the name of the driver. The
5763 instance name is arbitrary, but the name set in the &%driver%& option must be
5764 one of the driver modules that is in the Exim binary.
5765
5766 The &(dnslookup)& router routes addresses by looking up their domains in the
5767 DNS in order to obtain a list of hosts to which the address is routed. If the
5768 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5769 specified by the &%transport%& option. If the router does not find the domain
5770 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5771 the address fails and is bounced.
5772
5773 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5774 be entirely ignored. This option is present because a number of cases have been
5775 encountered where MX records in the DNS point to host names
5776 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5777 Completely ignoring these IP addresses causes Exim to fail to route the
5778 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5779 continue to try to deliver the message periodically until the address timed
5780 out.
5781 .code
5782 system_aliases:
5783   driver = redirect
5784   allow_fail
5785   allow_defer
5786   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5787 # user = exim
5788   file_transport = address_file
5789   pipe_transport = address_pipe
5790 .endd
5791 Control reaches this and subsequent routers only for addresses in the local
5792 domains. This router checks to see whether the local part is defined as an
5793 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5794 data that it looks up from that file. If no data is found for the local part,
5795 the value of the &%data%& option is empty, causing the address to be passed to
5796 the next router.
5797
5798 &_/etc/aliases_& is a conventional name for the system aliases file that is
5799 often used. That is why it is referenced by from the default configuration
5800 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5801 &_Local/Makefile_& before building Exim.
5802 .code
5803 userforward:
5804   driver = redirect
5805   check_local_user
5806 # local_part_suffix = +* : -*
5807 # local_part_suffix_optional
5808   file = $home/.forward
5809 # allow_filter
5810   no_verify
5811   no_expn
5812   check_ancestor
5813   file_transport = address_file
5814   pipe_transport = address_pipe
5815   reply_transport = address_reply
5816 .endd
5817 This is the most complicated router in the default configuration. It is another
5818 redirection router, but this time it is looking for forwarding data set up by
5819 individual users. The &%check_local_user%& setting specifies a check that the
5820 local part of the address is the login name of a local user. If it is not, the
5821 router is skipped. The two commented options that follow &%check_local_user%&,
5822 namely:
5823 .code
5824 # local_part_suffix = +* : -*
5825 # local_part_suffix_optional
5826 .endd
5827 .vindex "&$local_part_suffix$&"
5828 show how you can specify the recognition of local part suffixes. If the first
5829 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5830 by any sequence of characters, is removed from the local part and placed in the
5831 variable &$local_part_suffix$&. The second suffix option specifies that the
5832 presence of a suffix in the local part is optional. When a suffix is present,
5833 the check for a local login uses the local part with the suffix removed.
5834
5835 When a local user account is found, the file called &_.forward_& in the user's
5836 home directory is consulted. If it does not exist, or is empty, the router
5837 declines. Otherwise, the contents of &_.forward_& are interpreted as
5838 redirection data (see chapter &<<CHAPredirect>>& for more details).
5839
5840 .cindex "Sieve filter" "enabling in default router"
5841 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5842 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5843 is commented out by default), the contents of the file are interpreted as a set
5844 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5845 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5846 separate document entitled &'Exim's interfaces to mail filtering'&.
5847
5848 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5849 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5850 There are two reasons for doing this:
5851
5852 .olist
5853 Whether or not a local user has a &_.forward_& file is not really relevant when
5854 checking an address for validity; it makes sense not to waste resources doing
5855 unnecessary work.
5856 .next
5857 More importantly, when Exim is verifying addresses or handling an EXPN
5858 command during an SMTP session, it is running as the Exim user, not as root.
5859 The group is the Exim group, and no additional groups are set up.
5860 It may therefore not be possible for Exim to read users' &_.forward_& files at
5861 this time.
5862 .endlist
5863
5864 The setting of &%check_ancestor%& prevents the router from generating a new
5865 address that is the same as any previous address that was redirected. (This
5866 works round a problem concerning a bad interaction between aliasing and
5867 forwarding &-- see section &<<SECTredlocmai>>&).
5868
5869 The final three option settings specify the transports that are to be used when
5870 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5871 auto-reply, respectively. For example, if a &_.forward_& file contains
5872 .code
5873 a.nother@elsewhere.example, /home/spqr/archive
5874 .endd
5875 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5876 transport.
5877 .code
5878 localuser:
5879   driver = accept
5880   check_local_user
5881 # local_part_suffix = +* : -*
5882 # local_part_suffix_optional
5883   transport = local_delivery
5884 .endd
5885 The final router sets up delivery into local mailboxes, provided that the local
5886 part is the name of a local login, by accepting the address and assigning it to
5887 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5888 routers, so the address is bounced. The commented suffix settings fulfil the
5889 same purpose as they do for the &(userforward)& router.
5890
5891
5892 .section "Transport configuration" "SECID56"
5893 .cindex "default" "transports"
5894 .cindex "transports" "default"
5895 Transports define mechanisms for actually delivering messages. They operate
5896 only when referenced from routers, so the order in which they are defined does
5897 not matter. The transports section of the configuration starts with
5898 .code
5899 begin transports
5900 .endd
5901 One remote transport and four local transports are defined.
5902 .code
5903 remote_smtp:
5904   driver = smtp
5905 .endd
5906 This transport is used for delivering messages over SMTP connections. All its
5907 options are defaulted. The list of remote hosts comes from the router.
5908 .code
5909 local_delivery:
5910   driver = appendfile
5911   file = /var/mail/$local_part
5912   delivery_date_add
5913   envelope_to_add
5914   return_path_add
5915 # group = mail
5916 # mode = 0660
5917 .endd
5918 This &(appendfile)& transport is used for local delivery to user mailboxes in
5919 traditional BSD mailbox format. By default it runs under the uid and gid of the
5920 local user, which requires the sticky bit to be set on the &_/var/mail_&
5921 directory. Some systems use the alternative approach of running mail deliveries
5922 under a particular group instead of using the sticky bit. The commented options
5923 show how this can be done.
5924
5925 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5926 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5927 similarly-named options above.
5928 .code
5929 address_pipe:
5930   driver = pipe
5931   return_output
5932 .endd
5933 This transport is used for handling deliveries to pipes that are generated by
5934 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5935 option specifies that any output generated by the pipe is to be returned to the
5936 sender.
5937 .code
5938 address_file:
5939   driver = appendfile
5940   delivery_date_add
5941   envelope_to_add
5942   return_path_add
5943 .endd
5944 This transport is used for handling deliveries to files that are generated by
5945 redirection. The name of the file is not specified in this instance of
5946 &(appendfile)&, because it comes from the &(redirect)& router.
5947 .code
5948 address_reply:
5949   driver = autoreply
5950 .endd
5951 This transport is used for handling automatic replies generated by users'
5952 filter files.
5953
5954
5955
5956 .section "Default retry rule" "SECID57"
5957 .cindex "retry" "default rule"
5958 .cindex "default" "retry rule"
5959 The retry section of the configuration file contains rules which affect the way
5960 Exim retries deliveries that cannot be completed at the first attempt. It is
5961 introduced by the line
5962 .code
5963 begin retry
5964 .endd
5965 In the default configuration, there is just one rule, which applies to all
5966 errors:
5967 .code
5968 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5969 .endd
5970 This causes any temporarily failing address to be retried every 15 minutes for
5971 2 hours, then at intervals starting at one hour and increasing by a factor of
5972 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5973 is not delivered after 4 days of temporary failure, it is bounced.
5974
5975 If the retry section is removed from the configuration, or is empty (that is,
5976 if no retry rules are defined), Exim will not retry deliveries. This turns
5977 temporary errors into permanent errors.
5978
5979
5980 .section "Rewriting configuration" "SECID58"
5981 The rewriting section of the configuration, introduced by
5982 .code
5983 begin rewrite
5984 .endd
5985 contains rules for rewriting addresses in messages as they arrive. There are no
5986 rewriting rules in the default configuration file.
5987
5988
5989
5990 .section "Authenticators configuration" "SECTdefconfauth"
5991 .cindex "AUTH" "configuration"
5992 The authenticators section of the configuration, introduced by
5993 .code
5994 begin authenticators
5995 .endd
5996 defines mechanisms for the use of the SMTP AUTH command. The default
5997 configuration file contains two commented-out example authenticators
5998 which support plaintext username/password authentication using the
5999 standard PLAIN mechanism and the traditional but non-standard LOGIN
6000 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6001 to support most MUA software.
6002
6003 The example PLAIN authenticator looks like this:
6004 .code
6005 #PLAIN:
6006 #  driver                  = plaintext
6007 #  server_set_id           = $auth2
6008 #  server_prompts          = :
6009 #  server_condition        = Authentication is not yet configured
6010 #  server_advertise_condition = ${if def:tls_cipher }
6011 .endd
6012 And the example LOGIN authenticator looks like this:
6013 .code
6014 #LOGIN:
6015 #  driver                  = plaintext
6016 #  server_set_id           = $auth1
6017 #  server_prompts          = <| Username: | Password:
6018 #  server_condition        = Authentication is not yet configured
6019 #  server_advertise_condition = ${if def:tls_cipher }
6020 .endd
6021
6022 The &%server_set_id%& option makes Exim remember the authenticated username
6023 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6024 &%server_prompts%& option configures the &(plaintext)& authenticator so
6025 that it implements the details of the specific authentication mechanism,
6026 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6027 when Exim offers authentication to clients; in the examples, this is only
6028 when TLS or SSL has been started, so to enable the authenticators you also
6029 need to add support for TLS as described in &<<SECTdefconfmain>>&.
6030
6031 The &%server_condition%& setting defines how to verify that the username and
6032 password are correct. In the examples it just produces an error message.
6033 To make the authenticators work, you can use a string expansion
6034 expression like one of the examples in &<<CHAPplaintext>>&.
6035
6036 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6037 usercode and password are in different positions.  &<<CHAPplaintext>>&
6038 covers both.
6039
6040 .ecindex IIDconfiwal
6041
6042
6043
6044 . ////////////////////////////////////////////////////////////////////////////
6045 . ////////////////////////////////////////////////////////////////////////////
6046
6047 .chapter "Regular expressions" "CHAPregexp"
6048
6049 .cindex "regular expressions" "library"
6050 .cindex "PCRE"
6051 Exim supports the use of regular expressions in many of its options. It
6052 uses the PCRE regular expression library; this provides regular expression
6053 matching that is compatible with Perl 5. The syntax and semantics of
6054 regular expressions is discussed in many Perl reference books, and also in
6055 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6056 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6057
6058 The documentation for the syntax and semantics of the regular expressions that
6059 are supported by PCRE is included in the PCRE distribution, and no further
6060 description is included here. The PCRE functions are called from Exim using
6061 the default option settings (that is, with no PCRE options set), except that
6062 the PCRE_CASELESS option is set when the matching is required to be
6063 case-insensitive.
6064
6065 In most cases, when a regular expression is required in an Exim configuration,
6066 it has to start with a circumflex, in order to distinguish it from plain text
6067 or an &"ends with"& wildcard. In this example of a configuration setting, the
6068 second item in the colon-separated list is a regular expression.
6069 .code
6070 domains = a.b.c : ^\\d{3} : *.y.z : ...
6071 .endd
6072 The doubling of the backslash is required because of string expansion that
6073 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6074 of this issue, and a way of avoiding the need for doubling backslashes. The
6075 regular expression that is eventually used in this example contains just one
6076 backslash. The circumflex is included in the regular expression, and has the
6077 normal effect of &"anchoring"& it to the start of the string that is being
6078 matched.
6079
6080 There are, however, two cases where a circumflex is not required for the
6081 recognition of a regular expression: these are the &%match%& condition in a
6082 string expansion, and the &%matches%& condition in an Exim filter file. In
6083 these cases, the relevant string is always treated as a regular expression; if
6084 it does not start with a circumflex, the expression is not anchored, and can
6085 match anywhere in the subject string.
6086
6087 In all cases, if you want a regular expression to match at the end of a string,
6088 you must code the $ metacharacter to indicate this. For example:
6089 .code
6090 domains = ^\\d{3}\\.example
6091 .endd
6092 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6093 You need to use:
6094 .code
6095 domains = ^\\d{3}\\.example\$
6096 .endd
6097 if you want &'example'& to be the top-level domain. The backslash before the
6098 $ is needed because string expansion also interprets dollar characters.
6099
6100
6101
6102 . ////////////////////////////////////////////////////////////////////////////
6103 . ////////////////////////////////////////////////////////////////////////////
6104
6105 .chapter "File and database lookups" "CHAPfdlookup"
6106 .scindex IIDfidalo1 "file" "lookups"
6107 .scindex IIDfidalo2 "database" "lookups"
6108 .cindex "lookup" "description of"
6109 Exim can be configured to look up data in files or databases as it processes
6110 messages. Two different kinds of syntax are used:
6111
6112 .olist
6113 A string that is to be expanded may contain explicit lookup requests. These
6114 cause parts of the string to be replaced by data that is obtained from the
6115 lookup. Lookups of this type are conditional expansion items. Different results
6116 can be defined for the cases of lookup success and failure. See chapter
6117 &<<CHAPexpand>>&, where string expansions are described in detail.
6118 .next
6119 Lists of domains, hosts, and email addresses can contain lookup requests as a
6120 way of avoiding excessively long linear lists. In this case, the data that is
6121 returned by the lookup is often (but not always) discarded; whether the lookup
6122 succeeds or fails is what really counts. These kinds of list are described in
6123 chapter &<<CHAPdomhosaddlists>>&.
6124 .endlist
6125
6126 String expansions, lists, and lookups interact with each other in such a way
6127 that there is no order in which to describe any one of them that does not
6128 involve references to the others. Each of these three chapters makes more sense
6129 if you have read the other two first. If you are reading this for the first
6130 time, be aware that some of it will make a lot more sense after you have read
6131 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6132
6133 .section "Examples of different lookup syntax" "SECID60"
6134 It is easy to confuse the two different kinds of lookup, especially as the
6135 lists that may contain the second kind are always expanded before being
6136 processed as lists. Therefore, they may also contain lookups of the first kind.
6137 Be careful to distinguish between the following two examples:
6138 .code
6139 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6140 domains = lsearch;/some/file
6141 .endd
6142 The first uses a string expansion, the result of which must be a domain list.
6143 No strings have been specified for a successful or a failing lookup; the
6144 defaults in this case are the looked-up data and an empty string, respectively.
6145 The expansion takes place before the string is processed as a list, and the
6146 file that is searched could contain lines like this:
6147 .code
6148 192.168.3.4: domain1:domain2:...
6149 192.168.1.9: domain3:domain4:...
6150 .endd
6151 When the lookup succeeds, the result of the expansion is a list of domains (and
6152 possibly other types of item that are allowed in domain lists).
6153
6154 In the second example, the lookup is a single item in a domain list. It causes
6155 Exim to use a lookup to see if the domain that is being processed can be found
6156 in the file. The file could contains lines like this:
6157 .code
6158 domain1:
6159 domain2:
6160 .endd
6161 Any data that follows the keys is not relevant when checking that the domain
6162 matches the list item.
6163
6164 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6165 Consider a file containing lines like this:
6166 .code
6167 192.168.5.6: lsearch;/another/file
6168 .endd
6169 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6170 first &%domains%& setting above generates the second setting, which therefore
6171 causes a second lookup to occur.
6172
6173 The rest of this chapter describes the different lookup types that are
6174 available. Any of them can be used in any part of the configuration where a
6175 lookup is permitted.
6176
6177
6178 .section "Lookup types" "SECID61"
6179 .cindex "lookup" "types of"
6180 .cindex "single-key lookup" "definition of"
6181 Two different types of data lookup are implemented:
6182
6183 .ilist
6184 The &'single-key'& type requires the specification of a file in which to look,
6185 and a single key to search for. The key must be a non-empty string for the
6186 lookup to succeed. The lookup type determines how the file is searched.
6187 .next
6188 .cindex "query-style lookup" "definition of"
6189 The &'query-style'& type accepts a generalized database query. No particular
6190 key value is assumed by Exim for query-style lookups. You can use whichever
6191 Exim variables you need to construct the database query.
6192 .endlist
6193
6194 The code for each lookup type is in a separate source file that is included in
6195 the binary of Exim only if the corresponding compile-time option is set. The
6196 default settings in &_src/EDITME_& are:
6197 .code
6198 LOOKUP_DBM=yes
6199 LOOKUP_LSEARCH=yes
6200 .endd
6201 which means that only linear searching and DBM lookups are included by default.
6202 For some types of lookup (e.g. SQL databases), you need to install appropriate
6203 libraries and header files before building Exim.
6204
6205
6206
6207
6208 .section "Single-key lookup types" "SECTsinglekeylookups"
6209 .cindex "lookup" "single-key types"
6210 .cindex "single-key lookup" "list of types"
6211 The following single-key lookup types are implemented:
6212
6213 .ilist
6214 .cindex "cdb" "description of"
6215 .cindex "lookup" "cdb"
6216 .cindex "binary zero" "in lookup key"
6217 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6218 string without a terminating binary zero. The cdb format is designed for
6219 indexed files that are read frequently and never updated, except by total
6220 re-creation. As such, it is particularly suitable for large files containing
6221 aliases or other indexed data referenced by an MTA. Information about cdb can
6222 be found in several places:
6223 .display
6224 &url(http://www.pobox.com/~djb/cdb.html)
6225 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6226 &url(http://packages.debian.org/stable/utils/freecdb.html)
6227 .endd
6228 A cdb distribution is not needed in order to build Exim with cdb support,
6229 because the code for reading cdb files is included directly in Exim itself.
6230 However, no means of building or testing cdb files is provided with Exim, so
6231 you need to obtain a cdb distribution in order to do this.
6232 .next
6233 .cindex "DBM" "lookup type"
6234 .cindex "lookup" "dbm"
6235 .cindex "binary zero" "in lookup key"
6236 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6237 DBM file by looking up the record with the given key. A terminating binary
6238 zero is included in the key that is passed to the DBM library. See section
6239 &<<SECTdb>>& for a discussion of DBM libraries.
6240
6241 .cindex "Berkeley DB library" "file format"
6242 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6243 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6244 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6245 the DB_UNKNOWN option. This enables it to handle any of the types of database
6246 that the library supports, and can be useful for accessing DBM files created by
6247 other applications. (For earlier DB versions, DB_HASH is always used.)
6248 .new
6249 .next
6250 .cindex "lookup" "dbmjz"
6251 .cindex "lookup" "dbm &-- embedded NULs"
6252 .cindex "sasldb2"
6253 .cindex "dbmjz lookup type"
6254 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6255 interpreted as an Exim list; the elements of the list are joined together with
6256 ASCII NUL characters to form the lookup key.  An example usage would be to
6257 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6258 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6259 &(cram_md5)& authenticator.
6260 .wen
6261 .next
6262 .cindex "lookup" "dbmnz"
6263 .cindex "lookup" "dbm &-- terminating zero"
6264 .cindex "binary zero" "in lookup key"
6265 .cindex "Courier"
6266 .cindex "&_/etc/userdbshadow.dat_&"
6267 .cindex "dbmnz lookup type"
6268 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6269 is not included in the key that is passed to the DBM library. You may need this
6270 if you want to look up data in files that are created by or shared with some
6271 other application that does not use terminating zeros. For example, you need to
6272 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6273 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6274 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6275 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6276 .next
6277 .cindex "lookup" "dsearch"
6278 .cindex "dsearch lookup type"
6279 &(dsearch)&: The given file must be a directory; this is searched for an entry
6280 whose name is the key by calling the &[lstat()]& function. The key may not
6281 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6282 the lookup is the name of the entry, which may be a file, directory,
6283 symbolic link, or any other kind of directory entry. An example of how this
6284 lookup can be used to support virtual domains is given in section
6285 &<<SECTvirtualdomains>>&.
6286 .next
6287 .cindex "lookup" "iplsearch"
6288 .cindex "iplsearch lookup type"
6289 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6290 terminated by a colon or white space or the end of the line. The keys in the
6291 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6292 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6293 being interpreted as a key terminator. For example:
6294 .code
6295 1.2.3.4:           data for 1.2.3.4
6296 192.168.0.0/16:    data for 192.168.0.0/16
6297 "abcd::cdab":      data for abcd::cdab
6298 "abcd:abcd::/32"   data for abcd:abcd::/32
6299 .endd
6300 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6301 file is searched linearly, using the CIDR masks where present, until a matching
6302 key is found. The first key that matches is used; there is no attempt to find a
6303 &"best"& match. Apart from the way the keys are matched, the processing for
6304 &(iplsearch)& is the same as for &(lsearch)&.
6305
6306 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6307 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6308 lookup types support only literal keys.
6309
6310 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6311 the implicit key is the host's IP address rather than its name (see section
6312 &<<SECThoslispatsikey>>&).
6313 .next
6314 .cindex "linear search"
6315 .cindex "lookup" "lsearch"
6316 .cindex "lsearch lookup type"
6317 .cindex "case sensitivity" "in lsearch lookup"
6318 &(lsearch)&: The given file is a text file that is searched linearly for a
6319 line beginning with the search key, terminated by a colon or white space or the
6320 end of the line. The search is case-insensitive; that is, upper and lower case
6321 letters are treated as the same. The first occurrence of the key that is found
6322 in the file is used.
6323
6324 White space between the key and the colon is permitted. The remainder of the
6325 line, with leading and trailing white space removed, is the data. This can be
6326 continued onto subsequent lines by starting them with any amount of white
6327 space, but only a single space character is included in the data at such a
6328 junction. If the data begins with a colon, the key must be terminated by a
6329 colon, for example:
6330 .code
6331 baduser:  :fail:
6332 .endd
6333 Empty lines and lines beginning with # are ignored, even if they occur in the
6334 middle of an item. This is the traditional textual format of alias files. Note
6335 that the keys in an &(lsearch)& file are literal strings. There is no
6336 wildcarding of any kind.
6337
6338 .cindex "lookup" "lsearch &-- colons in keys"
6339 .cindex "white space" "in lsearch key"
6340 In most &(lsearch)& files, keys are not required to contain colons or #
6341 characters, or white space. However, if you need this feature, it is available.
6342 If a key begins with a doublequote character, it is terminated only by a
6343 matching quote (or end of line), and the normal escaping rules apply to its
6344 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6345 quoted keys (exactly as for unquoted keys). There is no special handling of
6346 quotes for the data part of an &(lsearch)& line.
6347
6348 .next
6349 .cindex "NIS lookup type"
6350 .cindex "lookup" "NIS"
6351 .cindex "binary zero" "in lookup key"
6352 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6353 the given key, without a terminating binary zero. There is a variant called
6354 &(nis0)& which does include the terminating binary zero in the key. This is
6355 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6356 aliases; the full map names must be used.
6357
6358 .next
6359 .cindex "wildlsearch lookup type"
6360 .cindex "lookup" "wildlsearch"
6361 .cindex "nwildlsearch lookup type"
6362 .cindex "lookup" "nwildlsearch"
6363 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6364 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6365 the file may be wildcarded. The difference between these two lookup types is
6366 that for &(wildlsearch)&, each key in the file is string-expanded before being
6367 used, whereas for &(nwildlsearch)&, no expansion takes place.
6368
6369 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6370 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6371 file that are regular expressions can be made case-sensitive by the use of
6372 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6373
6374 . ==== As this is a nested list, any displays it contains must be indented
6375 . ==== as otherwise they are too far to the left.
6376
6377 .olist
6378 The string may begin with an asterisk to mean &"ends with"&. For example:
6379 .code
6380     *.a.b.c       data for anything.a.b.c
6381     *fish         data for anythingfish
6382 .endd
6383 .next
6384 The string may begin with a circumflex to indicate a regular expression. For
6385 example, for &(wildlsearch)&:
6386 .code
6387     ^\N\d+\.a\.b\N    data for <digits>.a.b
6388 .endd
6389 Note the use of &`\N`& to disable expansion of the contents of the regular
6390 expression. If you are using &(nwildlsearch)&, where the keys are not
6391 string-expanded, the equivalent entry is:
6392 .code
6393     ^\d+\.a\.b        data for <digits>.a.b
6394 .endd
6395 The case-insensitive flag is set at the start of compiling the regular
6396 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6397 For example, to make the entire pattern case-sensitive:
6398 .code
6399     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6400 .endd
6401
6402 If the regular expression contains white space or colon characters, you must
6403 either quote it (see &(lsearch)& above), or represent these characters in other
6404 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6405 colon. This may be easier than quoting, because if you quote, you have to
6406 escape all the backslashes inside the quotes.
6407
6408 &*Note*&: It is not possible to capture substrings in a regular expression
6409 match for later use, because the results of all lookups are cached. If a lookup
6410 is repeated, the result is taken from the cache, and no actual pattern matching
6411 takes place. The values of all the numeric variables are unset after a
6412 &((n)wildlsearch)& match.
6413
6414 .next
6415 Although I cannot see it being of much use, the general matching function that
6416 is used to implement &((n)wildlsearch)& means that the string may begin with a
6417 lookup name terminated by a semicolon, and followed by lookup data. For
6418 example:
6419 .code
6420     cdb;/some/file  data for keys that match the file
6421 .endd
6422 The data that is obtained from the nested lookup is discarded.
6423 .endlist olist
6424
6425 Keys that do not match any of these patterns are interpreted literally. The
6426 continuation rules for the data are the same as for &(lsearch)&, and keys may
6427 be followed by optional colons.
6428
6429 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6430 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6431 lookup types support only literal keys.
6432 .endlist ilist
6433
6434
6435 .section "Query-style lookup types" "SECID62"
6436 .cindex "lookup" "query-style types"
6437 .cindex "query-style lookup" "list of types"
6438 The supported query-style lookup types are listed below. Further details about
6439 many of them are given in later sections.
6440
6441 .ilist
6442 .cindex "DNS" "as a lookup type"
6443 .cindex "lookup" "DNS"
6444 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6445 are given in the supplied query. The resulting data is the contents of the
6446 records. See section &<<SECTdnsdb>>&.
6447 .next
6448 .cindex "InterBase lookup type"
6449 .cindex "lookup" "InterBase"
6450 &(ibase)&: This does a lookup in an InterBase database.
6451 .next
6452 .cindex "LDAP" "lookup type"
6453 .cindex "lookup" "LDAP"
6454 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6455 returns attributes from a single entry. There is a variant called &(ldapm)&
6456 that permits values from multiple entries to be returned. A third variant
6457 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6458 any attribute values. See section &<<SECTldap>>&.
6459 .next
6460 .cindex "MySQL" "lookup type"
6461 .cindex "lookup" "MySQL"
6462 &(mysql)&: The format of the query is an SQL statement that is passed to a
6463 MySQL database. See section &<<SECTsql>>&.
6464 .next
6465 .cindex "NIS+ lookup type"
6466 .cindex "lookup" "NIS+"
6467 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6468 the field to be returned. See section &<<SECTnisplus>>&.
6469 .next
6470 .cindex "Oracle" "lookup type"
6471 .cindex "lookup" "Oracle"
6472 &(oracle)&: The format of the query is an SQL statement that is passed to an
6473 Oracle database. See section &<<SECTsql>>&.
6474 .next
6475 .cindex "lookup" "passwd"
6476 .cindex "passwd lookup type"
6477 .cindex "&_/etc/passwd_&"
6478 &(passwd)& is a query-style lookup with queries that are just user names. The
6479 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6480 success, the result string is the same as you would get from an &(lsearch)&
6481 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6482 password value. For example:
6483 .code
6484 *:42:42:King Rat:/home/kr:/bin/bash
6485 .endd
6486 .next
6487 .cindex "PostgreSQL lookup type"
6488 .cindex "lookup" "PostgreSQL"
6489 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6490 PostgreSQL database. See section &<<SECTsql>>&.
6491
6492 .next
6493 .cindex "sqlite lookup type"
6494 .cindex "lookup" "sqlite"
6495 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6496 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6497
6498 .next
6499 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6500 not likely to be useful in normal operation.
6501 .next
6502 .cindex "whoson lookup type"
6503 .cindex "lookup" "whoson"
6504 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6505 allows a server to check whether a particular (dynamically allocated) IP
6506 address is currently allocated to a known (trusted) user and, optionally, to
6507 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6508 at one time for &"POP before SMTP"& authentication, but that approach has been
6509 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6510 &"POP before SMTP"& checking using ACL statements such as
6511 .code
6512 require condition = \
6513   ${lookup whoson {$sender_host_address}{yes}{no}}
6514 .endd
6515 The query consists of a single IP address. The value returned is the name of
6516 the authenticated user, which is stored in the variable &$value$&. However, in
6517 this example, the data in &$value$& is not used; the result of the lookup is
6518 one of the fixed strings &"yes"& or &"no"&.
6519 .endlist
6520
6521
6522
6523 .section "Temporary errors in lookups" "SECID63"
6524 .cindex "lookup" "temporary error in"
6525 Lookup functions can return temporary error codes if the lookup cannot be
6526 completed. For example, an SQL or LDAP database might be unavailable. For this
6527 reason, it is not advisable to use a lookup that might do this for critical
6528 options such as a list of local domains.
6529
6530 When a lookup cannot be completed in a router or transport, delivery
6531 of the message (to the relevant address) is deferred, as for any other
6532 temporary error. In other circumstances Exim may assume the lookup has failed,
6533 or may give up altogether.
6534
6535
6536
6537 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6538 .cindex "wildcard lookups"
6539 .cindex "lookup" "default values"
6540 .cindex "lookup" "wildcard"
6541 .cindex "lookup" "* added to type"
6542 .cindex "default" "in single-key lookups"
6543 In this context, a &"default value"& is a value specified by the administrator
6544 that is to be used if a lookup fails.
6545
6546 &*Note:*& This section applies only to single-key lookups. For query-style
6547 lookups, the facilities of the query language must be used. An attempt to
6548 specify a default for a query-style lookup provokes an error.
6549
6550 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6551 and the initial lookup fails, the key &"*"& is looked up in the file to
6552 provide a default value. See also the section on partial matching below.
6553
6554 .cindex "*@ with single-key lookup"
6555 .cindex "lookup" "*@ added to type"
6556 .cindex "alias file" "per-domain default"
6557 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6558 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6559 character, a second lookup is done with everything before the last @ replaced
6560 by *. This makes it possible to provide per-domain defaults in alias files
6561 that include the domains in the keys. If the second lookup fails (or doesn't
6562 take place because there is no @ in the key), &"*"& is looked up.
6563 For example, a &(redirect)& router might contain:
6564 .code
6565 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6566 .endd
6567 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6568 looks up these keys, in this order:
6569 .code
6570 jane@eyre.example
6571 *@eyre.example
6572 *
6573 .endd
6574 The data is taken from whichever key it finds first. &*Note*&: In an
6575 &(lsearch)& file, this does not mean the first of these keys in the file. A
6576 complete scan is done for each key, and only if it is not found at all does
6577 Exim move on to try the next key.
6578
6579
6580
6581 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6582 .cindex "partial matching"
6583 .cindex "wildcard lookups"
6584 .cindex "lookup" "partial matching"
6585 .cindex "lookup" "wildcard"
6586 .cindex "asterisk" "in search type"
6587 The normal operation of a single-key lookup is to search the file for an exact
6588 match with the given key. However, in a number of situations where domains are
6589 being looked up, it is useful to be able to do partial matching. In this case,
6590 information in the file that has a key starting with &"*."& is matched by any
6591 domain that ends with the components that follow the full stop. For example, if
6592 a key in a DBM file is
6593 .code
6594 *.dates.fict.example
6595 .endd
6596 then when partial matching is enabled this is matched by (amongst others)
6597 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6598 by &'dates.fict.example'&, if that does not appear as a separate key in the
6599 file.
6600
6601 &*Note*&: Partial matching is not available for query-style lookups. It is
6602 also not available for any lookup items in address lists (see section
6603 &<<SECTaddresslist>>&).
6604
6605 Partial matching is implemented by doing a series of separate lookups using
6606 keys constructed by modifying the original subject key. This means that it can
6607 be used with any of the single-key lookup types, provided that
6608 partial matching keys
6609 beginning with a special prefix (default &"*."&) are included in the data file.
6610 Keys in the file that do not begin with the prefix are matched only by
6611 unmodified subject keys when partial matching is in use.
6612
6613 Partial matching is requested by adding the string &"partial-"& to the front of
6614 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6615 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6616 is added at the start of the subject key, and it is looked up again. If that
6617 fails, further lookups are tried with dot-separated components removed from the
6618 start of the subject key, one-by-one, and &"*."& added on the front of what
6619 remains.
6620
6621 A minimum number of two non-* components are required. This can be adjusted
6622 by including a number before the hyphen in the search type. For example,
6623 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6624 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6625 subject key is &'2250.dates.fict.example'& then the following keys are looked
6626 up when the minimum number of non-* components is two:
6627 .code
6628 2250.dates.fict.example
6629 *.2250.dates.fict.example
6630 *.dates.fict.example
6631 *.fict.example
6632 .endd
6633 As soon as one key in the sequence is successfully looked up, the lookup
6634 finishes.
6635
6636 .cindex "lookup" "partial matching &-- changing prefix"
6637 .cindex "prefix" "for partial matching"
6638 The use of &"*."& as the partial matching prefix is a default that can be
6639 changed. The motivation for this feature is to allow Exim to operate with file
6640 formats that are used by other MTAs. A different prefix can be supplied in
6641 parentheses instead of the hyphen after &"partial"&. For example:
6642 .code
6643 domains = partial(.)lsearch;/some/file
6644 .endd
6645 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6646 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6647 components is unchanged). The prefix may consist of any punctuation characters
6648 other than a closing parenthesis. It may be empty, for example:
6649 .code
6650 domains = partial1()cdb;/some/file
6651 .endd
6652 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6653 &`a.b.c`&, &`b.c`&, and &`c`&.
6654
6655 If &"partial0"& is specified, what happens at the end (when the lookup with
6656 just one non-wild component has failed, and the original key is shortened right
6657 down to the null string) depends on the prefix:
6658
6659 .ilist
6660 If the prefix has zero length, the whole lookup fails.
6661 .next
6662 If the prefix has length 1, a lookup for just the prefix is done. For
6663 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6664 .next
6665 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6666 remainder is looked up. With the default prefix, therefore, the final lookup is
6667 for &"*"& on its own.
6668 .next
6669 Otherwise, the whole prefix is looked up.
6670 .endlist
6671
6672
6673 If the search type ends in &"*"& or &"*@"& (see section
6674 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6675 this implies happens after all partial lookups have failed. If &"partial0"& is
6676 specified, adding &"*"& to the search type has no effect with the default
6677 prefix, because the &"*"& key is already included in the sequence of partial
6678 lookups. However, there might be a use for lookup types such as
6679 &"partial0(.)lsearch*"&.
6680
6681 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6682 in domain lists and the like. Partial matching works only in terms of
6683 dot-separated components; a key such as &`*fict.example`&
6684 in a database file is useless, because the asterisk in a partial matching
6685 subject key is always followed by a dot.
6686
6687
6688
6689
6690 .section "Lookup caching" "SECID64"
6691 .cindex "lookup" "caching"
6692 .cindex "caching" "lookup data"
6693 Exim caches all lookup results in order to avoid needless repetition of
6694 lookups. However, because (apart from the daemon) Exim operates as a collection
6695 of independent, short-lived processes, this caching applies only within a
6696 single Exim process. There is no inter-process lookup caching facility.
6697
6698 For single-key lookups, Exim keeps the relevant files open in case there is
6699 another lookup that needs them. In some types of configuration this can lead to
6700 many files being kept open for messages with many recipients. To avoid hitting
6701 the operating system limit on the number of simultaneously open files, Exim
6702 closes the least recently used file when it needs to open more files than its
6703 own internal limit, which can be changed via the &%lookup_open_max%& option.
6704
6705 The single-key lookup files are closed and the lookup caches are flushed at
6706 strategic points during delivery &-- for example, after all routing is
6707 complete.
6708
6709
6710
6711
6712 .section "Quoting lookup data" "SECID65"
6713 .cindex "lookup" "quoting"
6714 .cindex "quoting" "in lookups"
6715 When data from an incoming message is included in a query-style lookup, there
6716 is the possibility of special characters in the data messing up the syntax of
6717 the query. For example, a NIS+ query that contains
6718 .code
6719 [name=$local_part]
6720 .endd
6721 will be broken if the local part happens to contain a closing square bracket.
6722 For NIS+, data can be enclosed in double quotes like this:
6723 .code
6724 [name="$local_part"]
6725 .endd
6726 but this still leaves the problem of a double quote in the data. The rule for
6727 NIS+ is that double quotes must be doubled. Other lookup types have different
6728 rules, and to cope with the differing requirements, an expansion operator
6729 of the following form is provided:
6730 .code
6731 ${quote_<lookup-type>:<string>}
6732 .endd
6733 For example, the safest way to write the NIS+ query is
6734 .code
6735 [name="${quote_nisplus:$local_part}"]
6736 .endd
6737 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6738 operator can be used for all lookup types, but has no effect for single-key
6739 lookups, since no quoting is ever needed in their key strings.
6740
6741
6742
6743
6744 .section "More about dnsdb" "SECTdnsdb"
6745 .cindex "dnsdb lookup"
6746 .cindex "lookup" "dnsdb"
6747 .cindex "DNS" "as a lookup type"
6748 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6749 of a record type and a domain name, separated by an equals sign. For example,
6750 an expansion string could contain:
6751 .code
6752 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6753 .endd
6754 If the lookup succeeds, the result is placed in &$value$&, which in this case
6755 is used on its own as the result. If the lookup does not succeed, the
6756 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6757 &<<SECTforexpfai>>& for an explanation of what this means.
6758
6759 .new
6760 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6761 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6762 configured). If no type is given, TXT is assumed. When the type is PTR,
6763 the data can be an IP address, written as normal; inversion and the addition of
6764 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6765 .wen
6766 .code
6767 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6768 .endd
6769 If the data for a PTR record is not a syntactically valid IP address, it is not
6770 altered and nothing is added.
6771
6772 .cindex "MX record" "in &(dnsdb)& lookup"
6773 .cindex "SRV record" "in &(dnsdb)& lookup"
6774 For an MX lookup, both the preference value and the host name are returned for
6775 each record, separated by a space. For an SRV lookup, the priority, weight,
6776 port, and host name are returned for each record, separated by spaces.
6777
6778 For any record type, if multiple records are found (or, for A6 lookups, if a
6779 single record leads to multiple addresses), the data is returned as a
6780 concatenation, with newline as the default separator. The order, of course,
6781 depends on the DNS resolver. You can specify a different separator character
6782 between multiple records by putting a right angle-bracket followed immediately
6783 by the new separator at the start of the query. For example:
6784 .code
6785 ${lookup dnsdb{>: a=host1.example}}
6786 .endd
6787 It is permitted to specify a space as the separator character. Further
6788 white space is ignored.
6789
6790 .cindex "TXT record" "in &(dnsdb)& lookup"
6791 .cindex "SPF record" "in &(dnsdb)& lookup"
6792 .new
6793 For TXT records with multiple items of data, only the first item is returned,
6794 unless a separator for them is specified using a comma after the separator
6795 character followed immediately by the TXT record item separator. To concatenate
6796 items without a separator, use a semicolon instead. For SPF records the
6797 default behaviour is to concatenate multiple items without using a separator.
6798 .wen
6799 .code
6800 ${lookup dnsdb{>\n,: txt=a.b.example}}
6801 ${lookup dnsdb{>\n; txt=a.b.example}}
6802 ${lookup dnsdb{spf=example.org}}
6803 .endd
6804 It is permitted to specify a space as the separator character. Further
6805 white space is ignored.
6806
6807 .section "Pseudo dnsdb record types" "SECID66"
6808 .cindex "MX record" "in &(dnsdb)& lookup"
6809 By default, both the preference value and the host name are returned for
6810 each MX record, separated by a space. If you want only host names, you can use
6811 the pseudo-type MXH:
6812 .code
6813 ${lookup dnsdb{mxh=a.b.example}}
6814 .endd
6815 In this case, the preference values are omitted, and just the host names are
6816 returned.
6817
6818 .cindex "name server for enclosing domain"
6819 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6820 records on the given domain, but if none are found, it removes the first
6821 component of the domain name, and tries again. This process continues until NS
6822 records are found or there are no more components left (or there is a DNS
6823 error). In other words, it may return the name servers for a top-level domain,
6824 but it never returns the root name servers. If there are no NS records for the
6825 top-level domain, the lookup fails. Consider these examples:
6826 .code
6827 ${lookup dnsdb{zns=xxx.quercite.com}}
6828 ${lookup dnsdb{zns=xxx.edu}}
6829 .endd
6830 Assuming that in each case there are no NS records for the full domain name,
6831 the first returns the name servers for &%quercite.com%&, and the second returns
6832 the name servers for &%edu%&.
6833
6834 You should be careful about how you use this lookup because, unless the
6835 top-level domain does not exist, the lookup always returns some host names. The
6836 sort of use to which this might be put is for seeing if the name servers for a
6837 given domain are on a blacklist. You can probably assume that the name servers
6838 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6839 such a list.
6840
6841 .cindex "CSA" "in &(dnsdb)& lookup"
6842 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6843 records according to the CSA rules, which are described in section
6844 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6845 not sufficient because of the extra parent domain search behaviour of CSA. The
6846 result of a successful lookup such as:
6847 .code
6848 ${lookup dnsdb {csa=$sender_helo_name}}
6849 .endd
6850 has two space-separated fields: an authorization code and a target host name.
6851 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6852 authorization required but absent, or &"?"& for unknown.
6853
6854
6855 .section "Multiple dnsdb lookups" "SECID67"
6856 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6857 However, you can specify a list of domains or IP addresses in a single
6858 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6859 the default separator, but with the ability to change this. For example:
6860 .code
6861 ${lookup dnsdb{one.domain.com:two.domain.com}}
6862 ${lookup dnsdb{a=one.host.com:two.host.com}}
6863 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6864 .endd
6865 In order to retain backwards compatibility, there is one special case: if
6866 the lookup type is PTR and no change of separator is specified, Exim looks
6867 to see if the rest of the string is precisely one IPv6 address. In this
6868 case, it does not treat it as a list.
6869
6870 The data from each lookup is concatenated, with newline separators by default,
6871 in the same way that multiple DNS records for a single item are handled. A
6872 different separator can be specified, as described above.
6873
6874 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6875 temporary DNS error for any of them, the behaviour is controlled by
6876 an optional keyword followed by a comma that may appear before the record
6877 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6878 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6879 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6880 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6881 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6882 error causes the whole lookup to defer only if none of the other lookups
6883 succeed. The default is &"lax"&, so the following lookups are equivalent:
6884 .code
6885 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6886 ${lookup dnsdb{a=one.host.com:two.host.com}}
6887 .endd
6888 Thus, in the default case, as long as at least one of the DNS lookups
6889 yields some data, the lookup succeeds.
6890
6891
6892
6893
6894 .section "More about LDAP" "SECTldap"
6895 .cindex "LDAP" "lookup, more about"
6896 .cindex "lookup" "LDAP"
6897 .cindex "Solaris" "LDAP"
6898 The original LDAP implementation came from the University of Michigan; this has
6899 become &"Open LDAP"&, and there are now two different releases. Another
6900 implementation comes from Netscape, and Solaris 7 and subsequent releases
6901 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6902 the lookup function level, their error handling is different. For this reason
6903 it is necessary to set a compile-time variable when building Exim with LDAP, to
6904 indicate which LDAP library is in use. One of the following should appear in
6905 your &_Local/Makefile_&:
6906 .code
6907 LDAP_LIB_TYPE=UMICHIGAN
6908 LDAP_LIB_TYPE=OPENLDAP1
6909 LDAP_LIB_TYPE=OPENLDAP2
6910 LDAP_LIB_TYPE=NETSCAPE
6911 LDAP_LIB_TYPE=SOLARIS
6912 .endd
6913 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6914 same interface as the University of Michigan version.
6915
6916 There are three LDAP lookup types in Exim. These behave slightly differently in
6917 the way they handle the results of a query:
6918
6919 .ilist
6920 &(ldap)& requires the result to contain just one entry; if there are more, it
6921 gives an error.
6922 .next
6923 &(ldapdn)& also requires the result to contain just one entry, but it is the
6924 Distinguished Name that is returned rather than any attribute values.
6925 .next
6926 &(ldapm)& permits the result to contain more than one entry; the attributes
6927 from all of them are returned.
6928 .endlist
6929
6930
6931 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6932 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6933 the data returned by a successful lookup is described in the next section.
6934 First we explain how LDAP queries are coded.
6935
6936
6937 .section "Format of LDAP queries" "SECTforldaque"
6938 .cindex "LDAP" "query format"
6939 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6940 the configuration of a &(redirect)& router one might have this setting:
6941 .code
6942 data = ${lookup ldap \
6943   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6944   c=UK?mailbox?base?}}
6945 .endd
6946 .cindex "LDAP" "with TLS"
6947 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6948 secure (encrypted) LDAP connections. The second of these ensures that an
6949 encrypted TLS connection is used.
6950
6951 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
6952 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
6953 See the &%ldap_start_tls%& option.
6954
6955
6956 .section "LDAP quoting" "SECID68"
6957 .cindex "LDAP" "quoting"
6958 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6959 and the second because the LDAP query is represented as a URL. Furthermore,
6960 within an LDAP query, two different kinds of quoting are required. For this
6961 reason, there are two different LDAP-specific quoting operators.
6962
6963 The &%quote_ldap%& operator is designed for use on strings that are part of
6964 filter specifications. Conceptually, it first does the following conversions on
6965 the string:
6966 .code
6967 *   =>   \2A
6968 (   =>   \28
6969 )   =>   \29
6970 \   =>   \5C
6971 .endd
6972 in accordance with RFC 2254. The resulting string is then quoted according
6973 to the rules for URLs, that is, all non-alphanumeric characters except
6974 .code
6975 ! $ ' - . _ ( ) * +
6976 .endd
6977 are converted to their hex values, preceded by a percent sign. For example:
6978 .code
6979 ${quote_ldap: a(bc)*, a<yz>; }
6980 .endd
6981 yields
6982 .code
6983 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6984 .endd
6985 Removing the URL quoting, this is (with a leading and a trailing space):
6986 .code
6987 a\28bc\29\2A, a<yz>;
6988 .endd
6989 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6990 base DN specifications in queries. Conceptually, it first converts the string
6991 by inserting a backslash in front of any of the following characters:
6992 .code
6993 , + " \ < > ;
6994 .endd
6995 It also inserts a backslash before any leading spaces or # characters, and
6996 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6997 is then quoted according to the rules for URLs. For example:
6998 .code
6999 ${quote_ldap_dn: a(bc)*, a<yz>; }
7000 .endd
7001 yields
7002 .code
7003 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7004 .endd
7005 Removing the URL quoting, this is (with a trailing space):
7006 .code
7007 \ a(bc)*\, a\<yz\>\;\
7008 .endd
7009 There are some further comments about quoting in the section on LDAP
7010 authentication below.
7011
7012
7013 .section "LDAP connections" "SECID69"
7014 .cindex "LDAP" "connections"
7015 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7016 is in use, via a Unix domain socket. The example given above does not specify
7017 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7018 by starting it with
7019 .code
7020 ldap://<hostname>:<port>/...
7021 .endd
7022 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7023 used. When no server is specified in a query, a list of default servers is
7024 taken from the &%ldap_default_servers%& configuration option. This supplies a
7025 colon-separated list of servers which are tried in turn until one successfully
7026 handles a query, or there is a serious error. Successful handling either
7027 returns the requested data, or indicates that it does not exist. Serious errors
7028 are syntactical, or multiple values when only a single value is expected.
7029 Errors which cause the next server to be tried are connection failures, bind
7030 failures, and timeouts.
7031
7032 For each server name in the list, a port number can be given. The standard way
7033 of specifying a host and port is to use a colon separator (RFC 1738). Because
7034 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7035 doubled. For example
7036 .code
7037 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7038 .endd
7039 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7040 to the LDAP library with no server name, and the library's default (normally
7041 the local host) is used.
7042
7043 If you are using the OpenLDAP library, you can connect to an LDAP server using
7044 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7045 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7046 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7047 not available.
7048
7049 For this type of connection, instead of a host name for the server, a pathname
7050 for the socket is required, and the port number is not relevant. The pathname
7051 can be specified either as an item in &%ldap_default_servers%&, or inline in
7052 the query. In the former case, you can have settings such as
7053 .code
7054 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7055 .endd
7056 When the pathname is given in the query, you have to escape the slashes as
7057 &`%2F`& to fit in with the LDAP URL syntax. For example:
7058 .code
7059 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7060 .endd
7061 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7062 a pathname, it uses the Unix domain socket code, even if the query actually
7063 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7064 socket connection. This behaviour means that you can use a setting of
7065 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7066 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7067 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7068 backup host.
7069
7070 If an explicit &`ldapi`& type is given in a query when a host name is
7071 specified, an error is diagnosed. However, if there are more items in
7072 &%ldap_default_servers%&, they are tried. In other words:
7073
7074 .ilist
7075 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7076 interface.
7077 .next
7078 Using &`ldapi`& with a host name causes an error.
7079 .endlist
7080
7081
7082 Using &`ldapi`& with no host or path in the query, and no setting of
7083 &%ldap_default_servers%&, does whatever the library does by default.
7084
7085
7086
7087 .section "LDAP authentication and control information" "SECID70"
7088 .cindex "LDAP" "authentication"
7089 The LDAP URL syntax provides no way of passing authentication and other control
7090 information to the server. To make this possible, the URL in an LDAP query may
7091 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7092 spaces. If a value contains spaces it must be enclosed in double quotes, and
7093 when double quotes are used, backslash is interpreted in the usual way inside
7094 them. The following names are recognized:
7095 .display
7096 &`DEREFERENCE`&  set the dereferencing parameter
7097 &`NETTIME    `&  set a timeout for a network operation
7098 &`USER       `&  set the DN, for authenticating the LDAP bind
7099 &`PASS       `&  set the password, likewise
7100 &`REFERRALS  `&  set the referrals parameter
7101 &`SIZE       `&  set the limit for the number of entries returned
7102 &`TIME       `&  set the maximum waiting time for a query
7103 .endd
7104 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7105 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7106 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7107 library from trying to follow referrals issued by the LDAP server.
7108
7109 The name CONNECT is an obsolete name for NETTIME, retained for
7110 backwards compatibility. This timeout (specified as a number of seconds) is
7111 enforced from the client end for operations that can be carried out over a
7112 network. Specifically, it applies to network connections and calls to the
7113 &'ldap_result()'& function. If the value is greater than zero, it is used if
7114 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7115 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7116 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7117 Netscape SDK; for OpenLDAP no action is taken.
7118
7119 The TIME parameter (also a number of seconds) is passed to the server to
7120 set a server-side limit on the time taken to complete a search.
7121
7122
7123 Here is an example of an LDAP query in an Exim lookup that uses some of these
7124 values. This is a single line, folded to fit on the page:
7125 .code
7126 ${lookup ldap
7127   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7128   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7129   {$value}fail}
7130 .endd
7131 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7132 any of the auxiliary data. Exim configuration settings that include lookups
7133 which contain password information should be preceded by &"hide"& to prevent
7134 non-admin users from using the &%-bP%& option to see their values.
7135
7136 The auxiliary data items may be given in any order. The default is no
7137 connection timeout (the system timeout is used), no user or password, no limit
7138 on the number of entries returned, and no time limit on queries.
7139
7140 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7141 removes any URL quoting that it may contain before passing it LDAP. Apparently
7142 some libraries do this for themselves, but some do not. Removing the URL
7143 quoting has two advantages:
7144
7145 .ilist
7146 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7147 DNs as with DNs inside actual queries.
7148 .next
7149 It permits spaces inside USER= DNs.
7150 .endlist
7151
7152 For example, a setting such as
7153 .code
7154 USER=cn=${quote_ldap_dn:$1}
7155 .endd
7156 should work even if &$1$& contains spaces.
7157
7158 Expanded data for the PASS= value should be quoted using the &%quote%&
7159 expansion operator, rather than the LDAP quote operators. The only reason this
7160 field needs quoting is to ensure that it conforms to the Exim syntax, which
7161 does not allow unquoted spaces. For example:
7162 .code
7163 PASS=${quote:$3}
7164 .endd
7165 The LDAP authentication mechanism can be used to check passwords as part of
7166 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7167 &<<CHAPexpand>>&.
7168
7169
7170
7171 .section "Format of data returned by LDAP" "SECID71"
7172 .cindex "LDAP" "returned data formats"
7173 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7174 as a sequence of values, for example
7175 .code
7176 cn=manager, o=University of Cambridge, c=UK
7177 .endd
7178 The &(ldap)& lookup type generates an error if more than one entry matches the
7179 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7180 the result between the data from different entries. It is possible for multiple
7181 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7182 you know that whatever values are returned all came from a single entry in the
7183 directory.
7184
7185 In the common case where you specify a single attribute in your LDAP query, the
7186 result is not quoted, and does not contain the attribute name. If the attribute
7187 has multiple values, they are separated by commas.
7188
7189 If you specify multiple attributes, the result contains space-separated, quoted
7190 strings, each preceded by the attribute name and an equals sign. Within the
7191 quotes, the quote character, backslash, and newline are escaped with
7192 backslashes, and commas are used to separate multiple values for the attribute.
7193 Apart from the escaping, the string within quotes takes the same form as the
7194 output when a single attribute is requested. Specifying no attributes is the
7195 same as specifying all of an entry's attributes.
7196
7197 Here are some examples of the output format. The first line of each pair is an
7198 LDAP query, and the second is the data that is returned. The attribute called
7199 &%attr1%& has two values, whereas &%attr2%& has only one value:
7200 .code
7201 ldap:///o=base?attr1?sub?(uid=fred)
7202 value1.1, value1.2
7203
7204 ldap:///o=base?attr2?sub?(uid=fred)
7205 value two
7206
7207 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7208 attr1="value1.1, value1.2" attr2="value two"
7209
7210 ldap:///o=base??sub?(uid=fred)
7211 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7212 .endd
7213 The &%extract%& operator in string expansions can be used to pick out
7214 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7215 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7216 results of LDAP lookups.
7217
7218
7219
7220
7221 .section "More about NIS+" "SECTnisplus"
7222 .cindex "NIS+ lookup type"
7223 .cindex "lookup" "NIS+"
7224 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7225 and field name. If this is given, the result of a successful query is the
7226 contents of the named field; otherwise the result consists of a concatenation
7227 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7228 values containing spaces are quoted. For example, the query
7229 .code
7230 [name=mg1456],passwd.org_dir
7231 .endd
7232 might return the string
7233 .code
7234 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7235 home=/home/mg1456 shell=/bin/bash shadow=""
7236 .endd
7237 (split over two lines here to fit on the page), whereas
7238 .code
7239 [name=mg1456],passwd.org_dir:gcos
7240 .endd
7241 would just return
7242 .code
7243 Martin Guerre
7244 .endd
7245 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7246 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7247 operator is to double any quote characters within the text.
7248
7249
7250
7251 .section "SQL lookups" "SECTsql"
7252 .cindex "SQL lookup types"
7253 .cindex "MySQL" "lookup type"
7254 .cindex "PostgreSQL lookup type"
7255 .cindex "lookup" "MySQL"
7256 .cindex "lookup" "PostgreSQL"
7257 .cindex "Oracle" "lookup type"
7258 .cindex "lookup" "Oracle"
7259 .cindex "InterBase lookup type"
7260 .cindex "lookup" "InterBase"
7261 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7262 databases. Queries for these databases contain SQL statements, so an example
7263 might be
7264 .code
7265 ${lookup mysql{select mailbox from users where id='userx'}\
7266   {$value}fail}
7267 .endd
7268 If the result of the query contains more than one field, the data for each
7269 field in the row is returned, preceded by its name, so the result of
7270 .code
7271 ${lookup pgsql{select home,name from users where id='userx'}\
7272   {$value}}
7273 .endd
7274 might be
7275 .code
7276 home=/home/userx name="Mister X"
7277 .endd
7278 Empty values and values containing spaces are double quoted, with embedded
7279 quotes escaped by a backslash. If the result of the query contains just one
7280 field, the value is passed back verbatim, without a field name, for example:
7281 .code
7282 Mister X
7283 .endd
7284 If the result of the query yields more than one row, it is all concatenated,
7285 with a newline between the data for each row.
7286
7287
7288 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7289 .cindex "MySQL" "lookup type"
7290 .cindex "PostgreSQL lookup type"
7291 .cindex "lookup" "MySQL"
7292 .cindex "lookup" "PostgreSQL"
7293 .cindex "Oracle" "lookup type"
7294 .cindex "lookup" "Oracle"
7295 .cindex "InterBase lookup type"
7296 .cindex "lookup" "InterBase"
7297 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7298 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7299 option (as appropriate) must be set to a colon-separated list of server
7300 information.
7301 (For MySQL and PostgreSQL only, the global option need not be set if all
7302 queries contain their own server information &-- see section
7303 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7304 items: host name, database name, user name, and password. In the case of
7305 Oracle, the host name field is used for the &"service name"&, and the database
7306 name field is not used and should be empty. For example:
7307 .code
7308 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7309 .endd
7310 Because password data is sensitive, you should always precede the setting with
7311 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7312 option. Here is an example where two MySQL servers are listed:
7313 .code
7314 hide mysql_servers = localhost/users/root/secret:\
7315                      otherhost/users/root/othersecret
7316 .endd
7317 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7318 because this is a colon-separated list, the colon has to be doubled. For each
7319 query, these parameter groups are tried in order until a connection is made and
7320 a query is successfully processed. The result of a query may be that no data is
7321 found, but that is still a successful query. In other words, the list of
7322 servers provides a backup facility, not a list of different places to look.
7323
7324 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7325 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7326 respectively, and the characters single-quote, double-quote, and backslash
7327 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7328 addition, escapes the percent and underscore characters. This cannot be done
7329 for MySQL because these escapes are not recognized in contexts where these
7330 characters are not special.
7331
7332 .section "Specifying the server in the query" "SECTspeserque"
7333 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7334 it is possible to specify a list of servers with an individual query. This is
7335 done by starting the query with
7336 .display
7337 &`servers=`&&'server1:server2:server3:...'&&`;`&
7338 .endd
7339 Each item in the list may take one of two forms:
7340 .olist
7341 If it contains no slashes it is assumed to be just a host name. The appropriate
7342 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7343 of the same name, and the remaining parameters (database, user, password) are
7344 taken from there.
7345 .next
7346 If it contains any slashes, it is taken as a complete parameter set.
7347 .endlist
7348 The list of servers is used in exactly the same way as the global list.
7349 Once a connection to a server has happened and a query has been
7350 successfully executed, processing of the lookup ceases.
7351
7352 This feature is intended for use in master/slave situations where updates
7353 are occurring and you want to update the master rather than a slave. If the
7354 master is in the list as a backup for reading, you might have a global setting
7355 like this:
7356 .code
7357 mysql_servers = slave1/db/name/pw:\
7358                 slave2/db/name/pw:\
7359                 master/db/name/pw
7360 .endd
7361 In an updating lookup, you could then write:
7362 .code
7363 ${lookup mysql{servers=master; UPDATE ...} }
7364 .endd
7365 That query would then be sent only to the master server. If, on the other hand,
7366 the master is not to be used for reading, and so is not present in the global
7367 option, you can still update it by a query of this form:
7368 .code
7369 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7370 .endd
7371
7372
7373 .section "Special MySQL features" "SECID73"
7374 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7375 causes a connection to the server on the local host by means of a Unix domain
7376 socket. An alternate socket can be specified in parentheses. The full syntax of
7377 each item in &%mysql_servers%& is:
7378 .display
7379 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7380   <&'user'&>/<&'password'&>
7381 .endd
7382 Any of the three sub-parts of the first field can be omitted. For normal use on
7383 the local host it can be left blank or set to just &"localhost"&.
7384
7385 No database need be supplied &-- but if it is absent here, it must be given in
7386 the queries.
7387
7388 If a MySQL query is issued that does not request any data (an insert, update,
7389 or delete command), the result of the lookup is the number of rows affected.
7390
7391 &*Warning*&: This can be misleading. If an update does not actually change
7392 anything (for example, setting a field to the value it already has), the result
7393 is zero because no rows are affected.
7394
7395
7396 .section "Special PostgreSQL features" "SECID74"
7397 PostgreSQL lookups can also use Unix domain socket connections to the database.
7398 This is usually faster and costs less CPU time than a TCP/IP connection.
7399 However it can be used only if the mail server runs on the same machine as the
7400 database server. A configuration line for PostgreSQL via Unix domain sockets
7401 looks like this:
7402 .code
7403 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7404 .endd
7405 In other words, instead of supplying a host name, a path to the socket is
7406 given. The path name is enclosed in parentheses so that its slashes aren't
7407 visually confused with the delimiters for the other server parameters.
7408
7409 If a PostgreSQL query is issued that does not request any data (an insert,
7410 update, or delete command), the result of the lookup is the number of rows
7411 affected.
7412
7413 .section "More about SQLite" "SECTsqlite"
7414 .cindex "lookup" "SQLite"
7415 .cindex "sqlite lookup type"
7416 SQLite is different to the other SQL lookups because a file name is required in
7417 addition to the SQL query. An SQLite database is a single file, and there is no
7418 daemon as in the other SQL databases. The interface to Exim requires the name
7419 of the file, as an absolute path, to be given at the start of the query. It is
7420 separated from the query by white space. This means that the path name cannot
7421 contain white space. Here is a lookup expansion example:
7422 .code
7423 ${lookup sqlite {/some/thing/sqlitedb \
7424   select name from aliases where id='userx';}}
7425 .endd
7426 In a list, the syntax is similar. For example:
7427 .code
7428 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7429    select * from relays where ip='$sender_host_address';
7430 .endd
7431 The only character affected by the &%quote_sqlite%& operator is a single
7432 quote, which it doubles.
7433
7434 The SQLite library handles multiple simultaneous accesses to the database
7435 internally. Multiple readers are permitted, but only one process can
7436 update at once. Attempts to access the database while it is being updated
7437 are rejected after a timeout period, during which the SQLite library
7438 waits for the lock to be released. In Exim, the default timeout is set
7439 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7440 option.
7441 .ecindex IIDfidalo1
7442 .ecindex IIDfidalo2
7443
7444
7445 . ////////////////////////////////////////////////////////////////////////////
7446 . ////////////////////////////////////////////////////////////////////////////
7447
7448 .chapter "Domain, host, address, and local part lists" &&&
7449          "CHAPdomhosaddlists" &&&
7450          "Domain, host, and address lists"
7451 .scindex IIDdohoadli "lists of domains; hosts; etc."
7452 A number of Exim configuration options contain lists of domains, hosts,
7453 email addresses, or local parts. For example, the &%hold_domains%& option
7454 contains a list of domains whose delivery is currently suspended. These lists
7455 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7456 arguments to expansion conditions such as &%match_domain%&.
7457
7458 Each item in one of these lists is a pattern to be matched against a domain,
7459 host, email address, or local part, respectively. In the sections below, the
7460 different types of pattern for each case are described, but first we cover some
7461 general facilities that apply to all four kinds of list.
7462
7463
7464
7465 .section "Expansion of lists" "SECID75"
7466 .cindex "expansion" "of lists"
7467 Each list is expanded as a single string before it is used. The result of
7468 expansion must be a list, possibly containing empty items, which is split up
7469 into separate items for matching. By default, colon is the separator character,
7470 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7471 &<<SECTempitelis>>& for details of the list syntax; the second of these
7472 discusses the way to specify empty list items.
7473
7474
7475 If the string expansion is forced to fail, Exim behaves as if the item it is
7476 testing (domain, host, address, or local part) is not in the list. Other
7477 expansion failures cause temporary errors.
7478
7479 If an item in a list is a regular expression, backslashes, dollars and possibly
7480 other special characters in the expression must be protected against
7481 misinterpretation by the string expander. The easiest way to do this is to use
7482 the &`\N`& expansion feature to indicate that the contents of the regular
7483 expression should not be expanded. For example, in an ACL you might have:
7484 .code
7485 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7486                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7487 .endd
7488 The first item is a regular expression that is protected from expansion by
7489 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7490 senders based on the receiving domain.
7491
7492
7493
7494
7495 .section "Negated items in lists" "SECID76"
7496 .cindex "list" "negation"
7497 .cindex "negation" "in lists"
7498 Items in a list may be positive or negative. Negative items are indicated by a
7499 leading exclamation mark, which may be followed by optional white space. A list
7500 defines a set of items (domains, etc). When Exim processes one of these lists,
7501 it is trying to find out whether a domain, host, address, or local part
7502 (respectively) is in the set that is defined by the list. It works like this:
7503
7504 The list is scanned from left to right. If a positive item is matched, the
7505 subject that is being checked is in the set; if a negative item is matched, the
7506 subject is not in the set. If the end of the list is reached without the
7507 subject having matched any of the patterns, it is in the set if the last item
7508 was a negative one, but not if it was a positive one. For example, the list in
7509 .code
7510 domainlist relay_domains = !a.b.c : *.b.c
7511 .endd
7512 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7513 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7514 list is positive. However, if the setting were
7515 .code
7516 domainlist relay_domains = !a.b.c
7517 .endd
7518 then all domains other than &'a.b.c'& would match because the last item in the
7519 list is negative. In other words, a list that ends with a negative item behaves
7520 as if it had an extra item &`:*`& on the end.
7521
7522 Another way of thinking about positive and negative items in lists is to read
7523 the connector as &"or"& after a positive item and as &"and"& after a negative
7524 item.
7525
7526
7527
7528 .section "File names in lists" "SECTfilnamlis"
7529 .cindex "list" "file name in"
7530 If an item in a domain, host, address, or local part list is an absolute file
7531 name (beginning with a slash character), each line of the file is read and
7532 processed as if it were an independent item in the list, except that further
7533 file names are not allowed,
7534 and no expansion of the data from the file takes place.
7535 Empty lines in the file are ignored, and the file may also contain comment
7536 lines:
7537
7538 .ilist
7539 For domain and host lists, if a # character appears anywhere in a line of the
7540 file, it and all following characters are ignored.
7541 .next
7542 Because local parts may legitimately contain # characters, a comment in an
7543 address list or local part list file is recognized only if # is preceded by
7544 white space or the start of the line. For example:
7545 .code
7546 not#comment@x.y.z   # but this is a comment
7547 .endd
7548 .endlist
7549
7550 Putting a file name in a list has the same effect as inserting each line of the
7551 file as an item in the list (blank lines and comments excepted). However, there
7552 is one important difference: the file is read each time the list is processed,
7553 so if its contents vary over time, Exim's behaviour changes.
7554
7555 If a file name is preceded by an exclamation mark, the sense of any match
7556 within the file is inverted. For example, if
7557 .code
7558 hold_domains = !/etc/nohold-domains
7559 .endd
7560 and the file contains the lines
7561 .code
7562 !a.b.c
7563 *.b.c
7564 .endd
7565 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7566 any domain matching &`*.b.c`& is not.
7567
7568
7569
7570 .section "An lsearch file is not an out-of-line list" "SECID77"
7571 As will be described in the sections that follow, lookups can be used in lists
7572 to provide indexed methods of checking list membership. There has been some
7573 confusion about the way &(lsearch)& lookups work in lists. Because
7574 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7575 sometimes thought that it is allowed to contain wild cards and other kinds of
7576 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7577 always fixed strings, just as for any other single-key lookup type.
7578
7579 If you want to use a file to contain wild-card patterns that form part of a
7580 list, just give the file name on its own, without a search type, as described
7581 in the previous section. You could also use the &(wildlsearch)& or
7582 &(nwildlsearch)&, but there is no advantage in doing this.
7583
7584
7585
7586
7587 .section "Named lists" "SECTnamedlists"
7588 .cindex "named lists"
7589 .cindex "list" "named"
7590 A list of domains, hosts, email addresses, or local parts can be given a name
7591 which is then used to refer to the list elsewhere in the configuration. This is
7592 particularly convenient if the same list is required in several different
7593 places. It also allows lists to be given meaningful names, which can improve
7594 the readability of the configuration. For example, it is conventional to define
7595 a domain list called &'local_domains'& for all the domains that are handled
7596 locally on a host, using a configuration line such as
7597 .code
7598 domainlist local_domains = localhost:my.dom.example
7599 .endd
7600 Named lists are referenced by giving their name preceded by a plus sign, so,
7601 for example, a router that is intended to handle local domains would be
7602 configured with the line
7603 .code
7604 domains = +local_domains
7605 .endd
7606 The first router in a configuration is often one that handles all domains
7607 except the local ones, using a configuration with a negated item like this:
7608 .code
7609 dnslookup:
7610   driver = dnslookup
7611   domains = ! +local_domains
7612   transport = remote_smtp
7613   no_more
7614 .endd
7615 The four kinds of named list are created by configuration lines starting with
7616 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7617 respectively. Then there follows the name that you are defining, followed by an
7618 equals sign and the list itself. For example:
7619 .code
7620 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7621 addresslist bad_senders = cdb;/etc/badsenders
7622 .endd
7623 A named list may refer to other named lists:
7624 .code
7625 domainlist  dom1 = first.example : second.example
7626 domainlist  dom2 = +dom1 : third.example
7627 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7628 .endd
7629 &*Warning*&: If the last item in a referenced list is a negative one, the
7630 effect may not be what you intended, because the negation does not propagate
7631 out to the higher level. For example, consider:
7632 .code
7633 domainlist  dom1 = !a.b
7634 domainlist  dom2 = +dom1 : *.b
7635 .endd
7636 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7637 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7638 means it matches the second list as well. The effect is not the same as
7639 .code
7640 domainlist  dom2 = !a.b : *.b
7641 .endd
7642 where &'x.y'& does not match. It's best to avoid negation altogether in
7643 referenced lists if you can.
7644
7645 Named lists may have a performance advantage. When Exim is routing an
7646 address or checking an incoming message, it caches the result of tests on named
7647 lists. So, if you have a setting such as
7648 .code
7649 domains = +local_domains
7650 .endd
7651 on several of your routers
7652 or in several ACL statements,
7653 the actual test is done only for the first one. However, the caching works only
7654 if there are no expansions within the list itself or any sublists that it
7655 references. In other words, caching happens only for lists that are known to be
7656 the same each time they are referenced.
7657
7658 By default, there may be up to 16 named lists of each type. This limit can be
7659 extended by changing a compile-time variable. The use of domain and host lists
7660 is recommended for concepts such as local domains, relay domains, and relay
7661 hosts. The default configuration is set up like this.
7662
7663
7664
7665 .section "Named lists compared with macros" "SECID78"
7666 .cindex "list" "named compared with macro"
7667 .cindex "macro" "compared with named list"
7668 At first sight, named lists might seem to be no different from macros in the
7669 configuration file. However, macros are just textual substitutions. If you
7670 write
7671 .code
7672 ALIST = host1 : host2
7673 auth_advertise_hosts = !ALIST
7674 .endd
7675 it probably won't do what you want, because that is exactly the same as
7676 .code
7677 auth_advertise_hosts = !host1 : host2
7678 .endd
7679 Notice that the second host name is not negated. However, if you use a host
7680 list, and write
7681 .code
7682 hostlist alist = host1 : host2
7683 auth_advertise_hosts = ! +alist
7684 .endd
7685 the negation applies to the whole list, and so that is equivalent to
7686 .code
7687 auth_advertise_hosts = !host1 : !host2
7688 .endd
7689
7690
7691 .section "Named list caching" "SECID79"
7692 .cindex "list" "caching of named"
7693 .cindex "caching" "named lists"
7694 While processing a message, Exim caches the result of checking a named list if
7695 it is sure that the list is the same each time. In practice, this means that
7696 the cache operates only if the list contains no $ characters, which guarantees
7697 that it will not change when it is expanded. Sometimes, however, you may have
7698 an expanded list that you know will be the same each time within a given
7699 message. For example:
7700 .code
7701 domainlist special_domains = \
7702            ${lookup{$sender_host_address}cdb{/some/file}}
7703 .endd
7704 This provides a list of domains that depends only on the sending host's IP
7705 address. If this domain list is referenced a number of times (for example,
7706 in several ACL lines, or in several routers) the result of the check is not
7707 cached by default, because Exim does not know that it is going to be the
7708 same list each time.
7709
7710 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7711 cache the result anyway. For example:
7712 .code
7713 domainlist_cache special_domains = ${lookup{...
7714 .endd
7715 If you do this, you should be absolutely sure that caching is going to do
7716 the right thing in all cases. When in doubt, leave it out.
7717
7718
7719
7720 .section "Domain lists" "SECTdomainlist"
7721 .cindex "domain list" "patterns for"
7722 .cindex "list" "domain list"
7723 Domain lists contain patterns that are to be matched against a mail domain.
7724 The following types of item may appear in domain lists:
7725
7726 .ilist
7727 .cindex "primary host name"
7728 .cindex "host name" "matched in domain list"
7729 .oindex "&%primary_hostname%&"
7730 .cindex "domain list" "matching primary host name"
7731 .cindex "@ in a domain list"
7732 If a pattern consists of a single @ character, it matches the local host name,
7733 as set by the &%primary_hostname%& option (or defaulted). This makes it
7734 possible to use the same configuration file on several different hosts that
7735 differ only in their names.
7736 .next
7737 .cindex "@[] in a domain list"
7738 .cindex "domain list" "matching local IP interfaces"
7739 .cindex "domain literal"
7740 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7741 in square brackets (as in an email address that contains a domain literal), but
7742 only if that IP address is recognized as local for email routing purposes. The
7743 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7744 control which of a host's several IP addresses are treated as local.
7745 In today's Internet, the use of domain literals is controversial.
7746 .next
7747 .cindex "@mx_any"
7748 .cindex "@mx_primary"
7749 .cindex "@mx_secondary"
7750 .cindex "domain list" "matching MX pointers to local host"
7751 If a pattern consists of the string &`@mx_any`& it matches any domain that
7752 has an MX record pointing to the local host or to any host that is listed in
7753 .oindex "&%hosts_treat_as_local%&"
7754 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7755 are similar, except that the first matches only when a primary MX target is the
7756 local host, and the second only when no primary MX target is the local host,
7757 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7758 preference value &-- there may of course be more than one of them.
7759
7760 The MX lookup that takes place when matching a pattern of this type is
7761 performed with the resolver options for widening names turned off. Thus, for
7762 example, a single-component domain will &'not'& be expanded by adding the
7763 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7764 options of the &(dnslookup)& router for a discussion of domain widening.
7765
7766 Sometimes you may want to ignore certain IP addresses when using one of these
7767 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7768 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7769 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7770 on a router). For example:
7771 .code
7772 domains = @mx_any/ignore=127.0.0.1
7773 .endd
7774 This example matches any domain that has an MX record pointing to one of
7775 the local host's IP addresses other than 127.0.0.1.
7776
7777 The list of IP addresses is in fact processed by the same code that processes
7778 host lists, so it may contain CIDR-coded network specifications and it may also
7779 contain negative items.
7780
7781 Because the list of IP addresses is a sublist within a domain list, you have to
7782 be careful about delimiters if there is more than one address. Like any other
7783 list, the default delimiter can be changed. Thus, you might have:
7784 .code
7785 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7786           an.other.domain : ...
7787 .endd
7788 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7789 involved, it is easiest to change the delimiter for the main list as well:
7790 .code
7791 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7792           an.other.domain ? ...
7793 .endd
7794 .next
7795 .cindex "asterisk" "in domain list"
7796 .cindex "domain list" "asterisk in"
7797 .cindex "domain list" "matching &""ends with""&"
7798 If a pattern starts with an asterisk, the remaining characters of the pattern
7799 are compared with the terminating characters of the domain. The use of &"*"& in
7800 domain lists differs from its use in partial matching lookups. In a domain
7801 list, the character following the asterisk need not be a dot, whereas partial
7802 matching works only in terms of dot-separated components. For example, a domain
7803 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7804 &'cipher.key.ex'&.
7805
7806 .next
7807 .cindex "regular expressions" "in domain list"
7808 .cindex "domain list" "matching regular expression"
7809 If a pattern starts with a circumflex character, it is treated as a regular
7810 expression, and matched against the domain using a regular expression matching
7811 function. The circumflex is treated as part of the regular expression.
7812 Email domains are case-independent, so this regular expression match is by
7813 default case-independent, but you can make it case-dependent by starting it
7814 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7815 are given in chapter &<<CHAPregexp>>&.
7816
7817 &*Warning*&: Because domain lists are expanded before being processed, you
7818 must escape any backslash and dollar characters in the regular expression, or
7819 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7820 it is not to be expanded (unless you really do want to build a regular
7821 expression by expansion, of course).
7822 .next
7823 .cindex "lookup" "in domain list"
7824 .cindex "domain list" "matching by lookup"
7825 If a pattern starts with the name of a single-key lookup type followed by a
7826 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7827 must be a file name in a suitable format for the lookup type. For example, for
7828 &"cdb;"& it must be an absolute path:
7829 .code
7830 domains = cdb;/etc/mail/local_domains.cdb
7831 .endd
7832 The appropriate type of lookup is done on the file using the domain name as the
7833 key. In most cases, the data that is looked up is not used; Exim is interested
7834 only in whether or not the key is present in the file. However, when a lookup
7835 is used for the &%domains%& option on a router
7836 or a &%domains%& condition in an ACL statement, the data is preserved in the
7837 &$domain_data$& variable and can be referred to in other router options or
7838 other statements in the same ACL.
7839
7840 .next
7841 Any of the single-key lookup type names may be preceded by
7842 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7843 .code
7844 domains = partial-dbm;/partial/domains
7845 .endd
7846 This causes partial matching logic to be invoked; a description of how this
7847 works is given in section &<<SECTpartiallookup>>&.
7848
7849 .next
7850 .cindex "asterisk" "in lookup type"
7851 Any of the single-key lookup types may be followed by an asterisk. This causes
7852 a default lookup for a key consisting of a single asterisk to be done if the
7853 original lookup fails. This is not a useful feature when using a domain list to
7854 select particular domains (because any domain would match), but it might have
7855 value if the result of the lookup is being used via the &$domain_data$&
7856 expansion variable.
7857 .next
7858 If the pattern starts with the name of a query-style lookup type followed by a
7859 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7860 pattern must be an appropriate query for the lookup type, as described in
7861 chapter &<<CHAPfdlookup>>&. For example:
7862 .code
7863 hold_domains = mysql;select domain from holdlist \
7864   where domain = '${quote_mysql:$domain}';
7865 .endd
7866 In most cases, the data that is looked up is not used (so for an SQL query, for
7867 example, it doesn't matter what field you select). Exim is interested only in
7868 whether or not the query succeeds. However, when a lookup is used for the
7869 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7870 variable and can be referred to in other options.
7871 .next
7872 .cindex "domain list" "matching literal domain name"
7873 If none of the above cases apply, a caseless textual comparison is made
7874 between the pattern and the domain.
7875 .endlist
7876
7877 Here is an example that uses several different kinds of pattern:
7878 .code
7879 domainlist funny_domains = \
7880   @ : \
7881   lib.unseen.edu : \
7882   *.foundation.fict.example : \
7883   \N^[1-2]\d{3}\.fict\.example$\N : \
7884   partial-dbm;/opt/data/penguin/book : \
7885   nis;domains.byname : \
7886   nisplus;[name=$domain,status=local],domains.org_dir
7887 .endd
7888 There are obvious processing trade-offs among the various matching modes. Using
7889 an asterisk is faster than a regular expression, and listing a few names
7890 explicitly probably is too. The use of a file or database lookup is expensive,
7891 but may be the only option if hundreds of names are required. Because the
7892 patterns are tested in order, it makes sense to put the most commonly matched
7893 patterns earlier.
7894
7895
7896
7897 .section "Host lists" "SECThostlist"
7898 .cindex "host list" "patterns in"
7899 .cindex "list" "host list"
7900 Host lists are used to control what remote hosts are allowed to do. For
7901 example, some hosts may be allowed to use the local host as a relay, and some
7902 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7903 two different ways, by name or by IP address. In a host list, some types of
7904 pattern are matched to a host name, and some are matched to an IP address.
7905 You need to be particularly careful with this when single-key lookups are
7906 involved, to ensure that the right value is being used as the key.
7907
7908
7909 .section "Special host list patterns" "SECID80"
7910 .cindex "empty item in hosts list"
7911 .cindex "host list" "empty string in"
7912 If a host list item is the empty string, it matches only when no remote host is
7913 involved. This is the case when a message is being received from a local
7914 process using SMTP on the standard input, that is, when a TCP/IP connection is
7915 not used.
7916
7917 .cindex "asterisk" "in host list"
7918 The special pattern &"*"& in a host list matches any host or no host. Neither
7919 the IP address nor the name is actually inspected.
7920
7921
7922
7923 .section "Host list patterns that match by IP address" "SECThoslispatip"
7924 .cindex "host list" "matching IP addresses"
7925 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7926 the incoming address actually appears in the IPv6 host as
7927 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7928 list, it is converted into a traditional IPv4 address first. (Not all operating
7929 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7930 concerns.)
7931
7932 The following types of pattern in a host list check the remote host by
7933 inspecting its IP address:
7934
7935 .ilist
7936 If the pattern is a plain domain name (not a regular expression, not starting
7937 with *, not a lookup of any kind), Exim calls the operating system function
7938 to find the associated IP address(es). Exim uses the newer
7939 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7940 This typically causes a forward DNS lookup of the name. The result is compared
7941 with the IP address of the subject host.
7942
7943 If there is a temporary problem (such as a DNS timeout) with the host name
7944 lookup, a temporary error occurs. For example, if the list is being used in an
7945 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7946 temporary SMTP error code. If no IP address can be found for the host name,
7947 what happens is described in section &<<SECTbehipnot>>& below.
7948
7949 .next
7950 .cindex "@ in a host list"
7951 If the pattern is &"@"&, the primary host name is substituted and used as a
7952 domain name, as just described.
7953
7954 .next
7955 If the pattern is an IP address, it is matched against the IP address of the
7956 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7957 IPv6 addresses can be given in colon-separated format, but the colons have to
7958 be doubled so as not to be taken as item separators when the default list
7959 separator is used. IPv6 addresses are recognized even when Exim is compiled
7960 without IPv6 support. This means that if they appear in a host list on an
7961 IPv4-only host, Exim will not treat them as host names. They are just addresses
7962 that can never match a client host.
7963
7964 .next
7965 .cindex "@[] in a host list"
7966 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7967 the local host. For example, if the local host is an IPv4 host with one
7968 interface address 10.45.23.56, these two ACL statements have the same effect:
7969 .code
7970 accept hosts = 127.0.0.1 : 10.45.23.56
7971 accept hosts = @[]
7972 .endd
7973 .next
7974 .cindex "CIDR notation"
7975 If the pattern is an IP address followed by a slash and a mask length (for
7976 example 10.11.42.0/24), it is matched against the IP address of the subject
7977 host under the given mask. This allows, an entire network of hosts to be
7978 included (or excluded) by a single item. The mask uses CIDR notation; it
7979 specifies the number of address bits that must match, starting from the most
7980 significant end of the address.
7981
7982 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7983 of a range of addresses. It is the number of bits in the network portion of the
7984 address. The above example specifies a 24-bit netmask, so it matches all 256
7985 addresses in the 10.11.42.0 network. An item such as
7986 .code
7987 192.168.23.236/31
7988 .endd
7989 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7990 32 for an IPv4 address is the same as no mask at all; just a single address
7991 matches.
7992
7993 Here is another example which shows an IPv4 and an IPv6 network:
7994 .code
7995 recipient_unqualified_hosts = 192.168.0.0/16: \
7996                               3ffe::ffff::836f::::/48
7997 .endd
7998 The doubling of list separator characters applies only when these items
7999 appear inline in a host list. It is not required when indirecting via a file.
8000 For example:
8001 .code
8002 recipient_unqualified_hosts = /opt/exim/unqualnets
8003 .endd
8004 could make use of a file containing
8005 .code
8006 172.16.0.0/12
8007 3ffe:ffff:836f::/48
8008 .endd
8009 to have exactly the same effect as the previous example. When listing IPv6
8010 addresses inline, it is usually more convenient to use the facility for
8011 changing separator characters. This list contains the same two networks:
8012 .code
8013 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8014                                  3ffe:ffff:836f::/48
8015 .endd
8016 The separator is changed to semicolon by the leading &"<;"& at the start of the
8017 list.
8018 .endlist
8019
8020
8021
8022 .section "Host list patterns for single-key lookups by host address" &&&
8023          "SECThoslispatsikey"
8024 .cindex "host list" "lookup of IP address"
8025 When a host is to be identified by a single-key lookup of its complete IP
8026 address, the pattern takes this form:
8027 .display
8028 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8029 .endd
8030 For example:
8031 .code
8032 hosts_lookup = net-cdb;/hosts-by-ip.db
8033 .endd
8034 The text form of the IP address of the subject host is used as the lookup key.
8035 IPv6 addresses are converted to an unabbreviated form, using lower case
8036 letters, with dots as separators because colon is the key terminator in
8037 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8038 quoting the keys, but this is a facility that was added later.] The data
8039 returned by the lookup is not used.
8040
8041 .cindex "IP address" "masking"
8042 .cindex "host list" "masked IP address"
8043 Single-key lookups can also be performed using masked IP addresses, using
8044 patterns of this form:
8045 .display
8046 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8047 .endd
8048 For example:
8049 .code
8050 net24-dbm;/networks.db
8051 .endd
8052 The IP address of the subject host is masked using <&'number'&> as the mask
8053 length. A textual string is constructed from the masked value, followed by the
8054 mask, and this is used as the lookup key. For example, if the host's IP address
8055 is 192.168.34.6, the key that is looked up for the above example is
8056 &"192.168.34.0/24"&.
8057
8058 When an IPv6 address is converted to a string, dots are normally used instead
8059 of colons, so that keys in &(lsearch)& files need not contain colons (which
8060 terminate &(lsearch)& keys). This was implemented some time before the ability
8061 to quote keys was made available in &(lsearch)& files. However, the more
8062 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8063 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8064 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8065 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8066 addresses are always used.
8067
8068 Ideally, it would be nice to tidy up this anomalous situation by changing to
8069 colons in all cases, given that quoting is now available for &(lsearch)&.
8070 However, this would be an incompatible change that might break some existing
8071 configurations.
8072
8073 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8074 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8075 the former case the key strings include the mask value, whereas in the latter
8076 case the IP address is used on its own.
8077
8078
8079
8080 .section "Host list patterns that match by host name" "SECThoslispatnam"
8081 .cindex "host" "lookup failures"
8082 .cindex "unknown host name"
8083 .cindex "host list" "matching host name"
8084 There are several types of pattern that require Exim to know the name of the
8085 remote host. These are either wildcard patterns or lookups by name. (If a
8086 complete hostname is given without any wildcarding, it is used to find an IP
8087 address to match against, as described in the section &<<SECThoslispatip>>&
8088 above.)
8089
8090 If the remote host name is not already known when Exim encounters one of these
8091 patterns, it has to be found from the IP address.
8092 Although many sites on the Internet are conscientious about maintaining reverse
8093 DNS data for their hosts, there are also many that do not do this.
8094 Consequently, a name cannot always be found, and this may lead to unwanted
8095 effects. Take care when configuring host lists with wildcarded name patterns.
8096 Consider what will happen if a name cannot be found.
8097
8098 Because of the problems of determining host names from IP addresses, matching
8099 against host names is not as common as matching against IP addresses.
8100
8101 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8102 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8103 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8104 are done can be changed by setting the &%host_lookup_order%& option. For
8105 security, once Exim has found one or more names, it looks up the IP addresses
8106 for these names and compares them with the IP address that it started with.
8107 Only those names whose IP addresses match are accepted. Any other names are
8108 discarded. If no names are left, Exim behaves as if the host name cannot be
8109 found. In the most common case there is only one name and one IP address.
8110
8111 There are some options that control what happens if a host name cannot be
8112 found. These are described in section &<<SECTbehipnot>>& below.
8113
8114 .cindex "host" "alias for"
8115 .cindex "alias for host"
8116 As a result of aliasing, hosts may have more than one name. When processing any
8117 of the following types of pattern, all the host's names are checked:
8118
8119 .ilist
8120 .cindex "asterisk" "in host list"
8121 If a pattern starts with &"*"& the remainder of the item must match the end of
8122 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8123 &'.b.c'&. This special simple form is provided because this is a very common
8124 requirement. Other kinds of wildcarding require the use of a regular
8125 expression.
8126 .next
8127 .cindex "regular expressions" "in host list"
8128 .cindex "host list" "regular expression in"
8129 If the item starts with &"^"& it is taken to be a regular expression which is
8130 matched against the host name. Host names are case-independent, so this regular
8131 expression match is by default case-independent, but you can make it
8132 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8133 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8134 example,
8135 .code
8136 ^(a|b)\.c\.d$
8137 .endd
8138 is a regular expression that matches either of the two hosts &'a.c.d'& or
8139 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8140 that backslash and dollar characters are not misinterpreted as part of the
8141 string expansion. The simplest way to do this is to use &`\N`& to mark that
8142 part of the string as non-expandable. For example:
8143 .code
8144 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8145 .endd
8146 &*Warning*&: If you want to match a complete host name, you must include the
8147 &`$`& terminating metacharacter in the regular expression, as in the above
8148 example. Without it, a match at the start of the host name is all that is
8149 required.
8150 .endlist
8151
8152
8153
8154
8155 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8156 .cindex "host" "lookup failures, permanent"
8157 While processing a host list, Exim may need to look up an IP address from a
8158 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8159 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8160 behaviour when it fails to find the information it is seeking is the same.
8161
8162 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8163 apply to temporary DNS errors, whose handling is described in the next section.
8164
8165 .cindex "&`+include_unknown`&"
8166 .cindex "&`+ignore_unknown`&"
8167 By default, Exim behaves as if the host does not match the list. This may not
8168 always be what you want to happen. To change Exim's behaviour, the special
8169 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8170 top level &-- they are not recognized in an indirected file).
8171
8172 .ilist
8173 If any item that follows &`+include_unknown`& requires information that
8174 cannot found, Exim behaves as if the host does match the list. For example,
8175 .code
8176 host_reject_connection = +include_unknown:*.enemy.ex
8177 .endd
8178 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8179 any hosts whose name it cannot find.
8180
8181 .next
8182 If any item that follows &`+ignore_unknown`& requires information that cannot
8183 be found, Exim ignores that item and proceeds to the rest of the list. For
8184 example:
8185 .code
8186 accept hosts = +ignore_unknown : friend.example : \
8187                192.168.4.5
8188 .endd
8189 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8190 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8191 name can be found for 192.168.4.5, it is rejected.
8192 .endlist
8193
8194 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8195 list. The effect of each one lasts until the next, or until the end of the
8196 list.
8197
8198
8199 .section "Temporary DNS errors when looking up host information" &&&
8200          "SECTtemdnserr"
8201 .cindex "host" "lookup failures, temporary"
8202 .cindex "&`+include_defer`&"
8203 .cindex "&`+ignore_defer`&"
8204 A temporary DNS lookup failure normally causes a defer action (except when
8205 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8206 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8207 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8208 section. These options should be used with care, probably only in non-critical
8209 host lists such as whitelists.
8210
8211
8212
8213 .section "Host list patterns for single-key lookups by host name" &&&
8214          "SECThoslispatnamsk"
8215 .cindex "unknown host name"
8216 .cindex "host list" "matching host name"
8217 If a pattern is of the form
8218 .display
8219 <&'single-key-search-type'&>;<&'search-data'&>
8220 .endd
8221 for example
8222 .code
8223 dbm;/host/accept/list
8224 .endd
8225 a single-key lookup is performed, using the host name as its key. If the
8226 lookup succeeds, the host matches the item. The actual data that is looked up
8227 is not used.
8228
8229 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8230 keys in the file, not IP addresses. If you want to do lookups based on IP
8231 addresses, you must precede the search type with &"net-"& (see section
8232 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8233 two items in the same list, one doing an address lookup and one doing a name
8234 lookup, both using the same file.
8235
8236
8237
8238 .section "Host list patterns for query-style lookups" "SECID81"
8239 If a pattern is of the form
8240 .display
8241 <&'query-style-search-type'&>;<&'query'&>
8242 .endd
8243 the query is obeyed, and if it succeeds, the host matches the item. The actual
8244 data that is looked up is not used. The variables &$sender_host_address$& and
8245 &$sender_host_name$& can be used in the query. For example:
8246 .code
8247 hosts_lookup = pgsql;\
8248   select ip from hostlist where ip='$sender_host_address'
8249 .endd
8250 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8251 can use the &%sg%& expansion item to change this if you need to. If you want to
8252 use masked IP addresses in database queries, you can use the &%mask%& expansion
8253 operator.
8254
8255 If the query contains a reference to &$sender_host_name$&, Exim automatically
8256 looks up the host name if has not already done so. (See section
8257 &<<SECThoslispatnam>>& for comments on finding host names.)
8258
8259 Historical note: prior to release 4.30, Exim would always attempt to find a
8260 host name before running the query, unless the search type was preceded by
8261 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8262 still recognized for query-style lookups, but its presence or absence has no
8263 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8264 See section &<<SECThoslispatsikey>>&.)
8265
8266
8267
8268 .section "Mixing wildcarded host names and addresses in host lists" &&&
8269          "SECTmixwilhos"
8270 .cindex "host list" "mixing names and addresses in"
8271 If you have name lookups or wildcarded host names and IP addresses in the same
8272 host list, you should normally put the IP addresses first. For example, in an
8273 ACL you could have:
8274 .code
8275 accept hosts = 10.9.8.7 : *.friend.example
8276 .endd
8277 The reason for this lies in the left-to-right way that Exim processes lists.
8278 It can test IP addresses without doing any DNS lookups, but when it reaches an
8279 item that requires a host name, it fails if it cannot find a host name to
8280 compare with the pattern. If the above list is given in the opposite order, the
8281 &%accept%& statement fails for a host whose name cannot be found, even if its
8282 IP address is 10.9.8.7.
8283
8284 If you really do want to do the name check first, and still recognize the IP
8285 address, you can rewrite the ACL like this:
8286 .code
8287 accept hosts = *.friend.example
8288 accept hosts = 10.9.8.7
8289 .endd
8290 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8291 &<<CHAPACL>>& for details of ACLs.
8292
8293
8294
8295
8296
8297 .section "Address lists" "SECTaddresslist"
8298 .cindex "list" "address list"
8299 .cindex "address list" "empty item"
8300 .cindex "address list" "patterns"
8301 Address lists contain patterns that are matched against mail addresses. There
8302 is one special case to be considered: the sender address of a bounce message is
8303 always empty. You can test for this by providing an empty item in an address
8304 list. For example, you can set up a router to process bounce messages by
8305 using this option setting:
8306 .code
8307 senders = :
8308 .endd
8309 The presence of the colon creates an empty item. If you do not provide any
8310 data, the list is empty and matches nothing. The empty sender can also be
8311 detected by a regular expression that matches an empty string,
8312 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8313
8314 Non-empty items in an address list can be straightforward email addresses. For
8315 example:
8316 .code
8317 senders = jbc@askone.example : hs@anacreon.example
8318 .endd
8319 A certain amount of wildcarding is permitted. If a pattern contains an @
8320 character, but is not a regular expression and does not begin with a
8321 semicolon-terminated lookup type (described below), the local part of the
8322 subject address is compared with the local part of the pattern, which may start
8323 with an asterisk. If the local parts match, the domain is checked in exactly
8324 the same way as for a pattern in a domain list. For example, the domain can be
8325 wildcarded, refer to a named list, or be a lookup:
8326 .code
8327 deny senders = *@*.spamming.site:\
8328                *@+hostile_domains:\
8329                bozo@partial-lsearch;/list/of/dodgy/sites:\
8330                *@dbm;/bad/domains.db
8331 .endd
8332 .cindex "local part" "starting with !"
8333 .cindex "address list" "local part starting with !"
8334 If a local part that begins with an exclamation mark is required, it has to be
8335 specified using a regular expression, because otherwise the exclamation mark is
8336 treated as a sign of negation, as is standard in lists.
8337
8338 If a non-empty pattern that is not a regular expression or a lookup does not
8339 contain an @ character, it is matched against the domain part of the subject
8340 address. The only two formats that are recognized this way are a literal
8341 domain, or a domain pattern that starts with *. In both these cases, the effect
8342 is the same as if &`*@`& preceded the pattern. For example:
8343 .code
8344 deny senders = enemy.domain : *.enemy.domain
8345 .endd
8346
8347 The following kinds of more complicated address list pattern can match any
8348 address, including the empty address that is characteristic of bounce message
8349 senders:
8350
8351 .ilist
8352 .cindex "regular expressions" "in address list"
8353 .cindex "address list" "regular expression in"
8354 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8355 done against the complete address, with the pattern as the regular expression.
8356 You must take care that backslash and dollar characters are not misinterpreted
8357 as part of the string expansion. The simplest way to do this is to use &`\N`&
8358 to mark that part of the string as non-expandable. For example:
8359 .code
8360 deny senders = \N^.*this.*@example\.com$\N : \
8361                \N^\d{8}.+@spamhaus.example$\N : ...
8362 .endd
8363 The &`\N`& sequences are removed by the expansion, so these items do indeed
8364 start with &"^"& by the time they are being interpreted as address patterns.
8365
8366 .next
8367 .cindex "address list" "lookup for complete address"
8368 Complete addresses can be looked up by using a pattern that starts with a
8369 lookup type terminated by a semicolon, followed by the data for the lookup. For
8370 example:
8371 .code
8372 deny senders = cdb;/etc/blocked.senders : \
8373   mysql;select address from blocked where \
8374   address='${quote_mysql:$sender_address}'
8375 .endd
8376 Both query-style and single-key lookup types can be used. For a single-key
8377 lookup type, Exim uses the complete address as the key. However, empty keys are
8378 not supported for single-key lookups, so a match against the empty address
8379 always fails. This restriction does not apply to query-style lookups.
8380
8381 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8382 cannot be used, and is ignored if specified, with an entry being written to the
8383 panic log.
8384 .cindex "*@ with single-key lookup"
8385 However, you can configure lookup defaults, as described in section
8386 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8387 default. For example, with this lookup:
8388 .code
8389 accept senders = lsearch*@;/some/file
8390 .endd
8391 the file could contains lines like this:
8392 .code
8393 user1@domain1.example
8394 *@domain2.example
8395 .endd
8396 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8397 that are tried is:
8398 .code
8399 nimrod@jaeger.example
8400 *@jaeger.example
8401 *
8402 .endd
8403 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8404 would mean that every address matches, thus rendering the test useless.
8405
8406 &*Warning 2*&: Do not confuse these two kinds of item:
8407 .code
8408 deny recipients = dbm*@;/some/file
8409 deny recipients = *@dbm;/some/file
8410 .endd
8411 The first does a whole address lookup, with defaulting, as just described,
8412 because it starts with a lookup type. The second matches the local part and
8413 domain independently, as described in a bullet point below.
8414 .endlist
8415
8416
8417 The following kinds of address list pattern can match only non-empty addresses.
8418 If the subject address is empty, a match against any of these pattern types
8419 always fails.
8420
8421
8422 .ilist
8423 .cindex "@@ with single-key lookup"
8424 .cindex "address list" "@@ lookup type"
8425 .cindex "address list" "split local part and domain"
8426 If a pattern starts with &"@@"& followed by a single-key lookup item
8427 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8428 split into a local part and a domain. The domain is looked up in the file. If
8429 it is not found, there is no match. If it is found, the data that is looked up
8430 from the file is treated as a colon-separated list of local part patterns, each
8431 of which is matched against the subject local part in turn.
8432
8433 .cindex "asterisk" "in address list"
8434 The lookup may be a partial one, and/or one involving a search for a default
8435 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8436 patterns that are looked up can be regular expressions or begin with &"*"&, or
8437 even be further lookups. They may also be independently negated. For example,
8438 with
8439 .code
8440 deny senders = @@dbm;/etc/reject-by-domain
8441 .endd
8442 the data from which the DBM file is built could contain lines like
8443 .code
8444 baddomain.com:  !postmaster : *
8445 .endd
8446 to reject all senders except &%postmaster%& from that domain.
8447
8448 .cindex "local part" "starting with !"
8449 If a local part that actually begins with an exclamation mark is required, it
8450 has to be specified using a regular expression. In &(lsearch)& files, an entry
8451 may be split over several lines by indenting the second and subsequent lines,
8452 but the separating colon must still be included at line breaks. White space
8453 surrounding the colons is ignored. For example:
8454 .code
8455 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8456 spammer3 : spammer4
8457 .endd
8458 As in all colon-separated lists in Exim, a colon can be included in an item by
8459 doubling.
8460
8461 If the last item in the list starts with a right angle-bracket, the remainder
8462 of the item is taken as a new key to look up in order to obtain a continuation
8463 list of local parts. The new key can be any sequence of characters. Thus one
8464 might have entries like
8465 .code
8466 aol.com: spammer1 : spammer 2 : >*
8467 xyz.com: spammer3 : >*
8468 *:       ^\d{8}$
8469 .endd
8470 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8471 local parts for all domains, in addition to the specific local parts listed for
8472 each domain. Of course, using this feature costs another lookup each time a
8473 chain is followed, but the effort needed to maintain the data is reduced.
8474
8475 .cindex "loop" "in lookups"
8476 It is possible to construct loops using this facility, and in order to catch
8477 them, the chains may be no more than fifty items long.
8478
8479 .next
8480 The @@<&'lookup'&> style of item can also be used with a query-style
8481 lookup, but in this case, the chaining facility is not available. The lookup
8482 can only return a single list of local parts.
8483 .endlist
8484
8485 &*Warning*&: There is an important difference between the address list items
8486 in these two examples:
8487 .code
8488 senders = +my_list
8489 senders = *@+my_list
8490 .endd
8491 In the first one, &`my_list`& is a named address list, whereas in the second
8492 example it is a named domain list.
8493
8494
8495
8496
8497 .section "Case of letters in address lists" "SECTcasletadd"
8498 .cindex "case of local parts"
8499 .cindex "address list" "case forcing"
8500 .cindex "case forcing in address lists"
8501 Domains in email addresses are always handled caselessly, but for local parts
8502 case may be significant on some systems (see &%caseful_local_part%& for how
8503 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8504 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8505 blocking lists should be done in a case-independent manner. Since most address
8506 lists in Exim are used for this kind of control, Exim attempts to do this by
8507 default.
8508
8509 The domain portion of an address is always lowercased before matching it to an
8510 address list. The local part is lowercased by default, and any string
8511 comparisons that take place are done caselessly. This means that the data in
8512 the address list itself, in files included as plain file names, and in any file
8513 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8514 keys in files that are looked up by a search type other than &(lsearch)& (which
8515 works caselessly) must be in lower case, because these lookups are not
8516 case-independent.
8517
8518 .cindex "&`+caseful`&"
8519 To allow for the possibility of caseful address list matching, if an item in
8520 an address list is the string &"+caseful"&, the original case of the local
8521 part is restored for any comparisons that follow, and string comparisons are no
8522 longer case-independent. This does not affect the domain, which remains in
8523 lower case. However, although independent matches on the domain alone are still
8524 performed caselessly, regular expressions that match against an entire address
8525 become case-sensitive after &"+caseful"& has been seen.
8526
8527
8528
8529 .section "Local part lists" "SECTlocparlis"
8530 .cindex "list" "local part list"
8531 .cindex "local part" "list"
8532 Case-sensitivity in local part lists is handled in the same way as for address
8533 lists, as just described. The &"+caseful"& item can be used if required. In a
8534 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8535 set false, the subject is lowercased and the matching is initially
8536 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8537 matching in the local part list, but not elsewhere in the router. If
8538 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8539 option is case-sensitive from the start.
8540
8541 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8542 comments are handled in the same way as address lists &-- they are recognized
8543 only if the # is preceded by white space or the start of the line.
8544 Otherwise, local part lists are matched in the same way as domain lists, except
8545 that the special items that refer to the local host (&`@`&, &`@[]`&,
8546 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8547 Refer to section &<<SECTdomainlist>>& for details of the other available item
8548 types.
8549 .ecindex IIDdohoadli
8550
8551
8552
8553
8554 . ////////////////////////////////////////////////////////////////////////////
8555 . ////////////////////////////////////////////////////////////////////////////
8556
8557 .chapter "String expansions" "CHAPexpand"
8558 .scindex IIDstrexp "expansion" "of strings"
8559 Many strings in Exim's run time configuration are expanded before use. Some of
8560 them are expanded every time they are used; others are expanded only once.
8561
8562 When a string is being expanded it is copied verbatim from left to right except
8563 when a dollar or backslash character is encountered. A dollar specifies the
8564 start of a portion of the string that is interpreted and replaced as described
8565 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8566 escape character, as described in the following section.
8567
8568 Whether a string is expanded depends upon the context.  Usually this is solely
8569 dependent upon the option for which a value is sought; in this documentation,
8570 options for which string expansion is performed are marked with &dagger; after
8571 the data type.  ACL rules always expand strings.  A couple of expansion
8572 conditions do not expand some of the brace-delimited branches, for security
8573 reasons.
8574
8575
8576
8577 .section "Literal text in expanded strings" "SECTlittext"
8578 .cindex "expansion" "including literal text"
8579 An uninterpreted dollar can be included in an expanded string by putting a
8580 backslash in front of it. A backslash can be used to prevent any special
8581 character being treated specially in an expansion, including backslash itself.
8582 If the string appears in quotes in the configuration file, two backslashes are
8583 required because the quotes themselves cause interpretation of backslashes when
8584 the string is read in (see section &<<SECTstrings>>&).
8585
8586 .cindex "expansion" "non-expandable substrings"
8587 A portion of the string can specified as non-expandable by placing it between
8588 two occurrences of &`\N`&. This is particularly useful for protecting regular
8589 expressions, which often contain backslashes and dollar signs. For example:
8590 .code
8591 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8592 .endd
8593 On encountering the first &`\N`&, the expander copies subsequent characters
8594 without interpretation until it reaches the next &`\N`& or the end of the
8595 string.
8596
8597
8598
8599 .section "Character escape sequences in expanded strings" "SECID82"
8600 .cindex "expansion" "escape sequences"
8601 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8602 expanded string is recognized as an escape sequence for the character newline,
8603 carriage return, or tab, respectively. A backslash followed by up to three
8604 octal digits is recognized as an octal encoding for a single character, and a
8605 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8606 encoding.
8607
8608 These escape sequences are also recognized in quoted strings when they are read
8609 in. Their interpretation in expansions as well is useful for unquoted strings,
8610 and for other cases such as looked-up strings that are then expanded.
8611
8612
8613 .section "Testing string expansions" "SECID83"
8614 .cindex "expansion" "testing"
8615 .cindex "testing" "string expansion"
8616 .oindex "&%-be%&"
8617 Many expansions can be tested by calling Exim with the &%-be%& option. This
8618 takes the command arguments, or lines from the standard input if there are no
8619 arguments, runs them through the string expansion code, and writes the results
8620 to the standard output. Variables based on configuration values are set up, but
8621 since no message is being processed, variables such as &$local_part$& have no
8622 value. Nevertheless the &%-be%& option can be useful for checking out file and
8623 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8624 and &%nhash%&.
8625
8626 Exim gives up its root privilege when it is called with the &%-be%& option, and
8627 instead runs under the uid and gid it was called with, to prevent users from
8628 using &%-be%& for reading files to which they do not have access.
8629
8630 .oindex "&%-bem%&"
8631 If you want to test expansions that include variables whose values are taken
8632 from a message, there are two other options that can be used. The &%-bem%&
8633 option is like &%-be%& except that it is followed by a file name. The file is
8634 read as a message before doing the test expansions. For example:
8635 .code
8636 exim -bem /tmp/test.message '$h_subject:'
8637 .endd
8638 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8639 Exim message identifier. For example:
8640 .code
8641 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8642 .endd
8643 This loads the message from Exim's spool before doing the test expansions, and
8644 is therefore restricted to admin users.
8645
8646
8647 .section "Forced expansion failure" "SECTforexpfai"
8648 .cindex "expansion" "forced failure"
8649 A number of expansions that are described in the following section have
8650 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8651 (which are sometimes called &"curly brackets"&). Which of the two strings is
8652 used depends on some condition that is evaluated as part of the expansion. If,
8653 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8654 the entire string expansion fails in a way that can be detected by the code
8655 that requested the expansion. This is called &"forced expansion failure"&, and
8656 its consequences depend on the circumstances. In some cases it is no different
8657 from any other expansion failure, but in others a different action may be
8658 taken. Such variations are mentioned in the documentation of the option that is
8659 being expanded.
8660
8661
8662
8663
8664 .section "Expansion items" "SECTexpansionitems"
8665 The following items are recognized in expanded strings. White space may be used
8666 between sub-items that are keywords or substrings enclosed in braces inside an
8667 outer set of braces, to improve readability. &*Warning*&: Within braces,
8668 white space is significant.
8669
8670 .vlist
8671 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8672 .cindex "expansion" "variables"
8673 Substitute the contents of the named variable, for example:
8674 .code
8675 $local_part
8676 ${domain}
8677 .endd
8678 The second form can be used to separate the name from subsequent alphanumeric
8679 characters. This form (using braces) is available only for variables; it does
8680 &'not'& apply to message headers. The names of the variables are given in
8681 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8682 given, the expansion fails.
8683
8684 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8685 .cindex "expansion" "operators"
8686 The string is first itself expanded, and then the operation specified by
8687 <&'op'&> is applied to it. For example:
8688 .code
8689 ${lc:$local_part}
8690 .endd
8691 The string starts with the first character after the colon, which may be
8692 leading white space. A list of operators is given in section &<<SECTexpop>>&
8693 below. The operator notation is used for simple expansion items that have just
8694 one argument, because it reduces the number of braces and therefore makes the
8695 string easier to understand.
8696
8697 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8698 This item inserts &"basic"& header lines. It is described with the &%header%&
8699 expansion item below.
8700
8701 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8702        {*&<&'arg'&>&*}...}*&"
8703 .cindex &%dlfunc%&
8704 This expansion dynamically loads and then calls a locally-written C function.
8705 This functionality is available only if Exim is compiled with
8706 .code
8707 EXPAND_DLFUNC=yes
8708 .endd
8709 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8710 object so that it doesn't reload the same object file in the same Exim process
8711 (but of course Exim does start new processes frequently).
8712
8713 There may be from zero to eight arguments to the function. When compiling
8714 a local function that is to be called in this way, &_local_scan.h_& should be
8715 included. The Exim variables and functions that are defined by that API
8716 are also available for dynamically loaded functions. The function itself
8717 must have the following type:
8718 .code
8719 int dlfunction(uschar **yield, int argc, uschar *argv[])
8720 .endd
8721 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8722 function should return one of the following values:
8723
8724 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8725 into the expanded string that is being built.
8726
8727 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8728 from &'yield'&, if it is set.
8729
8730 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8731 taken from &'yield'& if it is set.
8732
8733 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8734
8735 When compiling a function that is to be used in this way with gcc,
8736 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8737 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8738
8739 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8740        {*&<&'string3'&>&*}}*&"
8741 .cindex "expansion" "extracting substrings by key"
8742 .cindex "&%extract%&" "substrings by key"
8743 The key and <&'string1'&> are first expanded separately. Leading and trailing
8744 white space is removed from the key (but not from any of the strings). The key
8745 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8746 form:
8747 .display
8748 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8749 .endd
8750 .vindex "&$value$&"
8751 where the equals signs and spaces (but not both) are optional. If any of the
8752 values contain white space, they must be enclosed in double quotes, and any
8753 values that are enclosed in double quotes are subject to escape processing as
8754 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8755 for the value that corresponds to the key. The search is case-insensitive. If
8756 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8757 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8758 variable &$value$& contains the value that has been extracted. Afterwards, it
8759 is restored to any previous value it might have had.
8760
8761 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8762 key is not found. If {<&'string2'&>} is also omitted, the value that was
8763 extracted is used. Thus, for example, these two expansions are identical, and
8764 yield &"2001"&:
8765 .code
8766 ${extract{gid}{uid=1984 gid=2001}}
8767 ${extract{gid}{uid=1984 gid=2001}{$value}}
8768 .endd
8769 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8770 appear, for example:
8771 .code
8772 ${extract{Z}{A=... B=...}{$value} fail }
8773 .endd
8774 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8775 {<&'string2'&>} must be present for &"fail"& to be recognized.
8776
8777
8778 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8779         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8780 .cindex "expansion" "extracting substrings by number"
8781 .cindex "&%extract%&" "substrings by number"
8782 The <&'number'&> argument must consist entirely of decimal digits,
8783 apart from leading and trailing white space, which is ignored.
8784 This is what distinguishes this form of &%extract%& from the previous kind. It
8785 behaves in the same way, except that, instead of extracting a named field, it
8786 extracts from <&'string1'&> the field whose number is given as the first
8787 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8788 <&'string3'&> as before.
8789
8790 The fields in the string are separated by any one of the characters in the
8791 separator string. These may include space or tab characters.
8792 The first field is numbered one. If the number is negative, the fields are
8793 counted from the end of the string, with the rightmost one numbered -1. If the
8794 number given is zero, the entire string is returned. If the modulus of the
8795 number is greater than the number of fields in the string, the result is the
8796 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8797 provided. For example:
8798 .code
8799 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8800 .endd
8801 yields &"42"&, and
8802 .code
8803 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8804 .endd
8805 yields &"99"&. Two successive separators mean that the field between them is
8806 empty (for example, the fifth field above).
8807
8808
8809 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8810 .cindex "list" "selecting by condition"
8811 .cindex "expansion" "selecting from list by condition"
8812 .vindex "&$item$&"
8813 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8814 default, but the separator can be changed in the usual way. For each item
8815 in this list, its value is place in &$item$&, and then the condition is
8816 evaluated. If the condition is true, &$item$& is added to the output as an
8817 item in a new list; if the condition is false, the item is discarded. The
8818 separator used for the output list is the same as the one used for the
8819 input, but a separator setting is not included in the output. For example:
8820 .code
8821 ${filter{a:b:c}{!eq{$item}{b}}
8822 .endd
8823 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8824 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8825
8826
8827 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8828 .cindex "hash function" "textual"
8829 .cindex "expansion" "textual hash"
8830 This is a textual hashing function, and was the first to be implemented in
8831 early versions of Exim. In current releases, there are other hashing functions
8832 (numeric, MD5, and SHA-1), which are described below.
8833
8834 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8835 <&'n'&>. If you are using fixed values for these numbers, that is, if
8836 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8837 use the simpler operator notation that avoids some of the braces:
8838 .code
8839 ${hash_<n>_<m>:<string>}
8840 .endd
8841 The second number is optional (in both notations). If <&'n'&> is greater than
8842 or equal to the length of the string, the expansion item returns the string.
8843 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8844 function to the string. The new string consists of characters taken from the
8845 first <&'m'&> characters of the string
8846 .code
8847 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8848 .endd
8849 If <&'m'&> is not present the value 26 is used, so that only lower case
8850 letters appear. For example:
8851 .display
8852 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8853 &`$hash{5}{monty}}           `&   yields  &`monty`&
8854 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8855 .endd
8856
8857 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8858         &*$h_*&<&'header&~name'&>&*:*&" &&&
8859        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8860         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8861        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8862         &*$rh_*&<&'header&~name'&>&*:*&"
8863 .cindex "expansion" "header insertion"
8864 .vindex "&$header_$&"
8865 .vindex "&$bheader_$&"
8866 .vindex "&$rheader_$&"
8867 .cindex "header lines" "in expansion strings"
8868 .cindex "header lines" "character sets"
8869 .cindex "header lines" "decoding"
8870 Substitute the contents of the named message header line, for example
8871 .code
8872 $header_reply-to:
8873 .endd
8874 The newline that terminates a header line is not included in the expansion, but
8875 internal newlines (caused by splitting the header line over several physical
8876 lines) may be present.
8877
8878 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8879 the data in the header line is interpreted.
8880
8881 .ilist
8882 .cindex "white space" "in header lines"
8883 &%rheader%& gives the original &"raw"& content of the header line, with no
8884 processing at all, and without the removal of leading and trailing white space.
8885
8886 .next
8887 .cindex "base64 encoding" "in header lines"
8888 &%bheader%& removes leading and trailing white space, and then decodes base64
8889 or quoted-printable MIME &"words"& within the header text, but does no
8890 character set translation. If decoding of what looks superficially like a MIME
8891 &"word"& fails, the raw string is returned. If decoding
8892 .cindex "binary zero" "in header line"
8893 produces a binary zero character, it is replaced by a question mark &-- this is
8894 what Exim does for binary zeros that are actually received in header lines.
8895
8896 .next
8897 &%header%& tries to translate the string as decoded by &%bheader%& to a
8898 standard character set. This is an attempt to produce the same string as would
8899 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8900 returned. Translation is attempted only on operating systems that support the
8901 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8902 a system Makefile or in &_Local/Makefile_&.
8903 .endlist ilist
8904
8905 In a filter file, the target character set for &%header%& can be specified by a
8906 command of the following form:
8907 .code
8908 headers charset "UTF-8"
8909 .endd
8910 This command affects all references to &$h_$& (or &$header_$&) expansions in
8911 subsequently obeyed filter commands. In the absence of this command, the target
8912 character set in a filter is taken from the setting of the &%headers_charset%&
8913 option in the runtime configuration. The value of this option defaults to the
8914 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8915 ISO-8859-1.
8916
8917 Header names follow the syntax of RFC 2822, which states that they may contain
8918 any printing characters except space and colon. Consequently, curly brackets
8919 &'do not'& terminate header names, and should not be used to enclose them as
8920 if they were variables. Attempting to do so causes a syntax error.
8921
8922 Only header lines that are common to all copies of a message are visible to
8923 this mechanism. These are the original header lines that are received with the
8924 message, and any that are added by an ACL statement or by a system
8925 filter. Header lines that are added to a particular copy of a message by a
8926 router or transport are not accessible.
8927
8928 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8929 before the DATA ACL, because the header structure is not set up until the
8930 message is received. Header lines that are added in a RCPT ACL (for example)
8931 are saved until the message's incoming header lines are available, at which
8932 point they are added. When a DATA ACL is running, however, header lines added
8933 by earlier ACLs are visible.
8934
8935 Upper case and lower case letters are synonymous in header names. If the
8936 following character is white space, the terminating colon may be omitted, but
8937 this is not recommended, because you may then forget it when it is needed. When
8938 white space terminates the header name, it is included in the expanded string.
8939 If the message does not contain the given header, the expansion item is
8940 replaced by an empty string. (See the &%def%& condition in section
8941 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8942
8943 If there is more than one header with the same name, they are all concatenated
8944 to form the substitution string, up to a maximum length of 64K. Unless
8945 &%rheader%& is being used, leading and trailing white space is removed from
8946 each header before concatenation, and a completely empty header is ignored. A
8947 newline character is then inserted between non-empty headers, but there is no
8948 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8949 those headers that contain lists of addresses, a comma is also inserted at the
8950 junctions between headers. This does not happen for the &%rheader%& expansion.
8951
8952
8953 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8954 .cindex "expansion" "hmac hashing"
8955 .cindex &%hmac%&
8956 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8957 shared secret and some text into a message authentication code, as specified in
8958 RFC 2104. This differs from &`${md5:secret_text...}`& or
8959 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8960 cryptographic hash, allowing for authentication that is not possible with MD5
8961 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8962 present. For example:
8963 .code
8964 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8965 .endd
8966 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8967 produces:
8968 .code
8969 dd97e3ba5d1a61b5006108f8c8252953
8970 .endd
8971 As an example of how this might be used, you might put in the main part of
8972 an Exim configuration:
8973 .code
8974 SPAMSCAN_SECRET=cohgheeLei2thahw
8975 .endd
8976 In a router or a transport you could then have:
8977 .code
8978 headers_add = \
8979   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8980   ${hmac{md5}{SPAMSCAN_SECRET}\
8981   {${primary_hostname},${message_exim_id},$h_message-id:}}
8982 .endd
8983 Then given a message, you can check where it was scanned by looking at the
8984 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8985 this header line is authentic by recomputing the authentication code from the
8986 host name, message ID and the &'Message-id:'& header line. This can be done
8987 using Exim's &%-be%& option, or by other means, for example by using the
8988 &'hmac_md5_hex()'& function in Perl.
8989
8990
8991 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8992 .cindex "expansion" "conditional"
8993 .cindex "&%if%&, expansion item"
8994 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8995 item; otherwise <&'string2'&> is used. The available conditions are described
8996 in section &<<SECTexpcond>>& below. For example:
8997 .code
8998 ${if eq {$local_part}{postmaster} {yes}{no} }
8999 .endd
9000 The second string need not be present; if it is not and the condition is not
9001 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9002 be present instead of the second string (without any curly brackets). In this
9003 case, the expansion is forced to fail if the condition is not true (see section
9004 &<<SECTforexpfai>>&).
9005
9006 If both strings are omitted, the result is the string &`true`& if the condition
9007 is true, and the empty string if the condition is false. This makes it less
9008 cumbersome to write custom ACL and router conditions. For example, instead of
9009 .code
9010 condition = ${if >{$acl_m4}{3}{true}{false}}
9011 .endd
9012 you can use
9013 .code
9014 condition = ${if >{$acl_m4}{3}}
9015 .endd
9016
9017 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9018 .cindex "expansion" "string truncation"
9019 .cindex "&%length%& expansion item"
9020 The &%length%& item is used to extract the initial portion of a string. Both
9021 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9022 you are using a fixed value for the number, that is, if <&'string1'&> does not
9023 change when expanded, you can use the simpler operator notation that avoids
9024 some of the braces:
9025 .code
9026 ${length_<n>:<string>}
9027 .endd
9028 The result of this item is either the first <&'n'&> characters or the whole
9029 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9030 &%strlen%&, which gives the length of a string.
9031
9032
9033 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9034         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9035 This is the first of one of two different types of lookup item, which are both
9036 described in the next item.
9037
9038 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9039         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9040 .cindex "expansion" "lookup in"
9041 .cindex "file" "lookups"
9042 .cindex "lookup" "in expanded string"
9043 The two forms of lookup item specify data lookups in files and databases, as
9044 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9045 lookups, and the second is used for query-style lookups. The <&'key'&>,
9046 <&'file'&>, and <&'query'&> strings are expanded before use.
9047
9048 If there is any white space in a lookup item which is part of a filter command,
9049 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9050 other place where white space is significant, the lookup item must be enclosed
9051 in double quotes. The use of data lookups in users' filter files may be locked
9052 out by the system administrator.
9053
9054 .vindex "&$value$&"
9055 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9056 During its expansion, the variable &$value$& contains the data returned by the
9057 lookup. Afterwards it reverts to the value it had previously (at the outer
9058 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9059 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9060 string on failure. If <&'string2'&> is provided, it can itself be a nested
9061 lookup, thus providing a mechanism for looking up a default value when the
9062 original lookup fails.
9063
9064 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9065 data for the outer lookup while the parameters of the second lookup are
9066 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9067 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9068 appear, and in this case, if the lookup fails, the entire expansion is forced
9069 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9070 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9071 successful lookup, and nothing in the case of failure.
9072
9073 For single-key lookups, the string &"partial"& is permitted to precede the
9074 search type in order to do partial matching, and * or *@ may follow a search
9075 type to request default lookups if the key does not match (see sections
9076 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9077
9078 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9079 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9080 and non-wild parts of the key during the expansion of the replacement text.
9081 They return to their previous values at the end of the lookup item.
9082
9083 This example looks up the postmaster alias in the conventional alias file:
9084 .code
9085 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9086 .endd
9087 This example uses NIS+ to look up the full name of the user corresponding to
9088 the local part of an address, forcing the expansion to fail if it is not found:
9089 .code
9090 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9091   {$value}fail}
9092 .endd
9093
9094
9095 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9096 .cindex "expansion" "list creation"
9097 .vindex "&$item$&"
9098 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9099 default, but the separator can be changed in the usual way. For each item
9100 in this list, its value is place in &$item$&, and then <&'string2'&> is
9101 expanded and added to the output as an item in a new list. The separator used
9102 for the output list is the same as the one used for the input, but a separator
9103 setting is not included in the output. For example:
9104 .code
9105 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9106 .endd
9107 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9108 value of &$item$& is restored to what it was before. See also the &*filter*&
9109 and &*reduce*& expansion items.
9110
9111 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9112 .cindex "expansion" "numeric hash"
9113 .cindex "hash function" "numeric"
9114 The three strings are expanded; the first two must yield numbers. Call them
9115 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9116 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9117 can use the simpler operator notation that avoids some of the braces:
9118 .code
9119 ${nhash_<n>_<m>:<string>}
9120 .endd
9121 The second number is optional (in both notations). If there is only one number,
9122 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9123 processed by a div/mod hash function that returns two numbers, separated by a
9124 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9125 example,
9126 .code
9127 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9128 .endd
9129 returns the string &"6/33"&.
9130
9131
9132
9133 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9134 .cindex "Perl" "use in expanded string"
9135 .cindex "expansion" "calling Perl from"
9136 This item is available only if Exim has been built to include an embedded Perl
9137 interpreter. The subroutine name and the arguments are first separately
9138 expanded, and then the Perl subroutine is called with those arguments. No
9139 additional arguments need be given; the maximum number permitted, including the
9140 name of the subroutine, is nine.
9141
9142 The return value of the subroutine is inserted into the expanded string, unless
9143 the return value is &%undef%&. In that case, the expansion fails in the same
9144 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9145 Whatever you return is evaluated in a scalar context. For example, if you
9146 return the name of a Perl vector, the return value is the size of the vector,
9147 not its contents.
9148
9149 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9150 with the error message that was passed to &%die%&. More details of the embedded
9151 Perl facility are given in chapter &<<CHAPperl>>&.
9152
9153 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9154 out the use of this expansion item in filter files.
9155
9156
9157 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9158 .cindex "&%prvs%& expansion item"
9159 The first argument is a complete email address and the second is secret
9160 keystring. The third argument, specifying a key number, is optional. If absent,
9161 it defaults to 0. The result of the expansion is a prvs-signed email address,
9162 to be typically used with the &%return_path%& option on an &(smtp)& transport
9163 as part of a bounce address tag validation (BATV) scheme. For more discussion
9164 and an example, see section &<<SECTverifyPRVS>>&.
9165
9166 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9167         {*&<&'string'&>&*}}*&"
9168 .cindex "&%prvscheck%& expansion item"
9169 This expansion item is the complement of the &%prvs%& item. It is used for
9170 checking prvs-signed addresses. If the expansion of the first argument does not
9171 yield a syntactically valid prvs-signed address, the whole item expands to the
9172 empty string. When the first argument does expand to a syntactically valid
9173 prvs-signed address, the second argument is expanded, with the prvs-decoded
9174 version of the address and the key number extracted from the address in the
9175 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9176
9177 These two variables can be used in the expansion of the second argument to
9178 retrieve the secret. The validity of the prvs-signed address is then checked
9179 against the secret. The result is stored in the variable &$prvscheck_result$&,
9180 which is empty for failure or &"1"& for success.
9181
9182 The third argument is optional; if it is missing, it defaults to an empty
9183 string. This argument is now expanded. If the result is an empty string, the
9184 result of the expansion is the decoded version of the address. This is the case
9185 whether or not the signature was valid. Otherwise, the result of the expansion
9186 is the expansion of the third argument.
9187
9188 All three variables can be used in the expansion of the third argument.
9189 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9190 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9191
9192 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9193 .cindex "expansion" "inserting an entire file"
9194 .cindex "file" "inserting into expansion"
9195 .cindex "&%readfile%& expansion item"
9196 The file name and end-of-line string are first expanded separately. The file is
9197 then read, and its contents replace the entire item. All newline characters in
9198 the file are replaced by the end-of-line string if it is present. Otherwise,
9199 newlines are left in the string.
9200 String expansion is not applied to the contents of the file. If you want this,
9201 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9202 the string expansion fails.
9203
9204 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9205 locks out the use of this expansion item in filter files.
9206
9207
9208
9209 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9210         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9211 .cindex "expansion" "inserting from a socket"
9212 .cindex "socket, use of in expansion"
9213 .cindex "&%readsocket%& expansion item"
9214 This item inserts data from a Unix domain or Internet socket into the expanded
9215 string. The minimal way of using it uses just two arguments, as in these
9216 examples:
9217 .code
9218 ${readsocket{/socket/name}{request string}}
9219 ${readsocket{inet:some.host:1234}{request string}}
9220 .endd
9221 For a Unix domain socket, the first substring must be the path to the socket.
9222 For an Internet socket, the first substring must contain &`inet:`& followed by
9223 a host name or IP address, followed by a colon and a port, which can be a
9224 number or the name of a TCP port in &_/etc/services_&. An IP address may
9225 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9226 example:
9227 .code
9228 ${readsocket{inet:[::1]:1234}{request string}}
9229 .endd
9230 Only a single host name may be given, but if looking it up yields more than
9231 one IP address, they are each tried in turn until a connection is made. For
9232 both kinds of socket, Exim makes a connection, writes the request string
9233 (unless it is an empty string) and reads from the socket until an end-of-file
9234 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9235 extend what can be done. Firstly, you can vary the timeout. For example:
9236 .code
9237 ${readsocket{/socket/name}{request string}{3s}}
9238 .endd
9239 A fourth argument allows you to change any newlines that are in the data
9240 that is read, in the same way as for &%readfile%& (see above). This example
9241 turns them into spaces:
9242 .code
9243 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9244 .endd
9245 As with all expansions, the substrings are expanded before the processing
9246 happens. Errors in these sub-expansions cause the expansion to fail. In
9247 addition, the following errors can occur:
9248
9249 .ilist
9250 Failure to create a socket file descriptor;
9251 .next
9252 Failure to connect the socket;
9253 .next
9254 Failure to write the request string;
9255 .next
9256 Timeout on reading from the socket.
9257 .endlist
9258
9259 By default, any of these errors causes the expansion to fail. However, if
9260 you supply a fifth substring, it is expanded and used when any of the above
9261 errors occurs. For example:
9262 .code
9263 ${readsocket{/socket/name}{request string}{3s}{\n}\
9264   {socket failure}}
9265 .endd
9266 You can test for the existence of a Unix domain socket by wrapping this
9267 expansion in &`${if exists`&, but there is a race condition between that test
9268 and the actual opening of the socket, so it is safer to use the fifth argument
9269 if you want to be absolutely sure of avoiding an expansion error for a
9270 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9271
9272 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9273 locks out the use of this expansion item in filter files.
9274
9275
9276 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9277 .cindex "expansion" "reducing a list to a scalar"
9278 .cindex "list" "reducing to a scalar"
9279 .vindex "&$value$&"
9280 .vindex "&$item$&"
9281 This operation reduces a list to a single, scalar string. After expansion,
9282 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9283 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9284 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9285 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9286 them. The result of that expansion is assigned to &$value$& before the next
9287 iteration. When the end of the list is reached, the final value of &$value$& is
9288 added to the expansion output. The &*reduce*& expansion item can be used in a
9289 number of ways. For example, to add up a list of numbers:
9290 .code
9291 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9292 .endd
9293 The result of that expansion would be &`6`&. The maximum of a list of numbers
9294 can be found:
9295 .code
9296 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9297 .endd
9298 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9299 restored to what they were before. See also the &*filter*& and &*map*&
9300 expansion items.
9301
9302 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9303 This item inserts &"raw"& header lines. It is described with the &%header%&
9304 expansion item above.
9305
9306 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9307         {*&<&'string2'&>&*}}*&"
9308 .cindex "expansion" "running a command"
9309 .cindex "&%run%& expansion item"
9310 The command and its arguments are first expanded separately, and then the
9311 command is run in a separate process, but under the same uid and gid. As in
9312 other command executions from Exim, a shell is not used by default. If you want
9313 a shell, you must explicitly code it.
9314
9315 The standard input for the command exists, but is empty. The standard output
9316 and standard error are set to the same file descriptor.
9317 .cindex "return code" "from &%run%& expansion"
9318 .vindex "&$value$&"
9319 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9320 and replaces the entire item; during this expansion, the standard output/error
9321 from the command is in the variable &$value$&. If the command fails,
9322 <&'string2'&>, if present, is expanded and used. Once again, during the
9323 expansion, the standard output/error from the command is in the variable
9324 &$value$&.
9325
9326 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9327 can be the word &"fail"& (not in braces) to force expansion failure if the
9328 command does not succeed. If both strings are omitted, the result is contents
9329 of the standard output/error on success, and nothing on failure.
9330
9331 .vindex "&$runrc$&"
9332 The return code from the command is put in the variable &$runrc$&, and this
9333 remains set afterwards, so in a filter file you can do things like this:
9334 .code
9335 if "${run{x y z}{}}$runrc" is 1 then ...
9336   elif $runrc is 2 then ...
9337   ...
9338 endif
9339 .endd
9340 If execution of the command fails (for example, the command does not exist),
9341 the return code is 127 &-- the same code that shells use for non-existent
9342 commands.
9343
9344 &*Warning*&: In a router or transport, you cannot assume the order in which
9345 option values are expanded, except for those preconditions whose order of
9346 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9347 by the expansion of one option, and use it in another.
9348
9349 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9350 out the use of this expansion item in filter files.
9351
9352
9353 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9354 .cindex "expansion" "string substitution"
9355 .cindex "&%sg%& expansion item"
9356 This item works like Perl's substitution operator (s) with the global (/g)
9357 option; hence its name. However, unlike the Perl equivalent, Exim does not
9358 modify the subject string; instead it returns the modified string for insertion
9359 into the overall expansion. The item takes three arguments: the subject string,
9360 a regular expression, and a substitution string. For example:
9361 .code
9362 ${sg{abcdefabcdef}{abc}{xyz}}
9363 .endd
9364 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9365 if any $ or \ characters are required in the regular expression or in the
9366 substitution string, they have to be escaped. For example:
9367 .code
9368 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9369 .endd
9370 yields &"defabc"&, and
9371 .code
9372 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9373 .endd
9374 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9375 the regular expression from string expansion.
9376
9377
9378
9379 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9380 .cindex "&%substr%& expansion item"
9381 .cindex "substring extraction"
9382 .cindex "expansion" "substring extraction"
9383 The three strings are expanded; the first two must yield numbers. Call them
9384 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9385 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9386 can use the simpler operator notation that avoids some of the braces:
9387 .code
9388 ${substr_<n>_<m>:<string>}
9389 .endd
9390 The second number is optional (in both notations).
9391 If it is absent in the simpler format, the preceding underscore must also be
9392 omitted.
9393
9394 The &%substr%& item can be used to extract more general substrings than
9395 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9396 length required. For example
9397 .code
9398 ${substr{3}{2}{$local_part}}
9399 .endd
9400 If the starting offset is greater than the string length the result is the
9401 null string; if the length plus starting offset is greater than the string
9402 length, the result is the right-hand part of the string, starting from the
9403 given offset. The first character in the string has offset zero.
9404
9405 The &%substr%& expansion item can take negative offset values to count
9406 from the right-hand end of its operand. The last character is offset -1, the
9407 second-last is offset -2, and so on. Thus, for example,
9408 .code
9409 ${substr{-5}{2}{1234567}}
9410 .endd
9411 yields &"34"&. If the absolute value of a negative offset is greater than the
9412 length of the string, the substring starts at the beginning of the string, and
9413 the length is reduced by the amount of overshoot. Thus, for example,
9414 .code
9415 ${substr{-5}{2}{12}}
9416 .endd
9417 yields an empty string, but
9418 .code
9419 ${substr{-3}{2}{12}}
9420 .endd
9421 yields &"1"&.
9422
9423 When the second number is omitted from &%substr%&, the remainder of the string
9424 is taken if the offset is positive. If it is negative, all characters in the
9425 string preceding the offset point are taken. For example, an offset of -1 and
9426 no length, as in these semantically identical examples:
9427 .code
9428 ${substr_-1:abcde}
9429 ${substr{-1}{abcde}}
9430 .endd
9431 yields all but the last character of the string, that is, &"abcd"&.
9432
9433
9434
9435 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9436         {*&<&'replacements'&>&*}}*&"
9437 .cindex "expansion" "character translation"
9438 .cindex "&%tr%& expansion item"
9439 This item does single-character translation on its subject string. The second
9440 argument is a list of characters to be translated in the subject string. Each
9441 matching character is replaced by the corresponding character from the
9442 replacement list. For example
9443 .code
9444 ${tr{abcdea}{ac}{13}}
9445 .endd
9446 yields &`1b3de1`&. If there are duplicates in the second character string, the
9447 last occurrence is used. If the third string is shorter than the second, its
9448 last character is replicated. However, if it is empty, no translation takes
9449 place.
9450 .endlist
9451
9452
9453
9454 .section "Expansion operators" "SECTexpop"
9455 .cindex "expansion" "operators"
9456 For expansion items that perform transformations on a single argument string,
9457 the &"operator"& notation is used because it is simpler and uses fewer braces.
9458 The substring is first expanded before the operation is applied to it. The
9459 following operations can be performed:
9460
9461 .vlist
9462 .vitem &*${address:*&<&'string'&>&*}*&
9463 .cindex "expansion" "RFC 2822 address handling"
9464 .cindex "&%address%& expansion item"
9465 The string is interpreted as an RFC 2822 address, as it might appear in a
9466 header line, and the effective address is extracted from it. If the string does
9467 not parse successfully, the result is empty.
9468
9469
9470 .vitem &*${addresses:*&<&'string'&>&*}*&
9471 .cindex "expansion" "RFC 2822 address handling"
9472 .cindex "&%addresses%& expansion item"
9473 The string (after expansion) is interpreted as a list of addresses in RFC
9474 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9475 operative address (&'local-part@domain'&) is extracted from each item, and the
9476 result of the expansion is a colon-separated list, with appropriate
9477 doubling of colons should any happen to be present in the email addresses.
9478 Syntactically invalid RFC2822 address items are omitted from the output.
9479
9480 It is possible to specify a character other than colon for the output
9481 separator by starting the string with > followed by the new separator
9482 character. For example:
9483 .code
9484 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9485 .endd
9486 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9487 expansion item, which extracts the working address from a single RFC2822
9488 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9489 processing lists.
9490
9491
9492 .vitem &*${base62:*&<&'digits'&>&*}*&
9493 .cindex "&%base62%& expansion item"
9494 .cindex "expansion" "conversion to base 62"
9495 The string must consist entirely of decimal digits. The number is converted to
9496 base 62 and output as a string of six characters, including leading zeros. In
9497 the few operating environments where Exim uses base 36 instead of base 62 for
9498 its message identifiers (because those systems do not have case-sensitive file
9499 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9500 be absolutely clear: this is &'not'& base64 encoding.
9501
9502 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9503 .cindex "&%base62d%& expansion item"
9504 .cindex "expansion" "conversion to base 62"
9505 The string must consist entirely of base-62 digits, or, in operating
9506 environments where Exim uses base 36 instead of base 62 for its message
9507 identifiers, base-36 digits. The number is converted to decimal and output as a
9508 string.
9509
9510 .vitem &*${domain:*&<&'string'&>&*}*&
9511 .cindex "domain" "extraction"
9512 .cindex "expansion" "domain extraction"
9513 The string is interpreted as an RFC 2822 address and the domain is extracted
9514 from it. If the string does not parse successfully, the result is empty.
9515
9516
9517 .vitem &*${escape:*&<&'string'&>&*}*&
9518 .cindex "expansion" "escaping non-printing characters"
9519 .cindex "&%escape%& expansion item"
9520 If the string contains any non-printing characters, they are converted to
9521 escape sequences starting with a backslash. Whether characters with the most
9522 significant bit set (so-called &"8-bit characters"&) count as printing or not
9523 is controlled by the &%print_topbitchars%& option.
9524
9525
9526 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9527 .cindex "expansion" "expression evaluation"
9528 .cindex "expansion" "arithmetic expression"
9529 .cindex "&%eval%& expansion item"
9530 These items supports simple arithmetic and bitwise logical operations in
9531 expansion strings. The string (after expansion) must be a conventional
9532 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9533 logical operators, and parentheses. All operations are carried out using
9534 integer arithmetic. The operator priorities are as follows (the same as in the
9535 C programming language):
9536 .table2 70pt 300pt
9537 .irow &'highest:'& "not (~), negate (-)"
9538 .irow ""   "multiply (*), divide (/), remainder (%)"
9539 .irow ""   "plus (+), minus (-)"
9540 .irow ""   "shift-left (<<), shift-right (>>)"
9541 .irow ""   "and (&&)"
9542 .irow ""   "xor (^)"
9543 .irow &'lowest:'&  "or (|)"
9544 .endtable
9545 Binary operators with the same priority are evaluated from left to right. White
9546 space is permitted before or after operators.
9547
9548 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9549 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9550 decimal, even if they start with a leading zero; hexadecimal numbers are not
9551 permitted. This can be useful when processing numbers extracted from dates or
9552 times, which often do have leading zeros.
9553
9554 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9555 or 1024*1024*1024,
9556 respectively. Negative numbers are supported. The result of the computation is
9557 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9558
9559 .display
9560 &`${eval:1+1}            `&  yields 2
9561 &`${eval:1+2*3}          `&  yields 7
9562 &`${eval:(1+2)*3}        `&  yields 9
9563 &`${eval:2+42%5}         `&  yields 4
9564 &`${eval:0xc&amp;5}          `&  yields 4
9565 &`${eval:0xc|5}          `&  yields 13
9566 &`${eval:0xc^5}          `&  yields 9
9567 &`${eval:0xc>>1}         `&  yields 6
9568 &`${eval:0xc<<1}         `&  yields 24
9569 &`${eval:~255&amp;0x1234}    `&  yields 4608
9570 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9571 .endd
9572
9573 As a more realistic example, in an ACL you might have
9574 .code
9575 deny   message = Too many bad recipients
9576        condition =                    \
9577          ${if and {                   \
9578            {>{$rcpt_count}{10}}       \
9579            {                          \
9580            <                          \
9581              {$recipients_count}      \
9582              {${eval:$rcpt_count/2}}  \
9583            }                          \
9584          }{yes}{no}}
9585 .endd
9586 The condition is true if there have been more than 10 RCPT commands and
9587 fewer than half of them have resulted in a valid recipient.
9588
9589
9590 .vitem &*${expand:*&<&'string'&>&*}*&
9591 .cindex "expansion" "re-expansion of substring"
9592 The &%expand%& operator causes a string to be expanded for a second time. For
9593 example,
9594 .code
9595 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9596 .endd
9597 first looks up a string in a file while expanding the operand for &%expand%&,
9598 and then re-expands what it has found.
9599
9600
9601 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9602 .cindex "Unicode"
9603 .cindex "UTF-8" "conversion from"
9604 .cindex "expansion" "UTF-8 conversion"
9605 .cindex "&%from_utf8%& expansion item"
9606 The world is slowly moving towards Unicode, although there are no standards for
9607 email yet. However, other applications (including some databases) are starting
9608 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9609 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9610 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9611 the result is an undefined sequence of bytes.
9612
9613 Unicode code points with values less than 256 are compatible with ASCII and
9614 ISO-8859-1 (also known as Latin-1).
9615 For example, character 169 is the copyright symbol in both cases, though the
9616 way it is encoded is different. In UTF-8, more than one byte is needed for
9617 characters with code values greater than 127, whereas ISO-8859-1 is a
9618 single-byte encoding (but thereby limited to 256 characters). This makes
9619 translation from UTF-8 to ISO-8859-1 straightforward.
9620
9621
9622 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9623 .cindex "hash function" "textual"
9624 .cindex "expansion" "textual hash"
9625 The &%hash%& operator is a simpler interface to the hashing function that can
9626 be used when the two parameters are fixed numbers (as opposed to strings that
9627 change when expanded). The effect is the same as
9628 .code
9629 ${hash{<n>}{<m>}{<string>}}
9630 .endd
9631 See the description of the general &%hash%& item above for details. The
9632 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9633
9634
9635
9636 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9637 .cindex "base64 encoding" "conversion from hex"
9638 .cindex "expansion" "hex to base64"
9639 .cindex "&%hex2b64%& expansion item"
9640 This operator converts a hex string into one that is base64 encoded. This can
9641 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9642
9643
9644 .vitem &*${lc:*&<&'string'&>&*}*&
9645 .cindex "case forcing in strings"
9646 .cindex "string" "case forcing"
9647 .cindex "lower casing"
9648 .cindex "expansion" "case forcing"
9649 .cindex "&%lc%& expansion item"
9650 This forces the letters in the string into lower-case, for example:
9651 .code
9652 ${lc:$local_part}
9653 .endd
9654
9655 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9656 .cindex "expansion" "string truncation"
9657 .cindex "&%length%& expansion item"
9658 The &%length%& operator is a simpler interface to the &%length%& function that
9659 can be used when the parameter is a fixed number (as opposed to a string that
9660 changes when expanded). The effect is the same as
9661 .code
9662 ${length{<number>}{<string>}}
9663 .endd
9664 See the description of the general &%length%& item above for details. Note that
9665 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9666 when &%length%& is used as an operator.
9667
9668
9669 .vitem &*${local_part:*&<&'string'&>&*}*&
9670 .cindex "expansion" "local part extraction"
9671 .cindex "&%local_part%& expansion item"
9672 The string is interpreted as an RFC 2822 address and the local part is
9673 extracted from it. If the string does not parse successfully, the result is
9674 empty.
9675
9676
9677 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9678 .cindex "masked IP address"
9679 .cindex "IP address" "masking"
9680 .cindex "CIDR notation"
9681 .cindex "expansion" "IP address masking"
9682 .cindex "&%mask%& expansion item"
9683 If the form of the string to be operated on is not an IP address followed by a
9684 slash and an integer (that is, a network address in CIDR notation), the
9685 expansion fails. Otherwise, this operator converts the IP address to binary,
9686 masks off the least significant bits according to the bit count, and converts
9687 the result back to text, with mask appended. For example,
9688 .code
9689 ${mask:10.111.131.206/28}
9690 .endd
9691 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9692 be mostly used for looking up masked addresses in files, the result for an IPv6
9693 address uses dots to separate components instead of colons, because colon
9694 terminates a key string in lsearch files. So, for example,
9695 .code
9696 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9697 .endd
9698 returns the string
9699 .code
9700 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9701 .endd
9702 Letters in IPv6 addresses are always output in lower case.
9703
9704
9705 .vitem &*${md5:*&<&'string'&>&*}*&
9706 .cindex "MD5 hash"
9707 .cindex "expansion" "MD5 hash"
9708 .cindex "&%md5%& expansion item"
9709 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9710 as a 32-digit hexadecimal number, in which any letters are in lower case.
9711
9712
9713 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9714 .cindex "expansion" "numeric hash"
9715 .cindex "hash function" "numeric"
9716 The &%nhash%& operator is a simpler interface to the numeric hashing function
9717 that can be used when the two parameters are fixed numbers (as opposed to
9718 strings that change when expanded). The effect is the same as
9719 .code
9720 ${nhash{<n>}{<m>}{<string>}}
9721 .endd
9722 See the description of the general &%nhash%& item above for details.
9723
9724
9725 .vitem &*${quote:*&<&'string'&>&*}*&
9726 .cindex "quoting" "in string expansions"
9727 .cindex "expansion" "quoting"
9728 .cindex "&%quote%& expansion item"
9729 The &%quote%& operator puts its argument into double quotes if it
9730 is an empty string or
9731 contains anything other than letters, digits, underscores, dots, and hyphens.
9732 Any occurrences of double quotes and backslashes are escaped with a backslash.
9733 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9734 respectively For example,
9735 .code
9736 ${quote:ab"*"cd}
9737 .endd
9738 becomes
9739 .code
9740 "ab\"*\"cd"
9741 .endd
9742 The place where this is useful is when the argument is a substitution from a
9743 variable or a message header.
9744
9745 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9746 .cindex "&%quote_local_part%& expansion item"
9747 This operator is like &%quote%&, except that it quotes the string only if
9748 required to do so by the rules of RFC 2822 for quoting local parts. For
9749 example, a plus sign would not cause quoting (but it would for &%quote%&).
9750 If you are creating a new email address from the contents of &$local_part$&
9751 (or any other unknown data), you should always use this operator.
9752
9753
9754 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9755 .cindex "quoting" "lookup-specific"
9756 This operator applies lookup-specific quoting rules to the string. Each
9757 query-style lookup type has its own quoting rules which are described with
9758 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9759 .code
9760 ${quote_ldap:two * two}
9761 .endd
9762 returns
9763 .code
9764 two%20%5C2A%20two
9765 .endd
9766 For single-key lookup types, no quoting is ever necessary and this operator
9767 yields an unchanged string.
9768
9769
9770 .vitem &*${randint:*&<&'n'&>&*}*&
9771 .cindex "random number"
9772 This operator returns a somewhat random number which is less than the
9773 supplied number and is at least 0.  The quality of this randomness depends
9774 on how Exim was built; the values are not suitable for keying material.
9775 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9776 .new
9777 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9778 for versions of GnuTLS with that function.
9779 .wen
9780 Otherwise, the implementation may be arc4random(), random() seeded by
9781 srandomdev() or srandom(), or a custom implementation even weaker than
9782 random().
9783
9784
9785 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9786 .cindex "expansion" "IP address"
9787 This operator reverses an IP address; for IPv4 addresses, the result is in
9788 dotted-quad decimal form, while for IPv6 addreses the result is in
9789 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9790 for DNS.  For example,
9791 .code
9792 ${reverse_ip:192.0.2.4}
9793 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9794 .endd
9795 returns
9796 .code
9797 4.2.0.192
9798 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
9799 .endd
9800
9801
9802 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9803 .cindex "expansion" "RFC 2047"
9804 .cindex "RFC 2047" "expansion operator"
9805 .cindex "&%rfc2047%& expansion item"
9806 This operator encodes text according to the rules of RFC 2047. This is an
9807 encoding that is used in header lines to encode non-ASCII characters. It is
9808 assumed that the input string is in the encoding specified by the
9809 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9810 contains only characters in the range 33&--126, and no instances of the
9811 characters
9812 .code
9813 ? = ( ) < > @ , ; : \ " . [ ] _
9814 .endd
9815 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9816 string, using as many &"encoded words"& as necessary to encode all the
9817 characters.
9818
9819
9820 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9821 .cindex "expansion" "RFC 2047"
9822 .cindex "RFC 2047" "decoding"
9823 .cindex "&%rfc2047d%& expansion item"
9824 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9825 bytes are replaced by question marks. Characters are converted into the
9826 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9827 not recognized unless &%check_rfc2047_length%& is set false.
9828
9829 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9830 access a header line, RFC 2047 decoding is done automatically. You do not need
9831 to use this operator as well.
9832
9833
9834
9835 .vitem &*${rxquote:*&<&'string'&>&*}*&
9836 .cindex "quoting" "in regular expressions"
9837 .cindex "regular expressions" "quoting"
9838 .cindex "&%rxquote%& expansion item"
9839 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9840 characters in its argument. This is useful when substituting the values of
9841 variables or headers inside regular expressions.
9842
9843
9844 .vitem &*${sha1:*&<&'string'&>&*}*&
9845 .cindex "SHA-1 hash"
9846 .cindex "expansion" "SHA-1 hashing"
9847 .cindex "&%sha2%& expansion item"
9848 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9849 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9850
9851
9852 .vitem &*${stat:*&<&'string'&>&*}*&
9853 .cindex "expansion" "statting a file"
9854 .cindex "file" "extracting characteristics"
9855 .cindex "&%stat%& expansion item"
9856 The string, after expansion, must be a file path. A call to the &[stat()]&
9857 function is made for this path. If &[stat()]& fails, an error occurs and the
9858 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9859 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9860 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9861 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9862 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9863 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9864 can extract individual fields using the &%extract%& expansion item.
9865
9866 The use of the &%stat%& expansion in users' filter files can be locked out by
9867 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9868 systems for files larger than 2GB.
9869
9870 .vitem &*${str2b64:*&<&'string'&>&*}*&
9871 .cindex "expansion" "base64 encoding"
9872 .cindex "base64 encoding" "in string expansion"
9873 .cindex "&%str2b64%& expansion item"
9874 This operator converts a string into one that is base64 encoded.
9875
9876
9877
9878 .vitem &*${strlen:*&<&'string'&>&*}*&
9879 .cindex "expansion" "string length"
9880 .cindex "string" "length in expansion"
9881 .cindex "&%strlen%& expansion item"
9882 The item is replace by the length of the expanded string, expressed as a
9883 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9884
9885
9886 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9887 .cindex "&%substr%& expansion item"
9888 .cindex "substring extraction"
9889 .cindex "expansion" "substring expansion"
9890 The &%substr%& operator is a simpler interface to the &%substr%& function that
9891 can be used when the two parameters are fixed numbers (as opposed to strings
9892 that change when expanded). The effect is the same as
9893 .code
9894 ${substr{<start>}{<length>}{<string>}}
9895 .endd
9896 See the description of the general &%substr%& item above for details. The
9897 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9898
9899 .vitem &*${time_eval:*&<&'string'&>&*}*&
9900 .cindex "&%time_eval%& expansion item"
9901 .cindex "time interval" "decoding"
9902 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9903 seconds.
9904
9905 .vitem &*${time_interval:*&<&'string'&>&*}*&
9906 .cindex "&%time_interval%& expansion item"
9907 .cindex "time interval" "formatting"
9908 The argument (after sub-expansion) must be a sequence of decimal digits that
9909 represents an interval of time as a number of seconds. It is converted into a
9910 number of larger units and output in Exim's normal time format, for example,
9911 &`1w3d4h2m6s`&.
9912
9913 .vitem &*${uc:*&<&'string'&>&*}*&
9914 .cindex "case forcing in strings"
9915 .cindex "string" "case forcing"
9916 .cindex "upper casing"
9917 .cindex "expansion" "case forcing"
9918 .cindex "&%uc%& expansion item"
9919 This forces the letters in the string into upper-case.
9920 .endlist
9921
9922
9923
9924
9925
9926
9927 .section "Expansion conditions" "SECTexpcond"
9928 .scindex IIDexpcond "expansion" "conditions"
9929 The following conditions are available for testing by the &%${if%& construct
9930 while expanding strings:
9931
9932 .vlist
9933 .vitem &*!*&<&'condition'&>
9934 .cindex "expansion" "negating a condition"
9935 .cindex "negation" "in expansion condition"
9936 Preceding any condition with an exclamation mark negates the result of the
9937 condition.
9938
9939 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9940 .cindex "numeric comparison"
9941 .cindex "expansion" "numeric comparison"
9942 There are a number of symbolic operators for doing numeric comparisons. They
9943 are:
9944 .display
9945 &`=   `&   equal
9946 &`==  `&   equal
9947 &`>   `&   greater
9948 &`>=  `&   greater or equal
9949 &`<   `&   less
9950 &`<=  `&   less or equal
9951 .endd
9952 For example:
9953 .code
9954 ${if >{$message_size}{10M} ...
9955 .endd
9956 Note that the general negation operator provides for inequality testing. The
9957 two strings must take the form of optionally signed decimal integers,
9958 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9959 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9960 As a special case, the numerical value of an empty string is taken as
9961 zero.
9962
9963 In all cases, a relative comparator OP is testing if <&'string1'&> OP
9964 <&'string2'&>; the above example is checking if &$message_size$& is larger than
9965 10M, not if 10M is larger than &$message_size$&.
9966
9967
9968 .vitem &*bool&~{*&<&'string'&>&*}*&
9969 .cindex "expansion" "boolean parsing"
9970 .cindex "&%bool%& expansion condition"
9971 This condition turns a string holding a true or false representation into
9972 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9973 (case-insensitively); also positive integer numbers map to true if non-zero,
9974 false if zero.
9975 An empty string is treated as false.
9976 Leading and trailing whitespace is ignored;
9977 thus a string consisting only of whitespace is false.
9978 All other string values will result in expansion failure.
9979
9980 When combined with ACL variables, this expansion condition will let you
9981 make decisions in one place and act on those decisions in another place.
9982 For example:
9983 .code
9984 ${if bool{$acl_m_privileged_sender} ...
9985 .endd
9986
9987
9988 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9989 .cindex "expansion" "boolean parsing"
9990 .cindex "&%bool_lax%& expansion condition"
9991 Like &%bool%&, this condition turns a string into a boolean state.  But
9992 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9993 loose definition that the Router &%condition%& option uses.  The empty string
9994 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9995 true.  Leading and trailing whitespace is ignored.
9996
9997 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9998
9999 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10000 .cindex "expansion" "encrypted comparison"
10001 .cindex "encrypted strings, comparing"
10002 .cindex "&%crypteq%& expansion condition"
10003 This condition is included in the Exim binary if it is built to support any
10004 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10005 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10006 included in the binary.
10007
10008 The &%crypteq%& condition has two arguments. The first is encrypted and
10009 compared against the second, which is already encrypted. The second string may
10010 be in the LDAP form for storing encrypted strings, which starts with the
10011 encryption type in curly brackets, followed by the data. If the second string
10012 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10013 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10014 Typically this will be a field from a password file. An example of an encrypted
10015 string in LDAP form is:
10016 .code
10017 {md5}CY9rzUYh03PK3k6DJie09g==
10018 .endd
10019 If such a string appears directly in an expansion, the curly brackets have to
10020 be quoted, because they are part of the expansion syntax. For example:
10021 .code
10022 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10023 .endd
10024 The following encryption types (whose names are matched case-independently) are
10025 supported:
10026
10027 .ilist
10028 .cindex "MD5 hash"
10029 .cindex "base64 encoding" "in encrypted password"
10030 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10031 printable characters to compare with the remainder of the second string. If the
10032 length of the comparison string is 24, Exim assumes that it is base64 encoded
10033 (as in the above example). If the length is 32, Exim assumes that it is a
10034 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10035 comparison fails.
10036
10037 .next
10038 .cindex "SHA-1 hash"
10039 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10040 printable characters to compare with the remainder of the second string. If the
10041 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10042 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10043 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10044
10045 .next
10046 .cindex "&[crypt()]&"
10047 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10048 only the first eight characters of the password. However, in modern operating
10049 systems this is no longer true, and in many cases the entire password is used,
10050 whatever its length.
10051
10052 .next
10053 .cindex "&[crypt16()]&"
10054 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10055 use up to 16 characters of the password in some operating systems. Again, in
10056 modern operating systems, more characters may be used.
10057 .endlist
10058 Exim has its own version of &[crypt16()]&, which is just a double call to
10059 &[crypt()]&. For operating systems that have their own version, setting
10060 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10061 operating system version instead of its own. This option is set by default in
10062 the OS-dependent &_Makefile_& for those operating systems that are known to
10063 support &[crypt16()]&.
10064
10065 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10066 it was not using the same algorithm as some operating systems' versions. It
10067 turns out that as well as &[crypt16()]& there is a function called
10068 &[bigcrypt()]& in some operating systems. This may or may not use the same
10069 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10070
10071 However, since there is now a move away from the traditional &[crypt()]&
10072 functions towards using SHA1 and other algorithms, tidying up this area of
10073 Exim is seen as very low priority.
10074
10075 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10076 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10077 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10078 default is &`{crypt}`&. Whatever the default, you can always use either
10079 function by specifying it explicitly in curly brackets.
10080
10081 .vitem &*def:*&<&'variable&~name'&>
10082 .cindex "expansion" "checking for empty variable"
10083 .cindex "&%def%& expansion condition"
10084 The &%def%& condition must be followed by the name of one of the expansion
10085 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10086 variable does not contain the empty string. For example:
10087 .code
10088 ${if def:sender_ident {from $sender_ident}}
10089 .endd
10090 Note that the variable name is given without a leading &%$%& character. If the
10091 variable does not exist, the expansion fails.
10092
10093 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10094         &~&*def:h_*&<&'header&~name'&>&*:*&"
10095 .cindex "expansion" "checking header line existence"
10096 This condition is true if a message is being processed and the named header
10097 exists in the message. For example,
10098 .code
10099 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10100 .endd
10101 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10102 the header name must be terminated by a colon if white space does not follow.
10103
10104 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10105        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10106 .cindex "string" "comparison"
10107 .cindex "expansion" "string comparison"
10108 .cindex "&%eq%& expansion condition"
10109 .cindex "&%eqi%& expansion condition"
10110 The two substrings are first expanded. The condition is true if the two
10111 resulting strings are identical. For &%eq%& the comparison includes the case of
10112 letters, whereas for &%eqi%& the comparison is case-independent.
10113
10114 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10115 .cindex "expansion" "file existence test"
10116 .cindex "file" "existence test"
10117 .cindex "&%exists%&, expansion condition"
10118 The substring is first expanded and then interpreted as an absolute path. The
10119 condition is true if the named file (or directory) exists. The existence test
10120 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10121 users' filter files may be locked out by the system administrator.
10122
10123 .vitem &*first_delivery*&
10124 .cindex "delivery" "first"
10125 .cindex "first delivery"
10126 .cindex "expansion" "first delivery test"
10127 .cindex "&%first_delivery%& expansion condition"
10128 This condition, which has no data, is true during a message's first delivery
10129 attempt. It is false during any subsequent delivery attempts.
10130
10131
10132 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10133        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10134 .cindex "list" "iterative conditions"
10135 .cindex "expansion" "&*forall*& condition"
10136 .cindex "expansion" "&*forany*& condition"
10137 .vindex "&$item$&"
10138 These conditions iterate over a list. The first argument is expanded to form
10139 the list. By default, the list separator is a colon, but it can be changed by
10140 the normal method. The second argument is interpreted as a condition that is to
10141 be applied to each item in the list in turn. During the interpretation of the
10142 condition, the current list item is placed in a variable called &$item$&.
10143 .ilist
10144 For &*forany*&, interpretation stops if the condition is true for any item, and
10145 the result of the whole condition is true. If the condition is false for all
10146 items in the list, the overall condition is false.
10147 .next
10148 For &*forall*&, interpretation stops if the condition is false for any item,
10149 and the result of the whole condition is false. If the condition is true for
10150 all items in the list, the overall condition is true.
10151 .endlist
10152 Note that negation of &*forany*& means that the condition must be false for all
10153 items for the overall condition to succeed, and negation of &*forall*& means
10154 that the condition must be false for at least one item. In this example, the
10155 list separator is changed to a comma:
10156 .code
10157 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10158 .endd
10159 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10160 being processed, to enable these expansion items to be nested.
10161
10162
10163 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10164        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10165 .cindex "string" "comparison"
10166 .cindex "expansion" "string comparison"
10167 .cindex "&%ge%& expansion condition"
10168 .cindex "&%gei%& expansion condition"
10169 The two substrings are first expanded. The condition is true if the first
10170 string is lexically greater than or equal to the second string. For &%ge%& the
10171 comparison includes the case of letters, whereas for &%gei%& the comparison is
10172 case-independent.
10173
10174 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10175        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10176 .cindex "string" "comparison"
10177 .cindex "expansion" "string comparison"
10178 .cindex "&%gt%& expansion condition"
10179 .cindex "&%gti%& expansion condition"
10180 The two substrings are first expanded. The condition is true if the first
10181 string is lexically greater than the second string. For &%gt%& the comparison
10182 includes the case of letters, whereas for &%gti%& the comparison is
10183 case-independent.
10184
10185 .new
10186 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10187        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10188 .cindex "string" "comparison"
10189 .cindex "list" "iterative conditions"
10190 Both strings are expanded; the second string is treated as a list of simple
10191 strings; if the first string is a member of the second, then the condition
10192 is true.
10193
10194 These are simpler to use versions of the more powerful &*forany*& condition.
10195 Examples, and the &*forany*& equivalents:
10196 .code
10197 ${if inlist{needle}{foo:needle:bar}}
10198   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10199 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10200   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10201 .endd
10202 .wen
10203
10204 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10205        &*isip4&~{*&<&'string'&>&*}*& &&&
10206        &*isip6&~{*&<&'string'&>&*}*&
10207 .cindex "IP address" "testing string format"
10208 .cindex "string" "testing for IP address"
10209 .cindex "&%isip%& expansion condition"
10210 .cindex "&%isip4%& expansion condition"
10211 .cindex "&%isip6%& expansion condition"
10212 The substring is first expanded, and then tested to see if it has the form of
10213 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10214 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10215
10216 For an IPv4 address, the test is for four dot-separated components, each of
10217 which consists of from one to three digits. For an IPv6 address, up to eight
10218 colon-separated components are permitted, each containing from one to four
10219 hexadecimal digits. There may be fewer than eight components if an empty
10220 component (adjacent colons) is present. Only one empty component is permitted.
10221
10222 &*Note*&: The checks are just on the form of the address; actual numerical
10223 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10224 check. The main use of these tests is to distinguish between IP addresses and
10225 host names, or between IPv4 and IPv6 addresses. For example, you could use
10226 .code
10227 ${if isip4{$sender_host_address}...
10228 .endd
10229 to test which IP version an incoming SMTP connection is using.
10230
10231 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10232 .cindex "LDAP" "use for authentication"
10233 .cindex "expansion" "LDAP authentication test"
10234 .cindex "&%ldapauth%& expansion condition"
10235 This condition supports user authentication using LDAP. See section
10236 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10237 queries. For this use, the query must contain a user name and password. The
10238 query itself is not used, and can be empty. The condition is true if the
10239 password is not empty, and the user name and password are accepted by the LDAP
10240 server. An empty password is rejected without calling LDAP because LDAP binds
10241 with an empty password are considered anonymous regardless of the username, and
10242 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10243 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10244 this can be used.
10245
10246
10247 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10248        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10249 .cindex "string" "comparison"
10250 .cindex "expansion" "string comparison"
10251 .cindex "&%le%& expansion condition"
10252 .cindex "&%lei%& expansion condition"
10253 The two substrings are first expanded. The condition is true if the first
10254 string is lexically less than or equal to the second string. For &%le%& the
10255 comparison includes the case of letters, whereas for &%lei%& the comparison is
10256 case-independent.
10257
10258 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10259        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10260 .cindex "string" "comparison"
10261 .cindex "expansion" "string comparison"
10262 .cindex "&%lt%& expansion condition"
10263 .cindex "&%lti%& expansion condition"
10264 The two substrings are first expanded. The condition is true if the first
10265 string is lexically less than the second string. For &%lt%& the comparison
10266 includes the case of letters, whereas for &%lti%& the comparison is
10267 case-independent.
10268
10269
10270 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10271 .cindex "expansion" "regular expression comparison"
10272 .cindex "regular expressions" "match in expanded string"
10273 .cindex "&%match%& expansion condition"
10274 The two substrings are first expanded. The second is then treated as a regular
10275 expression and applied to the first. Because of the pre-expansion, if the
10276 regular expression contains dollar, or backslash characters, they must be
10277 escaped. Care must also be taken if the regular expression contains braces
10278 (curly brackets). A closing brace must be escaped so that it is not taken as a
10279 premature termination of <&'string2'&>. The easiest approach is to use the
10280 &`\N`& feature to disable expansion of the regular expression.
10281 For example,
10282 .code
10283 ${if match {$local_part}{\N^\d{3}\N} ...
10284 .endd
10285 If the whole expansion string is in double quotes, further escaping of
10286 backslashes is also required.
10287
10288 The condition is true if the regular expression match succeeds.
10289 The regular expression is not required to begin with a circumflex
10290 metacharacter, but if there is no circumflex, the expression is not anchored,
10291 and it may match anywhere in the subject, not just at the start. If you want
10292 the pattern to match at the end of the subject, you must include the &`$`&
10293 metacharacter at an appropriate point.
10294
10295 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10296 At the start of an &%if%& expansion the values of the numeric variable
10297 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10298 succeeds causes them to be reset to the substrings of that condition and they
10299 will have these values during the expansion of the success string. At the end
10300 of the &%if%& expansion, the previous values are restored. After testing a
10301 combination of conditions using &%or%&, the subsequent values of the numeric
10302 variables are those of the condition that succeeded.
10303
10304 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10305 .cindex "&%match_address%& expansion condition"
10306 See &*match_local_part*&.
10307
10308 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10309 .cindex "&%match_domain%& expansion condition"
10310 See &*match_local_part*&.
10311
10312 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10313 .cindex "&%match_ip%& expansion condition"
10314 .new
10315 This condition matches an IP address to a list of IP address patterns. It must
10316 be followed by two argument strings. The first (after expansion) must be an IP
10317 address or an empty string. The second (not expanded) is a restricted host
10318 list that can match only an IP address, not a host name. For example:
10319 .wen
10320 .code
10321 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10322 .endd
10323 The specific types of host list item that are permitted in the list are:
10324
10325 .ilist
10326 An IP address, optionally with a CIDR mask.
10327 .next
10328 A single asterisk, which matches any IP address.
10329 .next
10330 An empty item, which matches only if the IP address is empty. This could be
10331 useful for testing for a locally submitted message or one from specific hosts
10332 in a single test such as
10333 . ==== As this is a nested list, any displays it contains must be indented
10334 . ==== as otherwise they are too far to the left. This comment applies to
10335 . ==== the use of xmlto plus fop. There's no problem when formatting with
10336 . ==== sdop, with or without the extra indent.
10337 .code
10338   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10339 .endd
10340 where the first item in the list is the empty string.
10341 .next
10342 The item @[] matches any of the local host's interface addresses.
10343 .next
10344 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10345 even if &`net-`& is not specified. There is never any attempt to turn the IP
10346 address into a host name. The most common type of linear search for
10347 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10348 masks. For example:
10349 .code
10350   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10351 .endd
10352 It is of course possible to use other kinds of lookup, and in such a case, you
10353 do need to specify the &`net-`& prefix if you want to specify a specific
10354 address mask, for example:
10355 .code
10356   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10357 .endd
10358 However, unless you are combining a &%match_ip%& condition with others, it is
10359 just as easy to use the fact that a lookup is itself a condition, and write:
10360 .code
10361   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10362 .endd
10363 .endlist ilist
10364
10365 .new
10366 Note that <&'string2'&> is not itself subject to string expansion, unless
10367 Exim was built with the EXPAND_LISTMATCH_RHS option.
10368 .wen
10369
10370 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10371
10372 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10373 .cindex "domain list" "in expansion condition"
10374 .cindex "address list" "in expansion condition"
10375 .cindex "local part" "list, in expansion condition"
10376 .cindex "&%match_local_part%& expansion condition"
10377 This condition, together with &%match_address%& and &%match_domain%&, make it
10378 possible to test domain, address, and local part lists within expansions. Each
10379 condition requires two arguments: an item and a list to match. A trivial
10380 example is:
10381 .code
10382 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10383 .endd
10384 In each case, the second argument may contain any of the allowable items for a
10385 list of the appropriate type. Also, because the second argument (after
10386 expansion) is a standard form of list, it is possible to refer to a named list.
10387 Thus, you can use conditions like this:
10388 .code
10389 ${if match_domain{$domain}{+local_domains}{...
10390 .endd
10391 .cindex "&`+caseful`&"
10392 For address lists, the matching starts off caselessly, but the &`+caseful`&
10393 item can be used, as in all address lists, to cause subsequent items to
10394 have their local parts matched casefully. Domains are always matched
10395 caselessly.
10396
10397 .new
10398 Note that <&'string2'&> is not itself subject to string expansion, unless
10399 Exim was built with the EXPAND_LISTMATCH_RHS option.
10400 .wen
10401
10402 &*Note*&: Host lists are &'not'& supported in this way. This is because
10403 hosts have two identities: a name and an IP address, and it is not clear
10404 how to specify cleanly how such a test would work. However, IP addresses can be
10405 matched using &%match_ip%&.
10406
10407 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10408 .cindex "PAM authentication"
10409 .cindex "AUTH" "with PAM"
10410 .cindex "Solaris" "PAM support"
10411 .cindex "expansion" "PAM authentication test"
10412 .cindex "&%pam%& expansion condition"
10413 &'Pluggable Authentication Modules'&
10414 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10415 available in the latest releases of Solaris and in some GNU/Linux
10416 distributions. The Exim support, which is intended for use in conjunction with
10417 the SMTP AUTH command, is available only if Exim is compiled with
10418 .code
10419 SUPPORT_PAM=yes
10420 .endd
10421 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10422 in some releases of GNU/Linux &%-ldl%& is also needed.
10423
10424 The argument string is first expanded, and the result must be a
10425 colon-separated list of strings. Leading and trailing white space is ignored.
10426 The PAM module is initialized with the service name &"exim"& and the user name
10427 taken from the first item in the colon-separated data string (<&'string1'&>).
10428 The remaining items in the data string are passed over in response to requests
10429 from the authentication function. In the simple case there will only be one
10430 request, for a password, so the data consists of just two strings.
10431
10432 There can be problems if any of the strings are permitted to contain colon
10433 characters. In the usual way, these have to be doubled to avoid being taken as
10434 separators. If the data is being inserted from a variable, the &%sg%& expansion
10435 item can be used to double any existing colons. For example, the configuration
10436 of a LOGIN authenticator might contain this setting:
10437 .code
10438 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10439 .endd
10440 For a PLAIN authenticator you could use:
10441 .code
10442 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10443 .endd
10444 In some operating systems, PAM authentication can be done only from a process
10445 running as root. Since Exim is running as the Exim user when receiving
10446 messages, this means that PAM cannot be used directly in those systems.
10447 A patched version of the &'pam_unix'& module that comes with the
10448 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10449 The patched module allows one special uid/gid combination, in addition to root,
10450 to authenticate. If you build the patched module to allow the Exim user and
10451 group, PAM can then be used from an Exim authenticator.
10452
10453
10454 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10455 .cindex "&'pwcheck'& daemon"
10456 .cindex "Cyrus"
10457 .cindex "expansion" "&'pwcheck'& authentication test"
10458 .cindex "&%pwcheck%& expansion condition"
10459 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10460 This is one way of making it possible for passwords to be checked by a process
10461 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10462 deprecated. Its replacement is &'saslauthd'& (see below).
10463
10464 The pwcheck support is not included in Exim by default. You need to specify
10465 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10466 building Exim. For example:
10467 .code
10468 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10469 .endd
10470 You do not need to install the full Cyrus software suite in order to use
10471 the pwcheck daemon. You can compile and install just the daemon alone
10472 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10473 access to the &_/var/pwcheck_& directory.
10474
10475 The &%pwcheck%& condition takes one argument, which must be the user name and
10476 password, separated by a colon. For example, in a LOGIN authenticator
10477 configuration, you might have this:
10478 .code
10479 server_condition = ${if pwcheck{$auth1:$auth2}}
10480 .endd
10481 Again, for a PLAIN authenticator configuration, this would be:
10482 .code
10483 server_condition = ${if pwcheck{$auth2:$auth3}}
10484 .endd
10485 .vitem &*queue_running*&
10486 .cindex "queue runner" "detecting when delivering from"
10487 .cindex "expansion" "queue runner test"
10488 .cindex "&%queue_running%& expansion condition"
10489 This condition, which has no data, is true during delivery attempts that are
10490 initiated by queue runner processes, and false otherwise.
10491
10492
10493 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10494 .cindex "Radius"
10495 .cindex "expansion" "Radius authentication"
10496 .cindex "&%radius%& expansion condition"
10497 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10498 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10499 the Radius client configuration file in order to build Exim with Radius
10500 support.
10501
10502 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10503 library, using the original API. If you are using release 0.4.0 or later of
10504 this library, you need to set
10505 .code
10506 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10507 .endd
10508 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10509 &%libradius%& library that comes with FreeBSD. To do this, set
10510 .code
10511 RADIUS_LIB_TYPE=RADLIB
10512 .endd
10513 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10514 You may also have to supply a suitable setting in EXTRALIBS so that the
10515 Radius library can be found when Exim is linked.
10516
10517 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10518 Radius client library, which calls the Radius server. The condition is true if
10519 the authentication is successful. For example:
10520 .code
10521 server_condition = ${if radius{<arguments>}}
10522 .endd
10523
10524
10525 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10526         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10527 .cindex "&'saslauthd'& daemon"
10528 .cindex "Cyrus"
10529 .cindex "expansion" "&'saslauthd'& authentication test"
10530 .cindex "&%saslauthd%& expansion condition"
10531 This condition supports user authentication using the Cyrus &'saslauthd'&
10532 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10533 Using this daemon is one way of making it possible for passwords to be checked
10534 by a process that is not running as root.
10535
10536 The saslauthd support is not included in Exim by default. You need to specify
10537 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10538 building Exim. For example:
10539 .code
10540 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10541 .endd
10542 You do not need to install the full Cyrus software suite in order to use
10543 the saslauthd daemon. You can compile and install just the daemon alone
10544 from the Cyrus SASL library.
10545
10546 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10547 two are mandatory. For example:
10548 .code
10549 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10550 .endd
10551 The service and the realm are optional (which is why the arguments are enclosed
10552 in their own set of braces). For details of the meaning of the service and
10553 realm, and how to run the daemon, consult the Cyrus documentation.
10554 .endlist vlist
10555
10556
10557
10558 .section "Combining expansion conditions" "SECID84"
10559 .cindex "expansion" "combining conditions"
10560 Several conditions can be tested at once by combining them using the &%and%&
10561 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10562 conditions on their own, and precede their lists of sub-conditions. Each
10563 sub-condition must be enclosed in braces within the overall braces that contain
10564 the list. No repetition of &%if%& is used.
10565
10566
10567 .vlist
10568 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10569 .cindex "&""or""& expansion condition"
10570 .cindex "expansion" "&""or""& of conditions"
10571 The sub-conditions are evaluated from left to right. The condition is true if
10572 any one of the sub-conditions is true.
10573 For example,
10574 .code
10575 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10576 .endd
10577 When a true sub-condition is found, the following ones are parsed but not
10578 evaluated. If there are several &"match"& sub-conditions the values of the
10579 numeric variables afterwards are taken from the first one that succeeds.
10580
10581 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10582 .cindex "&""and""& expansion condition"
10583 .cindex "expansion" "&""and""& of conditions"
10584 The sub-conditions are evaluated from left to right. The condition is true if
10585 all of the sub-conditions are true. If there are several &"match"&
10586 sub-conditions, the values of the numeric variables afterwards are taken from
10587 the last one. When a false sub-condition is found, the following ones are
10588 parsed but not evaluated.
10589 .endlist
10590 .ecindex IIDexpcond
10591
10592
10593
10594
10595 .section "Expansion variables" "SECTexpvar"
10596 .cindex "expansion" "variables, list of"
10597 This section contains an alphabetical list of all the expansion variables. Some
10598 of them are available only when Exim is compiled with specific options such as
10599 support for TLS or the content scanning extension.
10600
10601 .vlist
10602 .vitem "&$0$&, &$1$&, etc"
10603 .cindex "numerical variables (&$1$& &$2$& etc)"
10604 When a &%match%& expansion condition succeeds, these variables contain the
10605 captured substrings identified by the regular expression during subsequent
10606 processing of the success string of the containing &%if%& expansion item.
10607 However, they do not retain their values afterwards; in fact, their previous
10608 values are restored at the end of processing an &%if%& item. The numerical
10609 variables may also be set externally by some other matching process which
10610 precedes the expansion of the string. For example, the commands available in
10611 Exim filter files include an &%if%& command with its own regular expression
10612 matching condition.
10613
10614 .vitem "&$acl_c...$&"
10615 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10616 can be given any name that starts with &$acl_c$& and is at least six characters
10617 long, but the sixth character must be either a digit or an underscore. For
10618 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10619 variables persist throughout the lifetime of an SMTP connection. They can be
10620 used to pass information between ACLs and between different invocations of the
10621 same ACL. When a message is received, the values of these variables are saved
10622 with the message, and can be accessed by filters, routers, and transports
10623 during subsequent delivery.
10624
10625 .vitem "&$acl_m...$&"
10626 These variables are like the &$acl_c...$& variables, except that their values
10627 are reset after a message has been received. Thus, if several messages are
10628 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10629 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10630 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10631 message is received, the values of these variables are saved with the message,
10632 and can be accessed by filters, routers, and transports during subsequent
10633 delivery.
10634
10635 .vitem &$acl_verify_message$&
10636 .vindex "&$acl_verify_message$&"
10637 After an address verification has failed, this variable contains the failure
10638 message. It retains its value for use in subsequent modifiers. The message can
10639 be preserved by coding like this:
10640 .code
10641 warn !verify = sender
10642      set acl_m0 = $acl_verify_message
10643 .endd
10644 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10645 &%log_message%& modifiers, to include information about the verification
10646 failure.
10647
10648 .vitem &$address_data$&
10649 .vindex "&$address_data$&"
10650 This variable is set by means of the &%address_data%& option in routers. The
10651 value then remains with the address while it is processed by subsequent routers
10652 and eventually a transport. If the transport is handling multiple addresses,
10653 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10654 for more details. &*Note*&: The contents of &$address_data$& are visible in
10655 user filter files.
10656
10657 If &$address_data$& is set when the routers are called from an ACL to verify
10658 a recipient address, the final value is still in the variable for subsequent
10659 conditions and modifiers of the ACL statement. If routing the address caused it
10660 to be redirected to just one address, the child address is also routed as part
10661 of the verification, and in this case the final value of &$address_data$& is
10662 from the child's routing.
10663
10664 If &$address_data$& is set when the routers are called from an ACL to verify a
10665 sender address, the final value is also preserved, but this time in
10666 &$sender_address_data$&, to distinguish it from data from a recipient
10667 address.
10668
10669 In both cases (recipient and sender verification), the value does not persist
10670 after the end of the current ACL statement. If you want to preserve
10671 these values for longer, you can save them in ACL variables.
10672
10673 .vitem &$address_file$&
10674 .vindex "&$address_file$&"
10675 When, as a result of aliasing, forwarding, or filtering, a message is directed
10676 to a specific file, this variable holds the name of the file when the transport
10677 is running. At other times, the variable is empty. For example, using the
10678 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10679 .code
10680 /home/r2d2/savemail
10681 .endd
10682 then when the &(address_file)& transport is running, &$address_file$&
10683 contains the text string &`/home/r2d2/savemail`&.
10684 .cindex "Sieve filter" "value of &$address_file$&"
10685 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10686 then up to the transport configuration to generate an appropriate absolute path
10687 to the relevant file.
10688
10689 .vitem &$address_pipe$&
10690 .vindex "&$address_pipe$&"
10691 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10692 this variable holds the pipe command when the transport is running.
10693
10694 .vitem "&$auth1$& &-- &$auth3$&"
10695 .vindex "&$auth1$&, &$auth2$&, etc"
10696 These variables are used in SMTP authenticators (see chapters
10697 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10698
10699 .vitem &$authenticated_id$&
10700 .cindex "authentication" "id"
10701 .vindex "&$authenticated_id$&"
10702 When a server successfully authenticates a client it may be configured to
10703 preserve some of the authentication information in the variable
10704 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10705 user/password authenticator configuration might preserve the user name for use
10706 in the routers. Note that this is not the same information that is saved in
10707 &$sender_host_authenticated$&.
10708 When a message is submitted locally (that is, not over a TCP connection)
10709 the value of &$authenticated_id$& is normally the login name of the calling
10710 process. However, a trusted user can override this by means of the &%-oMai%&
10711 command line option.
10712
10713
10714
10715
10716 .vitem &$authenticated_sender$&
10717 .cindex "sender" "authenticated"
10718 .cindex "authentication" "sender"
10719 .cindex "AUTH" "on MAIL command"
10720 .vindex "&$authenticated_sender$&"
10721 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10722 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10723 described in section &<<SECTauthparamail>>&. Unless the data is the string
10724 &"<>"&, it is set as the authenticated sender of the message, and the value is
10725 available during delivery in the &$authenticated_sender$& variable. If the
10726 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10727
10728 .vindex "&$qualify_domain$&"
10729 When a message is submitted locally (that is, not over a TCP connection), the
10730 value of &$authenticated_sender$& is an address constructed from the login
10731 name of the calling process and &$qualify_domain$&, except that a trusted user
10732 can override this by means of the &%-oMas%& command line option.
10733
10734
10735 .vitem &$authentication_failed$&
10736 .cindex "authentication" "failure"
10737 .vindex "&$authentication_failed$&"
10738 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10739 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10740 possible to distinguish between &"did not try to authenticate"&
10741 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10742 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10743 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10744 negative response to an AUTH command, including (for example) an attempt to use
10745 an undefined mechanism.
10746
10747 .new
10748 .vitem &$av_failed$&
10749 .cindex "content scanning" "AV scanner failure"
10750 This variable is available when Exim is compiled with the content-scanning
10751 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10752 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10753 the ACL malware condition.
10754 .wen
10755
10756 .vitem &$body_linecount$&
10757 .cindex "message body" "line count"
10758 .cindex "body of message" "line count"
10759 .vindex "&$body_linecount$&"
10760 When a message is being received or delivered, this variable contains the
10761 number of lines in the message's body. See also &$message_linecount$&.
10762
10763 .vitem &$body_zerocount$&
10764 .cindex "message body" "binary zero count"
10765 .cindex "body of message" "binary zero count"
10766 .cindex "binary zero" "in message body"
10767 .vindex "&$body_zerocount$&"
10768 When a message is being received or delivered, this variable contains the
10769 number of binary zero bytes (ASCII NULs) in the message's body.
10770
10771 .vitem &$bounce_recipient$&
10772 .vindex "&$bounce_recipient$&"
10773 This is set to the recipient address of a bounce message while Exim is creating
10774 it. It is useful if a customized bounce message text file is in use (see
10775 chapter &<<CHAPemsgcust>>&).
10776
10777 .vitem &$bounce_return_size_limit$&
10778 .vindex "&$bounce_return_size_limit$&"
10779 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10780 up to a multiple of 1000. It is useful when a customized error message text
10781 file is in use (see chapter &<<CHAPemsgcust>>&).
10782
10783 .vitem &$caller_gid$&
10784 .cindex "gid (group id)" "caller"
10785 .vindex "&$caller_gid$&"
10786 The real group id under which the process that called Exim was running. This is
10787 not the same as the group id of the originator of a message (see
10788 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10789 incarnation normally contains the Exim gid.
10790
10791 .vitem &$caller_uid$&
10792 .cindex "uid (user id)" "caller"
10793 .vindex "&$caller_uid$&"
10794 The real user id under which the process that called Exim was running. This is
10795 not the same as the user id of the originator of a message (see
10796 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10797 incarnation normally contains the Exim uid.
10798
10799 .vitem &$compile_date$&
10800 .vindex "&$compile_date$&"
10801 The date on which the Exim binary was compiled.
10802
10803 .vitem &$compile_number$&
10804 .vindex "&$compile_number$&"
10805 The building process for Exim keeps a count of the number
10806 of times it has been compiled. This serves to distinguish different
10807 compilations of the same version of the program.
10808
10809 .vitem &$demime_errorlevel$&
10810 .vindex "&$demime_errorlevel$&"
10811 This variable is available when Exim is compiled with
10812 the content-scanning extension and the obsolete &%demime%& condition. For
10813 details, see section &<<SECTdemimecond>>&.
10814
10815 .vitem &$demime_reason$&
10816 .vindex "&$demime_reason$&"
10817 This variable is available when Exim is compiled with the
10818 content-scanning extension and the obsolete &%demime%& condition. For details,
10819 see section &<<SECTdemimecond>>&.
10820
10821 .vitem &$dnslist_domain$& &&&
10822        &$dnslist_matched$& &&&
10823        &$dnslist_text$& &&&
10824        &$dnslist_value$&
10825 .vindex "&$dnslist_domain$&"
10826 .vindex "&$dnslist_matched$&"
10827 .vindex "&$dnslist_text$&"
10828 .vindex "&$dnslist_value$&"
10829 .cindex "black list (DNS)"
10830 When a DNS (black) list lookup succeeds, these variables are set to contain
10831 the following data from the lookup: the list's domain name, the key that was
10832 looked up, the contents of any associated TXT record, and the value from the
10833 main A record. See section &<<SECID204>>& for more details.
10834
10835 .vitem &$domain$&
10836 .vindex "&$domain$&"
10837 When an address is being routed, or delivered on its own, this variable
10838 contains the domain. Uppercase letters in the domain are converted into lower
10839 case for &$domain$&.
10840
10841 Global address rewriting happens when a message is received, so the value of
10842 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10843 is set during user filtering, but not during system filtering, because a
10844 message may have many recipients and the system filter is called just once.
10845
10846 When more than one address is being delivered at once (for example, several
10847 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10848 have the same domain. Transports can be restricted to handling only one domain
10849 at a time if the value of &$domain$& is required at transport time &-- this is
10850 the default for local transports. For further details of the environment in
10851 which local transports are run, see chapter &<<CHAPenvironment>>&.
10852
10853 .oindex "&%delay_warning_condition%&"
10854 At the end of a delivery, if all deferred addresses have the same domain, it is
10855 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10856
10857 The &$domain$& variable is also used in some other circumstances:
10858
10859 .ilist
10860 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10861 the recipient address. The domain of the &'sender'& address is in
10862 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10863 normally set during the running of the MAIL ACL. However, if the sender address
10864 is verified with a callout during the MAIL ACL, the sender domain is placed in
10865 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10866 the &(smtp)& transport.
10867
10868 .next
10869 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10870 &$domain$& contains the domain portion of the address that is being rewritten;
10871 it can be used in the expansion of the replacement address, for example, to
10872 rewrite domains by file lookup.
10873
10874 .next
10875 With one important exception, whenever a domain list is being scanned,
10876 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10877 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10878 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10879 that, in a RCPT ACL, the sender domain list can be dependent on the
10880 recipient domain (which is what is in &$domain$& at this time).
10881
10882 .next
10883 .cindex "ETRN" "value of &$domain$&"
10884 .oindex "&%smtp_etrn_command%&"
10885 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10886 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10887 .endlist
10888
10889
10890 .vitem &$domain_data$&
10891 .vindex "&$domain_data$&"
10892 When the &%domains%& option on a router matches a domain by
10893 means of a lookup, the data read by the lookup is available during the running
10894 of the router as &$domain_data$&. In addition, if the driver routes the
10895 address to a transport, the value is available in that transport. If the
10896 transport is handling multiple addresses, the value from the first address is
10897 used.
10898
10899 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10900 domain by means of a lookup. The data read by the lookup is available during
10901 the rest of the ACL statement. In all other situations, this variable expands
10902 to nothing.
10903
10904 .vitem &$exim_gid$&
10905 .vindex "&$exim_gid$&"
10906 This variable contains the numerical value of the Exim group id.
10907
10908 .vitem &$exim_path$&
10909 .vindex "&$exim_path$&"
10910 This variable contains the path to the Exim binary.
10911
10912 .vitem &$exim_uid$&
10913 .vindex "&$exim_uid$&"
10914 This variable contains the numerical value of the Exim user id.
10915
10916 .vitem &$found_extension$&
10917 .vindex "&$found_extension$&"
10918 This variable is available when Exim is compiled with the
10919 content-scanning extension and the obsolete &%demime%& condition. For details,
10920 see section &<<SECTdemimecond>>&.
10921
10922 .vitem &$header_$&<&'name'&>
10923 This is not strictly an expansion variable. It is expansion syntax for
10924 inserting the message header line with the given name. Note that the name must
10925 be terminated by colon or white space, because it may contain a wide variety of
10926 characters. Note also that braces must &'not'& be used.
10927
10928 .vitem &$home$&
10929 .vindex "&$home$&"
10930 When the &%check_local_user%& option is set for a router, the user's home
10931 directory is placed in &$home$& when the check succeeds. In particular, this
10932 means it is set during the running of users' filter files. A router may also
10933 explicitly set a home directory for use by a transport; this can be overridden
10934 by a setting on the transport itself.
10935
10936 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10937 of the environment variable HOME.
10938
10939 .vitem &$host$&
10940 .vindex "&$host$&"
10941 If a router assigns an address to a transport (any transport), and passes a
10942 list of hosts with the address, the value of &$host$& when the transport starts
10943 to run is the name of the first host on the list. Note that this applies both
10944 to local and remote transports.
10945
10946 .cindex "transport" "filter"
10947 .cindex "filter" "transport filter"
10948 For the &(smtp)& transport, if there is more than one host, the value of
10949 &$host$& changes as the transport works its way through the list. In
10950 particular, when the &(smtp)& transport is expanding its options for encryption
10951 using TLS, or for specifying a transport filter (see chapter
10952 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10953 is connected.
10954
10955 When used in the client part of an authenticator configuration (see chapter
10956 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10957 client is connected.
10958
10959
10960 .vitem &$host_address$&
10961 .vindex "&$host_address$&"
10962 This variable is set to the remote host's IP address whenever &$host$& is set
10963 for a remote connection. It is also set to the IP address that is being checked
10964 when the &%ignore_target_hosts%& option is being processed.
10965
10966 .vitem &$host_data$&
10967 .vindex "&$host_data$&"
10968 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10969 result of the lookup is made available in the &$host_data$& variable. This
10970 allows you, for example, to do things like this:
10971 .code
10972 deny  hosts = net-lsearch;/some/file
10973 message = $host_data
10974 .endd
10975 .vitem &$host_lookup_deferred$&
10976 .cindex "host name" "lookup, failure of"
10977 .vindex "&$host_lookup_deferred$&"
10978 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10979 message comes from a remote host and there is an attempt to look up the host's
10980 name from its IP address, and the attempt is not successful, one of these
10981 variables is set to &"1"&.
10982
10983 .ilist
10984 If the lookup receives a definite negative response (for example, a DNS lookup
10985 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10986
10987 .next
10988 If there is any kind of problem during the lookup, such that Exim cannot
10989 tell whether or not the host name is defined (for example, a timeout for a DNS
10990 lookup), &$host_lookup_deferred$& is set to &"1"&.
10991 .endlist ilist
10992
10993 Looking up a host's name from its IP address consists of more than just a
10994 single reverse lookup. Exim checks that a forward lookup of at least one of the
10995 names it receives from a reverse lookup yields the original IP address. If this
10996 is not the case, Exim does not accept the looked up name(s), and
10997 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10998 IP address (for example, the existence of a PTR record in the DNS) is not
10999 sufficient on its own for the success of a host name lookup. If the reverse
11000 lookup succeeds, but there is a lookup problem such as a timeout when checking
11001 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11002 &"1"&. See also &$sender_host_name$&.
11003
11004 .vitem &$host_lookup_failed$&
11005 .vindex "&$host_lookup_failed$&"
11006 See &$host_lookup_deferred$&.
11007
11008
11009 .vitem &$inode$&
11010 .vindex "&$inode$&"
11011 The only time this variable is set is while expanding the &%directory_file%&
11012 option in the &(appendfile)& transport. The variable contains the inode number
11013 of the temporary file which is about to be renamed. It can be used to construct
11014 a unique name for the file.
11015
11016 .vitem &$interface_address$&
11017 .vindex "&$interface_address$&"
11018 This is an obsolete name for &$received_ip_address$&.
11019
11020 .vitem &$interface_port$&
11021 .vindex "&$interface_port$&"
11022 This is an obsolete name for &$received_port$&.
11023
11024 .vitem &$item$&
11025 .vindex "&$item$&"
11026 This variable is used during the expansion of &*forall*& and &*forany*&
11027 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11028 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11029 empty.
11030
11031 .vitem &$ldap_dn$&
11032 .vindex "&$ldap_dn$&"
11033 This variable, which is available only when Exim is compiled with LDAP support,
11034 contains the DN from the last entry in the most recently successful LDAP
11035 lookup.
11036
11037 .vitem &$load_average$&
11038 .vindex "&$load_average$&"
11039 This variable contains the system load average, multiplied by 1000 so that it
11040 is an integer. For example, if the load average is 0.21, the value of the
11041 variable is 210. The value is recomputed every time the variable is referenced.
11042
11043 .vitem &$local_part$&
11044 .vindex "&$local_part$&"
11045 When an address is being routed, or delivered on its own, this
11046 variable contains the local part. When a number of addresses are being
11047 delivered together (for example, multiple RCPT commands in an SMTP
11048 session), &$local_part$& is not set.
11049
11050 Global address rewriting happens when a message is received, so the value of
11051 &$local_part$& during routing and delivery is the value after rewriting.
11052 &$local_part$& is set during user filtering, but not during system filtering,
11053 because a message may have many recipients and the system filter is called just
11054 once.
11055
11056 .vindex "&$local_part_prefix$&"
11057 .vindex "&$local_part_suffix$&"
11058 If a local part prefix or suffix has been recognized, it is not included in the
11059 value of &$local_part$& during routing and subsequent delivery. The values of
11060 any prefix or suffix are in &$local_part_prefix$& and
11061 &$local_part_suffix$&, respectively.
11062
11063 When a message is being delivered to a file, pipe, or autoreply transport as a
11064 result of aliasing or forwarding, &$local_part$& is set to the local part of
11065 the parent address, not to the file name or command (see &$address_file$& and
11066 &$address_pipe$&).
11067
11068 When an ACL is running for a RCPT command, &$local_part$& contains the
11069 local part of the recipient address.
11070
11071 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11072 &$local_part$& contains the local part of the address that is being rewritten;
11073 it can be used in the expansion of the replacement address, for example.
11074
11075 In all cases, all quoting is removed from the local part. For example, for both
11076 the addresses
11077 .code
11078 "abc:xyz"@test.example
11079 abc\:xyz@test.example
11080 .endd
11081 the value of &$local_part$& is
11082 .code
11083 abc:xyz
11084 .endd
11085 If you use &$local_part$& to create another address, you should always wrap it
11086 inside a quoting operator. For example, in a &(redirect)& router you could
11087 have:
11088 .code
11089 data = ${quote_local_part:$local_part}@new.domain.example
11090 .endd
11091 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11092 to process local parts in a case-dependent manner in a router, you can set the
11093 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11094
11095 .vitem &$local_part_data$&
11096 .vindex "&$local_part_data$&"
11097 When the &%local_parts%& option on a router matches a local part by means of a
11098 lookup, the data read by the lookup is available during the running of the
11099 router as &$local_part_data$&. In addition, if the driver routes the address
11100 to a transport, the value is available in that transport. If the transport is
11101 handling multiple addresses, the value from the first address is used.
11102
11103 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11104 matches a local part by means of a lookup. The data read by the lookup is
11105 available during the rest of the ACL statement. In all other situations, this
11106 variable expands to nothing.
11107
11108 .vitem &$local_part_prefix$&
11109 .vindex "&$local_part_prefix$&"
11110 When an address is being routed or delivered, and a
11111 specific prefix for the local part was recognized, it is available in this
11112 variable, having been removed from &$local_part$&.
11113
11114 .vitem &$local_part_suffix$&
11115 .vindex "&$local_part_suffix$&"
11116 When an address is being routed or delivered, and a
11117 specific suffix for the local part was recognized, it is available in this
11118 variable, having been removed from &$local_part$&.
11119
11120 .vitem &$local_scan_data$&
11121 .vindex "&$local_scan_data$&"
11122 This variable contains the text returned by the &[local_scan()]& function when
11123 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11124
11125 .vitem &$local_user_gid$&
11126 .vindex "&$local_user_gid$&"
11127 See &$local_user_uid$&.
11128
11129 .vitem &$local_user_uid$&
11130 .vindex "&$local_user_uid$&"
11131 This variable and &$local_user_gid$& are set to the uid and gid after the
11132 &%check_local_user%& router precondition succeeds. This means that their values
11133 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11134 and &%condition%&), for the &%address_data%& expansion, and for any
11135 router-specific expansions. At all other times, the values in these variables
11136 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11137
11138 .vitem &$localhost_number$&
11139 .vindex "&$localhost_number$&"
11140 This contains the expanded value of the
11141 &%localhost_number%& option. The expansion happens after the main options have
11142 been read.
11143
11144 .vitem &$log_inodes$&
11145 .vindex "&$log_inodes$&"
11146 The number of free inodes in the disk partition where Exim's
11147 log files are being written. The value is recalculated whenever the variable is
11148 referenced. If the relevant file system does not have the concept of inodes,
11149 the value of is -1. See also the &%check_log_inodes%& option.
11150
11151 .vitem &$log_space$&
11152 .vindex "&$log_space$&"
11153 The amount of free space (as a number of kilobytes) in the disk
11154 partition where Exim's log files are being written. The value is recalculated
11155 whenever the variable is referenced. If the operating system does not have the
11156 ability to find the amount of free space (only true for experimental systems),
11157 the space value is -1. See also the &%check_log_space%& option.
11158
11159
11160 .vitem &$mailstore_basename$&
11161 .vindex "&$mailstore_basename$&"
11162 This variable is set only when doing deliveries in &"mailstore"& format in the
11163 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11164 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11165 contains the basename of the files that are being written, that is, the name
11166 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11167 variable is empty.
11168
11169 .vitem &$malware_name$&
11170 .vindex "&$malware_name$&"
11171 This variable is available when Exim is compiled with the
11172 content-scanning extension. It is set to the name of the virus that was found
11173 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11174
11175 .vitem &$max_received_linelength$&
11176 .vindex "&$max_received_linelength$&"
11177 .cindex "maximum" "line length"
11178 .cindex "line length" "maximum"
11179 This variable contains the number of bytes in the longest line that was
11180 received as part of the message, not counting the line termination
11181 character(s).
11182
11183 .vitem &$message_age$&
11184 .cindex "message" "age of"
11185 .vindex "&$message_age$&"
11186 This variable is set at the start of a delivery attempt to contain the number
11187 of seconds since the message was received. It does not change during a single
11188 delivery attempt.
11189
11190 .vitem &$message_body$&
11191 .cindex "body of message" "expansion variable"
11192 .cindex "message body" "in expansion"
11193 .cindex "binary zero" "in message body"
11194 .vindex "&$message_body$&"
11195 .oindex "&%message_body_visible%&"
11196 This variable contains the initial portion of a message's body while it is
11197 being delivered, and is intended mainly for use in filter files. The maximum
11198 number of characters of the body that are put into the variable is set by the
11199 &%message_body_visible%& configuration option; the default is 500.
11200
11201 .oindex "&%message_body_newlines%&"
11202 By default, newlines are converted into spaces in &$message_body$&, to make it
11203 easier to search for phrases that might be split over a line break. However,
11204 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11205 zeros are always converted into spaces.
11206
11207 .vitem &$message_body_end$&
11208 .cindex "body of message" "expansion variable"
11209 .cindex "message body" "in expansion"
11210 .vindex "&$message_body_end$&"
11211 This variable contains the final portion of a message's
11212 body while it is being delivered. The format and maximum size are as for
11213 &$message_body$&.
11214
11215 .vitem &$message_body_size$&
11216 .cindex "body of message" "size"
11217 .cindex "message body" "size"
11218 .vindex "&$message_body_size$&"
11219 When a message is being delivered, this variable contains the size of the body
11220 in bytes. The count starts from the character after the blank line that
11221 separates the body from the header. Newlines are included in the count. See
11222 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11223
11224 .vitem &$message_exim_id$&
11225 .vindex "&$message_exim_id$&"
11226 When a message is being received or delivered, this variable contains the
11227 unique message id that is generated and used by Exim to identify the message.
11228 An id is not created for a message until after its header has been successfully
11229 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11230 line; it is the local id that Exim assigns to the message, for example:
11231 &`1BXTIK-0001yO-VA`&.
11232
11233 .vitem &$message_headers$&
11234 .vindex &$message_headers$&
11235 This variable contains a concatenation of all the header lines when a message
11236 is being processed, except for lines added by routers or transports. The header
11237 lines are separated by newline characters. Their contents are decoded in the
11238 same way as a header line that is inserted by &%bheader%&.
11239
11240 .vitem &$message_headers_raw$&
11241 .vindex &$message_headers_raw$&
11242 This variable is like &$message_headers$& except that no processing of the
11243 contents of header lines is done.
11244
11245 .vitem &$message_id$&
11246 This is an old name for &$message_exim_id$&, which is now deprecated.
11247
11248 .vitem &$message_linecount$&
11249 .vindex "&$message_linecount$&"
11250 This variable contains the total number of lines in the header and body of the
11251 message. Compare &$body_linecount$&, which is the count for the body only.
11252 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11253 number of lines received. Before delivery happens (that is, before filters,
11254 routers, and transports run) the count is increased to include the
11255 &'Received:'& header line that Exim standardly adds, and also any other header
11256 lines that are added by ACLs. The blank line that separates the message header
11257 from the body is not counted.
11258
11259 As with the special case of &$message_size$&, during the expansion of the
11260 appendfile transport's maildir_tag option in maildir format, the value of
11261 &$message_linecount$& is the precise size of the number of newlines in the
11262 file that has been written (minus one for the blank line between the
11263 header and the body).
11264
11265 Here is an example of the use of this variable in a DATA ACL:
11266 .code
11267 deny message   = Too many lines in message header
11268      condition = \
11269       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11270 .endd
11271 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11272 message has not yet been received.
11273
11274 .vitem &$message_size$&
11275 .cindex "size" "of message"
11276 .cindex "message" "size"
11277 .vindex "&$message_size$&"
11278 When a message is being processed, this variable contains its size in bytes. In
11279 most cases, the size includes those headers that were received with the
11280 message, but not those (such as &'Envelope-to:'&) that are added to individual
11281 deliveries as they are written. However, there is one special case: during the
11282 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11283 doing a delivery in maildir format, the value of &$message_size$& is the
11284 precise size of the file that has been written. See also
11285 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11286
11287 .cindex "RCPT" "value of &$message_size$&"
11288 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11289 contains the size supplied on the MAIL command, or -1 if no size was given. The
11290 value may not, of course, be truthful.
11291
11292 .vitem &$mime_$&&'xxx'&
11293 A number of variables whose names start with &$mime$& are
11294 available when Exim is compiled with the content-scanning extension. For
11295 details, see section &<<SECTscanmimepart>>&.
11296
11297 .vitem "&$n0$& &-- &$n9$&"
11298 These variables are counters that can be incremented by means
11299 of the &%add%& command in filter files.
11300
11301 .vitem &$original_domain$&
11302 .vindex "&$domain$&"
11303 .vindex "&$original_domain$&"
11304 When a top-level address is being processed for delivery, this contains the
11305 same value as &$domain$&. However, if a &"child"& address (for example,
11306 generated by an alias, forward, or filter file) is being processed, this
11307 variable contains the domain of the original address (lower cased). This
11308 differs from &$parent_domain$& only when there is more than one level of
11309 aliasing or forwarding. When more than one address is being delivered in a
11310 single transport run, &$original_domain$& is not set.
11311
11312 If a new address is created by means of a &%deliver%& command in a system
11313 filter, it is set up with an artificial &"parent"& address. This has the local
11314 part &'system-filter'& and the default qualify domain.
11315
11316 .vitem &$original_local_part$&
11317 .vindex "&$local_part$&"
11318 .vindex "&$original_local_part$&"
11319 When a top-level address is being processed for delivery, this contains the
11320 same value as &$local_part$&, unless a prefix or suffix was removed from the
11321 local part, because &$original_local_part$& always contains the full local
11322 part. When a &"child"& address (for example, generated by an alias, forward, or
11323 filter file) is being processed, this variable contains the full local part of
11324 the original address.
11325
11326 If the router that did the redirection processed the local part
11327 case-insensitively, the value in &$original_local_part$& is in lower case.
11328 This variable differs from &$parent_local_part$& only when there is more than
11329 one level of aliasing or forwarding. When more than one address is being
11330 delivered in a single transport run, &$original_local_part$& is not set.
11331
11332 If a new address is created by means of a &%deliver%& command in a system
11333 filter, it is set up with an artificial &"parent"& address. This has the local
11334 part &'system-filter'& and the default qualify domain.
11335
11336 .vitem &$originator_gid$&
11337 .cindex "gid (group id)" "of originating user"
11338 .cindex "sender" "gid"
11339 .vindex "&$caller_gid$&"
11340 .vindex "&$originator_gid$&"
11341 This variable contains the value of &$caller_gid$& that was set when the
11342 message was received. For messages received via the command line, this is the
11343 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11344 normally the gid of the Exim user.
11345
11346 .vitem &$originator_uid$&
11347 .cindex "uid (user id)" "of originating user"
11348 .cindex "sender" "uid"
11349 .vindex "&$caller_uid$&"
11350 .vindex "&$originaltor_uid$&"
11351 The value of &$caller_uid$& that was set when the message was received. For
11352 messages received via the command line, this is the uid of the sending user.
11353 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11354 user.
11355
11356 .vitem &$parent_domain$&
11357 .vindex "&$parent_domain$&"
11358 This variable is similar to &$original_domain$& (see
11359 above), except that it refers to the immediately preceding parent address.
11360
11361 .vitem &$parent_local_part$&
11362 .vindex "&$parent_local_part$&"
11363 This variable is similar to &$original_local_part$&
11364 (see above), except that it refers to the immediately preceding parent address.
11365
11366 .vitem &$pid$&
11367 .cindex "pid (process id)" "of current process"
11368 .vindex "&$pid$&"
11369 This variable contains the current process id.
11370
11371 .vitem &$pipe_addresses$&
11372 .cindex "filter" "transport filter"
11373 .cindex "transport" "filter"
11374 .vindex "&$pipe_addresses$&"
11375 This is not an expansion variable, but is mentioned here because the string
11376 &`$pipe_addresses`& is handled specially in the command specification for the
11377 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11378 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11379 It cannot be used in general expansion strings, and provokes an &"unknown
11380 variable"& error if encountered.
11381
11382 .vitem &$primary_hostname$&
11383 .vindex "&$primary_hostname$&"
11384 This variable contains the value set by &%primary_hostname%& in the
11385 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11386 a single-component name, Exim calls &[gethostbyname()]& (or
11387 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11388 qualified host name. See also &$smtp_active_hostname$&.
11389
11390
11391 .vitem &$prvscheck_address$&
11392 This variable is used in conjunction with the &%prvscheck%& expansion item,
11393 which is described in sections &<<SECTexpansionitems>>& and
11394 &<<SECTverifyPRVS>>&.
11395
11396 .vitem &$prvscheck_keynum$&
11397 This variable is used in conjunction with the &%prvscheck%& expansion item,
11398 which is described in sections &<<SECTexpansionitems>>& and
11399 &<<SECTverifyPRVS>>&.
11400
11401 .vitem &$prvscheck_result$&
11402 This variable is used in conjunction with the &%prvscheck%& expansion item,
11403 which is described in sections &<<SECTexpansionitems>>& and
11404 &<<SECTverifyPRVS>>&.
11405
11406 .vitem &$qualify_domain$&
11407 .vindex "&$qualify_domain$&"
11408 The value set for the &%qualify_domain%& option in the configuration file.
11409
11410 .vitem &$qualify_recipient$&
11411 .vindex "&$qualify_recipient$&"
11412 The value set for the &%qualify_recipient%& option in the configuration file,
11413 or if not set, the value of &$qualify_domain$&.
11414
11415 .vitem &$rcpt_count$&
11416 .vindex "&$rcpt_count$&"
11417 When a message is being received by SMTP, this variable contains the number of
11418 RCPT commands received for the current message. If this variable is used in a
11419 RCPT ACL, its value includes the current command.
11420
11421 .vitem &$rcpt_defer_count$&
11422 .vindex "&$rcpt_defer_count$&"
11423 .cindex "4&'xx'& responses" "count of"
11424 When a message is being received by SMTP, this variable contains the number of
11425 RCPT commands in the current message that have previously been rejected with a
11426 temporary (4&'xx'&) response.
11427
11428 .vitem &$rcpt_fail_count$&
11429 .vindex "&$rcpt_fail_count$&"
11430 When a message is being received by SMTP, this variable contains the number of
11431 RCPT commands in the current message that have previously been rejected with a
11432 permanent (5&'xx'&) response.
11433
11434 .vitem &$received_count$&
11435 .vindex "&$received_count$&"
11436 This variable contains the number of &'Received:'& header lines in the message,
11437 including the one added by Exim (so its value is always greater than zero). It
11438 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11439 delivering.
11440
11441 .vitem &$received_for$&
11442 .vindex "&$received_for$&"
11443 If there is only a single recipient address in an incoming message, this
11444 variable contains that address when the &'Received:'& header line is being
11445 built. The value is copied after recipient rewriting has happened, but before
11446 the &[local_scan()]& function is run.
11447
11448 .vitem &$received_ip_address$&
11449 .vindex "&$received_ip_address$&"
11450 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11451 variable is set to the address of the local IP interface, and &$received_port$&
11452 is set to the local port number. (The remote IP address and port are in
11453 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11454 the port value is -1 unless it has been set using the &%-oMi%& command line
11455 option.
11456
11457 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11458 could be used, for example, to make the file name for a TLS certificate depend
11459 on which interface and/or port is being used for the incoming connection. The
11460 values of &$received_ip_address$& and &$received_port$& are saved with any
11461 messages that are received, thus making these variables available at delivery
11462 time.
11463
11464 &*Note:*& There are no equivalent variables for outgoing connections, because
11465 the values are unknown (unless they are explicitly set by options of the
11466 &(smtp)& transport).
11467
11468 .vitem &$received_port$&
11469 .vindex "&$received_port$&"
11470 See &$received_ip_address$&.
11471
11472 .vitem &$received_protocol$&
11473 .vindex "&$received_protocol$&"
11474 When a message is being processed, this variable contains the name of the
11475 protocol by which it was received. Most of the names used by Exim are defined
11476 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11477 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11478 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11479 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11480 connection and the client was successfully authenticated.
11481
11482 Exim uses the protocol name &"smtps"& for the case when encryption is
11483 automatically set up on connection without the use of STARTTLS (see
11484 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11485 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11486 where the client initially uses EHLO, sets up an encrypted connection using
11487 STARTTLS, and then uses HELO afterwards.
11488
11489 The &%-oMr%& option provides a way of specifying a custom protocol name for
11490 messages that are injected locally by trusted callers. This is commonly used to
11491 identify messages that are being re-injected after some kind of scanning.
11492
11493 .vitem &$received_time$&
11494 .vindex "&$received_time$&"
11495 This variable contains the date and time when the current message was received,
11496 as a number of seconds since the start of the Unix epoch.
11497
11498 .vitem &$recipient_data$&
11499 .vindex "&$recipient_data$&"
11500 This variable is set after an indexing lookup success in an ACL &%recipients%&
11501 condition. It contains the data from the lookup, and the value remains set
11502 until the next &%recipients%& test. Thus, you can do things like this:
11503 .display
11504 &`require recipients  = cdb*@;/some/file`&
11505 &`deny    `&&'some further test involving'& &`$recipient_data`&
11506 .endd
11507 &*Warning*&: This variable is set only when a lookup is used as an indexing
11508 method in the address list, using the semicolon syntax as in the example above.
11509 The variable is not set for a lookup that is used as part of the string
11510 expansion that all such lists undergo before being interpreted.
11511
11512 .vitem &$recipient_verify_failure$&
11513 .vindex "&$recipient_verify_failure$&"
11514 In an ACL, when a recipient verification fails, this variable contains
11515 information about the failure. It is set to one of the following words:
11516
11517 .ilist
11518 &"qualify"&: The address was unqualified (no domain), and the message
11519 was neither local nor came from an exempted host.
11520
11521 .next
11522 &"route"&: Routing failed.
11523
11524 .next
11525 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11526 or before the MAIL command (that is, on initial connection, HELO, or
11527 MAIL).
11528
11529 .next
11530 &"recipient"&: The RCPT command in a callout was rejected.
11531 .next
11532
11533 &"postmaster"&: The postmaster check in a callout was rejected.
11534 .endlist
11535
11536 The main use of this variable is expected to be to distinguish between
11537 rejections of MAIL and rejections of RCPT.
11538
11539 .vitem &$recipients$&
11540 .vindex "&$recipients$&"
11541 This variable contains a list of envelope recipients for a message. A comma and
11542 a space separate the addresses in the replacement text. However, the variable
11543 is not generally available, to prevent exposure of Bcc recipients in
11544 unprivileged users' filter files. You can use &$recipients$& only in these
11545 cases:
11546
11547 .olist
11548 In a system filter file.
11549 .next
11550 In the ACLs associated with the DATA command and with non-SMTP messages, that
11551 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11552 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11553 &%acl_not_smtp_mime%&.
11554 .next
11555 From within a &[local_scan()]& function.
11556 .endlist
11557
11558
11559 .vitem &$recipients_count$&
11560 .vindex "&$recipients_count$&"
11561 When a message is being processed, this variable contains the number of
11562 envelope recipients that came with the message. Duplicates are not excluded
11563 from the count. While a message is being received over SMTP, the number
11564 increases for each accepted recipient. It can be referenced in an ACL.
11565
11566
11567 .vitem &$regex_match_string$&
11568 .vindex "&$regex_match_string$&"
11569 This variable is set to contain the matching regular expression after a
11570 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11571
11572
11573 .vitem &$reply_address$&
11574 .vindex "&$reply_address$&"
11575 When a message is being processed, this variable contains the contents of the
11576 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11577 contents of the &'From:'& header line. Apart from the removal of leading
11578 white space, the value is not processed in any way. In particular, no RFC 2047
11579 decoding or character code translation takes place.
11580
11581 .vitem &$return_path$&
11582 .vindex "&$return_path$&"
11583 When a message is being delivered, this variable contains the return path &--
11584 the sender field that will be sent as part of the envelope. It is not enclosed
11585 in <> characters. At the start of routing an address, &$return_path$& has the
11586 same value as &$sender_address$&, but if, for example, an incoming message to a
11587 mailing list has been expanded by a router which specifies a different address
11588 for bounce messages, &$return_path$& subsequently contains the new bounce
11589 address, whereas &$sender_address$& always contains the original sender address
11590 that was received with the message. In other words, &$sender_address$& contains
11591 the incoming envelope sender, and &$return_path$& contains the outgoing
11592 envelope sender.
11593
11594 .vitem &$return_size_limit$&
11595 .vindex "&$return_size_limit$&"
11596 This is an obsolete name for &$bounce_return_size_limit$&.
11597
11598 .vitem &$runrc$&
11599 .cindex "return code" "from &%run%& expansion"
11600 .vindex "&$runrc$&"
11601 This variable contains the return code from a command that is run by the
11602 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11603 assume the order in which option values are expanded, except for those
11604 preconditions whose order of testing is documented. Therefore, you cannot
11605 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11606 another.
11607
11608 .vitem &$self_hostname$&
11609 .oindex "&%self%&" "value of host name"
11610 .vindex "&$self_hostname$&"
11611 When an address is routed to a supposedly remote host that turns out to be the
11612 local host, what happens is controlled by the &%self%& generic router option.
11613 One of its values causes the address to be passed to another router. When this
11614 happens, &$self_hostname$& is set to the name of the local host that the
11615 original router encountered. In other circumstances its contents are null.
11616
11617 .vitem &$sender_address$&
11618 .vindex "&$sender_address$&"
11619 When a message is being processed, this variable contains the sender's address
11620 that was received in the message's envelope. The case of letters in the address
11621 is retained, in both the local part and the domain. For bounce messages, the
11622 value of this variable is the empty string. See also &$return_path$&.
11623
11624 .vitem &$sender_address_data$&
11625 .vindex "&$address_data$&"
11626 .vindex "&$sender_address_data$&"
11627 If &$address_data$& is set when the routers are called from an ACL to verify a
11628 sender address, the final value is preserved in &$sender_address_data$&, to
11629 distinguish it from data from a recipient address. The value does not persist
11630 after the end of the current ACL statement. If you want to preserve it for
11631 longer, you can save it in an ACL variable.
11632
11633 .vitem &$sender_address_domain$&
11634 .vindex "&$sender_address_domain$&"
11635 The domain portion of &$sender_address$&.
11636
11637 .vitem &$sender_address_local_part$&
11638 .vindex "&$sender_address_local_part$&"
11639 The local part portion of &$sender_address$&.
11640
11641 .vitem &$sender_data$&
11642 .vindex "&$sender_data$&"
11643 This variable is set after a lookup success in an ACL &%senders%& condition or
11644 in a router &%senders%& option. It contains the data from the lookup, and the
11645 value remains set until the next &%senders%& test. Thus, you can do things like
11646 this:
11647 .display
11648 &`require senders      = cdb*@;/some/file`&
11649 &`deny    `&&'some further test involving'& &`$sender_data`&
11650 .endd
11651 &*Warning*&: This variable is set only when a lookup is used as an indexing
11652 method in the address list, using the semicolon syntax as in the example above.
11653 The variable is not set for a lookup that is used as part of the string
11654 expansion that all such lists undergo before being interpreted.
11655
11656 .vitem &$sender_fullhost$&
11657 .vindex "&$sender_fullhost$&"
11658 When a message is received from a remote host, this variable contains the host
11659 name and IP address in a single string. It ends with the IP address in square
11660 brackets, followed by a colon and a port number if the logging of ports is
11661 enabled. The format of the rest of the string depends on whether the host
11662 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11663 looking up its IP address. (Looking up the IP address can be forced by the
11664 &%host_lookup%& option, independent of verification.) A plain host name at the
11665 start of the string is a verified host name; if this is not present,
11666 verification either failed or was not requested. A host name in parentheses is
11667 the argument of a HELO or EHLO command. This is omitted if it is identical to
11668 the verified host name or to the host's IP address in square brackets.
11669
11670 .vitem &$sender_helo_name$&
11671 .vindex "&$sender_helo_name$&"
11672 When a message is received from a remote host that has issued a HELO or EHLO
11673 command, the argument of that command is placed in this variable. It is also
11674 set if HELO or EHLO is used when a message is received using SMTP locally via
11675 the &%-bs%& or &%-bS%& options.
11676
11677 .vitem &$sender_host_address$&
11678 .vindex "&$sender_host_address$&"
11679 When a message is received from a remote host, this variable contains that
11680 host's IP address. For locally submitted messages, it is empty.
11681
11682 .vitem &$sender_host_authenticated$&
11683 .vindex "&$sender_host_authenticated$&"
11684 This variable contains the name (not the public name) of the authenticator
11685 driver that successfully authenticated the client from which the message was
11686 received. It is empty if there was no successful authentication. See also
11687 &$authenticated_id$&.
11688
11689 .vitem &$sender_host_name$&
11690 .vindex "&$sender_host_name$&"
11691 When a message is received from a remote host, this variable contains the
11692 host's name as obtained by looking up its IP address. For messages received by
11693 other means, this variable is empty.
11694
11695 .vindex "&$host_lookup_failed$&"
11696 If the host name has not previously been looked up, a reference to
11697 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11698 A looked up name is accepted only if it leads back to the original IP address
11699 via a forward lookup. If either the reverse or the forward lookup fails to find
11700 any data, or if the forward lookup does not yield the original IP address,
11701 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11702
11703 .vindex "&$host_lookup_deferred$&"
11704 However, if either of the lookups cannot be completed (for example, there is a
11705 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11706 &$host_lookup_failed$& remains set to &"0"&.
11707
11708 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11709 host name again if there is a subsequent reference to &$sender_host_name$&
11710 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11711 is set to &"1"&.
11712
11713 Exim does not automatically look up every calling host's name. If you want
11714 maximum efficiency, you should arrange your configuration so that it avoids
11715 these lookups altogether. The lookup happens only if one or more of the
11716 following are true:
11717
11718 .ilist
11719 A string containing &$sender_host_name$& is expanded.
11720 .next
11721 The calling host matches the list in &%host_lookup%&. In the default
11722 configuration, this option is set to *, so it must be changed if lookups are
11723 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11724 .next
11725 Exim needs the host name in order to test an item in a host list. The items
11726 that require this are described in sections &<<SECThoslispatnam>>& and
11727 &<<SECThoslispatnamsk>>&.
11728 .next
11729 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11730 In this case, the host name is required to compare with the name quoted in any
11731 EHLO or HELO commands that the client issues.
11732 .next
11733 The remote host issues a EHLO or HELO command that quotes one of the
11734 domains in &%helo_lookup_domains%&. The default value of this option is
11735 . ==== As this is a nested list, any displays it contains must be indented
11736 . ==== as otherwise they are too far to the left.
11737 .code
11738   helo_lookup_domains = @ : @[]
11739 .endd
11740 which causes a lookup if a remote host (incorrectly) gives the server's name or
11741 IP address in an EHLO or HELO command.
11742 .endlist
11743
11744
11745 .vitem &$sender_host_port$&
11746 .vindex "&$sender_host_port$&"
11747 When a message is received from a remote host, this variable contains the port
11748 number that was used on the remote host.
11749
11750 .vitem &$sender_ident$&
11751 .vindex "&$sender_ident$&"
11752 When a message is received from a remote host, this variable contains the
11753 identification received in response to an RFC 1413 request. When a message has
11754 been received locally, this variable contains the login name of the user that
11755 called Exim.
11756
11757 .vitem &$sender_rate_$&&'xxx'&
11758 A number of variables whose names begin &$sender_rate_$& are set as part of the
11759 &%ratelimit%& ACL condition. Details are given in section
11760 &<<SECTratelimiting>>&.
11761
11762 .vitem &$sender_rcvhost$&
11763 .cindex "DNS" "reverse lookup"
11764 .cindex "reverse DNS lookup"
11765 .vindex "&$sender_rcvhost$&"
11766 This is provided specifically for use in &'Received:'& headers. It starts with
11767 either the verified host name (as obtained from a reverse DNS lookup) or, if
11768 there is no verified host name, the IP address in square brackets. After that
11769 there may be text in parentheses. When the first item is a verified host name,
11770 the first thing in the parentheses is the IP address in square brackets,
11771 followed by a colon and a port number if port logging is enabled. When the
11772 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11773 the parentheses.
11774
11775 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11776 was used and its argument was not identical to the real host name or IP
11777 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11778 all three items are present in the parentheses, a newline and tab are inserted
11779 into the string, to improve the formatting of the &'Received:'& header.
11780
11781 .vitem &$sender_verify_failure$&
11782 .vindex "&$sender_verify_failure$&"
11783 In an ACL, when a sender verification fails, this variable contains information
11784 about the failure. The details are the same as for
11785 &$recipient_verify_failure$&.
11786
11787 .vitem &$sending_ip_address$&
11788 .vindex "&$sending_ip_address$&"
11789 This variable is set whenever an outgoing SMTP connection to another host has
11790 been set up. It contains the IP address of the local interface that is being
11791 used. This is useful if a host that has more than one IP address wants to take
11792 on different personalities depending on which one is being used. For incoming
11793 connections, see &$received_ip_address$&.
11794
11795 .vitem &$sending_port$&
11796 .vindex "&$sending_port$&"
11797 This variable is set whenever an outgoing SMTP connection to another host has
11798 been set up. It contains the local port that is being used. For incoming
11799 connections, see &$received_port$&.
11800
11801 .vitem &$smtp_active_hostname$&
11802 .vindex "&$smtp_active_hostname$&"
11803 During an incoming SMTP session, this variable contains the value of the active
11804 host name, as specified by the &%smtp_active_hostname%& option. The value of
11805 &$smtp_active_hostname$& is saved with any message that is received, so its
11806 value can be consulted during routing and delivery.
11807
11808 .vitem &$smtp_command$&
11809 .vindex "&$smtp_command$&"
11810 During the processing of an incoming SMTP command, this variable contains the
11811 entire command. This makes it possible to distinguish between HELO and EHLO in
11812 the HELO ACL, and also to distinguish between commands such as these:
11813 .code
11814 MAIL FROM:<>
11815 MAIL FROM: <>
11816 .endd
11817 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11818 command, the address in &$smtp_command$& is the original address before any
11819 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11820 the address after SMTP-time rewriting.
11821
11822 .vitem &$smtp_command_argument$&
11823 .cindex "SMTP" "command, argument for"
11824 .vindex "&$smtp_command_argument$&"
11825 While an ACL is running to check an SMTP command, this variable contains the
11826 argument, that is, the text that follows the command name, with leading white
11827 space removed. Following the introduction of &$smtp_command$&, this variable is
11828 somewhat redundant, but is retained for backwards compatibility.
11829
11830 .vitem &$smtp_count_at_connection_start$&
11831 .vindex "&$smtp_count_at_connection_start$&"
11832 This variable is set greater than zero only in processes spawned by the Exim
11833 daemon for handling incoming SMTP connections. The name is deliberately long,
11834 in order to emphasize what the contents are. When the daemon accepts a new
11835 connection, it increments this variable. A copy of the variable is passed to
11836 the child process that handles the connection, but its value is fixed, and
11837 never changes. It is only an approximation of how many incoming connections
11838 there actually are, because many other connections may come and go while a
11839 single connection is being processed. When a child process terminates, the
11840 daemon decrements its copy of the variable.
11841
11842 .vitem "&$sn0$& &-- &$sn9$&"
11843 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11844 that were current at the end of the system filter file. This allows a system
11845 filter file to set values that can be tested in users' filter files. For
11846 example, a system filter could set a value indicating how likely it is that a
11847 message is junk mail.
11848
11849 .vitem &$spam_$&&'xxx'&
11850 A number of variables whose names start with &$spam$& are available when Exim
11851 is compiled with the content-scanning extension. For details, see section
11852 &<<SECTscanspamass>>&.
11853
11854
11855 .vitem &$spool_directory$&
11856 .vindex "&$spool_directory$&"
11857 The name of Exim's spool directory.
11858
11859 .vitem &$spool_inodes$&
11860 .vindex "&$spool_inodes$&"
11861 The number of free inodes in the disk partition where Exim's spool files are
11862 being written. The value is recalculated whenever the variable is referenced.
11863 If the relevant file system does not have the concept of inodes, the value of
11864 is -1. See also the &%check_spool_inodes%& option.
11865
11866 .vitem &$spool_space$&
11867 .vindex "&$spool_space$&"
11868 The amount of free space (as a number of kilobytes) in the disk partition where
11869 Exim's spool files are being written. The value is recalculated whenever the
11870 variable is referenced. If the operating system does not have the ability to
11871 find the amount of free space (only true for experimental systems), the space
11872 value is -1. For example, to check in an ACL that there is at least 50
11873 megabytes free on the spool, you could write:
11874 .code
11875 condition = ${if > {$spool_space}{50000}}
11876 .endd
11877 See also the &%check_spool_space%& option.
11878
11879
11880 .vitem &$thisaddress$&
11881 .vindex "&$thisaddress$&"
11882 This variable is set only during the processing of the &%foranyaddress%&
11883 command in a filter file. Its use is explained in the description of that
11884 command, which can be found in the separate document entitled &'Exim's
11885 interfaces to mail filtering'&.
11886
11887 .new
11888 .vitem &$tls_bits$&
11889 .vindex "&$tls_bits$&"
11890 Contains an approximation of the TLS cipher's bit-strength; the meaning of
11891 this depends upon the TLS implementation used.
11892 If TLS has not been negotiated, the value will be 0.
11893 The value of this is automatically fed into the Cyrus SASL authenticator
11894 when acting as a server, to specify the "external SSF" (a SASL term).
11895 .wen
11896
11897 .vitem &$tls_certificate_verified$&
11898 .vindex "&$tls_certificate_verified$&"
11899 This variable is set to &"1"& if a TLS certificate was verified when the
11900 message was received, and &"0"& otherwise.
11901
11902 .vitem &$tls_cipher$&
11903 .vindex "&$tls_cipher$&"
11904 When a message is received from a remote host over an encrypted SMTP
11905 connection, this variable is set to the cipher suite that was negotiated, for
11906 example DES-CBC3-SHA. In other circumstances, in particular, for message
11907 received over unencrypted connections, the variable is empty. Testing
11908 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11909 non-encrypted connections during ACL processing.
11910
11911 The &$tls_cipher$& variable retains its value during message delivery, except
11912 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11913 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11914 and then set to the outgoing cipher suite if one is negotiated. See chapter
11915 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11916 details of the &(smtp)& transport.
11917
11918 .vitem &$tls_peerdn$&
11919 .vindex "&$tls_peerdn$&"
11920 When a message is received from a remote host over an encrypted SMTP
11921 connection, and Exim is configured to request a certificate from the client,
11922 the value of the Distinguished Name of the certificate is made available in the
11923 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11924 value is retained during message delivery, except during outbound SMTP
11925 deliveries.
11926
11927 .new
11928 .vitem &$tls_sni$&
11929 .vindex "&$tls_sni$&"
11930 .cindex "TLS" "Server Name Indication"
11931 When a TLS session is being established, if the client sends the Server
11932 Name Indication extension, the value will be placed in this variable.
11933 If the variable appears in &%tls_certificate%& then this option and
11934 some others, described in &<<SECTtlssni>>&,
11935 will be re-expanded early in the TLS session, to permit
11936 a different certificate to be presented (and optionally a different key to be
11937 used) to the client, based upon the value of the SNI extension.
11938
11939 The value will be retained for the lifetime of the message.  During outbound
11940 SMTP deliveries, it reflects the value of the &%tls_sni%& option on
11941 the transport.
11942 .wen
11943
11944 .vitem &$tod_bsdinbox$&
11945 .vindex "&$tod_bsdinbox$&"
11946 The time of day and the date, in the format required for BSD-style mailbox
11947 files, for example: Thu Oct 17 17:14:09 1995.
11948
11949 .vitem &$tod_epoch$&
11950 .vindex "&$tod_epoch$&"
11951 The time and date as a number of seconds since the start of the Unix epoch.
11952
11953 .vitem &$tod_epoch_l$&
11954 .vindex "&$tod_epoch_l$&"
11955 The time and date as a number of microseconds since the start of the Unix epoch.
11956
11957 .vitem &$tod_full$&
11958 .vindex "&$tod_full$&"
11959 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11960 +0100. The timezone is always given as a numerical offset from UTC, with
11961 positive values used for timezones that are ahead (east) of UTC, and negative
11962 values for those that are behind (west).
11963
11964 .vitem &$tod_log$&
11965 .vindex "&$tod_log$&"
11966 The time and date in the format used for writing Exim's log files, for example:
11967 1995-10-12 15:32:29, but without a timezone.
11968
11969 .vitem &$tod_logfile$&
11970 .vindex "&$tod_logfile$&"
11971 This variable contains the date in the format yyyymmdd. This is the format that
11972 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11973 flag.
11974
11975 .vitem &$tod_zone$&
11976 .vindex "&$tod_zone$&"
11977 This variable contains the numerical value of the local timezone, for example:
11978 -0500.
11979
11980 .vitem &$tod_zulu$&
11981 .vindex "&$tod_zulu$&"
11982 This variable contains the UTC date and time in &"Zulu"& format, as specified
11983 by ISO 8601, for example: 20030221154023Z.
11984
11985 .vitem &$value$&
11986 .vindex "&$value$&"
11987 This variable contains the result of an expansion lookup, extraction operation,
11988 or external command, as described above. It is also used during a
11989 &*reduce*& expansion.
11990
11991 .vitem &$version_number$&
11992 .vindex "&$version_number$&"
11993 The version number of Exim.
11994
11995 .vitem &$warn_message_delay$&
11996 .vindex "&$warn_message_delay$&"
11997 This variable is set only during the creation of a message warning about a
11998 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11999
12000 .vitem &$warn_message_recipients$&
12001 .vindex "&$warn_message_recipients$&"
12002 This variable is set only during the creation of a message warning about a
12003 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12004 .endlist
12005 .ecindex IIDstrexp
12006
12007
12008
12009 . ////////////////////////////////////////////////////////////////////////////
12010 . ////////////////////////////////////////////////////////////////////////////
12011
12012 .chapter "Embedded Perl" "CHAPperl"
12013 .scindex IIDperl "Perl" "calling from Exim"
12014 Exim can be built to include an embedded Perl interpreter. When this is done,
12015 Perl subroutines can be called as part of the string expansion process. To make
12016 use of the Perl support, you need version 5.004 or later of Perl installed on
12017 your system. To include the embedded interpreter in the Exim binary, include
12018 the line
12019 .code
12020 EXIM_PERL = perl.o
12021 .endd
12022 in your &_Local/Makefile_& and then build Exim in the normal way.
12023
12024
12025 .section "Setting up so Perl can be used" "SECID85"
12026 .oindex "&%perl_startup%&"
12027 Access to Perl subroutines is via a global configuration option called
12028 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12029 no &%perl_startup%& option in the Exim configuration file then no Perl
12030 interpreter is started and there is almost no overhead for Exim (since none of
12031 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12032 option then the associated value is taken to be Perl code which is executed in
12033 a newly created Perl interpreter.
12034
12035 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12036 need backslashes before any characters to escape special meanings. The option
12037 should usually be something like
12038 .code
12039 perl_startup = do '/etc/exim.pl'
12040 .endd
12041 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12042 use from Exim. Exim can be configured either to start up a Perl interpreter as
12043 soon as it is entered, or to wait until the first time it is needed. Starting
12044 the interpreter at the beginning ensures that it is done while Exim still has
12045 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12046 fact used in a particular run. Also, note that this does not mean that Exim is
12047 necessarily running as root when Perl is called at a later time. By default,
12048 the interpreter is started only when it is needed, but this can be changed in
12049 two ways:
12050
12051 .ilist
12052 .oindex "&%perl_at_start%&"
12053 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12054 a startup when Exim is entered.
12055 .next
12056 The command line option &%-ps%& also requests a startup when Exim is entered,
12057 overriding the setting of &%perl_at_start%&.
12058 .endlist
12059
12060 There is also a command line option &%-pd%& (for delay) which suppresses the
12061 initial startup, even if &%perl_at_start%& is set.
12062
12063
12064 .section "Calling Perl subroutines" "SECID86"
12065 When the configuration file includes a &%perl_startup%& option you can make use
12066 of the string expansion item to call the Perl subroutines that are defined
12067 by the &%perl_startup%& code. The operator is used in any of the following
12068 forms:
12069 .code
12070 ${perl{foo}}
12071 ${perl{foo}{argument}}
12072 ${perl{foo}{argument1}{argument2} ... }
12073 .endd
12074 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12075 arguments may be passed. Passing more than this results in an expansion failure
12076 with an error message of the form
12077 .code
12078 Too many arguments passed to Perl subroutine "foo" (max is 8)
12079 .endd
12080 The return value of the Perl subroutine is evaluated in a scalar context before
12081 it is passed back to Exim to be inserted into the expanded string. If the
12082 return value is &'undef'&, the expansion is forced to fail in the same way as
12083 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12084 by obeying Perl's &%die%& function, the expansion fails with the error message
12085 that was passed to &%die%&.
12086
12087
12088 .section "Calling Exim functions from Perl" "SECID87"
12089 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12090 is available to call back into Exim's string expansion function. For example,
12091 the Perl code
12092 .code
12093 my $lp = Exim::expand_string('$local_part');
12094 .endd
12095 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12096 Note those are single quotes and not double quotes to protect against
12097 &$local_part$& being interpolated as a Perl variable.
12098
12099 If the string expansion is forced to fail by a &"fail"& item, the result of
12100 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12101 expansion string, the Perl call from the original expansion string fails with
12102 an appropriate error message, in the same way as if &%die%& were used.
12103
12104 .cindex "debugging" "from embedded Perl"
12105 .cindex "log" "writing from embedded Perl"
12106 Two other Exim functions are available for use from within Perl code.
12107 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12108 debugging is enabled. If you want a newline at the end, you must supply it.
12109 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12110 timestamp. In this case, you should not supply a terminating newline.
12111
12112
12113 .section "Use of standard output and error by Perl" "SECID88"
12114 .cindex "Perl" "standard output and error"
12115 You should not write to the standard error or output streams from within your
12116 Perl code, as it is not defined how these are set up. In versions of Exim
12117 before 4.50, it is possible for the standard output or error to refer to the
12118 SMTP connection during message reception via the daemon. Writing to this stream
12119 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12120 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12121 avoided, but the output is lost.
12122
12123 .cindex "Perl" "use of &%warn%&"
12124 The Perl &%warn%& statement writes to the standard error stream by default.
12125 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12126 you have no control. When Exim starts up the Perl interpreter, it arranges for
12127 output from the &%warn%& statement to be written to the Exim main log. You can
12128 change this by including appropriate Perl magic somewhere in your Perl code.
12129 For example, to discard &%warn%& output completely, you need this:
12130 .code
12131 $SIG{__WARN__} = sub { };
12132 .endd
12133 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12134 example, the code for the subroutine is empty, so it does nothing, but you can
12135 include any Perl code that you like. The text of the &%warn%& message is passed
12136 as the first subroutine argument.
12137 .ecindex IIDperl
12138
12139
12140 . ////////////////////////////////////////////////////////////////////////////
12141 . ////////////////////////////////////////////////////////////////////////////
12142
12143 .chapter "Starting the daemon and the use of network interfaces" &&&
12144          "CHAPinterfaces" &&&
12145          "Starting the daemon"
12146 .cindex "daemon" "starting"
12147 .cindex "interface" "listening"
12148 .cindex "network interface"
12149 .cindex "interface" "network"
12150 .cindex "IP address" "for listening"
12151 .cindex "daemon" "listening IP addresses"
12152 .cindex "TCP/IP" "setting listening interfaces"
12153 .cindex "TCP/IP" "setting listening ports"
12154 A host that is connected to a TCP/IP network may have one or more physical
12155 hardware network interfaces. Each of these interfaces may be configured as one
12156 or more &"logical"& interfaces, which are the entities that a program actually
12157 works with. Each of these logical interfaces is associated with an IP address.
12158 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12159 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12160 knowledge about the host's interfaces for use in three different circumstances:
12161
12162 .olist
12163 When a listening daemon is started, Exim needs to know which interfaces
12164 and ports to listen on.
12165 .next
12166 When Exim is routing an address, it needs to know which IP addresses
12167 are associated with local interfaces. This is required for the correct
12168 processing of MX lists by removing the local host and others with the
12169 same or higher priority values. Also, Exim needs to detect cases
12170 when an address is routed to an IP address that in fact belongs to the
12171 local host. Unless the &%self%& router option or the &%allow_localhost%&
12172 option of the smtp transport is set (as appropriate), this is treated
12173 as an error situation.
12174 .next
12175 When Exim connects to a remote host, it may need to know which interface to use
12176 for the outgoing connection.
12177 .endlist
12178
12179
12180 Exim's default behaviour is likely to be appropriate in the vast majority
12181 of cases. If your host has only one interface, and you want all its IP
12182 addresses to be treated in the same way, and you are using only the
12183 standard SMTP port, you should not need to take any special action. The
12184 rest of this chapter does not apply to you.
12185
12186 In a more complicated situation you may want to listen only on certain
12187 interfaces, or on different ports, and for this reason there are a number of
12188 options that can be used to influence Exim's behaviour. The rest of this
12189 chapter describes how they operate.
12190
12191 When a message is received over TCP/IP, the interface and port that were
12192 actually used are set in &$received_ip_address$& and &$received_port$&.
12193
12194
12195
12196 .section "Starting a listening daemon" "SECID89"
12197 When a listening daemon is started (by means of the &%-bd%& command line
12198 option), the interfaces and ports on which it listens are controlled by the
12199 following options:
12200
12201 .ilist
12202 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12203 compatibility, this option can also be specified in the singular.)
12204 .next
12205 &%local_interfaces%& contains list of interface IP addresses on which to
12206 listen. Each item may optionally also specify a port.
12207 .endlist
12208
12209 The default list separator in both cases is a colon, but this can be changed as
12210 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12211 it is usually best to change the separator to avoid having to double all the
12212 colons. For example:
12213 .code
12214 local_interfaces = <; 127.0.0.1 ; \
12215                       192.168.23.65 ; \
12216                       ::1 ; \
12217                       3ffe:ffff:836f::fe86:a061
12218 .endd
12219 There are two different formats for specifying a port along with an IP address
12220 in &%local_interfaces%&:
12221
12222 .olist
12223 The port is added onto the address with a dot separator. For example, to listen
12224 on port 1234 on two different IP addresses:
12225 .code
12226 local_interfaces = <; 192.168.23.65.1234 ; \
12227                       3ffe:ffff:836f::fe86:a061.1234
12228 .endd
12229 .next
12230 The IP address is enclosed in square brackets, and the port is added
12231 with a colon separator, for example:
12232 .code
12233 local_interfaces = <; [192.168.23.65]:1234 ; \
12234                       [3ffe:ffff:836f::fe86:a061]:1234
12235 .endd
12236 .endlist
12237
12238 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12239 default setting contains just one port:
12240 .code
12241 daemon_smtp_ports = smtp
12242 .endd
12243 If more than one port is listed, each interface that does not have its own port
12244 specified listens on all of them. Ports that are listed in
12245 &%daemon_smtp_ports%& can be identified either by name (defined in
12246 &_/etc/services_&) or by number. However, when ports are given with individual
12247 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12248
12249
12250
12251 .section "Special IP listening addresses" "SECID90"
12252 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12253 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12254 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12255 instead of setting up separate listening sockets for each interface. The
12256 default value of &%local_interfaces%& is
12257 .code
12258 local_interfaces = 0.0.0.0
12259 .endd
12260 when Exim is built without IPv6 support; otherwise it is:
12261 .code
12262 local_interfaces = <; ::0 ; 0.0.0.0
12263 .endd
12264 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12265
12266
12267
12268 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12269 The &%-oX%& command line option can be used to override the values of
12270 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12271 instance. Another way of doing this would be to use macros and the &%-D%&
12272 option. However, &%-oX%& can be used by any admin user, whereas modification of
12273 the runtime configuration by &%-D%& is allowed only when the caller is root or
12274 exim.
12275
12276 The value of &%-oX%& is a list of items. The default colon separator can be
12277 changed in the usual way if required. If there are any items that do not
12278 contain dots or colons (that is, are not IP addresses), the value of
12279 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12280 items that do contain dots or colons, the value of &%local_interfaces%& is
12281 replaced by those items. Thus, for example,
12282 .code
12283 -oX 1225
12284 .endd
12285 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12286 whereas
12287 .code
12288 -oX 192.168.34.5.1125
12289 .endd
12290 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12291 (However, since &%local_interfaces%& now contains no items without ports, the
12292 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12293
12294
12295
12296 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12297 .cindex "ssmtp protocol"
12298 .cindex "smtps protocol"
12299 .cindex "SMTP" "ssmtp protocol"
12300 .cindex "SMTP" "smtps protocol"
12301 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12302 before the STARTTLS command was standardized for SMTP. Some legacy clients
12303 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12304 list of port numbers, connections to those ports must use SSMTP. The most
12305 common use of this option is expected to be
12306 .code
12307 tls_on_connect_ports = 465
12308 .endd
12309 because 465 is the usual port number used by the legacy clients. There is also
12310 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12311 this way when a daemon is started.
12312
12313 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12314 daemon to listen on those ports. You must still specify them in
12315 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12316 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12317 connections via the daemon.)
12318
12319
12320
12321
12322 .section "IPv6 address scopes" "SECID92"
12323 .cindex "IPv6" "address scopes"
12324 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12325 can, in principle, have the same link-local IPv6 address on different
12326 interfaces. Thus, additional information is needed, over and above the IP
12327 address, to distinguish individual interfaces. A convention of using a
12328 percent sign followed by something (often the interface name) has been
12329 adopted in some cases, leading to addresses like this:
12330 .code
12331 fe80::202:b3ff:fe03:45c1%eth0
12332 .endd
12333 To accommodate this usage, a percent sign followed by an arbitrary string is
12334 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12335 to convert a textual IPv6 address for actual use. This function recognizes the
12336 percent convention in operating systems that support it, and it processes the
12337 address appropriately. Unfortunately, some older libraries have problems with
12338 &[getaddrinfo()]&. If
12339 .code
12340 IPV6_USE_INET_PTON=yes
12341 .endd
12342 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12343 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12344 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12345 function.) Of course, this means that the additional functionality of
12346 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12347
12348 .section "Disabling IPv6" "SECID93"
12349 .cindex "IPv6" "disabling"
12350 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12351 run on a host whose kernel does not support IPv6. The binary will fall back to
12352 using IPv4, but it may waste resources looking up AAAA records, and trying to
12353 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12354 .oindex "&%disable_ipv6%&"
12355 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12356 activities take place. AAAA records are never looked up, and any IPv6 addresses
12357 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12358 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12359 to handle IPv6 literal addresses.
12360
12361 On the other hand, when IPv6 is in use, there may be times when you want to
12362 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12363 option to globally suppress the lookup of AAAA records for specified domains,
12364 and you can use the &%ignore_target_hosts%& generic router option to ignore
12365 IPv6 addresses in an individual router.
12366
12367
12368
12369 .section "Examples of starting a listening daemon" "SECID94"
12370 The default case in an IPv6 environment is
12371 .code
12372 daemon_smtp_ports = smtp
12373 local_interfaces = <; ::0 ; 0.0.0.0
12374 .endd
12375 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12376 Either one or two sockets may be used, depending on the characteristics of
12377 the TCP/IP stack. (This is complicated and messy; for more information,
12378 read the comments in the &_daemon.c_& source file.)
12379
12380 To specify listening on ports 25 and 26 on all interfaces:
12381 .code
12382 daemon_smtp_ports = 25 : 26
12383 .endd
12384 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12385 .code
12386 local_interfaces = <; ::0.25     ; ::0.26 \
12387                       0.0.0.0.25 ; 0.0.0.0.26
12388 .endd
12389 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12390 IPv4 loopback address only:
12391 .code
12392 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12393 .endd
12394 To specify listening on the default port on specific interfaces only:
12395 .code
12396 local_interfaces = 192.168.34.67 : 192.168.34.67
12397 .endd
12398 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12399
12400
12401
12402 .section "Recognizing the local host" "SECTreclocipadd"
12403 The &%local_interfaces%& option is also used when Exim needs to determine
12404 whether or not an IP address refers to the local host. That is, the IP
12405 addresses of all the interfaces on which a daemon is listening are always
12406 treated as local.
12407
12408 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12409 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12410 available interfaces from the operating system, and extracts the relevant
12411 (that is, IPv4 or IPv6) addresses to use for checking.
12412
12413 Some systems set up large numbers of virtual interfaces in order to provide
12414 many virtual web servers. In this situation, you may want to listen for
12415 email on only a few of the available interfaces, but nevertheless treat all
12416 interfaces as local when routing. You can do this by setting
12417 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12418 &"all"& wildcard values. These addresses are recognized as local, but are not
12419 used for listening. Consider this example:
12420 .code
12421 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12422                       192.168.53.235 ; \
12423                       3ffe:2101:12:1:a00:20ff:fe86:a061
12424
12425 extra_local_interfaces = <; ::0 ; 0.0.0.0
12426 .endd
12427 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12428 address, but all available interface addresses are treated as local when
12429 Exim is routing.
12430
12431 In some environments the local host name may be in an MX list, but with an IP
12432 address that is not assigned to any local interface. In other cases it may be
12433 desirable to treat other host names as if they referred to the local host. Both
12434 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12435 This contains host names rather than IP addresses. When a host is referenced
12436 during routing, either via an MX record or directly, it is treated as the local
12437 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12438 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12439
12440
12441
12442 .section "Delivering to a remote host" "SECID95"
12443 Delivery to a remote host is handled by the smtp transport. By default, it
12444 allows the system's TCP/IP functions to choose which interface to use (if
12445 there is more than one) when connecting to a remote host. However, the
12446 &%interface%& option can be set to specify which interface is used. See the
12447 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12448 details.
12449
12450
12451
12452
12453 . ////////////////////////////////////////////////////////////////////////////
12454 . ////////////////////////////////////////////////////////////////////////////
12455
12456 .chapter "Main configuration" "CHAPmainconfig"
12457 .scindex IIDconfima "configuration file" "main section"
12458 .scindex IIDmaiconf "main configuration"
12459 The first part of the run time configuration file contains three types of item:
12460
12461 .ilist
12462 Macro definitions: These lines start with an upper case letter. See section
12463 &<<SECTmacrodefs>>& for details of macro processing.
12464 .next
12465 Named list definitions: These lines start with one of the words &"domainlist"&,
12466 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12467 section &<<SECTnamedlists>>&.
12468 .next
12469 Main configuration settings: Each setting occupies one line of the file
12470 (with possible continuations). If any setting is preceded by the word
12471 &"hide"&, the &%-bP%& command line option displays its value to admin users
12472 only. See section &<<SECTcos>>& for a description of the syntax of these option
12473 settings.
12474 .endlist
12475
12476 This chapter specifies all the main configuration options, along with their
12477 types and default values. For ease of finding a particular option, they appear
12478 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12479 are now so many options, they are first listed briefly in functional groups, as
12480 an aid to finding the name of the option you are looking for. Some options are
12481 listed in more than one group.
12482
12483 .section "Miscellaneous" "SECID96"
12484 .table2
12485 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12486 .row &%disable_ipv6%&                "do no IPv6 processing"
12487 .row &%keep_malformed%&              "for broken files &-- should not happen"
12488 .row &%localhost_number%&            "for unique message ids in clusters"
12489 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12490 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12491 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12492 .row &%print_topbitchars%&           "top-bit characters are printing"
12493 .row &%timezone%&                    "force time zone"
12494 .endtable
12495
12496
12497 .section "Exim parameters" "SECID97"
12498 .table2
12499 .row &%exim_group%&                  "override compiled-in value"
12500 .row &%exim_path%&                   "override compiled-in value"
12501 .row &%exim_user%&                   "override compiled-in value"
12502 .row &%primary_hostname%&            "default from &[uname()]&"
12503 .row &%split_spool_directory%&       "use multiple directories"
12504 .row &%spool_directory%&             "override compiled-in value"
12505 .endtable
12506
12507
12508
12509 .section "Privilege controls" "SECID98"
12510 .table2
12511 .row &%admin_groups%&                "groups that are Exim admin users"
12512 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12513 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12514 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12515 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12516 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12517 .row &%never_users%&                 "do not run deliveries as these"
12518 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12519 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12520 .row &%trusted_groups%&              "groups that are trusted"
12521 .row &%trusted_users%&               "users that are trusted"
12522 .endtable
12523
12524
12525
12526 .section "Logging" "SECID99"
12527 .table2
12528 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12529 .row &%log_file_path%&               "override compiled-in value"
12530 .row &%log_selector%&                "set/unset optional logging"
12531 .row &%log_timezone%&                "add timezone to log lines"
12532 .row &%message_logs%&                "create per-message logs"
12533 .row &%preserve_message_logs%&       "after message completion"
12534 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12535 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12536 .row &%syslog_facility%&             "set syslog &""facility""& field"
12537 .row &%syslog_processname%&          "set syslog &""ident""& field"
12538 .row &%syslog_timestamp%&            "timestamp syslog lines"
12539 .row &%write_rejectlog%&             "control use of message log"
12540 .endtable
12541
12542
12543
12544 .section "Frozen messages" "SECID100"
12545 .table2
12546 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12547 .row &%freeze_tell%&                 "send message when freezing"
12548 .row &%move_frozen_messages%&        "to another directory"
12549 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12550 .endtable
12551
12552
12553
12554 .section "Data lookups" "SECID101"
12555 .table2
12556 .row &%ibase_servers%&               "InterBase servers"
12557 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12558 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12559 .row &%ldap_cert_file%&              "client cert file for LDAP"
12560 .row &%ldap_cert_key%&               "client key file for LDAP"
12561 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12562 .row &%ldap_default_servers%&        "used if no server in query"
12563 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12564 .row &%ldap_start_tls%&              "require TLS within LDAP"
12565 .row &%ldap_version%&                "set protocol version"
12566 .row &%lookup_open_max%&             "lookup files held open"
12567 .row &%mysql_servers%&               "default MySQL servers"
12568 .row &%oracle_servers%&              "Oracle servers"
12569 .row &%pgsql_servers%&               "default PostgreSQL servers"
12570 .row &%sqlite_lock_timeout%&         "as it says"
12571 .endtable
12572
12573
12574
12575 .section "Message ids" "SECID102"
12576 .table2
12577 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12578 .row &%message_id_header_text%&      "ditto"
12579 .endtable
12580
12581
12582
12583 .section "Embedded Perl Startup" "SECID103"
12584 .table2
12585 .row &%perl_at_start%&               "always start the interpreter"
12586 .row &%perl_startup%&                "code to obey when starting Perl"
12587 .endtable
12588
12589
12590
12591 .section "Daemon" "SECID104"
12592 .table2
12593 .row &%daemon_smtp_ports%&           "default ports"
12594 .row &%daemon_startup_retries%&      "number of times to retry"
12595 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12596 .row &%extra_local_interfaces%&      "not necessarily listened on"
12597 .row &%local_interfaces%&            "on which to listen, with optional ports"
12598 .row &%pid_file_path%&               "override compiled-in value"
12599 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12600 .endtable
12601
12602
12603
12604 .section "Resource control" "SECID105"
12605 .table2
12606 .row &%check_log_inodes%&            "before accepting a message"
12607 .row &%check_log_space%&             "before accepting a message"
12608 .row &%check_spool_inodes%&          "before accepting a message"
12609 .row &%check_spool_space%&           "before accepting a message"
12610 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12611 .row &%queue_only_load%&             "queue incoming if load high"
12612 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12613 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12614 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12615 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12616 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12617 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12618 .row &%smtp_accept_max_per_connection%& "messages per connection"
12619 .row &%smtp_accept_max_per_host%&    "connections from one host"
12620 .row &%smtp_accept_queue%&           "queue mail if more connections"
12621 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12622                                            connection"
12623 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12624 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12625 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12626 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12627 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12628 .endtable
12629
12630
12631
12632 .section "Policy controls" "SECID106"
12633 .table2
12634 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12635 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12636 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12637 .row &%acl_smtp_auth%&               "ACL for AUTH"
12638 .row &%acl_smtp_connect%&            "ACL for connection"
12639 .row &%acl_smtp_data%&               "ACL for DATA"
12640 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12641 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12642 .row &%acl_smtp_expn%&               "ACL for EXPN"
12643 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12644 .row &%acl_smtp_mail%&               "ACL for MAIL"
12645 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12646 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12647 .row &%acl_smtp_predata%&            "ACL for start of data"
12648 .row &%acl_smtp_quit%&               "ACL for QUIT"
12649 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12650 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12651 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12652 .row &%av_scanner%&                  "specify virus scanner"
12653 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12654                                       words""&"
12655 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12656 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12657 .row &%header_maxsize%&              "total size of message header"
12658 .row &%header_line_maxsize%&         "individual header line limit"
12659 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12660 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12661 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12662 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12663 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12664 .row &%host_lookup%&                 "host name looked up for these hosts"
12665 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12666 .row &%host_reject_connection%&      "reject connection from these hosts"
12667 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12668 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12669 .row &%message_size_limit%&          "for all messages"
12670 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12671 .row &%spamd_address%&               "set interface to SpamAssassin"
12672 .row &%strict_acl_vars%&             "object to unset ACL variables"
12673 .endtable
12674
12675
12676
12677 .section "Callout cache" "SECID107"
12678 .table2
12679 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12680                                          item"
12681 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12682                                          item"
12683 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12684 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12685 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12686 .endtable
12687
12688
12689
12690 .section "TLS" "SECID108"
12691 .table2
12692 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12693 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12694 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12695 .row &%tls_certificate%&             "location of server certificate"
12696 .row &%tls_crl%&                     "certificate revocation list"
12697 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12698 .row &%tls_dhparam%&                 "DH parameters for server"
12699 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12700 .row &%tls_privatekey%&              "location of server private key"
12701 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12702 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12703 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12704 .row &%tls_verify_certificates%&     "expected client certificates"
12705 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12706 .endtable
12707
12708
12709
12710 .section "Local user handling" "SECID109"
12711 .table2
12712 .row &%finduser_retries%&            "useful in NIS environments"
12713 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12714 .row &%gecos_pattern%&               "ditto"
12715 .row &%max_username_length%&         "for systems that truncate"
12716 .row &%unknown_login%&               "used when no login name found"
12717 .row &%unknown_username%&            "ditto"
12718 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12719 .row &%uucp_from_sender%&            "ditto"
12720 .endtable
12721
12722
12723
12724 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12725 .table2
12726 .row &%header_maxsize%&              "total size of message header"
12727 .row &%header_line_maxsize%&         "individual header line limit"
12728 .row &%message_size_limit%&          "applies to all messages"
12729 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12730 .row &%received_header_text%&        "expanded to make &'Received:'&"
12731 .row &%received_headers_max%&        "for mail loop detection"
12732 .row &%recipients_max%&              "limit per message"
12733 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12734 .endtable
12735
12736
12737
12738
12739 .section "Non-SMTP incoming messages" "SECID111"
12740 .table2
12741 .row &%receive_timeout%&             "for non-SMTP messages"
12742 .endtable
12743
12744
12745
12746
12747
12748 .section "Incoming SMTP messages" "SECID112"
12749 See also the &'Policy controls'& section above.
12750
12751 .table2
12752 .row &%host_lookup%&                 "host name looked up for these hosts"
12753 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12754 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12755 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12756 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12757 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12758 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12759 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12760 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12761 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12762 .row &%smtp_accept_max_per_connection%& "messages per connection"
12763 .row &%smtp_accept_max_per_host%&    "connections from one host"
12764 .row &%smtp_accept_queue%&           "queue mail if more connections"
12765 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12766                                            connection"
12767 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12768 .row &%smtp_active_hostname%&        "host name to use in messages"
12769 .row &%smtp_banner%&                 "text for welcome banner"
12770 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12771 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12772 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12773 .row &%smtp_etrn_command%&           "what to run for ETRN"
12774 .row &%smtp_etrn_serialize%&         "only one at once"
12775 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12776 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12777 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12778 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12779 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12780 .row &%smtp_receive_timeout%&        "per command or data line"
12781 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12782 .row &%smtp_return_error_details%&   "give detail on rejections"
12783 .endtable
12784
12785
12786
12787 .section "SMTP extensions" "SECID113"
12788 .table2
12789 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12790 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12791 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12792 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12793 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12794 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12795 .endtable
12796
12797
12798
12799 .section "Processing messages" "SECID114"
12800 .table2
12801 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12802 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12803 .row &%allow_utf8_domains%&          "in addresses"
12804 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12805                                       words""&"
12806 .row &%delivery_date_remove%&        "from incoming messages"
12807 .row &%envelope_to_remove%&          "from incoming messages"
12808 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12809 .row &%headers_charset%&             "default for translations"
12810 .row &%qualify_domain%&              "default for senders"
12811 .row &%qualify_recipient%&           "default for recipients"
12812 .row &%return_path_remove%&          "from incoming messages"
12813 .row &%strip_excess_angle_brackets%& "in addresses"
12814 .row &%strip_trailing_dot%&          "at end of addresses"
12815 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12816 .endtable
12817
12818
12819
12820 .section "System filter" "SECID115"
12821 .table2
12822 .row &%system_filter%&               "locate system filter"
12823 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12824                                             directory"
12825 .row &%system_filter_file_transport%& "transport for delivery to a file"
12826 .row &%system_filter_group%&         "group for filter running"
12827 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12828 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12829 .row &%system_filter_user%&          "user for filter running"
12830 .endtable
12831
12832
12833
12834 .section "Routing and delivery" "SECID116"
12835 .table2
12836 .row &%disable_ipv6%&                "do no IPv6 processing"
12837 .row &%dns_again_means_nonexist%&    "for broken domains"
12838 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12839 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12840 .row &%dns_retrans%&                 "parameter for resolver"
12841 .row &%dns_retry%&                   "parameter for resolver"
12842 .row &%dns_use_edns0%&               "parameter for resolver"
12843 .row &%hold_domains%&                "hold delivery for these domains"
12844 .row &%local_interfaces%&            "for routing checks"
12845 .row &%queue_domains%&               "no immediate delivery for these"
12846 .row &%queue_only%&                  "no immediate delivery at all"
12847 .row &%queue_only_file%&             "no immediate delivery if file exists"
12848 .row &%queue_only_load%&             "no immediate delivery if load is high"
12849 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12850 .row &%queue_only_override%&         "allow command line to override"
12851 .row &%queue_run_in_order%&          "order of arrival"
12852 .row &%queue_run_max%&               "of simultaneous queue runners"
12853 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12854 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12855 .row &%remote_sort_domains%&         "order of remote deliveries"
12856 .row &%retry_data_expire%&           "timeout for retry data"
12857 .row &%retry_interval_max%&          "safety net for retry rules"
12858 .endtable
12859
12860
12861
12862 .section "Bounce and warning messages" "SECID117"
12863 .table2
12864 .row &%bounce_message_file%&         "content of bounce"
12865 .row &%bounce_message_text%&         "content of bounce"
12866 .row &%bounce_return_body%&          "include body if returning message"
12867 .row &%bounce_return_message%&       "include original message in bounce"
12868 .row &%bounce_return_size_limit%&    "limit on returned message"
12869 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12870 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12871 .row &%errors_copy%&                 "copy bounce messages"
12872 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12873 .row &%delay_warning%&               "time schedule"
12874 .row &%delay_warning_condition%&     "condition for warning messages"
12875 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12876 .row &%smtp_return_error_details%&   "give detail on rejections"
12877 .row &%warn_message_file%&           "content of warning message"
12878 .endtable
12879
12880
12881
12882 .section "Alphabetical list of main options" "SECTalomo"
12883 Those options that undergo string expansion before use are marked with
12884 &dagger;.
12885
12886 .new
12887 .option accept_8bitmime main boolean true
12888 .cindex "8BITMIME"
12889 .cindex "8-bit characters"
12890 This option causes Exim to send 8BITMIME in its response to an SMTP
12891 EHLO command, and to accept the BODY= parameter on MAIL commands.
12892 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12893 takes no steps to do anything special with messages received by this route.
12894
12895 Historically Exim kept this option off by default, but the maintainers
12896 feel that in today's Internet, this causes more problems than it solves.
12897 It now defaults to true.
12898 A more detailed analysis of the issues is provided by Dan Bernstein:
12899 .display
12900 &url(http://cr.yp.to/smtp/8bitmime.html)
12901 .endd
12902 .wen
12903
12904 .option acl_not_smtp main string&!! unset
12905 .cindex "&ACL;" "for non-SMTP messages"
12906 .cindex "non-SMTP messages" "ACLs for"
12907 This option defines the ACL that is run when a non-SMTP message has been
12908 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12909 further details.
12910
12911 .option acl_not_smtp_mime main string&!! unset
12912 This option defines the ACL that is run for individual MIME parts of non-SMTP
12913 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12914 SMTP messages.
12915
12916 .option acl_not_smtp_start main string&!! unset
12917 .cindex "&ACL;" "at start of non-SMTP message"
12918 .cindex "non-SMTP messages" "ACLs for"
12919 This option defines the ACL that is run before Exim starts reading a
12920 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12921
12922 .option acl_smtp_auth main string&!! unset
12923 .cindex "&ACL;" "setting up for SMTP commands"
12924 .cindex "AUTH" "ACL for"
12925 This option defines the ACL that is run when an SMTP AUTH command is
12926 received. See chapter &<<CHAPACL>>& for further details.
12927
12928 .option acl_smtp_connect main string&!! unset
12929 .cindex "&ACL;" "on SMTP connection"
12930 This option defines the ACL that is run when an SMTP connection is received.
12931 See chapter &<<CHAPACL>>& for further details.
12932
12933 .option acl_smtp_data main string&!! unset
12934 .cindex "DATA" "ACL for"
12935 This option defines the ACL that is run after an SMTP DATA command has been
12936 processed and the message itself has been received, but before the final
12937 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12938
12939 .option acl_smtp_etrn main string&!! unset
12940 .cindex "ETRN" "ACL for"
12941 This option defines the ACL that is run when an SMTP ETRN command is
12942 received. See chapter &<<CHAPACL>>& for further details.
12943
12944 .option acl_smtp_expn main string&!! unset
12945 .cindex "EXPN" "ACL for"
12946 This option defines the ACL that is run when an SMTP EXPN command is
12947 received. See chapter &<<CHAPACL>>& for further details.
12948
12949 .option acl_smtp_helo main string&!! unset
12950 .cindex "EHLO" "ACL for"
12951 .cindex "HELO" "ACL for"
12952 This option defines the ACL that is run when an SMTP EHLO or HELO
12953 command is received. See chapter &<<CHAPACL>>& for further details.
12954
12955
12956 .option acl_smtp_mail main string&!! unset
12957 .cindex "MAIL" "ACL for"
12958 This option defines the ACL that is run when an SMTP MAIL command is
12959 received. See chapter &<<CHAPACL>>& for further details.
12960
12961 .option acl_smtp_mailauth main string&!! unset
12962 .cindex "AUTH" "on MAIL command"
12963 This option defines the ACL that is run when there is an AUTH parameter on
12964 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12965 &<<CHAPSMTPAUTH>>& for details of authentication.
12966
12967 .option acl_smtp_mime main string&!! unset
12968 .cindex "MIME content scanning" "ACL for"
12969 This option is available when Exim is built with the content-scanning
12970 extension. It defines the ACL that is run for each MIME part in a message. See
12971 section &<<SECTscanmimepart>>& for details.
12972
12973 .option acl_smtp_predata main string&!! unset
12974 This option defines the ACL that is run when an SMTP DATA command is
12975 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12976 further details.
12977
12978 .option acl_smtp_quit main string&!! unset
12979 .cindex "QUIT, ACL for"
12980 This option defines the ACL that is run when an SMTP QUIT command is
12981 received. See chapter &<<CHAPACL>>& for further details.
12982
12983 .option acl_smtp_rcpt main string&!! unset
12984 .cindex "RCPT" "ACL for"
12985 This option defines the ACL that is run when an SMTP RCPT command is
12986 received. See chapter &<<CHAPACL>>& for further details.
12987
12988 .option acl_smtp_starttls main string&!! unset
12989 .cindex "STARTTLS, ACL for"
12990 This option defines the ACL that is run when an SMTP STARTTLS command is
12991 received. See chapter &<<CHAPACL>>& for further details.
12992
12993 .option acl_smtp_vrfy main string&!! unset
12994 .cindex "VRFY" "ACL for"
12995 This option defines the ACL that is run when an SMTP VRFY command is
12996 received. See chapter &<<CHAPACL>>& for further details.
12997
12998 .option admin_groups main "string list&!!" unset
12999 .cindex "admin user"
13000 This option is expanded just once, at the start of Exim's processing. If the
13001 current group or any of the supplementary groups of an Exim caller is in this
13002 colon-separated list, the caller has admin privileges. If all your system
13003 programmers are in a specific group, for example, you can give them all Exim
13004 admin privileges by putting that group in &%admin_groups%&. However, this does
13005 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13006 To permit this, you have to add individuals to the Exim group.
13007
13008 .option allow_domain_literals main boolean false
13009 .cindex "domain literal"
13010 If this option is set, the RFC 2822 domain literal format is permitted in
13011 email addresses. The option is not set by default, because the domain literal
13012 format is not normally required these days, and few people know about it. It
13013 has, however, been exploited by mail abusers.
13014
13015 Unfortunately, it seems that some DNS black list maintainers are using this
13016 format to report black listing to postmasters. If you want to accept messages
13017 addressed to your hosts by IP address, you need to set
13018 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13019 domains (defined in the named domain list &%local_domains%& in the default
13020 configuration). This &"magic string"& matches the domain literal form of all
13021 the local host's IP addresses.
13022
13023
13024 .option allow_mx_to_ip main boolean false
13025 .cindex "MX record" "pointing to IP address"
13026 It appears that more and more DNS zone administrators are breaking the rules
13027 and putting domain names that look like IP addresses on the right hand side of
13028 MX records. Exim follows the rules and rejects this, giving an error message
13029 that explains the mis-configuration. However, some other MTAs support this
13030 practice, so to avoid &"Why can't Exim do this?"& complaints,
13031 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13032 recommended, except when you have no other choice.
13033
13034 .option allow_utf8_domains main boolean false
13035 .cindex "domain" "UTF-8 characters in"
13036 .cindex "UTF-8" "in domain name"
13037 Lots of discussion is going on about internationalized domain names. One
13038 camp is strongly in favour of just using UTF-8 characters, and it seems
13039 that at least two other MTAs permit this. This option allows Exim users to
13040 experiment if they wish.
13041
13042 If it is set true, Exim's domain parsing function allows valid
13043 UTF-8 multicharacters to appear in domain name components, in addition to
13044 letters, digits, and hyphens. However, just setting this option is not
13045 enough; if you want to look up these domain names in the DNS, you must also
13046 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13047 suitable setting is:
13048 .code
13049 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13050   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13051 .endd
13052 Alternatively, you can just disable this feature by setting
13053 .code
13054 dns_check_names_pattern =
13055 .endd
13056 That is, set the option to an empty string so that no check is done.
13057
13058
13059 .option auth_advertise_hosts main "host list&!!" *
13060 .cindex "authentication" "advertising"
13061 .cindex "AUTH" "advertising"
13062 If any server authentication mechanisms are configured, Exim advertises them in
13063 response to an EHLO command only if the calling host matches this list.
13064 Otherwise, Exim does not advertise AUTH.
13065 Exim does not accept AUTH commands from clients to which it has not
13066 advertised the availability of AUTH. The advertising of individual
13067 authentication mechanisms can be controlled by the use of the
13068 &%server_advertise_condition%& generic authenticator option on the individual
13069 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13070
13071 Certain mail clients (for example, Netscape) require the user to provide a name
13072 and password for authentication if AUTH is advertised, even though it may
13073 not be needed (the host may accept messages from hosts on its local LAN without
13074 authentication, for example). The &%auth_advertise_hosts%& option can be used
13075 to make these clients more friendly by excluding them from the set of hosts to
13076 which Exim advertises AUTH.
13077
13078 .cindex "AUTH" "advertising when encrypted"
13079 If you want to advertise the availability of AUTH only when the connection
13080 is encrypted using TLS, you can make use of the fact that the value of this
13081 option is expanded, with a setting like this:
13082 .code
13083 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
13084 .endd
13085 .vindex "&$tls_cipher$&"
13086 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
13087 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13088 expansion is *, which matches all hosts.
13089
13090
13091 .option auto_thaw main time 0s
13092 .cindex "thawing messages"
13093 .cindex "unfreezing messages"
13094 If this option is set to a time greater than zero, a queue runner will try a
13095 new delivery attempt on any frozen message, other than a bounce message, if
13096 this much time has passed since it was frozen. This may result in the message
13097 being re-frozen if nothing has changed since the last attempt. It is a way of
13098 saying &"keep on trying, even though there are big problems"&.
13099
13100 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13101 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13102 thought to be very useful any more, and its use should probably be avoided.
13103
13104
13105 .option av_scanner main string "see below"
13106 This option is available if Exim is built with the content-scanning extension.
13107 It specifies which anti-virus scanner to use. The default value is:
13108 .code
13109 sophie:/var/run/sophie
13110 .endd
13111 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13112 before use. See section &<<SECTscanvirus>>& for further details.
13113
13114
13115 .option bi_command main string unset
13116 .oindex "&%-bi%&"
13117 This option supplies the name of a command that is run when Exim is called with
13118 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13119 just the command name, it is not a complete command line. If an argument is
13120 required, it must come from the &%-oA%& command line option.
13121
13122
13123 .option bounce_message_file main string unset
13124 .cindex "bounce message" "customizing"
13125 .cindex "customizing" "bounce message"
13126 This option defines a template file containing paragraphs of text to be used
13127 for constructing bounce messages.  Details of the file's contents are given in
13128 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13129
13130
13131 .option bounce_message_text main string unset
13132 When this option is set, its contents are included in the default bounce
13133 message immediately after &"This message was created automatically by mail
13134 delivery software."& It is not used if &%bounce_message_file%& is set.
13135
13136 .option bounce_return_body main boolean true
13137 .cindex "bounce message" "including body"
13138 This option controls whether the body of an incoming message is included in a
13139 bounce message when &%bounce_return_message%& is true. The default setting
13140 causes the entire message, both header and body, to be returned (subject to the
13141 value of &%bounce_return_size_limit%&). If this option is false, only the
13142 message header is included. In the case of a non-SMTP message containing an
13143 error that is detected during reception, only those header lines preceding the
13144 point at which the error was detected are returned.
13145 .cindex "bounce message" "including original"
13146
13147 .option bounce_return_message main boolean true
13148 If this option is set false, none of the original message is included in
13149 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13150 &%bounce_return_body%&.
13151
13152
13153 .option bounce_return_size_limit main integer 100K
13154 .cindex "size" "of bounce, limit"
13155 .cindex "bounce message" "size limit"
13156 .cindex "limit" "bounce message size"
13157 This option sets a limit in bytes on the size of messages that are returned to
13158 senders as part of bounce messages when &%bounce_return_message%& is true. The
13159 limit should be less than the value of the global &%message_size_limit%& and of
13160 any &%message_size_limit%& settings on transports, to allow for the bounce text
13161 that Exim generates. If this option is set to zero there is no limit.
13162
13163 When the body of any message that is to be included in a bounce message is
13164 greater than the limit, it is truncated, and a comment pointing this out is
13165 added at the top. The actual cutoff may be greater than the value given, owing
13166 to the use of buffering for transferring the message in chunks (typically 8K in
13167 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13168 messages.
13169
13170 .option bounce_sender_authentication main string unset
13171 .cindex "bounce message" "sender authentication"
13172 .cindex "authentication" "bounce message"
13173 .cindex "AUTH" "on bounce message"
13174 This option provides an authenticated sender address that is sent with any
13175 bounce messages generated by Exim that are sent over an authenticated SMTP
13176 connection. A typical setting might be:
13177 .code
13178 bounce_sender_authentication = mailer-daemon@my.domain.example
13179 .endd
13180 which would cause bounce messages to be sent using the SMTP command:
13181 .code
13182 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13183 .endd
13184 The value of &%bounce_sender_authentication%& must always be a complete email
13185 address.
13186
13187 .option callout_domain_negative_expire main time 3h
13188 .cindex "caching" "callout timeouts"
13189 .cindex "callout" "caching timeouts"
13190 This option specifies the expiry time for negative callout cache data for a
13191 domain. See section &<<SECTcallver>>& for details of callout verification, and
13192 section &<<SECTcallvercache>>& for details of the caching.
13193
13194
13195 .option callout_domain_positive_expire main time 7d
13196 This option specifies the expiry time for positive callout cache data for a
13197 domain. See section &<<SECTcallver>>& for details of callout verification, and
13198 section &<<SECTcallvercache>>& for details of the caching.
13199
13200
13201 .option callout_negative_expire main time 2h
13202 This option specifies the expiry time for negative callout cache data for an
13203 address. See section &<<SECTcallver>>& for details of callout verification, and
13204 section &<<SECTcallvercache>>& for details of the caching.
13205
13206
13207 .option callout_positive_expire main time 24h
13208 This option specifies the expiry time for positive callout cache data for an
13209 address. See section &<<SECTcallver>>& for details of callout verification, and
13210 section &<<SECTcallvercache>>& for details of the caching.
13211
13212
13213 .option callout_random_local_part main string&!! "see below"
13214 This option defines the &"random"& local part that can be used as part of
13215 callout verification. The default value is
13216 .code
13217 $primary_hostname-$tod_epoch-testing
13218 .endd
13219 See section &<<CALLaddparcall>>& for details of how this value is used.
13220
13221
13222 .option check_log_inodes main integer 0
13223 See &%check_spool_space%& below.
13224
13225
13226 .option check_log_space main integer 0
13227 See &%check_spool_space%& below.
13228
13229 .oindex "&%check_rfc2047_length%&"
13230 .cindex "RFC 2047" "disabling length check"
13231 .option check_rfc2047_length main boolean true
13232 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13233 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13234 word; strings to be encoded that exceed this length are supposed to use
13235 multiple encoded words. By default, Exim does not recognize encoded words that
13236 exceed the maximum length. However, it seems that some software, in violation
13237 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13238 set false, Exim recognizes encoded words of any length.
13239
13240
13241 .option check_spool_inodes main integer 0
13242 See &%check_spool_space%& below.
13243
13244
13245 .option check_spool_space main integer 0
13246 .cindex "checking disk space"
13247 .cindex "disk space, checking"
13248 .cindex "spool directory" "checking space"
13249 The four &%check_...%& options allow for checking of disk resources before a
13250 message is accepted.
13251
13252 .vindex "&$log_inodes$&"
13253 .vindex "&$log_space$&"
13254 .vindex "&$spool_inodes$&"
13255 .vindex "&$spool_space$&"
13256 When any of these options are set, they apply to all incoming messages. If you
13257 want to apply different checks to different kinds of message, you can do so by
13258 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13259 &$spool_space$& in an ACL with appropriate additional conditions.
13260
13261
13262 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13263 either value is greater than zero, for example:
13264 .code
13265 check_spool_space = 10M
13266 check_spool_inodes = 100
13267 .endd
13268 The spool partition is the one that contains the directory defined by
13269 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13270 transit.
13271
13272 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13273 files are written if either is greater than zero. These should be set only if
13274 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13275
13276 If there is less space or fewer inodes than requested, Exim refuses to accept
13277 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13278 error response to the MAIL command. If ESMTP is in use and there was a
13279 SIZE parameter on the MAIL command, its value is added to the
13280 &%check_spool_space%& value, and the check is performed even if
13281 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13282
13283 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13284 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13285
13286 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13287 failure a message is written to stderr and Exim exits with a non-zero code, as
13288 it obviously cannot send an error message of any kind.
13289
13290 .option daemon_smtp_ports main string &`smtp`&
13291 .cindex "port" "for daemon"
13292 .cindex "TCP/IP" "setting listening ports"
13293 This option specifies one or more default SMTP ports on which the Exim daemon
13294 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13295 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13296
13297 .option daemon_startup_retries main integer 9
13298 .cindex "daemon startup, retrying"
13299 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13300 the daemon at startup when it cannot immediately bind a listening socket
13301 (typically because the socket is already in use): &%daemon_startup_retries%&
13302 defines the number of retries after the first failure, and
13303 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13304
13305 .option daemon_startup_sleep main time 30s
13306 See &%daemon_startup_retries%&.
13307
13308 .option delay_warning main "time list" 24h
13309 .cindex "warning of delay"
13310 .cindex "delay warning, specifying"
13311 When a message is delayed, Exim sends a warning message to the sender at
13312 intervals specified by this option. The data is a colon-separated list of times
13313 after which to send warning messages. If the value of the option is an empty
13314 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13315 message has been on the queue for longer than the last time, the last interval
13316 between the times is used to compute subsequent warning times. For example,
13317 with
13318 .code
13319 delay_warning = 4h:8h:24h
13320 .endd
13321 the first message is sent after 4 hours, the second after 8 hours, and
13322 the third one after 24 hours. After that, messages are sent every 16 hours,
13323 because that is the interval between the last two times on the list. If you set
13324 just one time, it specifies the repeat interval. For example, with:
13325 .code
13326 delay_warning = 6h
13327 .endd
13328 messages are repeated every six hours. To stop warnings after a given time, set
13329 a very large time at the end of the list. For example:
13330 .code
13331 delay_warning = 2h:12h:99d
13332 .endd
13333
13334 .option delay_warning_condition main string&!! "see below"
13335 .vindex "&$domain$&"
13336 The string is expanded at the time a warning message might be sent. If all the
13337 deferred addresses have the same domain, it is set in &$domain$& during the
13338 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13339 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13340 &"false"& (the comparison being done caselessly) then the warning message is
13341 not sent. The default is:
13342 .code
13343 delay_warning_condition = ${if or {\
13344   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13345   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13346   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13347   } {no}{yes}}
13348 .endd
13349 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13350 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13351 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13352 &"auto-replied"& in an &'Auto-Submitted:'& header.
13353
13354 .option deliver_drop_privilege main boolean false
13355 .cindex "unprivileged delivery"
13356 .cindex "delivery" "unprivileged"
13357 If this option is set true, Exim drops its root privilege at the start of a
13358 delivery process, and runs as the Exim user throughout. This severely restricts
13359 the kinds of local delivery that are possible, but is viable in certain types
13360 of configuration. There is a discussion about the use of root privilege in
13361 chapter &<<CHAPsecurity>>&.
13362
13363 .option deliver_queue_load_max main fixed-point unset
13364 .cindex "load average"
13365 .cindex "queue runner" "abandoning"
13366 When this option is set, a queue run is abandoned if the system load average
13367 becomes greater than the value of the option. The option has no effect on
13368 ancient operating systems on which Exim cannot determine the load average.
13369 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13370
13371
13372 .option delivery_date_remove main boolean true
13373 .cindex "&'Delivery-date:'& header line"
13374 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13375 message when it is delivered, in exactly the same way as &'Return-path:'& is
13376 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13377 should not be present in incoming messages, and this option causes them to be
13378 removed at the time the message is received, to avoid any problems that might
13379 occur when a delivered message is subsequently sent on to some other recipient.
13380
13381 .option disable_fsync main boolean false
13382 .cindex "&[fsync()]&, disabling"
13383 This option is available only if Exim was built with the compile-time option
13384 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13385 a runtime configuration generates an &"unknown option"& error. You should not
13386 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13387 really, really, really understand what you are doing. &'No pre-compiled
13388 distributions of Exim should ever make this option available.'&
13389
13390 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13391 updated files' data to be written to disc before continuing. Unexpected events
13392 such as crashes and power outages may cause data to be lost or scrambled.
13393 Here be Dragons. &*Beware.*&
13394
13395
13396 .option disable_ipv6 main boolean false
13397 .cindex "IPv6" "disabling"
13398 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13399 activities take place. AAAA records are never looked up, and any IPv6 addresses
13400 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13401 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13402 to handle IPv6 literal addresses.
13403
13404
13405 .option dns_again_means_nonexist main "domain list&!!" unset
13406 .cindex "DNS" "&""try again""& response; overriding"
13407 DNS lookups give a &"try again"& response for the DNS errors
13408 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13409 keep trying to deliver a message, or to give repeated temporary errors to
13410 incoming mail. Sometimes the effect is caused by a badly set up name server and
13411 may persist for a long time. If a domain which exhibits this problem matches
13412 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13413 This option should be used with care. You can make it apply to reverse lookups
13414 by a setting such as this:
13415 .code
13416 dns_again_means_nonexist = *.in-addr.arpa
13417 .endd
13418 This option applies to all DNS lookups that Exim does. It also applies when the
13419 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13420 since these are most likely to be caused by DNS lookup problems. The
13421 &(dnslookup)& router has some options of its own for controlling what happens
13422 when lookups for MX or SRV records give temporary errors. These more specific
13423 options are applied after this global option.
13424
13425 .option dns_check_names_pattern main string "see below"
13426 .cindex "DNS" "pre-check of name syntax"
13427 When this option is set to a non-empty string, it causes Exim to check domain
13428 names for characters that are not allowed in host names before handing them to
13429 the DNS resolver, because some resolvers give temporary errors for names that
13430 contain unusual characters. If a domain name contains any unwanted characters,
13431 a &"not found"& result is forced, and the resolver is not called. The check is
13432 done by matching the domain name against a regular expression, which is the
13433 value of this option. The default pattern is
13434 .code
13435 dns_check_names_pattern = \
13436   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13437 .endd
13438 which permits only letters, digits, slashes, and hyphens in components, but
13439 they must start and end with a letter or digit. Slashes are not, in fact,
13440 permitted in host names, but they are found in certain NS records (which can be
13441 accessed in Exim by using a &%dnsdb%& lookup). If you set
13442 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13443 empty string.
13444
13445 .option dns_csa_search_limit main integer 5
13446 This option controls the depth of parental searching for CSA SRV records in the
13447 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13448
13449 .option dns_csa_use_reverse main boolean true
13450 This option controls whether or not an IP address, given as a CSA domain, is
13451 reversed and looked up in the reverse DNS, as described in more detail in
13452 section &<<SECTverifyCSA>>&.
13453
13454 .option dns_ipv4_lookup main "domain list&!!" unset
13455 .cindex "IPv6" "DNS lookup for AAAA records"
13456 .cindex "DNS" "IPv6 lookup for AAAA records"
13457 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13458 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13459 (A records) when trying to find IP addresses for hosts, unless the host's
13460 domain matches this list.
13461
13462 This is a fudge to help with name servers that give big delays or otherwise do
13463 not work for the AAAA record type. In due course, when the world's name
13464 servers have all been upgraded, there should be no need for this option.
13465
13466
13467 .option dns_retrans main time 0s
13468 .cindex "DNS" "resolver options"
13469 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13470 retransmission and retry parameters for DNS lookups. Values of zero (the
13471 defaults) leave the system default settings unchanged. The first value is the
13472 time between retries, and the second is the number of retries. It isn't
13473 totally clear exactly how these settings affect the total time a DNS lookup may
13474 take. I haven't found any documentation about timeouts on DNS lookups; these
13475 parameter values are available in the external resolver interface structure,
13476 but nowhere does it seem to describe how they are used or what you might want
13477 to set in them.
13478
13479
13480 .option dns_retry main integer 0
13481 See &%dns_retrans%& above.
13482
13483
13484 .new
13485 .option dns_use_edns0 main integer -1
13486 .cindex "DNS" "resolver options"
13487 .cindex "DNS" "EDNS0"
13488 If this option is set to a non-negative number then Exim will initialise the
13489 DNS resolver library to either use or not use EDNS0 extensions, overriding
13490 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13491 on.
13492
13493 If the resolver library does not support EDNS0 then this option has no effect.
13494 .wen
13495
13496
13497 .option drop_cr main boolean false
13498 This is an obsolete option that is now a no-op. It used to affect the way Exim
13499 handled CR and LF characters in incoming messages. What happens now is
13500 described in section &<<SECTlineendings>>&.
13501
13502 .option dsn_from main "string&!!" "see below"
13503 .cindex "&'From:'& header line" "in bounces"
13504 .cindex "bounce messages" "&'From:'& line, specifying"
13505 This option can be used to vary the contents of &'From:'& header lines in
13506 bounces and other automatically generated messages (&"Delivery Status
13507 Notifications"& &-- hence the name of the option). The default setting is:
13508 .code
13509 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13510 .endd
13511 The value is expanded every time it is needed. If the expansion fails, a
13512 panic is logged, and the default value is used.
13513
13514 .option envelope_to_remove main boolean true
13515 .cindex "&'Envelope-to:'& header line"
13516 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13517 message when it is delivered, in exactly the same way as &'Return-path:'& is
13518 handled. &'Envelope-to:'& records the original recipient address from the
13519 messages's envelope that caused the delivery to happen. Such headers should not
13520 be present in incoming messages, and this option causes them to be removed at
13521 the time the message is received, to avoid any problems that might occur when a
13522 delivered message is subsequently sent on to some other recipient.
13523
13524
13525 .option errors_copy main "string list&!!" unset
13526 .cindex "bounce message" "copy to other address"
13527 .cindex "copy of bounce message"
13528 Setting this option causes Exim to send bcc copies of bounce messages that it
13529 generates to other addresses. &*Note*&: This does not apply to bounce messages
13530 coming from elsewhere. The value of the option is a colon-separated list of
13531 items. Each item consists of a pattern, terminated by white space, followed by
13532 a comma-separated list of email addresses. If a pattern contains spaces, it
13533 must be enclosed in double quotes.
13534
13535 Each pattern is processed in the same way as a single item in an address list
13536 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13537 the bounce message, the message is copied to the addresses on the list. The
13538 items are scanned in order, and once a matching one is found, no further items
13539 are examined. For example:
13540 .code
13541 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13542               rqps@mydomain   hostmaster@mydomain.example,\
13543                               postmaster@mydomain.example
13544 .endd
13545 .vindex "&$domain$&"
13546 .vindex "&$local_part$&"
13547 The address list is expanded before use. The expansion variables &$local_part$&
13548 and &$domain$& are set from the original recipient of the error message, and if
13549 there was any wildcard matching in the pattern, the expansion
13550 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13551 variables &$0$&, &$1$&, etc. are set in the normal way.
13552
13553
13554 .option errors_reply_to main string unset
13555 .cindex "bounce message" "&'Reply-to:'& in"
13556 By default, Exim's bounce and delivery warning messages contain the header line
13557 .display
13558 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13559 .endd
13560 .oindex &%quota_warn_message%&
13561 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13562 A warning message that is generated by the &%quota_warn_message%& option in an
13563 &(appendfile)& transport may contain its own &'From:'& header line that
13564 overrides the default.
13565
13566 Experience shows that people reply to bounce messages. If the
13567 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13568 and warning messages. For example:
13569 .code
13570 errors_reply_to = postmaster@my.domain.example
13571 .endd
13572 The value of the option is not expanded. It must specify a valid RFC 2822
13573 address. However, if a warning message that is generated by the
13574 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13575 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13576 not used.
13577
13578
13579 .option exim_group main string "compile-time configured"
13580 .cindex "gid (group id)" "Exim's own"
13581 .cindex "Exim group"
13582 This option changes the gid under which Exim runs when it gives up root
13583 privilege. The default value is compiled into the binary. The value of this
13584 option is used only when &%exim_user%& is also set. Unless it consists entirely
13585 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13586 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13587 security issues.
13588
13589
13590 .option exim_path main string "see below"
13591 .cindex "Exim binary, path name"
13592 This option specifies the path name of the Exim binary, which is used when Exim
13593 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13594 the directory configured at compile time by the BIN_DIRECTORY setting. It
13595 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13596 other place.
13597 &*Warning*&: Do not use a macro to define the value of this option, because
13598 you will break those Exim utilities that scan the configuration file to find
13599 where the binary is. (They then use the &%-bP%& option to extract option
13600 settings such as the value of &%spool_directory%&.)
13601
13602
13603 .option exim_user main string "compile-time configured"
13604 .cindex "uid (user id)" "Exim's own"
13605 .cindex "Exim user"
13606 This option changes the uid under which Exim runs when it gives up root
13607 privilege. The default value is compiled into the binary. Ownership of the run
13608 time configuration file and the use of the &%-C%& and &%-D%& command line
13609 options is checked against the values in the binary, not what is set here.
13610
13611 Unless it consists entirely of digits, the string is looked up using
13612 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13613 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13614 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13615
13616
13617 .option extra_local_interfaces main "string list" unset
13618 This option defines network interfaces that are to be considered local when
13619 routing, but which are not used for listening by the daemon. See section
13620 &<<SECTreclocipadd>>& for details.
13621
13622
13623 . Allow this long option name to split; give it unsplit as a fifth argument
13624 . for the automatic .oindex that is generated by .option.
13625
13626 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13627          extract_addresses_remove_arguments
13628 .oindex "&%-t%&"
13629 .cindex "command line" "addresses with &%-t%&"
13630 .cindex "Sendmail compatibility" "&%-t%& option"
13631 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13632 are present on the command line when the &%-t%& option is used to build an
13633 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13634 line addresses are removed from the recipients list. This is also how Smail
13635 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13636 command line addresses are added to those obtained from the header lines. When
13637 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13638 argument headers. If it is set false, Exim adds rather than removes argument
13639 addresses.
13640
13641
13642 .option finduser_retries main integer 0
13643 .cindex "NIS, retrying user lookups"
13644 On systems running NIS or other schemes in which user and group information is
13645 distributed from a remote system, there can be times when &[getpwnam()]& and
13646 related functions fail, even when given valid data, because things time out.
13647 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13648 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13649 many extra times to find a user or a group, waiting for one second between
13650 retries.
13651
13652 .cindex "&_/etc/passwd_&" "multiple reading of"
13653 You should not set this option greater than zero if your user information is in
13654 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13655 search the file multiple times for non-existent users, and also cause delay.
13656
13657
13658
13659 .option freeze_tell main "string list, comma separated" unset
13660 .cindex "freezing messages" "sending a message when freezing"
13661 On encountering certain errors, or when configured to do so in a system filter,
13662 ACL, or special router, Exim freezes a message. This means that no further
13663 delivery attempts take place until an administrator thaws the message, or the
13664 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13665 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13666 warning message whenever it freezes something, unless the message it is
13667 freezing is a locally-generated bounce message. (Without this exception there
13668 is the possibility of looping.) The warning message is sent to the addresses
13669 supplied as the comma-separated value of this option. If several of the
13670 message's addresses cause freezing, only a single message is sent. If the
13671 freezing was automatic, the reason(s) for freezing can be found in the message
13672 log. If you configure freezing in a filter or ACL, you must arrange for any
13673 logging that you require.
13674
13675
13676 .option gecos_name main string&!! unset
13677 .cindex "HP-UX"
13678 .cindex "&""gecos""& field, parsing"
13679 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13680 password file to hold other information in addition to users' real names. Exim
13681 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13682 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13683 of the field are used unchanged, except that, if an ampersand is encountered,
13684 it is replaced by the user's login name with the first character forced to
13685 upper case, since this is a convention that is observed on many systems.
13686
13687 When these options are set, &%gecos_pattern%& is treated as a regular
13688 expression that is to be applied to the field (again with && replaced by the
13689 login name), and if it matches, &%gecos_name%& is expanded and used as the
13690 user's name.
13691
13692 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13693 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13694 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13695 name terminates at the first comma, the following can be used:
13696 .code
13697 gecos_pattern = ([^,]*)
13698 gecos_name = $1
13699 .endd
13700
13701 .option gecos_pattern main string unset
13702 See &%gecos_name%& above.
13703
13704
13705 .option gnutls_compat_mode main boolean unset
13706 This option controls whether GnuTLS is used in compatibility mode in an Exim
13707 server. This reduces security slightly, but improves interworking with older
13708 implementations of TLS.
13709
13710 .option headers_charset main string "see below"
13711 This option sets a default character set for translating from encoded MIME
13712 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13713 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13714 ultimate default is ISO-8859-1. For more details see the description of header
13715 insertions in section &<<SECTexpansionitems>>&.
13716
13717
13718
13719 .option header_maxsize main integer "see below"
13720 .cindex "header section" "maximum size of"
13721 .cindex "limit" "size of message header section"
13722 This option controls the overall maximum size of a message's header
13723 section. The default is the value of HEADER_MAXSIZE in
13724 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13725 sections are rejected.
13726
13727
13728 .option header_line_maxsize main integer 0
13729 .cindex "header lines" "maximum size of"
13730 .cindex "limit" "size of one header line"
13731 This option limits the length of any individual header line in a message, after
13732 all the continuations have been joined together. Messages with individual
13733 header lines that are longer than the limit are rejected. The default value of
13734 zero means &"no limit"&.
13735
13736
13737
13738
13739 .option helo_accept_junk_hosts main "host list&!!" unset
13740 .cindex "HELO" "accepting junk data"
13741 .cindex "EHLO" "accepting junk data"
13742 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13743 mail, and gives an error response for invalid data. Unfortunately, there are
13744 some SMTP clients that send syntactic junk. They can be accommodated by setting
13745 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13746 if you want to do semantic checking.
13747 See also &%helo_allow_chars%& for a way of extending the permitted character
13748 set.
13749
13750
13751 .option helo_allow_chars main string unset
13752 .cindex "HELO" "underscores in"
13753 .cindex "EHLO" "underscores in"
13754 .cindex "underscore in EHLO/HELO"
13755 This option can be set to a string of rogue characters that are permitted in
13756 all EHLO and HELO names in addition to the standard letters, digits,
13757 hyphens, and dots. If you really must allow underscores, you can set
13758 .code
13759 helo_allow_chars = _
13760 .endd
13761 Note that the value is one string, not a list.
13762
13763
13764 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13765 .cindex "HELO" "forcing reverse lookup"
13766 .cindex "EHLO" "forcing reverse lookup"
13767 If the domain given by a client in a HELO or EHLO command matches this
13768 list, a reverse lookup is done in order to establish the host's true name. The
13769 default forces a lookup if the client host gives the server's name or any of
13770 its IP addresses (in brackets), something that broken clients have been seen to
13771 do.
13772
13773
13774 .option helo_try_verify_hosts main "host list&!!" unset
13775 .cindex "HELO verifying" "optional"
13776 .cindex "EHLO" "verifying, optional"
13777 By default, Exim just checks the syntax of HELO and EHLO commands (see
13778 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13779 to do more extensive checking of the data supplied by these commands. The ACL
13780 condition &`verify = helo`& is provided to make this possible.
13781 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13782 to force the check to occur. From release 4.53 onwards, this is no longer
13783 necessary. If the check has not been done before &`verify = helo`& is
13784 encountered, it is done at that time. Consequently, this option is obsolete.
13785 Its specification is retained here for backwards compatibility.
13786
13787 When an EHLO or HELO command is received, if the calling host matches
13788 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13789 EHLO command either:
13790
13791 .ilist
13792 is an IP literal matching the calling address of the host, or
13793 .next
13794 .cindex "DNS" "reverse lookup"
13795 .cindex "reverse DNS lookup"
13796 matches the host name that Exim obtains by doing a reverse lookup of the
13797 calling host address, or
13798 .next
13799 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13800 available) yields the calling host address.
13801 .endlist
13802
13803 However, the EHLO or HELO command is not rejected if any of the checks
13804 fail. Processing continues, but the result of the check is remembered, and can
13805 be detected later in an ACL by the &`verify = helo`& condition.
13806
13807 .option helo_verify_hosts main "host list&!!" unset
13808 .cindex "HELO verifying" "mandatory"
13809 .cindex "EHLO" "verifying, mandatory"
13810 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13811 backwards compatibility. For hosts that match this option, Exim checks the host
13812 name given in the HELO or EHLO in the same way as for
13813 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13814 rejected with a 550 error, and entries are written to the main and reject logs.
13815 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13816 error.
13817
13818 .option hold_domains main "domain list&!!" unset
13819 .cindex "domain" "delaying delivery"
13820 .cindex "delivery" "delaying certain domains"
13821 This option allows mail for particular domains to be held on the queue
13822 manually. The option is overridden if a message delivery is forced with the
13823 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13824 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13825 item in &%hold_domains%&, no routing or delivery for that address is done, and
13826 it is deferred every time the message is looked at.
13827
13828 This option is intended as a temporary operational measure for delaying the
13829 delivery of mail while some problem is being sorted out, or some new
13830 configuration tested. If you just want to delay the processing of some
13831 domains until a queue run occurs, you should use &%queue_domains%& or
13832 &%queue_smtp_domains%&, not &%hold_domains%&.
13833
13834 A setting of &%hold_domains%& does not override Exim's code for removing
13835 messages from the queue if they have been there longer than the longest retry
13836 time in any retry rule. If you want to hold messages for longer than the normal
13837 retry times, insert a dummy retry rule with a long retry time.
13838
13839
13840 .option host_lookup main "host list&!!" unset
13841 .cindex "host name" "lookup, forcing"
13842 Exim does not look up the name of a calling host from its IP address unless it
13843 is required to compare against some host list, or the host matches
13844 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13845 option (which normally contains IP addresses rather than host names). The
13846 default configuration file contains
13847 .code
13848 host_lookup = *
13849 .endd
13850 which causes a lookup to happen for all hosts. If the expense of these lookups
13851 is felt to be too great, the setting can be changed or removed.
13852
13853 After a successful reverse lookup, Exim does a forward lookup on the name it
13854 has obtained, to verify that it yields the IP address that it started with. If
13855 this check fails, Exim behaves as if the name lookup failed.
13856
13857 .vindex "&$host_lookup_failed$&"
13858 .vindex "&$sender_host_name$&"
13859 After any kind of failure, the host name (in &$sender_host_name$&) remains
13860 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13861 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13862 &`verify = reverse_host_lookup`& in ACLs.
13863
13864
13865 .option host_lookup_order main "string list" &`bydns:byaddr`&
13866 This option specifies the order of different lookup methods when Exim is trying
13867 to find a host name from an IP address. The default is to do a DNS lookup
13868 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13869 if that fails. You can change the order of these lookups, or omit one entirely,
13870 if you want.
13871
13872 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13873 multiple PTR records in the DNS and the IP address is not listed in
13874 &_/etc/hosts_&. Different operating systems give different results in this
13875 case. That is why the default tries a DNS lookup first.
13876
13877
13878
13879 .option host_reject_connection main "host list&!!" unset
13880 .cindex "host" "rejecting connections from"
13881 If this option is set, incoming SMTP calls from the hosts listed are rejected
13882 as soon as the connection is made.
13883 This option is obsolete, and retained only for backward compatibility, because
13884 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13885 connections immediately.
13886
13887 The ability to give an immediate rejection (either by this option or using an
13888 ACL) is provided for use in unusual cases. Many hosts will just try again,
13889 sometimes without much delay. Normally, it is better to use an ACL to reject
13890 incoming messages at a later stage, such as after RCPT commands. See
13891 chapter &<<CHAPACL>>&.
13892
13893
13894 .option hosts_connection_nolog main "host list&!!" unset
13895 .cindex "host" "not logging connections from"
13896 This option defines a list of hosts for which connection logging does not
13897 happen, even though the &%smtp_connection%& log selector is set. For example,
13898 you might want not to log SMTP connections from local processes, or from
13899 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13900 the daemon; you should therefore strive to restrict its value to a short inline
13901 list of IP addresses and networks. To disable logging SMTP connections from
13902 local processes, you must create a host list with an empty item. For example:
13903 .code
13904 hosts_connection_nolog = :
13905 .endd
13906 If the &%smtp_connection%& log selector is not set, this option has no effect.
13907
13908
13909
13910 .option hosts_treat_as_local main "domain list&!!" unset
13911 .cindex "local host" "domains treated as"
13912 .cindex "host" "treated as local"
13913 If this option is set, any host names that match the domain list are treated as
13914 if they were the local host when Exim is scanning host lists obtained from MX
13915 records
13916 or other sources. Note that the value of this option is a domain list, not a
13917 host list, because it is always used to check host names, not IP addresses.
13918
13919 This option also applies when Exim is matching the special items
13920 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13921 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13922 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13923 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13924 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13925 interfaces and recognizing the local host.
13926
13927
13928 .option ibase_servers main "string list" unset
13929 .cindex "InterBase" "server list"
13930 This option provides a list of InterBase servers and associated connection data,
13931 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13932 The option is available only if Exim has been built with InterBase support.
13933
13934
13935
13936 .option ignore_bounce_errors_after main time 10w
13937 .cindex "bounce message" "discarding"
13938 .cindex "discarding bounce message"
13939 This option affects the processing of bounce messages that cannot be delivered,
13940 that is, those that suffer a permanent delivery failure. (Bounce messages that
13941 suffer temporary delivery failures are of course retried in the usual way.)
13942
13943 After a permanent delivery failure, bounce messages are frozen,
13944 because there is no sender to whom they can be returned. When a frozen bounce
13945 message has been on the queue for more than the given time, it is unfrozen at
13946 the next queue run, and a further delivery is attempted. If delivery fails
13947 again, the bounce message is discarded. This makes it possible to keep failed
13948 bounce messages around for a shorter time than the normal maximum retry time
13949 for frozen messages. For example,
13950 .code
13951 ignore_bounce_errors_after = 12h
13952 .endd
13953 retries failed bounce message deliveries after 12 hours, discarding any further
13954 failures. If the value of this option is set to a zero time period, bounce
13955 failures are discarded immediately. Setting a very long time (as in the default
13956 value) has the effect of disabling this option. For ways of automatically
13957 dealing with other kinds of frozen message, see &%auto_thaw%& and
13958 &%timeout_frozen_after%&.
13959
13960
13961 .option ignore_fromline_hosts main "host list&!!" unset
13962 .cindex "&""From""& line"
13963 .cindex "UUCP" "&""From""& line"
13964 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13965 the headers of a message. By default this is treated as the start of the
13966 message's body, which means that any following headers are not recognized as
13967 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13968 match those hosts that insist on sending it. If the sender is actually a local
13969 process rather than a remote host, and is using &%-bs%& to inject the messages,
13970 &%ignore_fromline_local%& must be set to achieve this effect.
13971
13972
13973 .option ignore_fromline_local main boolean false
13974 See &%ignore_fromline_hosts%& above.
13975
13976
13977 .option keep_malformed main time 4d
13978 This option specifies the length of time to keep messages whose spool files
13979 have been corrupted in some way. This should, of course, never happen. At the
13980 next attempt to deliver such a message, it gets removed. The incident is
13981 logged.
13982
13983
13984 .option ldap_ca_cert_dir main string unset
13985 .cindex "LDAP", "TLS CA certificate directory"
13986 This option indicates which directory contains CA certificates for verifying
13987 a TLS certificate presented by an LDAP server.
13988 While Exim does not provide a default value, your SSL library may.
13989 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13990 and constrained to be a directory.
13991
13992
13993 .option ldap_ca_cert_file main string unset
13994 .cindex "LDAP", "TLS CA certificate file"
13995 This option indicates which file contains CA certificates for verifying
13996 a TLS certificate presented by an LDAP server.
13997 While Exim does not provide a default value, your SSL library may.
13998 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13999 and constrained to be a file.
14000
14001
14002 .option ldap_cert_file main string unset
14003 .cindex "LDAP" "TLS client certificate file"
14004 This option indicates which file contains an TLS client certificate which
14005 Exim should present to the LDAP server during TLS negotiation.
14006 Should be used together with &%ldap_cert_key%&.
14007
14008
14009 .option ldap_cert_key main string unset
14010 .cindex "LDAP" "TLS client key file"
14011 This option indicates which file contains the secret/private key to use
14012 to prove identity to the LDAP server during TLS negotiation.
14013 Should be used together with &%ldap_cert_file%&, which contains the
14014 identity to be proven.
14015
14016
14017 .option ldap_cipher_suite main string unset
14018 .cindex "LDAP" "TLS cipher suite"
14019 This controls the TLS cipher-suite negotiation during TLS negotiation with
14020 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14021 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14022
14023
14024 .option ldap_default_servers main "string list" unset
14025 .cindex "LDAP" "default servers"
14026 This option provides a list of LDAP servers which are tried in turn when an
14027 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14028 details of LDAP queries. This option is available only when Exim has been built
14029 with LDAP support.
14030
14031
14032 .option ldap_require_cert main string unset.
14033 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14034 This should be one of the values "hard", "demand", "allow", "try" or "never".
14035 A value other than one of these is interpreted as "never".
14036 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14037 Although Exim does not set a default, the LDAP library probably defaults
14038 to hard/demand.
14039
14040
14041 .option ldap_start_tls main boolean false
14042 .cindex "LDAP" "whether or not to negotiate TLS"
14043 If set, Exim will attempt to negotiate TLS with the LDAP server when
14044 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14045 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14046 of SSL-on-connect.
14047 In the event of failure to negotiate TLS, the action taken is controlled
14048 by &%ldap_require_cert%&.
14049
14050
14051 .option ldap_version main integer unset
14052 .cindex "LDAP" "protocol version, forcing"
14053 This option can be used to force Exim to set a specific protocol version for
14054 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14055 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14056 the LDAP headers; otherwise it is 2. This option is available only when Exim
14057 has been built with LDAP support.
14058
14059
14060
14061 .option local_from_check main boolean true
14062 .cindex "&'Sender:'& header line" "disabling addition of"
14063 .cindex "&'From:'& header line" "disabling checking of"
14064 When a message is submitted locally (that is, not over a TCP/IP connection) by
14065 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14066 checks that the &'From:'& header line matches the login of the calling user and
14067 the domain specified by &%qualify_domain%&.
14068
14069 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14070 locally submitted message is automatically qualified by Exim, unless the
14071 &%-bnq%& command line option is used.
14072
14073 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14074 on the local part. If the &'From:'& header line does not match, Exim adds a
14075 &'Sender:'& header with an address constructed from the calling user's login
14076 and the default qualify domain.
14077
14078 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14079 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14080 &'Sender:'& header lines supplied by untrusted users, you must also set
14081 &%local_sender_retain%& to be true.
14082
14083 .cindex "envelope sender"
14084 These options affect only the header lines in the message. The envelope sender
14085 is still forced to be the login id at the qualify domain unless
14086 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14087
14088 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14089 request similar header line checking. See section &<<SECTthesenhea>>&, which
14090 has more details about &'Sender:'& processing.
14091
14092
14093
14094
14095 .option local_from_prefix main string unset
14096 When Exim checks the &'From:'& header line of locally submitted messages for
14097 matching the login id (see &%local_from_check%& above), it can be configured to
14098 ignore certain prefixes and suffixes in the local part of the address. This is
14099 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14100 appropriate lists, in the same form as the &%local_part_prefix%& and
14101 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14102 example, if
14103 .code
14104 local_from_prefix = *-
14105 .endd
14106 is set, a &'From:'& line containing
14107 .code
14108 From: anything-user@your.domain.example
14109 .endd
14110 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14111 matches the actual sender address that is constructed from the login name and
14112 qualify domain.
14113
14114
14115 .option local_from_suffix main string unset
14116 See &%local_from_prefix%& above.
14117
14118
14119 .option local_interfaces main "string list" "see below"
14120 This option controls which network interfaces are used by the daemon for
14121 listening; they are also used to identify the local host when routing. Chapter
14122 &<<CHAPinterfaces>>& contains a full description of this option and the related
14123 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14124 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14125 &%local_interfaces%& is
14126 .code
14127 local_interfaces = 0.0.0.0
14128 .endd
14129 when Exim is built without IPv6 support; otherwise it is
14130 .code
14131 local_interfaces = <; ::0 ; 0.0.0.0
14132 .endd
14133
14134 .option local_scan_timeout main time 5m
14135 .cindex "timeout" "for &[local_scan()]& function"
14136 .cindex "&[local_scan()]& function" "timeout"
14137 This timeout applies to the &[local_scan()]& function (see chapter
14138 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14139 the incoming message is rejected with a temporary error if it is an SMTP
14140 message. For a non-SMTP message, the message is dropped and Exim ends with a
14141 non-zero code. The incident is logged on the main and reject logs.
14142
14143
14144
14145 .option local_sender_retain main boolean false
14146 .cindex "&'Sender:'& header line" "retaining from local submission"
14147 When a message is submitted locally (that is, not over a TCP/IP connection) by
14148 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14149 do not want this to happen, you must set &%local_sender_retain%&, and you must
14150 also set &%local_from_check%& to be false (Exim will complain if you do not).
14151 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14152 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14153
14154
14155
14156
14157 .option localhost_number main string&!! unset
14158 .cindex "host" "locally unique number for"
14159 .cindex "message ids" "with multiple hosts"
14160 .vindex "&$localhost_number$&"
14161 Exim's message ids are normally unique only within the local host. If
14162 uniqueness among a set of hosts is required, each host must set a different
14163 value for the &%localhost_number%& option. The string is expanded immediately
14164 after reading the configuration file (so that a number can be computed from the
14165 host name, for example) and the result of the expansion must be a number in the
14166 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14167 systems). This is available in subsequent string expansions via the variable
14168 &$localhost_number$&. When &%localhost_number is set%&, the final two
14169 characters of the message id, instead of just being a fractional part of the
14170 time, are computed from the time and the local host number as described in
14171 section &<<SECTmessiden>>&.
14172
14173
14174
14175 .option log_file_path main "string list&!!" "set at compile time"
14176 .cindex "log" "file path for"
14177 This option sets the path which is used to determine the names of Exim's log
14178 files, or indicates that logging is to be to syslog, or both. It is expanded
14179 when Exim is entered, so it can, for example, contain a reference to the host
14180 name. If no specific path is set for the log files at compile or run time, they
14181 are written in a sub-directory called &_log_& in Exim's spool directory.
14182 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14183 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14184 used. If this string is fixed at your installation (contains no expansion
14185 variables) it is recommended that you do not set this option in the
14186 configuration file, but instead supply the path using LOG_FILE_PATH in
14187 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14188 early on &-- in particular, failure to read the configuration file.
14189
14190
14191 .option log_selector main string unset
14192 .cindex "log" "selectors"
14193 This option can be used to reduce or increase the number of things that Exim
14194 writes to its log files. Its argument is made up of names preceded by plus or
14195 minus characters. For example:
14196 .code
14197 log_selector = +arguments -retry_defer
14198 .endd
14199 A list of possible names and what they control is given in the chapter on
14200 logging, in section &<<SECTlogselector>>&.
14201
14202
14203 .option log_timezone main boolean false
14204 .cindex "log" "timezone for entries"
14205 .vindex "&$tod_log$&"
14206 .vindex "&$tod_zone$&"
14207 By default, the timestamps on log lines are in local time without the
14208 timezone. This means that if your timezone changes twice a year, the timestamps
14209 in log lines are ambiguous for an hour when the clocks go back. One way of
14210 avoiding this problem is to set the timezone to UTC. An alternative is to set
14211 &%log_timezone%& true. This turns on the addition of the timezone offset to
14212 timestamps in log lines. Turning on this option can add quite a lot to the size
14213 of log files because each line is extended by 6 characters. Note that the
14214 &$tod_log$& variable contains the log timestamp without the zone, but there is
14215 another variable called &$tod_zone$& that contains just the timezone offset.
14216
14217
14218 .option lookup_open_max main integer 25
14219 .cindex "too many open files"
14220 .cindex "open files, too many"
14221 .cindex "file" "too many open"
14222 .cindex "lookup" "maximum open files"
14223 .cindex "limit" "open files for lookups"
14224 This option limits the number of simultaneously open files for single-key
14225 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14226 Exim normally keeps these files open during routing, because often the same
14227 file is required several times. If the limit is reached, Exim closes the least
14228 recently used file. Note that if you are using the &'ndbm'& library, it
14229 actually opens two files for each logical DBM database, though it still counts
14230 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14231 open files"& errors with NDBM, you need to reduce the value of
14232 &%lookup_open_max%&.
14233
14234
14235 .option max_username_length main integer 0
14236 .cindex "length of login name"
14237 .cindex "user name" "maximum length"
14238 .cindex "limit" "user name length"
14239 Some operating systems are broken in that they truncate long arguments to
14240 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14241 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14242 an argument that is longer behaves as if &[getpwnam()]& failed.
14243
14244
14245 .option message_body_newlines main bool false
14246 .cindex "message body" "newlines in variables"
14247 .cindex "newline" "in message body variables"
14248 .vindex "&$message_body$&"
14249 .vindex "&$message_body_end$&"
14250 By default, newlines in the message body are replaced by spaces when setting
14251 the &$message_body$& and &$message_body_end$& expansion variables. If this
14252 option is set true, this no longer happens.
14253
14254
14255 .option message_body_visible main integer 500
14256 .cindex "body of message" "visible size"
14257 .cindex "message body" "visible size"
14258 .vindex "&$message_body$&"
14259 .vindex "&$message_body_end$&"
14260 This option specifies how much of a message's body is to be included in the
14261 &$message_body$& and &$message_body_end$& expansion variables.
14262
14263
14264 .option message_id_header_domain main string&!! unset
14265 .cindex "&'Message-ID:'& header line"
14266 If this option is set, the string is expanded and used as the right hand side
14267 (domain) of the &'Message-ID:'& header that Exim creates if a
14268 locally-originated incoming message does not have one. &"Locally-originated"&
14269 means &"not received over TCP/IP."&
14270 Otherwise, the primary host name is used.
14271 Only letters, digits, dot and hyphen are accepted; any other characters are
14272 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14273 empty string, the option is ignored.
14274
14275
14276 .option message_id_header_text main string&!! unset
14277 If this variable is set, the string is expanded and used to augment the text of
14278 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14279 message does not have one. The text of this header is required by RFC 2822 to
14280 take the form of an address. By default, Exim uses its internal message id as
14281 the local part, and the primary host name as the domain. If this option is set,
14282 it is expanded, and provided the expansion is not forced to fail, and does not
14283 yield an empty string, the result is inserted into the header immediately
14284 before the @, separated from the internal message id by a dot. Any characters
14285 that are illegal in an address are automatically converted into hyphens. This
14286 means that variables such as &$tod_log$& can be used, because the spaces and
14287 colons will become hyphens.
14288
14289
14290 .option message_logs main boolean true
14291 .cindex "message logs" "disabling"
14292 .cindex "log" "message log; disabling"
14293 If this option is turned off, per-message log files are not created in the
14294 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14295 Exim, by reducing the number of files involved in handling a message from a
14296 minimum of four (header spool file, body spool file, delivery journal, and
14297 per-message log) to three. The other major I/O activity is Exim's main log,
14298 which is not affected by this option.
14299
14300
14301 .option message_size_limit main string&!! 50M
14302 .cindex "message" "size limit"
14303 .cindex "limit" "message size"
14304 .cindex "size" "of message, limit"
14305 This option limits the maximum size of message that Exim will process. The
14306 value is expanded for each incoming connection so, for example, it can be made
14307 to depend on the IP address of the remote host for messages arriving via
14308 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14309 optionally followed by K or M.
14310
14311 &*Note*&: This limit cannot be made to depend on a message's sender or any
14312 other properties of an individual message, because it has to be advertised in
14313 the server's response to EHLO. String expansion failure causes a temporary
14314 error. A value of zero means no limit, but its use is not recommended. See also
14315 &%bounce_return_size_limit%&.
14316
14317 Incoming SMTP messages are failed with a 552 error if the limit is
14318 exceeded; locally-generated messages either get a stderr message or a delivery
14319 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14320 an oversized message is logged in both the main and the reject logs. See also
14321 the generic transport option &%message_size_limit%&, which limits the size of
14322 message that an individual transport can process.
14323
14324 If you use a virus-scanner and set this option to to a value larger than the
14325 maximum size that your virus-scanner is configured to support, you may get
14326 failures triggered by large mails.  The right size to configure for the
14327 virus-scanner depends upon what data is passed and the options in use but it's
14328 probably safest to just set it to a little larger than this value.  Eg, with a
14329 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14330 some problems may result.
14331
14332 A value of 0 will disable size limit checking; Exim will still advertise the
14333 SIZE extension in an EHLO response, but without a limit, so as to permit
14334 SMTP clients to still indicate the message size along with the MAIL verb.
14335
14336
14337 .option move_frozen_messages main boolean false
14338 .cindex "frozen messages" "moving"
14339 This option, which is available only if Exim has been built with the setting
14340 .code
14341 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14342 .endd
14343 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14344 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14345 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14346 standard utilities for handling such moved messages, and they do not show up in
14347 lists generated by &%-bp%& or by the Exim monitor.
14348
14349
14350 .option mua_wrapper main boolean false
14351 Setting this option true causes Exim to run in a very restrictive mode in which
14352 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14353 contains a full description of this facility.
14354
14355
14356
14357 .option mysql_servers main "string list" unset
14358 .cindex "MySQL" "server list"
14359 This option provides a list of MySQL servers and associated connection data, to
14360 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14361 option is available only if Exim has been built with MySQL support.
14362
14363
14364 .option never_users main "string list&!!" unset
14365 This option is expanded just once, at the start of Exim's processing. Local
14366 message deliveries are normally run in processes that are setuid to the
14367 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14368 It is usually desirable to prevent any deliveries from running as root, as a
14369 safety precaution.
14370
14371 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14372 list of users that must not be used for local deliveries. This list is fixed in
14373 the binary and cannot be overridden by the configuration file. By default, it
14374 contains just the single user name &"root"&. The &%never_users%& runtime option
14375 can be used to add more users to the fixed list.
14376
14377 If a message is to be delivered as one of the users on the fixed list or the
14378 &%never_users%& list, an error occurs, and delivery is deferred. A common
14379 example is
14380 .code
14381 never_users = root:daemon:bin
14382 .endd
14383 Including root is redundant if it is also on the fixed list, but it does no
14384 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14385 transport driver.
14386
14387
14388 .option openssl_options main "string list" unset
14389 .cindex "OpenSSL "compatibility options"
14390 This option allows an administrator to adjust the SSL options applied
14391 by OpenSSL to connections.  It is given as a space-separated list of items,
14392 each one to be +added or -subtracted from the current value.
14393
14394 This option is only available if Exim is built against OpenSSL.  The values
14395 available for this option vary according to the age of your OpenSSL install.
14396 The &"all"& value controls a subset of flags which are available, typically
14397 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14398 list the values known on your system and Exim should support all the
14399 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14400 names lose the leading &"SSL_OP_"& and are lower-cased.
14401
14402 Note that adjusting the options can have severe impact upon the security of
14403 SSL as used by Exim.  It is possible to disable safety checks and shoot
14404 yourself in the foot in various unpleasant ways.  This option should not be
14405 adjusted lightly.  An unrecognised item will be detected at startup, by
14406 invoking Exim with the &%-bV%& flag.
14407
14408 .new
14409 Historical note: prior to release 4.80, Exim defaulted this value to
14410 "+dont_insert_empty_fragments", which may still be needed for compatibility
14411 with some clients, but which lowers security by increasing exposure to
14412 some now infamous attacks.
14413 .wen
14414
14415 An example:
14416 .code
14417 # Make both old MS and old Eudora happy:
14418 openssl_options = -all +microsoft_big_sslv3_buffer \
14419                        +dont_insert_empty_fragments
14420 .endd
14421
14422 Possible options may include:
14423 .ilist
14424 &`all`&
14425 .next
14426 &`allow_unsafe_legacy_renegotiation`&
14427 .next
14428 &`cipher_server_preference`&
14429 .next
14430 &`dont_insert_empty_fragments`&
14431 .next
14432 &`ephemeral_rsa`&
14433 .next
14434 &`legacy_server_connect`&
14435 .next
14436 &`microsoft_big_sslv3_buffer`&
14437 .next
14438 &`microsoft_sess_id_bug`&
14439 .next
14440 &`msie_sslv2_rsa_padding`&
14441 .next
14442 &`netscape_challenge_bug`&
14443 .next
14444 &`netscape_reuse_cipher_change_bug`&
14445 .next
14446 &`no_compression`&
14447 .next
14448 &`no_session_resumption_on_renegotiation`&
14449 .next
14450 &`no_sslv2`&
14451 .next
14452 &`no_sslv3`&
14453 .next
14454 &`no_ticket`&
14455 .next
14456 &`no_tlsv1`&
14457 .next
14458 &`no_tlsv1_1`&
14459 .next
14460 &`no_tlsv1_2`&
14461 .next
14462 &`single_dh_use`&
14463 .next
14464 &`single_ecdh_use`&
14465 .next
14466 &`ssleay_080_client_dh_bug`&
14467 .next
14468 &`sslref2_reuse_cert_type_bug`&
14469 .next
14470 &`tls_block_padding_bug`&
14471 .next
14472 &`tls_d5_bug`&
14473 .next
14474 &`tls_rollback_bug`&
14475 .endlist
14476
14477
14478 .option oracle_servers main "string list" unset
14479 .cindex "Oracle" "server list"
14480 This option provides a list of Oracle servers and associated connection data,
14481 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14482 The option is available only if Exim has been built with Oracle support.
14483
14484
14485 .option percent_hack_domains main "domain list&!!" unset
14486 .cindex "&""percent hack""&"
14487 .cindex "source routing" "in email address"
14488 .cindex "address" "source-routed"
14489 The &"percent hack"& is the convention whereby a local part containing a
14490 percent sign is re-interpreted as a new email address, with the percent
14491 replaced by @. This is sometimes called &"source routing"&, though that term is
14492 also applied to RFC 2822 addresses that begin with an @ character. If this
14493 option is set, Exim implements the percent facility for those domains listed,
14494 but no others. This happens before an incoming SMTP address is tested against
14495 an ACL.
14496
14497 &*Warning*&: The &"percent hack"& has often been abused by people who are
14498 trying to get round relaying restrictions. For this reason, it is best avoided
14499 if at all possible. Unfortunately, a number of less security-conscious MTAs
14500 implement it unconditionally. If you are running Exim on a gateway host, and
14501 routing mail through to internal MTAs without processing the local parts, it is
14502 a good idea to reject recipient addresses with percent characters in their
14503 local parts. Exim's default configuration does this.
14504
14505
14506 .option perl_at_start main boolean false
14507 This option is available only when Exim is built with an embedded Perl
14508 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14509
14510
14511 .option perl_startup main string unset
14512 This option is available only when Exim is built with an embedded Perl
14513 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14514
14515
14516 .option pgsql_servers main "string list" unset
14517 .cindex "PostgreSQL lookup type" "server list"
14518 This option provides a list of PostgreSQL servers and associated connection
14519 data, to be used in conjunction with &(pgsql)& lookups (see section
14520 &<<SECID72>>&). The option is available only if Exim has been built with
14521 PostgreSQL support.
14522
14523
14524 .option pid_file_path main string&!! "set at compile time"
14525 .cindex "daemon" "pid file path"
14526 .cindex "pid file, path for"
14527 This option sets the name of the file to which the Exim daemon writes its
14528 process id. The string is expanded, so it can contain, for example, references
14529 to the host name:
14530 .code
14531 pid_file_path = /var/log/$primary_hostname/exim.pid
14532 .endd
14533 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14534 spool directory.
14535 The value set by the option can be overridden by the &%-oP%& command line
14536 option. A pid file is not written if a &"non-standard"& daemon is run by means
14537 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14538
14539
14540 .option pipelining_advertise_hosts main "host list&!!" *
14541 .cindex "PIPELINING" "suppressing advertising"
14542 This option can be used to suppress the advertisement of the SMTP
14543 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14544 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14545 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14546 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14547 that clients will use it; &"out of order"& commands that are &"expected"& do
14548 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14549
14550
14551 .option preserve_message_logs main boolean false
14552 .cindex "message logs" "preserving"
14553 If this option is set, message log files are not deleted when messages are
14554 completed. Instead, they are moved to a sub-directory of the spool directory
14555 called &_msglog.OLD_&, where they remain available for statistical or debugging
14556 purposes. This is a dangerous option to set on systems with any appreciable
14557 volume of mail. Use with care!
14558
14559
14560 .option primary_hostname main string "see below"
14561 .cindex "name" "of local host"
14562 .cindex "host" "name of local"
14563 .cindex "local host" "name of"
14564 .vindex "&$primary_hostname$&"
14565 This specifies the name of the current host. It is used in the default EHLO or
14566 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14567 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14568 The value is also used by default in some SMTP response messages from an Exim
14569 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14570
14571 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14572 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14573 contains only one component, Exim passes it to &[gethostbyname()]& (or
14574 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14575 version. The variable &$primary_hostname$& contains the host name, whether set
14576 explicitly by this option, or defaulted.
14577
14578
14579 .option print_topbitchars main boolean false
14580 .cindex "printing characters"
14581 .cindex "8-bit characters"
14582 By default, Exim considers only those characters whose codes lie in the range
14583 32&--126 to be printing characters. In a number of circumstances (for example,
14584 when writing log entries) non-printing characters are converted into escape
14585 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14586 is set, code values of 128 and above are also considered to be printing
14587 characters.
14588
14589 This option also affects the header syntax checks performed by the
14590 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14591 the user's full name when constructing From: and Sender: addresses (as
14592 described in section &<<SECTconstr>>&). Setting this option can cause
14593 Exim to generate eight bit message headers that do not conform to the
14594 standards.
14595
14596
14597 .option process_log_path main string unset
14598 .cindex "process log path"
14599 .cindex "log" "process log"
14600 .cindex "&'exiwhat'&"
14601 This option sets the name of the file to which an Exim process writes its
14602 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14603 utility script. If this option is unset, the file called &_exim-process.info_&
14604 in Exim's spool directory is used. The ability to specify the name explicitly
14605 can be useful in environments where two different Exims are running, using
14606 different spool directories.
14607
14608
14609 .option prod_requires_admin main boolean true
14610 .oindex "&%-M%&"
14611 .oindex "&%-R%&"
14612 .oindex "&%-q%&"
14613 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14614 admin user unless &%prod_requires_admin%& is set false. See also
14615 &%queue_list_requires_admin%&.
14616
14617
14618 .option qualify_domain main string "see below"
14619 .cindex "domain" "for qualifying addresses"
14620 .cindex "address" "qualification"
14621 This option specifies the domain name that is added to any envelope sender
14622 addresses that do not have a domain qualification. It also applies to
14623 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14624 are accepted by default only for locally-generated messages. Qualification is
14625 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14626 locally-generated messages, unless the &%-bnq%& command line option is used.
14627
14628 Messages from external sources must always contain fully qualified addresses,
14629 unless the sending host matches &%sender_unqualified_hosts%& or
14630 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14631 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14632 necessary. Internally, Exim always works with fully qualified envelope
14633 addresses. If &%qualify_domain%& is not set, it defaults to the
14634 &%primary_hostname%& value.
14635
14636
14637 .option qualify_recipient main string "see below"
14638 This option allows you to specify a different domain for qualifying recipient
14639 addresses to the one that is used for senders. See &%qualify_domain%& above.
14640
14641
14642
14643 .option queue_domains main "domain list&!!" unset
14644 .cindex "domain" "specifying non-immediate delivery"
14645 .cindex "queueing incoming messages"
14646 .cindex "message" "queueing certain domains"
14647 This option lists domains for which immediate delivery is not required.
14648 A delivery process is started whenever a message is received, but only those
14649 domains that do not match are processed. All other deliveries wait until the
14650 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14651
14652
14653 .option queue_list_requires_admin main boolean true
14654 .oindex "&%-bp%&"
14655 The &%-bp%& command-line option, which lists the messages that are on the
14656 queue, requires the caller to be an admin user unless
14657 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14658
14659
14660 .option queue_only main boolean false
14661 .cindex "queueing incoming messages"
14662 .cindex "message" "queueing unconditionally"
14663 If &%queue_only%& is set, a delivery process is not automatically started
14664 whenever a message is received. Instead, the message waits on the queue for the
14665 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14666 delivered immediately when certain conditions (such as heavy load) occur.
14667
14668 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14669 and &%-odi%& command line options override &%queue_only%& unless
14670 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14671 &%queue_only_load%&, and &%smtp_accept_queue%&.
14672
14673
14674 .option queue_only_file main string unset
14675 .cindex "queueing incoming messages"
14676 .cindex "message" "queueing by file existence"
14677 This option can be set to a colon-separated list of absolute path names, each
14678 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14679 it tests for the existence of each listed path using a call to &[stat()]&. For
14680 each path that exists, the corresponding queueing option is set.
14681 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14682 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14683 .code
14684 queue_only_file = smtp/some/file
14685 .endd
14686 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14687 &_/some/file_& exists.
14688
14689
14690 .option queue_only_load main fixed-point unset
14691 .cindex "load average"
14692 .cindex "queueing incoming messages"
14693 .cindex "message" "queueing by load"
14694 If the system load average is higher than this value, incoming messages from
14695 all sources are queued, and no automatic deliveries are started. If this
14696 happens during local or remote SMTP input, all subsequent messages received on
14697 the same SMTP connection are queued by default, whatever happens to the load in
14698 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14699 false.
14700
14701 Deliveries will subsequently be performed by queue runner processes. This
14702 option has no effect on ancient operating systems on which Exim cannot
14703 determine the load average. See also &%deliver_queue_load_max%& and
14704 &%smtp_load_reserve%&.
14705
14706
14707 .option queue_only_load_latch main boolean true
14708 .cindex "load average" "re-evaluating per message"
14709 When this option is true (the default), once one message has been queued
14710 because the load average is higher than the value set by &%queue_only_load%&,
14711 all subsequent messages received on the same SMTP connection are also queued.
14712 This is a deliberate choice; even though the load average may fall below the
14713 threshold, it doesn't seem right to deliver later messages on the same
14714 connection when not delivering earlier ones. However, there are special
14715 circumstances such as very long-lived connections from scanning appliances
14716 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14717 should be set false. This causes the value of the load average to be
14718 re-evaluated for each message.
14719
14720
14721 .option queue_only_override main boolean true
14722 .cindex "queueing incoming messages"
14723 When this option is true, the &%-od%&&'x'& command line options override the
14724 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14725 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14726 to override; they are accepted, but ignored.
14727
14728
14729 .option queue_run_in_order main boolean false
14730 .cindex "queue runner" "processing messages in order"
14731 If this option is set, queue runs happen in order of message arrival instead of
14732 in an arbitrary order. For this to happen, a complete list of the entire queue
14733 must be set up before the deliveries start. When the queue is all held in a
14734 single directory (the default), a single list is created for both the ordered
14735 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14736 single list is not created when &%queue_run_in_order%& is false. In this case,
14737 the sub-directories are processed one at a time (in a random order), and this
14738 avoids setting up one huge list for the whole queue. Thus, setting
14739 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14740 when the queue is large, because of the extra work in setting up the single,
14741 large list. In most situations, &%queue_run_in_order%& should not be set.
14742
14743
14744
14745 .option queue_run_max main integer 5
14746 .cindex "queue runner" "maximum number of"
14747 This controls the maximum number of queue runner processes that an Exim daemon
14748 can run simultaneously. This does not mean that it starts them all at once,
14749 but rather that if the maximum number are still running when the time comes to
14750 start another one, it refrains from starting another one. This can happen with
14751 very large queues and/or very sluggish deliveries. This option does not,
14752 however, interlock with other processes, so additional queue runners can be
14753 started by other means, or by killing and restarting the daemon.
14754
14755 Setting this option to zero does not suppress queue runs; rather, it disables
14756 the limit, allowing any number of simultaneous queue runner processes to be
14757 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14758 the daemon's command line.
14759
14760 .option queue_smtp_domains main "domain list&!!" unset
14761 .cindex "queueing incoming messages"
14762 .cindex "message" "queueing remote deliveries"
14763 When this option is set, a delivery process is started whenever a message is
14764 received, routing is performed, and local deliveries take place.
14765 However, if any SMTP deliveries are required for domains that match
14766 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14767 message waits on the queue for the next queue run. Since routing of the message
14768 has taken place, Exim knows to which remote hosts it must be delivered, and so
14769 when the queue run happens, multiple messages for the same host are delivered
14770 over a single SMTP connection. The &%-odqs%& command line option causes all
14771 SMTP deliveries to be queued in this way, and is equivalent to setting
14772 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14773 &%queue_domains%&.
14774
14775
14776 .option receive_timeout main time 0s
14777 .cindex "timeout" "for non-SMTP input"
14778 This option sets the timeout for accepting a non-SMTP message, that is, the
14779 maximum time that Exim waits when reading a message on the standard input. If
14780 the value is zero, it will wait for ever. This setting is overridden by the
14781 &%-or%& command line option. The timeout for incoming SMTP messages is
14782 controlled by &%smtp_receive_timeout%&.
14783
14784 .option received_header_text main string&!! "see below"
14785 .cindex "customizing" "&'Received:'& header"
14786 .cindex "&'Received:'& header line" "customizing"
14787 This string defines the contents of the &'Received:'& message header that is
14788 added to each message, except for the timestamp, which is automatically added
14789 on at the end (preceded by a semicolon). The string is expanded each time it is
14790 used. If the expansion yields an empty string, no &'Received:'& header line is
14791 added to the message. Otherwise, the string should start with the text
14792 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14793 header lines. The default setting is:
14794
14795 .code
14796 received_header_text = Received: \
14797   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14798   {${if def:sender_ident \
14799   {from ${quote_local_part:$sender_ident} }}\
14800   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14801   by $primary_hostname \
14802   ${if def:received_protocol {with $received_protocol}} \
14803   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14804   (Exim $version_number)\n\t\
14805   ${if def:sender_address \
14806   {(envelope-from <$sender_address>)\n\t}}\
14807   id $message_exim_id\
14808   ${if def:received_for {\n\tfor $received_for}}
14809 .endd
14810
14811 The reference to the TLS cipher is omitted when Exim is built without TLS
14812 support. The use of conditional expansions ensures that this works for both
14813 locally generated messages and messages received from remote hosts, giving
14814 header lines such as the following:
14815 .code
14816 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14817 by marley.carol.example with esmtp (Exim 4.00)
14818 (envelope-from <bob@carol.example>)
14819 id 16IOWa-00019l-00
14820 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14821 Received: by scrooge.carol.example with local (Exim 4.00)
14822 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14823 .endd
14824 Until the body of the message has been received, the timestamp is the time when
14825 the message started to be received. Once the body has arrived, and all policy
14826 checks have taken place, the timestamp is updated to the time at which the
14827 message was accepted.
14828
14829
14830 .option received_headers_max main integer 30
14831 .cindex "loop" "prevention"
14832 .cindex "mail loop prevention"
14833 .cindex "&'Received:'& header line" "counting"
14834 When a message is to be delivered, the number of &'Received:'& headers is
14835 counted, and if it is greater than this parameter, a mail loop is assumed to
14836 have occurred, the delivery is abandoned, and an error message is generated.
14837 This applies to both local and remote deliveries.
14838
14839
14840 .option recipient_unqualified_hosts main "host list&!!" unset
14841 .cindex "unqualified addresses"
14842 .cindex "host" "unqualified addresses from"
14843 This option lists those hosts from which Exim is prepared to accept unqualified
14844 recipient addresses in message envelopes. The addresses are made fully
14845 qualified by the addition of the &%qualify_recipient%& value. This option also
14846 affects message header lines. Exim does not reject unqualified recipient
14847 addresses in headers, but it qualifies them only if the message came from a
14848 host that matches &%recipient_unqualified_hosts%&,
14849 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14850 option was not set.
14851
14852
14853 .option recipients_max main integer 0
14854 .cindex "limit" "number of recipients"
14855 .cindex "recipient" "maximum number"
14856 If this option is set greater than zero, it specifies the maximum number of
14857 original recipients for any message. Additional recipients that are generated
14858 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14859 all recipients over the limit; earlier recipients are delivered as normal.
14860 Non-SMTP messages with too many recipients are failed, and no deliveries are
14861 done.
14862
14863 .cindex "RCPT" "maximum number of incoming"
14864 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14865 RCPT commands in a single message.
14866
14867
14868 .option recipients_max_reject main boolean false
14869 If this option is set true, Exim rejects SMTP messages containing too many
14870 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14871 error to the eventual DATA command. Otherwise (the default) it gives a 452
14872 error to the surplus RCPT commands and accepts the message on behalf of the
14873 initial set of recipients. The remote server should then re-send the message
14874 for the remaining recipients at a later time.
14875
14876
14877 .option remote_max_parallel main integer 2
14878 .cindex "delivery" "parallelism for remote"
14879 This option controls parallel delivery of one message to a number of remote
14880 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14881 does all the remote deliveries for a message one by one. Otherwise, if a single
14882 message has to be delivered to more than one remote host, or if several copies
14883 have to be sent to the same remote host, up to &%remote_max_parallel%&
14884 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14885 deliveries are required, the maximum number of processes are started, and as
14886 each one finishes, another is begun. The order of starting processes is the
14887 same as if sequential delivery were being done, and can be controlled by the
14888 &%remote_sort_domains%& option. If parallel delivery takes place while running
14889 with debugging turned on, the debugging output from each delivery process is
14890 tagged with its process id.
14891
14892 This option controls only the maximum number of parallel deliveries for one
14893 message in one Exim delivery process. Because Exim has no central queue
14894 manager, there is no way of controlling the total number of simultaneous
14895 deliveries if the configuration allows a delivery attempt as soon as a message
14896 is received.
14897
14898 .cindex "number of deliveries"
14899 .cindex "delivery" "maximum number of"
14900 If you want to control the total number of deliveries on the system, you
14901 need to set the &%queue_only%& option. This ensures that all incoming messages
14902 are added to the queue without starting a delivery process. Then set up an Exim
14903 daemon to start queue runner processes at appropriate intervals (probably
14904 fairly often, for example, every minute), and limit the total number of queue
14905 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14906 delivers only one message at a time, the maximum number of deliveries that can
14907 then take place at once is &%queue_run_max%& multiplied by
14908 &%remote_max_parallel%&.
14909
14910 If it is purely remote deliveries you want to control, use
14911 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14912 doing the SMTP routing before queueing, so that several messages for the same
14913 host will eventually get delivered down the same connection.
14914
14915
14916 .option remote_sort_domains main "domain list&!!" unset
14917 .cindex "sorting remote deliveries"
14918 .cindex "delivery" "sorting remote"
14919 When there are a number of remote deliveries for a message, they are sorted by
14920 domain into the order given by this list. For example,
14921 .code
14922 remote_sort_domains = *.cam.ac.uk:*.uk
14923 .endd
14924 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14925 then to those in the &%uk%& domain, then to any others.
14926
14927
14928 .option retry_data_expire main time 7d
14929 .cindex "hints database" "data expiry"
14930 This option sets a &"use before"& time on retry information in Exim's hints
14931 database. Any older retry data is ignored. This means that, for example, once a
14932 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14933 past failures.
14934
14935
14936 .option retry_interval_max main time 24h
14937 .cindex "retry" "limit on interval"
14938 .cindex "limit" "on retry interval"
14939 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14940 intervals between delivery attempts for messages that cannot be delivered
14941 straight away. This option sets an overall limit to the length of time between
14942 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14943 the default value.
14944
14945
14946 .option return_path_remove main boolean true
14947 .cindex "&'Return-path:'& header line" "removing"
14948 RFC 2821, section 4.4, states that an SMTP server must insert a
14949 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14950 The &'Return-path:'& header preserves the sender address as received in the
14951 MAIL command. This description implies that this header should not be present
14952 in an incoming message. If &%return_path_remove%& is true, any existing
14953 &'Return-path:'& headers are removed from messages at the time they are
14954 received. Exim's transports have options for adding &'Return-path:'& headers at
14955 the time of delivery. They are normally used only for final local deliveries.
14956
14957
14958 .option return_size_limit main integer 100K
14959 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14960
14961
14962 .option rfc1413_hosts main "host list&!!" *
14963 .cindex "RFC 1413"
14964 .cindex "host" "for RFC 1413 calls"
14965 RFC 1413 identification calls are made to any client host which matches an item
14966 in the list.
14967
14968 .option rfc1413_query_timeout main time 5s
14969 .cindex "RFC 1413" "query timeout"
14970 .cindex "timeout" "for RFC 1413 call"
14971 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14972 no RFC 1413 calls are ever made.
14973
14974
14975 .option sender_unqualified_hosts main "host list&!!" unset
14976 .cindex "unqualified addresses"
14977 .cindex "host" "unqualified addresses from"
14978 This option lists those hosts from which Exim is prepared to accept unqualified
14979 sender addresses. The addresses are made fully qualified by the addition of
14980 &%qualify_domain%&. This option also affects message header lines. Exim does
14981 not reject unqualified addresses in headers that contain sender addresses, but
14982 it qualifies them only if the message came from a host that matches
14983 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14984 using TCP/IP), and the &%-bnq%& option was not set.
14985
14986
14987 .option smtp_accept_keepalive main boolean true
14988 .cindex "keepalive" "on incoming connection"
14989 This option controls the setting of the SO_KEEPALIVE option on incoming
14990 TCP/IP socket connections. When set, it causes the kernel to probe idle
14991 connections periodically, by sending packets with &"old"& sequence numbers. The
14992 other end of the connection should send an acknowledgment if the connection is
14993 still okay or a reset if the connection has been aborted. The reason for doing
14994 this is that it has the beneficial effect of freeing up certain types of
14995 connection that can get stuck when the remote host is disconnected without
14996 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14997 hours to detect unreachable hosts.
14998
14999
15000
15001 .option smtp_accept_max main integer 20
15002 .cindex "limit" "incoming SMTP connections"
15003 .cindex "SMTP" "incoming connection count"
15004 .cindex "inetd"
15005 This option specifies the maximum number of simultaneous incoming SMTP calls
15006 that Exim will accept. It applies only to the listening daemon; there is no
15007 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15008 value is set to zero, no limit is applied. However, it is required to be
15009 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15010 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15011
15012 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15013 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15014 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15015 and &%smtp_load_reserve%& are then checked before accepting the connection.
15016
15017
15018 .option smtp_accept_max_nonmail main integer 10
15019 .cindex "limit" "non-mail SMTP commands"
15020 .cindex "SMTP" "limiting non-mail commands"
15021 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15022 the connection if there are too many. This option defines &"too many"&. The
15023 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15024 client looping sending EHLO, for example. The check is applied only if the
15025 client host matches &%smtp_accept_max_nonmail_hosts%&.
15026
15027 When a new message is expected, one occurrence of RSET is not counted. This
15028 allows a client to send one RSET between messages (this is not necessary,
15029 but some clients do it). Exim also allows one uncounted occurrence of HELO
15030 or EHLO, and one occurrence of STARTTLS between messages. After
15031 starting up a TLS session, another EHLO is expected, and so it too is not
15032 counted. The first occurrence of AUTH in a connection, or immediately
15033 following STARTTLS is not counted. Otherwise, all commands other than
15034 MAIL, RCPT, DATA, and QUIT are counted.
15035
15036
15037 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15038 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15039 check by setting this option. The default value makes it apply to all hosts. By
15040 changing the value, you can exclude any badly-behaved hosts that you have to
15041 live with.
15042
15043
15044 . Allow this long option name to split; give it unsplit as a fifth argument
15045 . for the automatic .oindex that is generated by .option.
15046
15047 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
15048          smtp_accept_max_per_connection
15049 .cindex "SMTP" "limiting incoming message count"
15050 .cindex "limit" "messages per SMTP connection"
15051 The value of this option limits the number of MAIL commands that Exim is
15052 prepared to accept over a single SMTP connection, whether or not each command
15053 results in the transfer of a message. After the limit is reached, a 421
15054 response is given to subsequent MAIL commands. This limit is a safety
15055 precaution against a client that goes mad (incidents of this type have been
15056 seen).
15057
15058
15059 .option smtp_accept_max_per_host main string&!! unset
15060 .cindex "limit" "SMTP connections from one host"
15061 .cindex "host" "limiting SMTP connections from"
15062 This option restricts the number of simultaneous IP connections from a single
15063 host (strictly, from a single IP address) to the Exim daemon. The option is
15064 expanded, to enable different limits to be applied to different hosts by
15065 reference to &$sender_host_address$&. Once the limit is reached, additional
15066 connection attempts from the same host are rejected with error code 421. This
15067 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15068 of zero imposes no limit. If this option is set greater than zero, it is
15069 required that &%smtp_accept_max%& be non-zero.
15070
15071 &*Warning*&: When setting this option you should not use any expansion
15072 constructions that take an appreciable amount of time. The expansion and test
15073 happen in the main daemon loop, in order to reject additional connections
15074 without forking additional processes (otherwise a denial-of-service attack
15075 could cause a vast number or processes to be created). While the daemon is
15076 doing this processing, it cannot accept any other incoming connections.
15077
15078
15079
15080 .option smtp_accept_queue main integer 0
15081 .cindex "SMTP" "incoming connection count"
15082 .cindex "queueing incoming messages"
15083 .cindex "message" "queueing by SMTP connection count"
15084 If the number of simultaneous incoming SMTP connections being handled via the
15085 listening daemon exceeds this value, messages received by SMTP are just placed
15086 on the queue; no delivery processes are started automatically. The count is
15087 fixed at the start of an SMTP connection. It cannot be updated in the
15088 subprocess that receives messages, and so the queueing or not queueing applies
15089 to all messages received in the same connection.
15090
15091 A value of zero implies no limit, and clearly any non-zero value is useful only
15092 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15093 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15094 various &%-od%&&'x'& command line options.
15095
15096
15097 . Allow this long option name to split; give it unsplit as a fifth argument
15098 . for the automatic .oindex that is generated by .option.
15099
15100 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15101          smtp_accept_queue_per_connection
15102 .cindex "queueing incoming messages"
15103 .cindex "message" "queueing by message count"
15104 This option limits the number of delivery processes that Exim starts
15105 automatically when receiving messages via SMTP, whether via the daemon or by
15106 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15107 and the number of messages received in a single SMTP session exceeds this
15108 number, subsequent messages are placed on the queue, but no delivery processes
15109 are started. This helps to limit the number of Exim processes when a server
15110 restarts after downtime and there is a lot of mail waiting for it on other
15111 systems. On large systems, the default should probably be increased, and on
15112 dial-in client systems it should probably be set to zero (that is, disabled).
15113
15114
15115 .option smtp_accept_reserve main integer 0
15116 .cindex "SMTP" "incoming call count"
15117 .cindex "host" "reserved"
15118 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15119 number of SMTP connections that are reserved for connections from the hosts
15120 that are specified in &%smtp_reserve_hosts%&. The value set in
15121 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15122 restricted to this number of connections; the option specifies a minimum number
15123 of connection slots for them, not a maximum. It is a guarantee that this group
15124 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15125 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15126 individual host.
15127
15128 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15129 set to 5, once there are 45 active connections (from any hosts), new
15130 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15131 provided the other criteria for acceptance are met.
15132
15133
15134 .option smtp_active_hostname main string&!! unset
15135 .cindex "host" "name in SMTP responses"
15136 .cindex "SMTP" "host name in responses"
15137 .vindex "&$primary_hostname$&"
15138 This option is provided for multi-homed servers that want to masquerade as
15139 several different hosts. At the start of an incoming SMTP connection, its value
15140 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15141 responses. For example, it is used as domain name in the response to an
15142 incoming HELO or EHLO command.
15143
15144 .vindex "&$smtp_active_hostname$&"
15145 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15146 is saved with any messages that are received. It is therefore available for use
15147 in routers and transports when the message is later delivered.
15148
15149 If this option is unset, or if its expansion is forced to fail, or if the
15150 expansion results in an empty string, the value of &$primary_hostname$& is
15151 used. Other expansion failures cause a message to be written to the main and
15152 panic logs, and the SMTP command receives a temporary error. Typically, the
15153 value of &%smtp_active_hostname%& depends on the incoming interface address.
15154 For example:
15155 .code
15156 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15157   {cox.mydomain}{box.mydomain}}
15158 .endd
15159
15160 Although &$smtp_active_hostname$& is primarily concerned with incoming
15161 messages, it is also used as the default for HELO commands in callout
15162 verification if there is no remote transport from which to obtain a
15163 &%helo_data%& value.
15164
15165 .option smtp_banner main string&!! "see below"
15166 .cindex "SMTP" "welcome banner"
15167 .cindex "banner for SMTP"
15168 .cindex "welcome banner for SMTP"
15169 .cindex "customizing" "SMTP banner"
15170 This string, which is expanded every time it is used, is output as the initial
15171 positive response to an SMTP connection. The default setting is:
15172 .code
15173 smtp_banner = $smtp_active_hostname ESMTP Exim \
15174   $version_number $tod_full
15175 .endd
15176 Failure to expand the string causes a panic error. If you want to create a
15177 multiline response to the initial SMTP connection, use &"\n"& in the string at
15178 appropriate points, but not at the end. Note that the 220 code is not included
15179 in this string. Exim adds it automatically (several times in the case of a
15180 multiline response).
15181
15182
15183 .option smtp_check_spool_space main boolean true
15184 .cindex "checking disk space"
15185 .cindex "disk space, checking"
15186 .cindex "spool directory" "checking space"
15187 When this option is set, if an incoming SMTP session encounters the SIZE
15188 option on a MAIL command, it checks that there is enough space in the
15189 spool directory's partition to accept a message of that size, while still
15190 leaving free the amount specified by &%check_spool_space%& (even if that value
15191 is zero). If there isn't enough space, a temporary error code is returned.
15192
15193
15194 .option smtp_connect_backlog main integer 20
15195 .cindex "connection backlog"
15196 .cindex "SMTP" "connection backlog"
15197 .cindex "backlog of connections"
15198 This option specifies a maximum number of waiting SMTP connections. Exim passes
15199 this value to the TCP/IP system when it sets up its listener. Once this number
15200 of connections are waiting for the daemon's attention, subsequent connection
15201 attempts are refused at the TCP/IP level. At least, that is what the manuals
15202 say; in some circumstances such connection attempts have been observed to time
15203 out instead. For large systems it is probably a good idea to increase the
15204 value (to 50, say). It also gives some protection against denial-of-service
15205 attacks by SYN flooding.
15206
15207
15208 .option smtp_enforce_sync main boolean true
15209 .cindex "SMTP" "synchronization checking"
15210 .cindex "synchronization checking in SMTP"
15211 The SMTP protocol specification requires the client to wait for a response from
15212 the server at certain points in the dialogue. Without PIPELINING these
15213 synchronization points are after every command; with PIPELINING they are
15214 fewer, but they still exist.
15215
15216 Some spamming sites send out a complete set of SMTP commands without waiting
15217 for any response. Exim protects against this by rejecting a message if the
15218 client has sent further input when it should not have. The error response &"554
15219 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15220 for this error cannot be perfect because of transmission delays (unexpected
15221 input may be on its way but not yet received when Exim checks). However, it
15222 does detect many instances.
15223
15224 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15225 If you want to disable the check selectively (for example, only for certain
15226 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15227 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15228
15229
15230
15231 .option smtp_etrn_command main string&!! unset
15232 .cindex "ETRN" "command to be run"
15233 .vindex "&$domain$&"
15234 If this option is set, the given command is run whenever an SMTP ETRN
15235 command is received from a host that is permitted to issue such commands (see
15236 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15237 are independently expanded. The expansion variable &$domain$& is set to the
15238 argument of the ETRN command, and no syntax checking is done on it. For
15239 example:
15240 .code
15241 smtp_etrn_command = /etc/etrn_command $domain \
15242                     $sender_host_address
15243 .endd
15244 A new process is created to run the command, but Exim does not wait for it to
15245 complete. Consequently, its status cannot be checked. If the command cannot be
15246 run, a line is written to the panic log, but the ETRN caller still receives
15247 a 250 success response. Exim is normally running under its own uid when
15248 receiving SMTP, so it is not possible for it to change the uid before running
15249 the command.
15250
15251
15252 .option smtp_etrn_serialize main boolean true
15253 .cindex "ETRN" "serializing"
15254 When this option is set, it prevents the simultaneous execution of more than
15255 one identical command as a result of ETRN in an SMTP connection. See
15256 section &<<SECTETRN>>& for details.
15257
15258
15259 .option smtp_load_reserve main fixed-point unset
15260 .cindex "load average"
15261 If the system load average ever gets higher than this, incoming SMTP calls are
15262 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15263 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15264 the load is over the limit. The option has no effect on ancient operating
15265 systems on which Exim cannot determine the load average. See also
15266 &%deliver_queue_load_max%& and &%queue_only_load%&.
15267
15268
15269
15270 .option smtp_max_synprot_errors main integer 3
15271 .cindex "SMTP" "limiting syntax and protocol errors"
15272 .cindex "limit" "SMTP syntax and protocol errors"
15273 Exim rejects SMTP commands that contain syntax or protocol errors. In
15274 particular, a syntactically invalid email address, as in this command:
15275 .code
15276 RCPT TO:<abc xyz@a.b.c>
15277 .endd
15278 causes immediate rejection of the command, before any other tests are done.
15279 (The ACL cannot be run if there is no valid address to set up for it.) An
15280 example of a protocol error is receiving RCPT before MAIL. If there are
15281 too many syntax or protocol errors in one SMTP session, the connection is
15282 dropped. The limit is set by this option.
15283
15284 .cindex "PIPELINING" "expected errors"
15285 When the PIPELINING extension to SMTP is in use, some protocol errors are
15286 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15287 Exim assumes that PIPELINING will be used if it advertises it (see
15288 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15289 not count towards the limit.
15290
15291
15292
15293 .option smtp_max_unknown_commands main integer 3
15294 .cindex "SMTP" "limiting unknown commands"
15295 .cindex "limit" "unknown SMTP commands"
15296 If there are too many unrecognized commands in an incoming SMTP session, an
15297 Exim server drops the connection. This is a defence against some kinds of abuse
15298 that subvert web
15299 clients
15300 into making connections to SMTP ports; in these circumstances, a number of
15301 non-SMTP command lines are sent first.
15302
15303
15304
15305 .option smtp_ratelimit_hosts main "host list&!!" unset
15306 .cindex "SMTP" "rate limiting"
15307 .cindex "limit" "rate of message arrival"
15308 .cindex "RCPT" "rate limiting"
15309 Some sites find it helpful to be able to limit the rate at which certain hosts
15310 can send them messages, and the rate at which an individual message can specify
15311 recipients.
15312
15313 Exim has two rate-limiting facilities. This section describes the older
15314 facility, which can limit rates within a single connection. The newer
15315 &%ratelimit%& ACL condition can limit rates across all connections. See section
15316 &<<SECTratelimiting>>& for details of the newer facility.
15317
15318 When a host matches &%smtp_ratelimit_hosts%&, the values of
15319 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15320 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15321 respectively. Each option, if set, must contain a set of four comma-separated
15322 values:
15323
15324 .ilist
15325 A threshold, before which there is no rate limiting.
15326 .next
15327 An initial time delay. Unlike other times in Exim, numbers with decimal
15328 fractional parts are allowed here.
15329 .next
15330 A factor by which to increase the delay each time.
15331 .next
15332 A maximum value for the delay. This should normally be less than 5 minutes,
15333 because after that time, the client is liable to timeout the SMTP command.
15334 .endlist
15335
15336 For example, these settings have been used successfully at the site which
15337 first suggested this feature, for controlling mail from their customers:
15338 .code
15339 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15340 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15341 .endd
15342 The first setting specifies delays that are applied to MAIL commands after
15343 two have been received over a single connection. The initial delay is 0.5
15344 seconds, increasing by a factor of 1.05 each time. The second setting applies
15345 delays to RCPT commands when more than four occur in a single message.
15346
15347
15348 .option smtp_ratelimit_mail main string unset
15349 See &%smtp_ratelimit_hosts%& above.
15350
15351
15352 .option smtp_ratelimit_rcpt main string unset
15353 See &%smtp_ratelimit_hosts%& above.
15354
15355
15356 .option smtp_receive_timeout main time 5m
15357 .cindex "timeout" "for SMTP input"
15358 .cindex "SMTP" "input timeout"
15359 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15360 input, including batch SMTP. If a line of input (either an SMTP command or a
15361 data line) is not received within this time, the SMTP connection is dropped and
15362 the message is abandoned.
15363 A line is written to the log containing one of the following messages:
15364 .code
15365 SMTP command timeout on connection from...
15366 SMTP data timeout on connection from...
15367 .endd
15368 The former means that Exim was expecting to read an SMTP command; the latter
15369 means that it was in the DATA phase, reading the contents of a message.
15370
15371
15372 .oindex "&%-os%&"
15373 The value set by this option can be overridden by the
15374 &%-os%& command-line option. A setting of zero time disables the timeout, but
15375 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15376 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15377 timeout is controlled by &%receive_timeout%& and &%-or%&.
15378
15379
15380 .option smtp_reserve_hosts main "host list&!!" unset
15381 This option defines hosts for which SMTP connections are reserved; see
15382 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15383
15384
15385 .option smtp_return_error_details main boolean false
15386 .cindex "SMTP" "details policy failures"
15387 .cindex "policy control" "rejection, returning details"
15388 In the default state, Exim uses bland messages such as
15389 &"Administrative prohibition"& when it rejects SMTP commands for policy
15390 reasons. Many sysadmins like this because it gives away little information
15391 to spammers. However, some other sysadmins who are applying strict checking
15392 policies want to give out much fuller information about failures. Setting
15393 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15394 example, instead of &"Administrative prohibition"&, it might give:
15395 .code
15396 550-Rejected after DATA: '>' missing at end of address:
15397 550 failing address in "From" header is: <user@dom.ain
15398 .endd
15399
15400 .option spamd_address main string "see below"
15401 This option is available when Exim is compiled with the content-scanning
15402 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15403 The default value is
15404 .code
15405 127.0.0.1 783
15406 .endd
15407 See section &<<SECTscanspamass>>& for more details.
15408
15409
15410
15411 .option split_spool_directory main boolean false
15412 .cindex "multiple spool directories"
15413 .cindex "spool directory" "split"
15414 .cindex "directories, multiple"
15415 If this option is set, it causes Exim to split its input directory into 62
15416 subdirectories, each with a single alphanumeric character as its name. The
15417 sixth character of the message id is used to allocate messages to
15418 subdirectories; this is the least significant base-62 digit of the time of
15419 arrival of the message.
15420
15421 Splitting up the spool in this way may provide better performance on systems
15422 where there are long mail queues, by reducing the number of files in any one
15423 directory. The msglog directory is also split up in a similar way to the input
15424 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15425 are still placed in the single directory &_msglog.OLD_&.
15426
15427 It is not necessary to take any special action for existing messages when
15428 changing &%split_spool_directory%&. Exim notices messages that are in the
15429 &"wrong"& place, and continues to process them. If the option is turned off
15430 after a period of being on, the subdirectories will eventually empty and be
15431 automatically deleted.
15432
15433 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15434 changes. Instead of creating a list of all messages in the queue, and then
15435 trying to deliver each one in turn, it constructs a list of those in one
15436 sub-directory and tries to deliver them, before moving on to the next
15437 sub-directory. The sub-directories are processed in a random order. This
15438 spreads out the scanning of the input directories, and uses less memory. It is
15439 particularly beneficial when there are lots of messages on the queue. However,
15440 if &%queue_run_in_order%& is set, none of this new processing happens. The
15441 entire queue has to be scanned and sorted before any deliveries can start.
15442
15443
15444 .option spool_directory main string&!! "set at compile time"
15445 .cindex "spool directory" "path to"
15446 This defines the directory in which Exim keeps its spool, that is, the messages
15447 it is waiting to deliver. The default value is taken from the compile-time
15448 configuration setting, if there is one. If not, this option must be set. The
15449 string is expanded, so it can contain, for example, a reference to
15450 &$primary_hostname$&.
15451
15452 If the spool directory name is fixed on your installation, it is recommended
15453 that you set it at build time rather than from this option, particularly if the
15454 log files are being written to the spool directory (see &%log_file_path%&).
15455 Otherwise log files cannot be used for errors that are detected early on, such
15456 as failures in the configuration file.
15457
15458 By using this option to override the compiled-in path, it is possible to run
15459 tests of Exim without using the standard spool.
15460
15461 .option sqlite_lock_timeout main time 5s
15462 .cindex "sqlite lookup type" "lock timeout"
15463 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15464 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15465
15466 .option strict_acl_vars main boolean false
15467 .cindex "&ACL;" "variables, handling unset"
15468 This option controls what happens if a syntactically valid but undefined ACL
15469 variable is referenced. If it is false (the default), an empty string
15470 is substituted; if it is true, an error is generated. See section
15471 &<<SECTaclvariables>>& for details of ACL variables.
15472
15473 .option strip_excess_angle_brackets main boolean false
15474 .cindex "angle brackets, excess"
15475 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15476 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15477 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15478 passed on to another MTA, the excess angle brackets are not passed on. If this
15479 option is not set, multiple pairs of angle brackets cause a syntax error.
15480
15481
15482 .option strip_trailing_dot main boolean false
15483 .cindex "trailing dot on domain"
15484 .cindex "dot" "trailing on domain"
15485 If this option is set, a trailing dot at the end of a domain in an address is
15486 ignored. If this is in the envelope and the message is passed on to another
15487 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15488 domain causes a syntax error.
15489 However, addresses in header lines are checked only when an ACL requests header
15490 syntax checking.
15491
15492
15493 .option syslog_duplication main boolean true
15494 .cindex "syslog" "duplicate log lines; suppressing"
15495 When Exim is logging to syslog, it writes the log lines for its three
15496 separate logs at different syslog priorities so that they can in principle
15497 be separated on the logging hosts. Some installations do not require this
15498 separation, and in those cases, the duplication of certain log lines is a
15499 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15500 particular log line is written to syslog. For lines that normally go to
15501 both the main log and the reject log, the reject log version (possibly
15502 containing message header lines) is written, at LOG_NOTICE priority.
15503 Lines that normally go to both the main and the panic log are written at
15504 the LOG_ALERT priority.
15505
15506
15507 .option syslog_facility main string unset
15508 .cindex "syslog" "facility; setting"
15509 This option sets the syslog &"facility"& name, used when Exim is logging to
15510 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15511 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15512 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15513 details of Exim's logging.
15514
15515
15516
15517 .option syslog_processname main string &`exim`&
15518 .cindex "syslog" "process name; setting"
15519 This option sets the syslog &"ident"& name, used when Exim is logging to
15520 syslog. The value must be no longer than 32 characters. See chapter
15521 &<<CHAPlog>>& for details of Exim's logging.
15522
15523
15524
15525 .option syslog_timestamp main boolean true
15526 .cindex "syslog" "timestamps"
15527 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15528 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15529 details of Exim's logging.
15530
15531
15532 .option system_filter main string&!! unset
15533 .cindex "filter" "system filter"
15534 .cindex "system filter" "specifying"
15535 .cindex "Sieve filter" "not available for system filter"
15536 This option specifies an Exim filter file that is applied to all messages at
15537 the start of each delivery attempt, before any routing is done. System filters
15538 must be Exim filters; they cannot be Sieve filters. If the system filter
15539 generates any deliveries to files or pipes, or any new mail messages, the
15540 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15541 which transports are to be used. Details of this facility are given in chapter
15542 &<<CHAPsystemfilter>>&.
15543
15544
15545 .option system_filter_directory_transport main string&!! unset
15546 .vindex "&$address_file$&"
15547 This sets the name of the transport driver that is to be used when the
15548 &%save%& command in a system message filter specifies a path ending in &"/"&,
15549 implying delivery of each message into a separate file in some directory.
15550 During the delivery, the variable &$address_file$& contains the path name.
15551
15552
15553 .option system_filter_file_transport main string&!! unset
15554 .cindex "file" "transport for system filter"
15555 This sets the name of the transport driver that is to be used when the &%save%&
15556 command in a system message filter specifies a path not ending in &"/"&. During
15557 the delivery, the variable &$address_file$& contains the path name.
15558
15559 .option system_filter_group main string unset
15560 .cindex "gid (group id)" "system filter"
15561 This option is used only when &%system_filter_user%& is also set. It sets the
15562 gid under which the system filter is run, overriding any gid that is associated
15563 with the user. The value may be numerical or symbolic.
15564
15565 .option system_filter_pipe_transport main string&!! unset
15566 .cindex "&(pipe)& transport" "for system filter"
15567 .vindex "&$address_pipe$&"
15568 This specifies the transport driver that is to be used when a &%pipe%& command
15569 is used in a system filter. During the delivery, the variable &$address_pipe$&
15570 contains the pipe command.
15571
15572
15573 .option system_filter_reply_transport main string&!! unset
15574 .cindex "&(autoreply)& transport" "for system filter"
15575 This specifies the transport driver that is to be used when a &%mail%& command
15576 is used in a system filter.
15577
15578
15579 .option system_filter_user main string unset
15580 .cindex "uid (user id)" "system filter"
15581 If this option is set to root, the system filter is run in the main Exim
15582 delivery process, as root.  Otherwise, the system filter runs in a separate
15583 process, as the given user, defaulting to the Exim run-time user.
15584 Unless the string consists entirely of digits, it
15585 is looked up in the password data. Failure to find the named user causes a
15586 configuration error. The gid is either taken from the password data, or
15587 specified by &%system_filter_group%&. When the uid is specified numerically,
15588 &%system_filter_group%& is required to be set.
15589
15590 If the system filter generates any pipe, file, or reply deliveries, the uid
15591 under which the filter is run is used when transporting them, unless a
15592 transport option overrides.
15593
15594
15595 .option tcp_nodelay main boolean true
15596 .cindex "daemon" "TCP_NODELAY on sockets"
15597 .cindex "Nagle algorithm"
15598 .cindex "TCP_NODELAY on listening sockets"
15599 If this option is set false, it stops the Exim daemon setting the
15600 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15601 turns off the &"Nagle algorithm"&, which is a way of improving network
15602 performance in interactive (character-by-character) situations. Turning it off
15603 should improve Exim's performance a bit, so that is what happens by default.
15604 However, it appears that some broken clients cannot cope, and time out. Hence
15605 this option. It affects only those sockets that are set up for listening by the
15606 daemon. Sockets created by the smtp transport for delivering mail always set
15607 TCP_NODELAY.
15608
15609
15610 .option timeout_frozen_after main time 0s
15611 .cindex "frozen messages" "timing out"
15612 .cindex "timeout" "frozen messages"
15613 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15614 message of any kind that has been on the queue for longer than the given time
15615 is automatically cancelled at the next queue run. If the frozen message is a
15616 bounce message, it is just discarded; otherwise, a bounce is sent to the
15617 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15618 If you want to timeout frozen bounce messages earlier than other kinds of
15619 frozen message, see &%ignore_bounce_errors_after%&.
15620
15621 &*Note:*& the default value of zero means no timeouts; with this setting,
15622 frozen messages remain on the queue forever (except for any frozen bounce
15623 messages that are released by &%ignore_bounce_errors_after%&).
15624
15625
15626 .option timezone main string unset
15627 .cindex "timezone, setting"
15628 The value of &%timezone%& is used to set the environment variable TZ while
15629 running Exim (if it is different on entry). This ensures that all timestamps
15630 created by Exim are in the required timezone. If you want all your timestamps
15631 to be in UTC (aka GMT) you should set
15632 .code
15633 timezone = UTC
15634 .endd
15635 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15636 or, if that is not set, from the value of the TZ environment variable when Exim
15637 is built. If &%timezone%& is set to the empty string, either at build or run
15638 time, any existing TZ variable is removed from the environment when Exim
15639 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15640 unfortunately not all, operating systems.
15641
15642
15643 .option tls_advertise_hosts main "host list&!!" unset
15644 .cindex "TLS" "advertising"
15645 .cindex "encryption" "on SMTP connection"
15646 .cindex "SMTP" "encrypted connection"
15647 When Exim is built with support for TLS encrypted connections, the availability
15648 of the STARTTLS command to set up an encrypted session is advertised in
15649 response to EHLO only to those client hosts that match this option. See
15650 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15651
15652
15653 .option tls_certificate main string&!! unset
15654 .cindex "TLS" "server certificate; location of"
15655 .cindex "certificate" "server, location of"
15656 The value of this option is expanded, and must then be the absolute path to a
15657 file which contains the server's certificates. The server's private key is also
15658 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15659 &<<CHAPTLS>>& for further details.
15660
15661 &*Note*&: The certificates defined by this option are used only when Exim is
15662 receiving incoming messages as a server. If you want to supply certificates for
15663 use when sending messages as a client, you must set the &%tls_certificate%&
15664 option in the relevant &(smtp)& transport.
15665
15666 .new
15667 If the option contains &$tls_sni$& and Exim is built against OpenSSL, then
15668 if the OpenSSL build supports TLS extensions and the TLS client sends the
15669 Server Name Indication extension, then this option and others documented in
15670 &<<SECTtlssni>>& will be re-expanded.
15671 .wen
15672
15673 .option tls_crl main string&!! unset
15674 .cindex "TLS" "server certificate revocation list"
15675 .cindex "certificate" "revocation list for server"
15676 This option specifies a certificate revocation list. The expanded value must
15677 be the name of a file that contains a CRL in PEM format.
15678
15679 .new
15680 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15681 .wen
15682
15683
15684 .new
15685 .option tls_dh_max_bits main integer 2236
15686 .cindex "TLS" "D-H bit count"
15687 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15688 the chosen TLS library.  That value might prove to be too high for
15689 interoperability.  This option provides a maximum clamp on the value
15690 suggested, trading off security for interoperability.
15691
15692 The value must be at least 1024.
15693
15694 The value 2236 was chosen because, at time of adding the option, it was the
15695 hard-coded maximum value supported by the NSS cryptographic library, as used
15696 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15697
15698 If you prefer more security and are willing to break some clients, raise this
15699 number.
15700 .wen
15701
15702
15703 .option tls_dhparam main string&!! unset
15704 .cindex "TLS" "D-H parameters for server"
15705 The value of this option is expanded, and must then be the absolute path to
15706 a file which contains the server's DH parameter values.
15707 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15708 ignored. See section &<<SECTopenvsgnu>>& for further details.
15709
15710 .new
15711 If the DH bit-count from loading the file is greater than tls_dh_max_bits then
15712 it will be ignored.
15713 .end
15714
15715
15716 .option tls_on_connect_ports main "string list" unset
15717 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15718 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15719 set up without waiting for the client to issue a STARTTLS command. For
15720 further details, see section &<<SECTsupobssmt>>&.
15721
15722
15723
15724 .option tls_privatekey main string&!! unset
15725 .cindex "TLS" "server private key; location of"
15726 The value of this option is expanded, and must then be the absolute path to a
15727 file which contains the server's private key. If this option is unset, or if
15728 the expansion is forced to fail, or the result is an empty string, the private
15729 key is assumed to be in the same file as the server's certificates. See chapter
15730 &<<CHAPTLS>>& for further details.
15731
15732 .new
15733 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15734 .wen
15735
15736
15737 .option tls_remember_esmtp main boolean false
15738 .cindex "TLS" "esmtp state; remembering"
15739 .cindex "TLS" "broken clients"
15740 If this option is set true, Exim violates the RFCs by remembering that it is in
15741 &"esmtp"& state after successfully negotiating a TLS session. This provides
15742 support for broken clients that fail to send a new EHLO after starting a
15743 TLS session.
15744
15745
15746 .option tls_require_ciphers main string&!! unset
15747 .cindex "TLS" "requiring specific ciphers"
15748 .cindex "cipher" "requiring specific"
15749 This option controls which ciphers can be used for incoming TLS connections.
15750 The &(smtp)& transport has an option of the same name for controlling outgoing
15751 connections. This option is expanded for each connection, so can be varied for
15752 different clients if required. The value of this option must be a list of
15753 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15754 in somewhat different ways. If GnuTLS is being used, the client controls the
15755 preference order of the available ciphers. Details are given in sections
15756 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15757
15758
15759 .option tls_try_verify_hosts main "host list&!!" unset
15760 .cindex "TLS" "client certificate verification"
15761 .cindex "certificate" "verification of client"
15762 See &%tls_verify_hosts%& below.
15763
15764
15765 .option tls_verify_certificates main string&!! unset
15766 .cindex "TLS" "client certificate verification"
15767 .cindex "certificate" "verification of client"
15768 The value of this option is expanded, and must then be the absolute path to
15769 a file containing permitted certificates for clients that
15770 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15771 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15772 directory containing certificate files. This does not work with GnuTLS; the
15773 option must be set to the name of a single file if you are using GnuTLS.
15774
15775 These certificates should be for the certificate authorities trusted, rather
15776 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15777 the value is a file then the certificates are sent by Exim as a server to
15778 connecting clients, defining the list of accepted certificate authorities.
15779 Thus the values defined should be considered public data.  To avoid this,
15780 use OpenSSL with a directory.
15781
15782 .new
15783 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15784 .wen
15785
15786
15787 .option tls_verify_hosts main "host list&!!" unset
15788 .cindex "TLS" "client certificate verification"
15789 .cindex "certificate" "verification of client"
15790 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15791 certificates from clients. The expected certificates are defined by
15792 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15793 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15794 &%tls_verify_certificates%& is not set.
15795
15796 Any client that matches &%tls_verify_hosts%& is constrained by
15797 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15798 present one of the listed certificates. If it does not, the connection is
15799 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15800 the host to use TLS. It can still send SMTP commands through unencrypted
15801 connections. Forcing a client to use TLS has to be done separately using an
15802 ACL to reject inappropriate commands when the connection is not encrypted.
15803
15804 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15805 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15806 certificate and checks it against &%tls_verify_certificates%&, but does not
15807 abort the connection if there is no certificate or if it does not match. This
15808 state can be detected in an ACL, which makes it possible to implement policies
15809 such as &"accept for relay only if a verified certificate has been received,
15810 but accept for local delivery if encrypted, even without a verified
15811 certificate"&.
15812
15813 Client hosts that match neither of these lists are not asked to present
15814 certificates.
15815
15816
15817 .option trusted_groups main "string list&!!" unset
15818 .cindex "trusted groups"
15819 .cindex "groups" "trusted"
15820 This option is expanded just once, at the start of Exim's processing. If this
15821 option is set, any process that is running in one of the listed groups, or
15822 which has one of them as a supplementary group, is trusted. The groups can be
15823 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15824 details of what trusted callers are permitted to do. If neither
15825 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15826 are trusted.
15827
15828 .option trusted_users main "string list&!!" unset
15829 .cindex "trusted users"
15830 .cindex "user" "trusted"
15831 This option is expanded just once, at the start of Exim's processing. If this
15832 option is set, any process that is running as one of the listed users is
15833 trusted. The users can be specified numerically or by name. See section
15834 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15835 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15836 Exim user are trusted.
15837
15838 .option unknown_login main string&!! unset
15839 .cindex "uid (user id)" "unknown caller"
15840 .vindex "&$caller_uid$&"
15841 This is a specialized feature for use in unusual configurations. By default, if
15842 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15843 gives up. The &%unknown_login%& option can be used to set a login name to be
15844 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15845 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15846 is used for the user's real name (gecos field), unless this has been set by the
15847 &%-F%& option.
15848
15849 .option unknown_username main string unset
15850 See &%unknown_login%&.
15851
15852 .option untrusted_set_sender main "address list&!!" unset
15853 .cindex "trusted users"
15854 .cindex "sender" "setting by untrusted user"
15855 .cindex "untrusted user setting sender"
15856 .cindex "user" "untrusted setting sender"
15857 .cindex "envelope sender"
15858 When an untrusted user submits a message to Exim using the standard input, Exim
15859 normally creates an envelope sender address from the user's login and the
15860 default qualification domain. Data from the &%-f%& option (for setting envelope
15861 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15862 is used) is ignored.
15863
15864 However, untrusted users are permitted to set an empty envelope sender address,
15865 to declare that a message should never generate any bounces. For example:
15866 .code
15867 exim -f '<>' user@domain.example
15868 .endd
15869 .vindex "&$sender_ident$&"
15870 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15871 other envelope sender addresses in a controlled way. When it is set, untrusted
15872 users are allowed to set envelope sender addresses that match any of the
15873 patterns in the list. Like all address lists, the string is expanded. The
15874 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15875 users to setting senders that start with their login ids
15876 followed by a hyphen
15877 by a setting like this:
15878 .code
15879 untrusted_set_sender = ^$sender_ident-
15880 .endd
15881 If you want to allow untrusted users to set envelope sender addresses without
15882 restriction, you can use
15883 .code
15884 untrusted_set_sender = *
15885 .endd
15886 The &%untrusted_set_sender%& option applies to all forms of local input, but
15887 only to the setting of the envelope sender. It does not permit untrusted users
15888 to use the other options which trusted user can use to override message
15889 parameters. Furthermore, it does not stop Exim from removing an existing
15890 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15891 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15892 overriding these actions. The handling of the &'Sender:'& header is also
15893 described in section &<<SECTthesenhea>>&.
15894
15895 The log line for a message's arrival shows the envelope sender following
15896 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15897 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15898 envelope sender address, the user's login is shown in parentheses after the
15899 sender address.
15900
15901
15902 .option uucp_from_pattern main string "see below"
15903 .cindex "&""From""& line"
15904 .cindex "UUCP" "&""From""& line"
15905 Some applications that pass messages to an MTA via a command line interface use
15906 an initial line starting with &"From&~"& to pass the envelope sender. In
15907 particular, this is used by UUCP software. Exim recognizes such a line by means
15908 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15909 matches, the sender address is constructed by expanding the contents of
15910 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15911 default pattern recognizes lines in the following two forms:
15912 .code
15913 From ph10 Fri Jan  5 12:35 GMT 1996
15914 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15915 .endd
15916 The pattern can be seen by running
15917 .code
15918 exim -bP uucp_from_pattern
15919 .endd
15920 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15921 year in the second case. The first word after &"From&~"& is matched in the
15922 regular expression by a parenthesized subpattern. The default value for
15923 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15924 (&"ph10"& in the example above) as the message's sender. See also
15925 &%ignore_fromline_hosts%&.
15926
15927
15928 .option uucp_from_sender main string&!! &`$1`&
15929 See &%uucp_from_pattern%& above.
15930
15931
15932 .option warn_message_file main string unset
15933 .cindex "warning of delay" "customizing the message"
15934 .cindex "customizing" "warning message"
15935 This option defines a template file containing paragraphs of text to be used
15936 for constructing the warning message which is sent by Exim when a message has
15937 been on the queue for a specified amount of time, as specified by
15938 &%delay_warning%&. Details of the file's contents are given in chapter
15939 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15940
15941
15942 .option write_rejectlog main boolean true
15943 .cindex "reject log" "disabling"
15944 If this option is set false, Exim no longer writes anything to the reject log.
15945 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15946 .ecindex IIDconfima
15947 .ecindex IIDmaiconf
15948
15949
15950
15951
15952 . ////////////////////////////////////////////////////////////////////////////
15953 . ////////////////////////////////////////////////////////////////////////////
15954
15955 .chapter "Generic options for routers" "CHAProutergeneric"
15956 .scindex IIDgenoprou1 "options" "generic; for routers"
15957 .scindex IIDgenoprou2 "generic options" "router"
15958 This chapter describes the generic options that apply to all routers.
15959 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15960
15961 For a general description of how a router operates, see sections
15962 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15963 which the preconditions are tested. The order of expansion of the options that
15964 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15965 &%headers_remove%&, &%transport%&.
15966
15967
15968
15969 .option address_data routers string&!! unset
15970 .cindex "router" "data attached to address"
15971 The string is expanded just before the router is run, that is, after all the
15972 precondition tests have succeeded. If the expansion is forced to fail, the
15973 router declines, the value of &%address_data%& remains unchanged, and the
15974 &%more%& option controls what happens next. Other expansion failures cause
15975 delivery of the address to be deferred.
15976
15977 .vindex "&$address_data$&"
15978 When the expansion succeeds, the value is retained with the address, and can be
15979 accessed using the variable &$address_data$& in the current router, subsequent
15980 routers, and the eventual transport.
15981
15982 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15983 that runs a user's filter file, the contents of &$address_data$& are accessible
15984 in the filter. This is not normally a problem, because such data is usually
15985 either not confidential or it &"belongs"& to the current user, but if you do
15986 put confidential data into &$address_data$& you need to remember this point.
15987
15988 Even if the router declines or passes, the value of &$address_data$& remains
15989 with the address, though it can be changed by another &%address_data%& setting
15990 on a subsequent router. If a router generates child addresses, the value of
15991 &$address_data$& propagates to them. This also applies to the special kind of
15992 &"child"& that is generated by a router with the &%unseen%& option.
15993
15994 The idea of &%address_data%& is that you can use it to look up a lot of data
15995 for the address once, and then pick out parts of the data later. For example,
15996 you could use a single LDAP lookup to return a string of the form
15997 .code
15998 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15999 .endd
16000 In the transport you could pick out the mailbox by a setting such as
16001 .code
16002 file = ${extract{mailbox}{$address_data}}
16003 .endd
16004 This makes the configuration file less messy, and also reduces the number of
16005 lookups (though Exim does cache lookups).
16006
16007 .vindex "&$sender_address_data$&"
16008 .vindex "&$address_data$&"
16009 The &%address_data%& facility is also useful as a means of passing information
16010 from one router to another, and from a router to a transport. In addition, if
16011 &$address_data$& is set by a router when verifying a recipient address from an
16012 ACL, it remains available for use in the rest of the ACL statement. After
16013 verifying a sender, the value is transferred to &$sender_address_data$&.
16014
16015
16016
16017 .option address_test routers&!? boolean true
16018 .oindex "&%-bt%&"
16019 .cindex "router" "skipping when address testing"
16020 If this option is set false, the router is skipped when routing is being tested
16021 by means of the &%-bt%& command line option. This can be a convenience when
16022 your first router sends messages to an external scanner, because it saves you
16023 having to set the &"already scanned"& indicator when testing real address
16024 routing.
16025
16026
16027
16028 .option cannot_route_message routers string&!! unset
16029 .cindex "router" "customizing &""cannot route""& message"
16030 .cindex "customizing" "&""cannot route""& message"
16031 This option specifies a text message that is used when an address cannot be
16032 routed because Exim has run out of routers. The default message is
16033 &"Unrouteable address"&. This option is useful only on routers that have
16034 &%more%& set false, or on the very last router in a configuration, because the
16035 value that is used is taken from the last router that is considered. This
16036 includes a router that is skipped because its preconditions are not met, as
16037 well as a router that declines. For example, using the default configuration,
16038 you could put:
16039 .code
16040 cannot_route_message = Remote domain not found in DNS
16041 .endd
16042 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16043 and
16044 .code
16045 cannot_route_message = Unknown local user
16046 .endd
16047 on the final router that checks for local users. If string expansion fails for
16048 this option, the default message is used. Unless the expansion failure was
16049 explicitly forced, a message about the failure is written to the main and panic
16050 logs, in addition to the normal message about the routing failure.
16051
16052
16053 .option caseful_local_part routers boolean false
16054 .cindex "case of local parts"
16055 .cindex "router" "case of local parts"
16056 By default, routers handle the local parts of addresses in a case-insensitive
16057 manner, though the actual case is preserved for transmission with the message.
16058 If you want the case of letters to be significant in a router, you must set
16059 this option true. For individual router options that contain address or local
16060 part lists (for example, &%local_parts%&), case-sensitive matching can be
16061 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16062 more details.
16063
16064 .vindex "&$local_part$&"
16065 .vindex "&$original_local_part$&"
16066 .vindex "&$parent_local_part$&"
16067 The value of the &$local_part$& variable is forced to lower case while a
16068 router is running unless &%caseful_local_part%& is set. When a router assigns
16069 an address to a transport, the value of &$local_part$& when the transport runs
16070 is the same as it was in the router. Similarly, when a router generates child
16071 addresses by aliasing or forwarding, the values of &$original_local_part$&
16072 and &$parent_local_part$& are those that were used by the redirecting router.
16073
16074 This option applies to the processing of an address by a router. When a
16075 recipient address is being processed in an ACL, there is a separate &%control%&
16076 modifier that can be used to specify case-sensitive processing within the ACL
16077 (see section &<<SECTcontrols>>&).
16078
16079
16080
16081 .option check_local_user routers&!? boolean false
16082 .cindex "local user, checking in router"
16083 .cindex "router" "checking for local user"
16084 .cindex "&_/etc/passwd_&"
16085 .vindex "&$home$&"
16086 When this option is true, Exim checks that the local part of the recipient
16087 address (with affixes removed if relevant) is the name of an account on the
16088 local system. The check is done by calling the &[getpwnam()]& function rather
16089 than trying to read &_/etc/passwd_& directly. This means that other methods of
16090 holding password data (such as NIS) are supported. If the local part is a local
16091 user, &$home$& is set from the password data, and can be tested in other
16092 preconditions that are evaluated after this one (the order of evaluation is
16093 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16094 overridden by &%router_home_directory%&. If the local part is not a local user,
16095 the router is skipped.
16096
16097 If you want to check that the local part is either the name of a local user
16098 or matches something else, you cannot combine &%check_local_user%& with a
16099 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16100 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16101 setting to achieve this. For example:
16102 .code
16103 local_parts = passwd;$local_part : lsearch;/etc/other/users
16104 .endd
16105 Note, however, that the side effects of &%check_local_user%& (such as setting
16106 up a home directory) do not occur when a &(passwd)& lookup is used in a
16107 &%local_parts%& (or any other) precondition.
16108
16109
16110
16111 .option condition routers&!? string&!! unset
16112 .cindex "router" "customized precondition"
16113 This option specifies a general precondition test that has to succeed for the
16114 router to be called. The &%condition%& option is the last precondition to be
16115 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16116 result is a forced failure, or an empty string, or one of the strings &"0"& or
16117 &"no"& or &"false"& (checked without regard to the case of the letters), the
16118 router is skipped, and the address is offered to the next one.
16119
16120 If the result is any other value, the router is run (as this is the last
16121 precondition to be evaluated, all the other preconditions must be true).
16122
16123 This option is unique in that multiple &%condition%& options may be present.
16124 All &%condition%& options must succeed.
16125
16126 The &%condition%& option provides a means of applying custom conditions to the
16127 running of routers. Note that in the case of a simple conditional expansion,
16128 the default expansion values are exactly what is wanted. For example:
16129 .code
16130 condition = ${if >{$message_age}{600}}
16131 .endd
16132 Because of the default behaviour of the string expansion, this is equivalent to
16133 .code
16134 condition = ${if >{$message_age}{600}{true}{}}
16135 .endd
16136
16137 A multiple condition example, which succeeds:
16138 .code
16139 condition = ${if >{$message_age}{600}}
16140 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16141 condition = foobar
16142 .endd
16143
16144 If the expansion fails (other than forced failure) delivery is deferred. Some
16145 of the other precondition options are common special cases that could in fact
16146 be specified using &%condition%&.
16147
16148
16149 .option debug_print routers string&!! unset
16150 .cindex "testing" "variables in drivers"
16151 If this option is set and debugging is enabled (see the &%-d%& command line
16152 option), the string is expanded and included in the debugging output.
16153 If expansion of the string fails, the error message is written to the debugging
16154 output, and Exim carries on processing.
16155 This option is provided to help with checking out the values of variables and
16156 so on when debugging router configurations. For example, if a &%condition%&
16157 option appears not to be working, &%debug_print%& can be used to output the
16158 variables it references. The output happens after checks for &%domains%&,
16159 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16160 are tested. A newline is added to the text if it does not end with one.
16161
16162
16163
16164 .option disable_logging routers boolean false
16165 If this option is set true, nothing is logged for any routing errors
16166 or for any deliveries caused by this router. You should not set this option
16167 unless you really, really know what you are doing. See also the generic
16168 transport option of the same name.
16169
16170
16171 .option domains routers&!? "domain list&!!" unset
16172 .cindex "router" "restricting to specific domains"
16173 .vindex "&$domain_data$&"
16174 If this option is set, the router is skipped unless the current domain matches
16175 the list. If the match is achieved by means of a file lookup, the data that the
16176 lookup returned for the domain is placed in &$domain_data$& for use in string
16177 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16178 a list of the order in which preconditions are evaluated.
16179
16180
16181
16182 .option driver routers string unset
16183 This option must always be set. It specifies which of the available routers is
16184 to be used.
16185
16186
16187
16188 .option errors_to routers string&!! unset
16189 .cindex "envelope sender"
16190 .cindex "router" "changing address for errors"
16191 If a router successfully handles an address, it may assign the address to a
16192 transport for delivery or it may generate child addresses. In both cases, if
16193 there is a delivery problem during later processing, the resulting bounce
16194 message is sent to the address that results from expanding this string,
16195 provided that the address verifies successfully. The &%errors_to%& option is
16196 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16197
16198 The &%errors_to%& setting associated with an address can be overridden if it
16199 subsequently passes through other routers that have their own &%errors_to%&
16200 settings, or if the message is delivered by a transport with a &%return_path%&
16201 setting.
16202
16203 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16204 the expansion fails to verify, the errors address associated with the incoming
16205 address is used. At top level, this is the envelope sender. A non-forced
16206 expansion failure causes delivery to be deferred.
16207
16208 If an address for which &%errors_to%& has been set ends up being delivered over
16209 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16210 any bounces that are generated by other MTAs on the delivery route are also
16211 sent there. You can set &%errors_to%& to the empty string by either of these
16212 settings:
16213 .code
16214 errors_to =
16215 errors_to = ""
16216 .endd
16217 An expansion item that yields an empty string has the same effect. If you do
16218 this, a locally detected delivery error for addresses processed by this router
16219 no longer gives rise to a bounce message; the error is discarded. If the
16220 address is delivered to a remote host, the return path is set to &`<>`&, unless
16221 overridden by the &%return_path%& option on the transport.
16222
16223 .vindex "&$address_data$&"
16224 If for some reason you want to discard local errors, but use a non-empty
16225 MAIL command for remote delivery, you can preserve the original return
16226 path in &$address_data$& in the router, and reinstate it in the transport by
16227 setting &%return_path%&.
16228
16229 The most common use of &%errors_to%& is to direct mailing list bounces to the
16230 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16231 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16232
16233
16234
16235 .option expn routers&!? boolean true
16236 .cindex "address" "testing"
16237 .cindex "testing" "addresses"
16238 .cindex "EXPN" "router skipping"
16239 .cindex "router" "skipping for EXPN"
16240 If this option is turned off, the router is skipped when testing an address
16241 as a result of processing an SMTP EXPN command. You might, for example,
16242 want to turn it off on a router for users' &_.forward_& files, while leaving it
16243 on for the system alias file.
16244 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16245 are evaluated.
16246
16247 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16248 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16249 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16250
16251
16252
16253 .option fail_verify routers boolean false
16254 .cindex "router" "forcing verification failure"
16255 Setting this option has the effect of setting both &%fail_verify_sender%& and
16256 &%fail_verify_recipient%& to the same value.
16257
16258
16259
16260 .option fail_verify_recipient routers boolean false
16261 If this option is true and an address is accepted by this router when
16262 verifying a recipient, verification fails.
16263
16264
16265
16266 .option fail_verify_sender routers boolean false
16267 If this option is true and an address is accepted by this router when
16268 verifying a sender, verification fails.
16269
16270
16271
16272 .option fallback_hosts routers "string list" unset
16273 .cindex "router" "fallback hosts"
16274 .cindex "fallback" "hosts specified on router"
16275 String expansion is not applied to this option. The argument must be a
16276 colon-separated list of host names or IP addresses. The list separator can be
16277 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16278 each name or address. In fact, the format of each item is exactly the same as
16279 defined for the list of hosts in a &(manualroute)& router (see section
16280 &<<SECTformatonehostitem>>&).
16281
16282 If a router queues an address for a remote transport, this host list is
16283 associated with the address, and used instead of the transport's fallback host
16284 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16285 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16286 transport for further details.
16287
16288
16289 .option group routers string&!! "see below"
16290 .cindex "gid (group id)" "local delivery"
16291 .cindex "local transports" "uid and gid"
16292 .cindex "transport" "local"
16293 .cindex "router" "setting group"
16294 When a router queues an address for a transport, and the transport does not
16295 specify a group, the group given here is used when running the delivery
16296 process.
16297 The group may be specified numerically or by name. If expansion fails, the
16298 error is logged and delivery is deferred.
16299 The default is unset, unless &%check_local_user%& is set, when the default
16300 is taken from the password information. See also &%initgroups%& and &%user%&
16301 and the discussion in chapter &<<CHAPenvironment>>&.
16302
16303
16304
16305 .option headers_add routers string&!! unset
16306 .cindex "header lines" "adding"
16307 .cindex "router" "adding header lines"
16308 This option specifies a string of text that is expanded at routing time, and
16309 associated with any addresses that are accepted by the router. However, this
16310 option has no effect when an address is just being verified. The way in which
16311 the text is used to add header lines at transport time is described in section
16312 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16313 message is in the process of being transported. This means that references to
16314 header lines in string expansions in the transport's configuration do not
16315 &"see"& the added header lines.
16316
16317 The &%headers_add%& option is expanded after &%errors_to%&, but before
16318 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16319 the expansion is forced to fail, the option has no effect. Other expansion
16320 failures are treated as configuration errors.
16321
16322 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16323 router that has the &%one_time%& option set.
16324
16325 .cindex "duplicate addresses"
16326 .oindex "&%unseen%&"
16327 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16328 additions are deleted when the address is passed on to subsequent routers.
16329 For a &%redirect%& router, if a generated address is the same as the incoming
16330 address, this can lead to duplicate addresses with different header
16331 modifications. Exim does not do duplicate deliveries (except, in certain
16332 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16333 which of the duplicates is discarded, so this ambiguous situation should be
16334 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16335
16336
16337
16338 .option headers_remove routers string&!! unset
16339 .cindex "header lines" "removing"
16340 .cindex "router" "removing header lines"
16341 This option specifies a string of text that is expanded at routing time, and
16342 associated with any addresses that are accepted by the router. However, this
16343 option has no effect when an address is just being verified. The way in which
16344 the text is used to remove header lines at transport time is described in
16345 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16346 the message is in the process of being transported. This means that references
16347 to header lines in string expansions in the transport's configuration still
16348 &"see"& the original header lines.
16349
16350 The &%headers_remove%& option is expanded after &%errors_to%& and
16351 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16352 the option has no effect. Other expansion failures are treated as configuration
16353 errors.
16354
16355 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16356 router that has the &%one_time%& option set.
16357
16358 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16359 removal requests are deleted when the address is passed on to subsequent
16360 routers, and this can lead to problems with duplicates -- see the similar
16361 warning for &%headers_add%& above.
16362
16363
16364 .option ignore_target_hosts routers "host list&!!" unset
16365 .cindex "IP address" "discarding"
16366 .cindex "router" "discarding IP addresses"
16367 Although this option is a host list, it should normally contain IP address
16368 entries rather than names. If any host that is looked up by the router has an
16369 IP address that matches an item in this list, Exim behaves as if that IP
16370 address did not exist. This option allows you to cope with rogue DNS entries
16371 like
16372 .code
16373 remote.domain.example.  A  127.0.0.1
16374 .endd
16375 by setting
16376 .code
16377 ignore_target_hosts = 127.0.0.1
16378 .endd
16379 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16380 discarded in this way, the router declines. In a conventional configuration, an
16381 attempt to mail to such a domain would normally provoke the &"unrouteable
16382 domain"& error, and an attempt to verify an address in the domain would fail.
16383 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16384 router declines if presented with one of the listed addresses.
16385
16386 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16387 means of the first or the second of the following settings, respectively:
16388 .code
16389 ignore_target_hosts = 0.0.0.0/0
16390 ignore_target_hosts = <; 0::0/0
16391 .endd
16392 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16393 in the second line matches all IPv6 addresses.
16394
16395 This option may also be useful for ignoring link-local and site-local IPv6
16396 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16397 is expanded before use as a list, it is possible to make it dependent on the
16398 domain that is being routed.
16399
16400 .vindex "&$host_address$&"
16401 During its expansion, &$host_address$& is set to the IP address that is being
16402 checked.
16403
16404 .option initgroups routers boolean false
16405 .cindex "additional groups"
16406 .cindex "groups" "additional"
16407 .cindex "local transports" "uid and gid"
16408 .cindex "transport" "local"
16409 If the router queues an address for a transport, and this option is true, and
16410 the uid supplied by the router is not overridden by the transport, the
16411 &[initgroups()]& function is called when running the transport to ensure that
16412 any additional groups associated with the uid are set up. See also &%group%&
16413 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16414
16415
16416
16417 .option local_part_prefix routers&!? "string list" unset
16418 .cindex "router" "prefix for local part"
16419 .cindex "prefix" "for local part, used in router"
16420 If this option is set, the router is skipped unless the local part starts with
16421 one of the given strings, or &%local_part_prefix_optional%& is true. See
16422 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16423 evaluated.
16424
16425 The list is scanned from left to right, and the first prefix that matches is
16426 used. A limited form of wildcard is available; if the prefix begins with an
16427 asterisk, it matches the longest possible sequence of arbitrary characters at
16428 the start of the local part. An asterisk should therefore always be followed by
16429 some character that does not occur in normal local parts.
16430 .cindex "multiple mailboxes"
16431 .cindex "mailbox" "multiple"
16432 Wildcarding can be used to set up multiple user mailboxes, as described in
16433 section &<<SECTmulbox>>&.
16434
16435 .vindex "&$local_part$&"
16436 .vindex "&$local_part_prefix$&"
16437 During the testing of the &%local_parts%& option, and while the router is
16438 running, the prefix is removed from the local part, and is available in the
16439 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16440 the router accepts the address, this remains true during subsequent delivery by
16441 a transport. In particular, the local part that is transmitted in the RCPT
16442 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16443 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16444 the relevant transport.
16445
16446 When an address is being verified, &%local_part_prefix%& affects only the
16447 behaviour of the router. If the callout feature of verification is in use, this
16448 means that the full address, including the prefix, will be used during the
16449 callout.
16450
16451 The prefix facility is commonly used to handle local parts of the form
16452 &%owner-something%&. Another common use is to support local parts of the form
16453 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16454 to tell a user their forwarding is broken &-- by placing a router like this one
16455 immediately before the router that handles &_.forward_& files:
16456 .code
16457 real_localuser:
16458   driver = accept
16459   local_part_prefix = real-
16460   check_local_user
16461   transport = local_delivery
16462 .endd
16463 For security, it would probably be a good idea to restrict the use of this
16464 router to locally-generated messages, using a condition such as this:
16465 .code
16466   condition = ${if match {$sender_host_address}\
16467                          {\N^(|127\.0\.0\.1)$\N}}
16468 .endd
16469
16470 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16471 both conditions must be met if not optional. Care must be taken if wildcards
16472 are used in both a prefix and a suffix on the same router. Different
16473 separator characters must be used to avoid ambiguity.
16474
16475
16476 .option local_part_prefix_optional routers boolean false
16477 See &%local_part_prefix%& above.
16478
16479
16480
16481 .option local_part_suffix routers&!? "string list" unset
16482 .cindex "router" "suffix for local part"
16483 .cindex "suffix for local part" "used in router"
16484 This option operates in the same way as &%local_part_prefix%&, except that the
16485 local part must end (rather than start) with the given string, the
16486 &%local_part_suffix_optional%& option determines whether the suffix is
16487 mandatory, and the wildcard * character, if present, must be the last
16488 character of the suffix. This option facility is commonly used to handle local
16489 parts of the form &%something-request%& and multiple user mailboxes of the form
16490 &%username-foo%&.
16491
16492
16493 .option local_part_suffix_optional routers boolean false
16494 See &%local_part_suffix%& above.
16495
16496
16497
16498 .option local_parts routers&!? "local part list&!!" unset
16499 .cindex "router" "restricting to specific local parts"
16500 .cindex "local part" "checking in router"
16501 The router is run only if the local part of the address matches the list.
16502 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16503 are evaluated, and
16504 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16505 string is expanded, it is possible to make it depend on the domain, for
16506 example:
16507 .code
16508 local_parts = dbm;/usr/local/specials/$domain
16509 .endd
16510 .vindex "&$local_part_data$&"
16511 If the match is achieved by a lookup, the data that the lookup returned
16512 for the local part is placed in the variable &$local_part_data$& for use in
16513 expansions of the router's private options. You might use this option, for
16514 example, if you have a large number of local virtual domains, and you want to
16515 send all postmaster mail to the same place without having to set up an alias in
16516 each virtual domain:
16517 .code
16518 postmaster:
16519   driver = redirect
16520   local_parts = postmaster
16521   data = postmaster@real.domain.example
16522 .endd
16523
16524
16525 .option log_as_local routers boolean "see below"
16526 .cindex "log" "delivery line"
16527 .cindex "delivery" "log line format"
16528 Exim has two logging styles for delivery, the idea being to make local
16529 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16530 recipient address is given just as the local part, without a domain. The use of
16531 this style is controlled by this option. It defaults to true for the &(accept)&
16532 router, and false for all the others. This option applies only when a
16533 router assigns an address to a transport. It has no effect on routers that
16534 redirect addresses.
16535
16536
16537
16538 .option more routers boolean&!! true
16539 The result of string expansion for this option must be a valid boolean value,
16540 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16541 result causes an error, and delivery is deferred. If the expansion is forced to
16542 fail, the default value for the option (true) is used. Other failures cause
16543 delivery to be deferred.
16544
16545 If this option is set false, and the router declines to handle the address, no
16546 further routers are tried, routing fails, and the address is bounced.
16547 .oindex "&%self%&"
16548 However, if the router explicitly passes an address to the following router by
16549 means of the setting
16550 .code
16551 self = pass
16552 .endd
16553 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16554 does not affect the behaviour if one of the precondition tests fails. In that
16555 case, the address is always passed to the next router.
16556
16557 Note that &%address_data%& is not considered to be a precondition. If its
16558 expansion is forced to fail, the router declines, and the value of &%more%&
16559 controls what happens next.
16560
16561
16562 .option pass_on_timeout routers boolean false
16563 .cindex "timeout" "of router"
16564 .cindex "router" "timeout"
16565 If a router times out during a host lookup, it normally causes deferral of the
16566 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16567 router, overriding &%no_more%&. This may be helpful for systems that are
16568 intermittently connected to the Internet, or those that want to pass to a smart
16569 host any messages that cannot immediately be delivered.
16570
16571 There are occasional other temporary errors that can occur while doing DNS
16572 lookups. They are treated in the same way as a timeout, and this option
16573 applies to all of them.
16574
16575
16576
16577 .option pass_router routers string unset
16578 .cindex "router" "go to after &""pass""&"
16579 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16580 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16581 routing to continue, and overriding a false setting of &%more%&. When one of
16582 these routers returns &"pass"&, the address is normally handed on to the next
16583 router in sequence. This can be changed by setting &%pass_router%& to the name
16584 of another router. However (unlike &%redirect_router%&) the named router must
16585 be below the current router, to avoid loops. Note that this option applies only
16586 to the special case of &"pass"&. It does not apply when a router returns
16587 &"decline"& because it cannot handle an address.
16588
16589
16590
16591 .option redirect_router routers string unset
16592 .cindex "router" "start at after redirection"
16593 Sometimes an administrator knows that it is pointless to reprocess addresses
16594 generated from alias or forward files with the same router again. For
16595 example, if an alias file translates real names into login ids there is no
16596 point searching the alias file a second time, especially if it is a large file.
16597
16598 The &%redirect_router%& option can be set to the name of any router instance.
16599 It causes the routing of any generated addresses to start at the named router
16600 instead of at the first router. This option has no effect if the router in
16601 which it is set does not generate new addresses.
16602
16603
16604
16605 .option require_files routers&!? "string list&!!" unset
16606 .cindex "file" "requiring for router"
16607 .cindex "router" "requiring file existence"
16608 This option provides a general mechanism for predicating the running of a
16609 router on the existence or non-existence of certain files or directories.
16610 Before running a router, as one of its precondition tests, Exim works its way
16611 through the &%require_files%& list, expanding each item separately.
16612
16613 Because the list is split before expansion, any colons in expansion items must
16614 be doubled, or the facility for using a different list separator must be used.
16615 If any expansion is forced to fail, the item is ignored. Other expansion
16616 failures cause routing of the address to be deferred.
16617
16618 If any expanded string is empty, it is ignored. Otherwise, except as described
16619 below, each string must be a fully qualified file path, optionally preceded by
16620 &"!"&. The paths are passed to the &[stat()]& function to test for the
16621 existence of the files or directories. The router is skipped if any paths not
16622 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16623
16624 .cindex "NFS"
16625 If &[stat()]& cannot determine whether a file exists or not, delivery of
16626 the message is deferred. This can happen when NFS-mounted filesystems are
16627 unavailable.
16628
16629 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16630 options, so you cannot use it to check for the existence of a file in which to
16631 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16632 full list of the order in which preconditions are evaluated.) However, as
16633 these options are all expanded, you can use the &%exists%& expansion condition
16634 to make such tests. The &%require_files%& option is intended for checking files
16635 that the router may be going to use internally, or which are needed by a
16636 transport (for example &_.procmailrc_&).
16637
16638 During delivery, the &[stat()]& function is run as root, but there is a
16639 facility for some checking of the accessibility of a file by another user.
16640 This is not a proper permissions check, but just a &"rough"& check that
16641 operates as follows:
16642
16643 If an item in a &%require_files%& list does not contain any forward slash
16644 characters, it is taken to be the user (and optional group, separated by a
16645 comma) to be checked for subsequent files in the list. If no group is specified
16646 but the user is specified symbolically, the gid associated with the uid is
16647 used. For example:
16648 .code
16649 require_files = mail:/some/file
16650 require_files = $local_part:$home/.procmailrc
16651 .endd
16652 If a user or group name in a &%require_files%& list does not exist, the
16653 &%require_files%& condition fails.
16654
16655 Exim performs the check by scanning along the components of the file path, and
16656 checking the access for the given uid and gid. It checks for &"x"& access on
16657 directories, and &"r"& access on the final file. Note that this means that file
16658 access control lists, if the operating system has them, are ignored.
16659
16660 &*Warning 1*&: When the router is being run to verify addresses for an
16661 incoming SMTP message, Exim is not running as root, but under its own uid. This
16662 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16663 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16664 user is not permitted to read one of the directories on the file's path.
16665
16666 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16667 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16668 without root access. In this case, if a check for access by a particular user
16669 is requested, Exim creates a subprocess that runs as that user, and tries the
16670 check again in that process.
16671
16672 The default action for handling an unresolved EACCES is to consider it to
16673 be caused by a configuration error, and routing is deferred because the
16674 existence or non-existence of the file cannot be determined. However, in some
16675 circumstances it may be desirable to treat this condition as if the file did
16676 not exist. If the file name (or the exclamation mark that precedes the file
16677 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16678 as if the file did not exist. For example:
16679 .code
16680 require_files = +/some/file
16681 .endd
16682 If the router is not an essential part of verification (for example, it
16683 handles users' &_.forward_& files), another solution is to set the &%verify%&
16684 option false so that the router is skipped when verifying.
16685
16686
16687
16688 .option retry_use_local_part routers boolean "see below"
16689 .cindex "hints database" "retry keys"
16690 .cindex "local part" "in retry keys"
16691 When a delivery suffers a temporary routing failure, a retry record is created
16692 in Exim's hints database. For addresses whose routing depends only on the
16693 domain, the key for the retry record should not involve the local part, but for
16694 other addresses, both the domain and the local part should be included.
16695 Usually, remote routing is of the former kind, and local routing is of the
16696 latter kind.
16697
16698 This option controls whether the local part is used to form the key for retry
16699 hints for addresses that suffer temporary errors while being handled by this
16700 router. The default value is true for any router that has &%check_local_user%&
16701 set, and false otherwise. Note that this option does not apply to hints keys
16702 for transport delays; they are controlled by a generic transport option of the
16703 same name.
16704
16705 The setting of &%retry_use_local_part%& applies only to the router on which it
16706 appears. If the router generates child addresses, they are routed
16707 independently; this setting does not become attached to them.
16708
16709
16710
16711 .option router_home_directory routers string&!! unset
16712 .cindex "router" "home directory for"
16713 .cindex "home directory" "for router"
16714 .vindex "&$home$&"
16715 This option sets a home directory for use while the router is running. (Compare
16716 &%transport_home_directory%&, which sets a home directory for later
16717 transporting.) In particular, if used on a &(redirect)& router, this option
16718 sets a value for &$home$& while a filter is running. The value is expanded;
16719 forced expansion failure causes the option to be ignored &-- other failures
16720 cause the router to defer.
16721
16722 Expansion of &%router_home_directory%& happens immediately after the
16723 &%check_local_user%& test (if configured), before any further expansions take
16724 place.
16725 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16726 are evaluated.)
16727 While the router is running, &%router_home_directory%& overrides the value of
16728 &$home$& that came from &%check_local_user%&.
16729
16730 When a router accepts an address and assigns it to a local transport (including
16731 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16732 delivery), the home directory setting for the transport is taken from the first
16733 of these values that is set:
16734
16735 .ilist
16736 The &%home_directory%& option on the transport;
16737 .next
16738 The &%transport_home_directory%& option on the router;
16739 .next
16740 The password data if &%check_local_user%& is set on the router;
16741 .next
16742 The &%router_home_directory%& option on the router.
16743 .endlist
16744
16745 In other words, &%router_home_directory%& overrides the password data for the
16746 router, but not for the transport.
16747
16748
16749
16750 .option self routers string freeze
16751 .cindex "MX record" "pointing to local host"
16752 .cindex "local host" "MX pointing to"
16753 This option applies to those routers that use a recipient address to find a
16754 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16755 and &(manualroute)& routers.
16756 Certain configurations of the &(queryprogram)& router can also specify a list
16757 of remote hosts.
16758 Usually such routers are configured to send the message to a remote host via an
16759 &(smtp)& transport. The &%self%& option specifies what happens when the first
16760 host on the list turns out to be the local host.
16761 The way in which Exim checks for the local host is described in section
16762 &<<SECTreclocipadd>>&.
16763
16764 Normally this situation indicates either an error in Exim's configuration (for
16765 example, the router should be configured not to process this domain), or an
16766 error in the DNS (for example, the MX should not point to this host). For this
16767 reason, the default action is to log the incident, defer the address, and
16768 freeze the message. The following alternatives are provided for use in special
16769 cases:
16770
16771 .vlist
16772 .vitem &%defer%&
16773 Delivery of the message is tried again later, but the message is not frozen.
16774
16775 .vitem "&%reroute%&: <&'domain'&>"
16776 The domain is changed to the given domain, and the address is passed back to
16777 be reprocessed by the routers. No rewriting of headers takes place. This
16778 behaviour is essentially a redirection.
16779
16780 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16781 The domain is changed to the given domain, and the address is passed back to be
16782 reprocessed by the routers. Any headers that contain the original domain are
16783 rewritten.
16784
16785 .vitem &%pass%&
16786 .oindex "&%more%&"
16787 .vindex "&$self_hostname$&"
16788 The router passes the address to the next router, or to the router named in the
16789 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16790 subsequent routing and delivery, the variable &$self_hostname$& contains the
16791 name of the local host that the router encountered. This can be used to
16792 distinguish between different cases for hosts with multiple names. The
16793 combination
16794 .code
16795 self = pass
16796 no_more
16797 .endd
16798 ensures that only those addresses that routed to the local host are passed on.
16799 Without &%no_more%&, addresses that were declined for other reasons would also
16800 be passed to the next router.
16801
16802 .vitem &%fail%&
16803 Delivery fails and an error report is generated.
16804
16805 .vitem &%send%&
16806 .cindex "local host" "sending to"
16807 The anomaly is ignored and the address is queued for the transport. This
16808 setting should be used with extreme caution. For an &(smtp)& transport, it
16809 makes sense only in cases where the program that is listening on the SMTP port
16810 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16811 different configuration file that handles the domain in another way.
16812 .endlist
16813
16814
16815
16816 .option senders routers&!? "address list&!!" unset
16817 .cindex "router" "checking senders"
16818 If this option is set, the router is skipped unless the message's sender
16819 address matches something on the list.
16820 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16821 are evaluated.
16822
16823 There are issues concerning verification when the running of routers is
16824 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16825 setting, it sets the sender to the null string. When using the &%-bt%& option
16826 to check a configuration file, it is necessary also to use the &%-f%& option to
16827 set an appropriate sender. For incoming mail, the sender is unset when
16828 verifying the sender, but is available when verifying any recipients. If the
16829 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16830 matters.
16831
16832
16833 .option translate_ip_address routers string&!! unset
16834 .cindex "IP address" "translating"
16835 .cindex "packet radio"
16836 .cindex "router" "IP address translation"
16837 There exist some rare networking situations (for example, packet radio) where
16838 it is helpful to be able to translate IP addresses generated by normal routing
16839 mechanisms into other IP addresses, thus performing a kind of manual IP
16840 routing. This should be done only if the normal IP routing of the TCP/IP stack
16841 is inadequate or broken. Because this is an extremely uncommon requirement, the
16842 code to support this option is not included in the Exim binary unless
16843 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16844
16845 .vindex "&$host_address$&"
16846 The &%translate_ip_address%& string is expanded for every IP address generated
16847 by the router, with the generated address set in &$host_address$&. If the
16848 expansion is forced to fail, no action is taken.
16849 For any other expansion error, delivery of the message is deferred.
16850 If the result of the expansion is an IP address, that replaces the original
16851 address; otherwise the result is assumed to be a host name &-- this is looked
16852 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16853 produce one or more replacement IP addresses. For example, to subvert all IP
16854 addresses in some specific networks, this could be added to a router:
16855 .code
16856 translate_ip_address = \
16857   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16858     {$value}fail}}
16859 .endd
16860 The file would contain lines like
16861 .code
16862 10.2.3.128/26    some.host
16863 10.8.4.34/26     10.44.8.15
16864 .endd
16865 You should not make use of this facility unless you really understand what you
16866 are doing.
16867
16868
16869
16870 .option transport routers string&!! unset
16871 This option specifies the transport to be used when a router accepts an address
16872 and sets it up for delivery. A transport is never needed if a router is used
16873 only for verification. The value of the option is expanded at routing time,
16874 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16875 and result must be the name of one of the configured transports. If it is not,
16876 delivery is deferred.
16877
16878 The &%transport%& option is not used by the &(redirect)& router, but it does
16879 have some private options that set up transports for pipe and file deliveries
16880 (see chapter &<<CHAPredirect>>&).
16881
16882
16883
16884 .option transport_current_directory routers string&!! unset
16885 .cindex "current directory for local transport"
16886 This option associates a current directory with any address that is routed
16887 to a local transport. This can happen either because a transport is
16888 explicitly configured for the router, or because it generates a delivery to a
16889 file or a pipe. During the delivery process (that is, at transport time), this
16890 option string is expanded and is set as the current directory, unless
16891 overridden by a setting on the transport.
16892 If the expansion fails for any reason, including forced failure, an error is
16893 logged, and delivery is deferred.
16894 See chapter &<<CHAPenvironment>>& for details of the local delivery
16895 environment.
16896
16897
16898
16899
16900 .option transport_home_directory routers string&!! "see below"
16901 .cindex "home directory" "for local transport"
16902 This option associates a home directory with any address that is routed to a
16903 local transport. This can happen either because a transport is explicitly
16904 configured for the router, or because it generates a delivery to a file or a
16905 pipe. During the delivery process (that is, at transport time), the option
16906 string is expanded and is set as the home directory, unless overridden by a
16907 setting of &%home_directory%& on the transport.
16908 If the expansion fails for any reason, including forced failure, an error is
16909 logged, and delivery is deferred.
16910
16911 If the transport does not specify a home directory, and
16912 &%transport_home_directory%& is not set for the router, the home directory for
16913 the transport is taken from the password data if &%check_local_user%& is set for
16914 the router. Otherwise it is taken from &%router_home_directory%& if that option
16915 is set; if not, no home directory is set for the transport.
16916
16917 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16918 environment.
16919
16920
16921
16922
16923 .option unseen routers boolean&!! false
16924 .cindex "router" "carrying on after success"
16925 The result of string expansion for this option must be a valid boolean value,
16926 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16927 result causes an error, and delivery is deferred. If the expansion is forced to
16928 fail, the default value for the option (false) is used. Other failures cause
16929 delivery to be deferred.
16930
16931 When this option is set true, routing does not cease if the router accepts the
16932 address. Instead, a copy of the incoming address is passed to the next router,
16933 overriding a false setting of &%more%&. There is little point in setting
16934 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16935 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16936 sometimes true and sometimes false).
16937
16938 .cindex "copy of message (&%unseen%& option)"
16939 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16940 qualifier in filter files. It can be used to cause copies of messages to be
16941 delivered to some other destination, while also carrying out a normal delivery.
16942 In effect, the current address is made into a &"parent"& that has two children
16943 &-- one that is delivered as specified by this router, and a clone that goes on
16944 to be routed further. For this reason, &%unseen%& may not be combined with the
16945 &%one_time%& option in a &(redirect)& router.
16946
16947 &*Warning*&: Header lines added to the address (or specified for removal) by
16948 this router or by previous routers affect the &"unseen"& copy of the message
16949 only. The clone that continues to be processed by further routers starts with
16950 no added headers and none specified for removal. For a &%redirect%& router, if
16951 a generated address is the same as the incoming address, this can lead to
16952 duplicate addresses with different header modifications. Exim does not do
16953 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16954 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16955 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16956 &%redirect%& router may be of help.
16957
16958 Unlike the handling of header modifications, any data that was set by the
16959 &%address_data%& option in the current or previous routers &'is'& passed on to
16960 subsequent routers.
16961
16962
16963 .option user routers string&!! "see below"
16964 .cindex "uid (user id)" "local delivery"
16965 .cindex "local transports" "uid and gid"
16966 .cindex "transport" "local"
16967 .cindex "router" "user for filter processing"
16968 .cindex "filter" "user for processing"
16969 When a router queues an address for a transport, and the transport does not
16970 specify a user, the user given here is used when running the delivery process.
16971 The user may be specified numerically or by name. If expansion fails, the
16972 error is logged and delivery is deferred.
16973 This user is also used by the &(redirect)& router when running a filter file.
16974 The default is unset, except when &%check_local_user%& is set. In this case,
16975 the default is taken from the password information. If the user is specified as
16976 a name, and &%group%& is not set, the group associated with the user is used.
16977 See also &%initgroups%& and &%group%& and the discussion in chapter
16978 &<<CHAPenvironment>>&.
16979
16980
16981
16982 .option verify routers&!? boolean true
16983 Setting this option has the effect of setting &%verify_sender%& and
16984 &%verify_recipient%& to the same value.
16985
16986
16987 .option verify_only routers&!? boolean false
16988 .cindex "EXPN" "with &%verify_only%&"
16989 .oindex "&%-bv%&"
16990 .cindex "router" "used only when verifying"
16991 If this option is set, the router is used only when verifying an address or
16992 testing with the &%-bv%& option, not when actually doing a delivery, testing
16993 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16994 restricted to verifying only senders or recipients by means of
16995 &%verify_sender%& and &%verify_recipient%&.
16996
16997 &*Warning*&: When the router is being run to verify addresses for an incoming
16998 SMTP message, Exim is not running as root, but under its own uid. If the router
16999 accesses any files, you need to make sure that they are accessible to the Exim
17000 user or group.
17001
17002
17003 .option verify_recipient routers&!? boolean true
17004 If this option is false, the router is skipped when verifying recipient
17005 addresses
17006 or testing recipient verification using &%-bv%&.
17007 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17008 are evaluated.
17009
17010
17011 .option verify_sender routers&!? boolean true
17012 If this option is false, the router is skipped when verifying sender addresses
17013 or testing sender verification using &%-bvs%&.
17014 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17015 are evaluated.
17016 .ecindex IIDgenoprou1
17017 .ecindex IIDgenoprou2
17018
17019
17020
17021
17022
17023
17024 . ////////////////////////////////////////////////////////////////////////////
17025 . ////////////////////////////////////////////////////////////////////////////
17026
17027 .chapter "The accept router" "CHID4"
17028 .cindex "&(accept)& router"
17029 .cindex "routers" "&(accept)&"
17030 The &(accept)& router has no private options of its own. Unless it is being
17031 used purely for verification (see &%verify_only%&) a transport is required to
17032 be defined by the generic &%transport%& option. If the preconditions that are
17033 specified by generic options are met, the router accepts the address and queues
17034 it for the given transport. The most common use of this router is for setting
17035 up deliveries to local mailboxes. For example:
17036 .code
17037 localusers:
17038   driver = accept
17039   domains = mydomain.example
17040   check_local_user
17041   transport = local_delivery
17042 .endd
17043 The &%domains%& condition in this example checks the domain of the address, and
17044 &%check_local_user%& checks that the local part is the login of a local user.
17045 When both preconditions are met, the &(accept)& router runs, and queues the
17046 address for the &(local_delivery)& transport.
17047
17048
17049
17050
17051
17052
17053 . ////////////////////////////////////////////////////////////////////////////
17054 . ////////////////////////////////////////////////////////////////////////////
17055
17056 .chapter "The dnslookup router" "CHAPdnslookup"
17057 .scindex IIDdnsrou1 "&(dnslookup)& router"
17058 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17059 The &(dnslookup)& router looks up the hosts that handle mail for the
17060 recipient's domain in the DNS. A transport must always be set for this router,
17061 unless &%verify_only%& is set.
17062
17063 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17064 SRV records. If none are found, or if SRV support is not configured,
17065 MX records are looked up. If no MX records exist, address records are sought.
17066 However, &%mx_domains%& can be set to disable the direct use of address
17067 records.
17068
17069 MX records of equal priority are sorted by Exim into a random order. Exim then
17070 looks for address records for the host names obtained from MX or SRV records.
17071 When a host has more than one IP address, they are sorted into a random order,
17072 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17073 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17074 generic option, the router declines.
17075
17076 Unless they have the highest priority (lowest MX value), MX records that point
17077 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17078 are discarded, together with any other MX records of equal or lower priority.
17079
17080 .cindex "MX record" "pointing to local host"
17081 .cindex "local host" "MX pointing to"
17082 .oindex "&%self%&" "in &(dnslookup)& router"
17083 If the host pointed to by the highest priority MX record, or looked up as an
17084 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17085 happens is controlled by the generic &%self%& option.
17086
17087
17088 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17089 There have been problems with DNS servers when SRV records are looked up.
17090 Some mis-behaving servers return a DNS error or timeout when a non-existent
17091 SRV record is sought. Similar problems have in the past been reported for
17092 MX records. The global &%dns_again_means_nonexist%& option can help with this
17093 problem, but it is heavy-handed because it is a global option.
17094
17095 For this reason, there are two options, &%srv_fail_domains%& and
17096 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17097 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17098 an attempt to look up an SRV or MX record causes one of these results, and the
17099 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17100 such record"&. In the case of an SRV lookup, this means that the router
17101 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17102 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17103 case routing fails.
17104
17105
17106
17107
17108 .section "Private options for dnslookup" "SECID118"
17109 .cindex "options" "&(dnslookup)& router"
17110 The private options for the &(dnslookup)& router are as follows:
17111
17112 .option check_secondary_mx dnslookup boolean false
17113 .cindex "MX record" "checking for secondary"
17114 If this option is set, the router declines unless the local host is found in
17115 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17116 process domains for which the local host is a secondary mail exchanger
17117 differently to other domains. The way in which Exim decides whether a host is
17118 the local host is described in section &<<SECTreclocipadd>>&.
17119
17120
17121 .option check_srv dnslookup string&!! unset
17122 .cindex "SRV record" "enabling use of"
17123 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17124 addition to MX and address records. The support is disabled by default. To
17125 enable SRV support, set the &%check_srv%& option to the name of the service
17126 required. For example,
17127 .code
17128 check_srv = smtp
17129 .endd
17130 looks for SRV records that refer to the normal smtp service. The option is
17131 expanded, so the service name can vary from message to message or address
17132 to address. This might be helpful if SRV records are being used for a
17133 submission service. If the expansion is forced to fail, the &%check_srv%&
17134 option is ignored, and the router proceeds to look for MX records in the
17135 normal way.
17136
17137 When the expansion succeeds, the router searches first for SRV records for
17138 the given service (it assumes TCP protocol). A single SRV record with a
17139 host name that consists of just a single dot indicates &"no such service for
17140 this domain"&; if this is encountered, the router declines. If other kinds of
17141 SRV record are found, they are used to construct a host list for delivery
17142 according to the rules of RFC 2782. MX records are not sought in this case.
17143
17144 When no SRV records are found, MX records (and address records) are sought in
17145 the traditional way. In other words, SRV records take precedence over MX
17146 records, just as MX records take precedence over address records. Note that
17147 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17148 defined it. It is apparently believed that MX records are sufficient for email
17149 and that SRV records should not be used for this purpose. However, SRV records
17150 have an additional &"weight"& feature which some people might find useful when
17151 trying to split an SMTP load between hosts of different power.
17152
17153 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17154 when there is a DNS lookup error.
17155
17156
17157
17158 .option mx_domains dnslookup "domain list&!!" unset
17159 .cindex "MX record" "required to exist"
17160 .cindex "SRV record" "required to exist"
17161 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17162 record in order to be recognized. (The name of this option could be improved.)
17163 For example, if all the mail hosts in &'fict.example'& are known to have MX
17164 records, except for those in &'discworld.fict.example'&, you could use this
17165 setting:
17166 .code
17167 mx_domains = ! *.discworld.fict.example : *.fict.example
17168 .endd
17169 This specifies that messages addressed to a domain that matches the list but
17170 has no MX record should be bounced immediately instead of being routed using
17171 the address record.
17172
17173
17174 .option mx_fail_domains dnslookup "domain list&!!" unset
17175 If the DNS lookup for MX records for one of the domains in this list causes a
17176 DNS lookup error, Exim behaves as if no MX records were found. See section
17177 &<<SECTprowitdnsloo>>& for more discussion.
17178
17179
17180
17181
17182 .option qualify_single dnslookup boolean true
17183 .cindex "DNS" "resolver options"
17184 .cindex "DNS" "qualifying single-component names"
17185 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17186 lookups. Typically, but not standardly, this causes the resolver to qualify
17187 single-component names with the default domain. For example, on a machine
17188 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17189 &'thesaurus.ref.example'& inside the resolver. For details of what your
17190 resolver actually does, consult your man pages for &'resolver'& and
17191 &'resolv.conf'&.
17192
17193
17194
17195 .option rewrite_headers dnslookup boolean true
17196 .cindex "rewriting" "header lines"
17197 .cindex "header lines" "rewriting"
17198 If the domain name in the address that is being processed is not fully
17199 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17200 an address is specified as &'dormouse@teaparty'&, the domain might be
17201 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17202 occur as a result of setting the &%widen_domains%& option. If
17203 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17204 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17205 header lines of the message are rewritten with the full domain name.
17206
17207 This option should be turned off only when it is known that no message is
17208 ever going to be sent outside an environment where the abbreviation makes
17209 sense.
17210
17211 When an MX record is looked up in the DNS and matches a wildcard record, name
17212 servers normally return a record containing the name that has been looked up,
17213 making it impossible to detect whether a wildcard was present or not. However,
17214 some name servers have recently been seen to return the wildcard entry. If the
17215 name returned by a DNS lookup begins with an asterisk, it is not used for
17216 header rewriting.
17217
17218
17219 .option same_domain_copy_routing dnslookup boolean false
17220 .cindex "address" "copying routing"
17221 Addresses with the same domain are normally routed by the &(dnslookup)& router
17222 to the same list of hosts. However, this cannot be presumed, because the router
17223 options and preconditions may refer to the local part of the address. By
17224 default, therefore, Exim routes each address in a message independently. DNS
17225 servers run caches, so repeated DNS lookups are not normally expensive, and in
17226 any case, personal messages rarely have more than a few recipients.
17227
17228 If you are running mailing lists with large numbers of subscribers at the same
17229 domain, and you are using a &(dnslookup)& router which is independent of the
17230 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17231 lookups for identical domains in one message. In this case, when &(dnslookup)&
17232 routes an address to a remote transport, any other unrouted addresses in the
17233 message that have the same domain are automatically given the same routing
17234 without processing them independently,
17235 provided the following conditions are met:
17236
17237 .ilist
17238 No router that processed the address specified &%headers_add%& or
17239 &%headers_remove%&.
17240 .next
17241 The router did not change the address in any way, for example, by &"widening"&
17242 the domain.
17243 .endlist
17244
17245
17246
17247
17248 .option search_parents dnslookup boolean false
17249 .cindex "DNS" "resolver options"
17250 When this option is true, the resolver option RES_DNSRCH is set for DNS
17251 lookups. This is different from the &%qualify_single%& option in that it
17252 applies to domains containing dots. Typically, but not standardly, it causes
17253 the resolver to search for the name in the current domain and in parent
17254 domains. For example, on a machine in the &'fict.example'& domain, if looking
17255 up &'teaparty.wonderland'& failed, the resolver would try
17256 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17257 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17258
17259 Setting this option true can cause problems in domains that have a wildcard MX
17260 record, because any domain that does not have its own MX record matches the
17261 local wildcard.
17262
17263
17264
17265 .option srv_fail_domains dnslookup "domain list&!!" unset
17266 If the DNS lookup for SRV records for one of the domains in this list causes a
17267 DNS lookup error, Exim behaves as if no SRV records were found. See section
17268 &<<SECTprowitdnsloo>>& for more discussion.
17269
17270
17271
17272
17273 .option widen_domains dnslookup "string list" unset
17274 .cindex "domain" "partial; widening"
17275 If a DNS lookup fails and this option is set, each of its strings in turn is
17276 added onto the end of the domain, and the lookup is tried again. For example,
17277 if
17278 .code
17279 widen_domains = fict.example:ref.example
17280 .endd
17281 is set and a lookup of &'klingon.dictionary'& fails,
17282 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17283 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17284 and &%search_parents%& options can cause some widening to be undertaken inside
17285 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17286 when verifying, unless &%rewrite_headers%& is false (not the default).
17287
17288
17289 .section "Effect of qualify_single and search_parents" "SECID119"
17290 When a domain from an envelope recipient is changed by the resolver as a result
17291 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17292 corresponding address in the message's header lines unless &%rewrite_headers%&
17293 is set false. Exim then re-routes the address, using the full domain.
17294
17295 These two options affect only the DNS lookup that takes place inside the router
17296 for the domain of the address that is being routed. They do not affect lookups
17297 such as that implied by
17298 .code
17299 domains = @mx_any
17300 .endd
17301 that may happen while processing a router precondition before the router is
17302 entered. No widening ever takes place for these lookups.
17303 .ecindex IIDdnsrou1
17304 .ecindex IIDdnsrou2
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314 . ////////////////////////////////////////////////////////////////////////////
17315 . ////////////////////////////////////////////////////////////////////////////
17316
17317 .chapter "The ipliteral router" "CHID5"
17318 .cindex "&(ipliteral)& router"
17319 .cindex "domain literal" "routing"
17320 .cindex "routers" "&(ipliteral)&"
17321 This router has no private options. Unless it is being used purely for
17322 verification (see &%verify_only%&) a transport is required to be defined by the
17323 generic &%transport%& option. The router accepts the address if its domain part
17324 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17325 router handles the address
17326 .code
17327 root@[192.168.1.1]
17328 .endd
17329 by setting up delivery to the host with that IP address. IPv4 domain literals
17330 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17331 are similar, but the address is preceded by &`ipv6:`&. For example:
17332 .code
17333 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17334 .endd
17335 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17336 grounds that sooner or later somebody will try it.
17337
17338 .oindex "&%self%&" "in &(ipliteral)& router"
17339 If the IP address matches something in &%ignore_target_hosts%&, the router
17340 declines. If an IP literal turns out to refer to the local host, the generic
17341 &%self%& option determines what happens.
17342
17343 The RFCs require support for domain literals; however, their use is
17344 controversial in today's Internet. If you want to use this router, you must
17345 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17346 Exim will not recognize the domain literal syntax in addresses.
17347
17348
17349
17350 . ////////////////////////////////////////////////////////////////////////////
17351 . ////////////////////////////////////////////////////////////////////////////
17352
17353 .chapter "The iplookup router" "CHID6"
17354 .cindex "&(iplookup)& router"
17355 .cindex "routers" "&(iplookup)&"
17356 The &(iplookup)& router was written to fulfil a specific requirement in
17357 Cambridge University (which in fact no longer exists). For this reason, it is
17358 not included in the binary of Exim by default. If you want to include it, you
17359 must set
17360 .code
17361 ROUTER_IPLOOKUP=yes
17362 .endd
17363 in your &_Local/Makefile_& configuration file.
17364
17365 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17366 connection to one or more specific hosts. The host can then return the same or
17367 a different address &-- in effect rewriting the recipient address in the
17368 message's envelope. The new address is then passed on to subsequent routers. If
17369 this process fails, the address can be passed on to other routers, or delivery
17370 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17371 must not be specified for it.
17372
17373 .cindex "options" "&(iplookup)& router"
17374 .option hosts iplookup string unset
17375 This option must be supplied. Its value is a colon-separated list of host
17376 names. The hosts are looked up using &[gethostbyname()]&
17377 (or &[getipnodebyname()]& when available)
17378 and are tried in order until one responds to the query. If none respond, what
17379 happens is controlled by &%optional%&.
17380
17381
17382 .option optional iplookup boolean false
17383 If &%optional%& is true, if no response is obtained from any host, the address
17384 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17385 delivery to the address is deferred.
17386
17387
17388 .option port iplookup integer 0
17389 .cindex "port" "&(iplookup)& router"
17390 This option must be supplied. It specifies the port number for the TCP or UDP
17391 call.
17392
17393
17394 .option protocol iplookup string udp
17395 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17396 protocols is to be used.
17397
17398
17399 .option query iplookup string&!! "see below"
17400 This defines the content of the query that is sent to the remote hosts. The
17401 default value is:
17402 .code
17403 $local_part@$domain $local_part@$domain
17404 .endd
17405 The repetition serves as a way of checking that a response is to the correct
17406 query in the default case (see &%response_pattern%& below).
17407
17408
17409 .option reroute iplookup string&!! unset
17410 If this option is not set, the rerouted address is precisely the byte string
17411 returned by the remote host, up to the first white space, if any. If set, the
17412 string is expanded to form the rerouted address. It can include parts matched
17413 in the response by &%response_pattern%& by means of numeric variables such as
17414 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17415 whether or not a pattern is in use. In all cases, the rerouted address must end
17416 up in the form &'local_part@domain'&.
17417
17418
17419 .option response_pattern iplookup string unset
17420 This option can be set to a regular expression that is applied to the string
17421 returned from the remote host. If the pattern does not match the response, the
17422 router declines. If &%response_pattern%& is not set, no checking of the
17423 response is done, unless the query was defaulted, in which case there is a
17424 check that the text returned after the first white space is the original
17425 address. This checks that the answer that has been received is in response to
17426 the correct question. For example, if the response is just a new domain, the
17427 following could be used:
17428 .code
17429 response_pattern = ^([^@]+)$
17430 reroute = $local_part@$1
17431 .endd
17432
17433 .option timeout iplookup time 5s
17434 This specifies the amount of time to wait for a response from the remote
17435 machine. The same timeout is used for the &[connect()]& function for a TCP
17436 call. It does not apply to UDP.
17437
17438
17439
17440
17441 . ////////////////////////////////////////////////////////////////////////////
17442 . ////////////////////////////////////////////////////////////////////////////
17443
17444 .chapter "The manualroute router" "CHID7"
17445 .scindex IIDmanrou1 "&(manualroute)& router"
17446 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17447 .cindex "domain" "manually routing"
17448 The &(manualroute)& router is so-called because it provides a way of manually
17449 routing an address according to its domain. It is mainly used when you want to
17450 route addresses to remote hosts according to your own rules, bypassing the
17451 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17452 route to local transports, a facility that may be useful if you want to save
17453 messages for dial-in hosts in local files.
17454
17455 The &(manualroute)& router compares a list of domain patterns with the domain
17456 it is trying to route. If there is no match, the router declines. Each pattern
17457 has associated with it a list of hosts and some other optional data, which may
17458 include a transport. The combination of a pattern and its data is called a
17459 &"routing rule"&. For patterns that do not have an associated transport, the
17460 generic &%transport%& option must specify a transport, unless the router is
17461 being used purely for verification (see &%verify_only%&).
17462
17463 .vindex "&$host$&"
17464 In the case of verification, matching the domain pattern is sufficient for the
17465 router to accept the address. When actually routing an address for delivery,
17466 an address that matches a domain pattern is queued for the associated
17467 transport. If the transport is not a local one, a host list must be associated
17468 with the pattern; IP addresses are looked up for the hosts, and these are
17469 passed to the transport along with the mail address. For local transports, a
17470 host list is optional. If it is present, it is passed in &$host$& as a single
17471 text string.
17472
17473 The list of routing rules can be provided as an inline string in
17474 &%route_list%&, or the data can be obtained by looking up the domain in a file
17475 or database by setting &%route_data%&. Only one of these settings may appear in
17476 any one instance of &(manualroute)&. The format of routing rules is described
17477 below, following the list of private options.
17478
17479
17480 .section "Private options for manualroute" "SECTprioptman"
17481
17482 .cindex "options" "&(manualroute)& router"
17483 The private options for the &(manualroute)& router are as follows:
17484
17485 .option host_all_ignored manualroute string defer
17486 See &%host_find_failed%&.
17487
17488 .option host_find_failed manualroute string freeze
17489 This option controls what happens when &(manualroute)& tries to find an IP
17490 address for a host, and the host does not exist. The option can be set to one
17491 of the following values:
17492 .code
17493 decline
17494 defer
17495 fail
17496 freeze
17497 ignore
17498 pass
17499 .endd
17500 The default (&"freeze"&) assumes that this state is a serious configuration
17501 error. The difference between &"pass"& and &"decline"& is that the former
17502 forces the address to be passed to the next router (or the router defined by
17503 &%pass_router%&),
17504 .oindex "&%more%&"
17505 overriding &%no_more%&, whereas the latter passes the address to the next
17506 router only if &%more%& is true.
17507
17508 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17509 cannot be found. If all the hosts in the list are ignored, the behaviour is
17510 controlled by the &%host_all_ignored%& option. This takes the same values
17511 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17512
17513 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17514 state; if a host lookup gets a temporary error, delivery is deferred unless the
17515 generic &%pass_on_timeout%& option is set.
17516
17517
17518 .option hosts_randomize manualroute boolean false
17519 .cindex "randomized host list"
17520 .cindex "host" "list of; randomized"
17521 If this option is set, the order of the items in a host list in a routing rule
17522 is randomized each time the list is used, unless an option in the routing rule
17523 overrides (see below). Randomizing the order of a host list can be used to do
17524 crude load sharing. However, if more than one mail address is routed by the
17525 same router to the same host list, the host lists are considered to be the same
17526 (even though they may be randomized into different orders) for the purpose of
17527 deciding whether to batch the deliveries into a single SMTP transaction.
17528
17529 When &%hosts_randomize%& is true, a host list may be split
17530 into groups whose order is separately randomized. This makes it possible to
17531 set up MX-like behaviour. The boundaries between groups are indicated by an
17532 item that is just &`+`& in the host list. For example:
17533 .code
17534 route_list = * host1:host2:host3:+:host4:host5
17535 .endd
17536 The order of the first three hosts and the order of the last two hosts is
17537 randomized for each use, but the first three always end up before the last two.
17538 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17539 randomized host list is passed to an &(smtp)& transport that also has
17540 &%hosts_randomize set%&, the list is not re-randomized.
17541
17542
17543 .option route_data manualroute string&!! unset
17544 If this option is set, it must expand to yield the data part of a routing rule.
17545 Typically, the expansion string includes a lookup based on the domain. For
17546 example:
17547 .code
17548 route_data = ${lookup{$domain}dbm{/etc/routes}}
17549 .endd
17550 If the expansion is forced to fail, or the result is an empty string, the
17551 router declines. Other kinds of expansion failure cause delivery to be
17552 deferred.
17553
17554
17555 .option route_list manualroute "string list" unset
17556 This string is a list of routing rules, in the form defined below. Note that,
17557 unlike most string lists, the items are separated by semicolons. This is so
17558 that they may contain colon-separated host lists.
17559
17560
17561 .option same_domain_copy_routing manualroute boolean false
17562 .cindex "address" "copying routing"
17563 Addresses with the same domain are normally routed by the &(manualroute)&
17564 router to the same list of hosts. However, this cannot be presumed, because the
17565 router options and preconditions may refer to the local part of the address. By
17566 default, therefore, Exim routes each address in a message independently. DNS
17567 servers run caches, so repeated DNS lookups are not normally expensive, and in
17568 any case, personal messages rarely have more than a few recipients.
17569
17570 If you are running mailing lists with large numbers of subscribers at the same
17571 domain, and you are using a &(manualroute)& router which is independent of the
17572 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17573 lookups for identical domains in one message. In this case, when
17574 &(manualroute)& routes an address to a remote transport, any other unrouted
17575 addresses in the message that have the same domain are automatically given the
17576 same routing without processing them independently. However, this is only done
17577 if &%headers_add%& and &%headers_remove%& are unset.
17578
17579
17580
17581
17582 .section "Routing rules in route_list" "SECID120"
17583 The value of &%route_list%& is a string consisting of a sequence of routing
17584 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17585 entered as two semicolons. Alternatively, the list separator can be changed as
17586 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17587 Empty rules are ignored. The format of each rule is
17588 .display
17589 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17590 .endd
17591 The following example contains two rules, each with a simple domain pattern and
17592 no options:
17593 .code
17594 route_list = \
17595   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17596   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17597 .endd
17598 The three parts of a rule are separated by white space. The pattern and the
17599 list of hosts can be enclosed in quotes if necessary, and if they are, the
17600 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17601 single domain pattern, which is the only mandatory item in the rule. The
17602 pattern is in the same format as one item in a domain list (see section
17603 &<<SECTdomainlist>>&),
17604 except that it may not be the name of an interpolated file.
17605 That is, it may be wildcarded, or a regular expression, or a file or database
17606 lookup (with semicolons doubled, because of the use of semicolon as a separator
17607 in a &%route_list%&).
17608
17609 The rules in &%route_list%& are searched in order until one of the patterns
17610 matches the domain that is being routed. The list of hosts and then options are
17611 then used as described below. If there is no match, the router declines. When
17612 &%route_list%& is set, &%route_data%& must not be set.
17613
17614
17615
17616 .section "Routing rules in route_data" "SECID121"
17617 The use of &%route_list%& is convenient when there are only a small number of
17618 routing rules. For larger numbers, it is easier to use a file or database to
17619 hold the routing information, and use the &%route_data%& option instead.
17620 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17621 Most commonly, &%route_data%& is set as a string that contains an
17622 expansion lookup. For example, suppose we place two routing rules in a file
17623 like this:
17624 .code
17625 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17626 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17627 .endd
17628 This data can be accessed by setting
17629 .code
17630 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17631 .endd
17632 Failure of the lookup results in an empty string, causing the router to
17633 decline. However, you do not have to use a lookup in &%route_data%&. The only
17634 requirement is that the result of expanding the string is a list of hosts,
17635 possibly followed by options, separated by white space. The list of hosts must
17636 be enclosed in quotes if it contains white space.
17637
17638
17639
17640
17641 .section "Format of the list of hosts" "SECID122"
17642 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17643 always separately expanded before use. If the expansion fails, the router
17644 declines. The result of the expansion must be a colon-separated list of names
17645 and/or IP addresses, optionally also including ports. The format of each item
17646 in the list is described in the next section. The list separator can be changed
17647 as described in section &<<SECTlistconstruct>>&.
17648
17649 If the list of hosts was obtained from a &%route_list%& item, the following
17650 variables are set during its expansion:
17651
17652 .ilist
17653 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17654 If the domain was matched against a regular expression, the numeric variables
17655 &$1$&, &$2$&, etc. may be set. For example:
17656 .code
17657 route_list = ^domain(\d+)   host-$1.text.example
17658 .endd
17659 .next
17660 &$0$& is always set to the entire domain.
17661 .next
17662 &$1$& is also set when partial matching is done in a file lookup.
17663
17664 .next
17665 .vindex "&$value$&"
17666 If the pattern that matched the domain was a lookup item, the data that was
17667 looked up is available in the expansion variable &$value$&. For example:
17668 .code
17669 route_list = lsearch;;/some/file.routes  $value
17670 .endd
17671 .endlist
17672
17673 Note the doubling of the semicolon in the pattern that is necessary because
17674 semicolon is the default route list separator.
17675
17676
17677
17678 .section "Format of one host item" "SECTformatonehostitem"
17679 Each item in the list of hosts is either a host name or an IP address,
17680 optionally with an attached port number. When no port is given, an IP address
17681 is not enclosed in brackets. When a port is specified, it overrides the port
17682 specification on the transport. The port is separated from the name or address
17683 by a colon. This leads to some complications:
17684
17685 .ilist
17686 Because colon is the default separator for the list of hosts, either
17687 the colon that specifies a port must be doubled, or the list separator must
17688 be changed. The following two examples have the same effect:
17689 .code
17690 route_list = * "host1.tld::1225 : host2.tld::1226"
17691 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17692 .endd
17693 .next
17694 When IPv6 addresses are involved, it gets worse, because they contain
17695 colons of their own. To make this case easier, it is permitted to
17696 enclose an IP address (either v4 or v6) in square brackets if a port
17697 number follows. For example:
17698 .code
17699 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17700 .endd
17701 .endlist
17702
17703 .section "How the list of hosts is used" "SECThostshowused"
17704 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17705 the hosts is tried, in the order specified, when carrying out the SMTP
17706 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17707 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17708 transport.
17709
17710 Hosts may be listed by name or by IP address. An unadorned name in the list of
17711 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17712 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17713 records in the DNS. For example:
17714 .code
17715 route_list = *  x.y.z:p.q.r/MX:e.f.g
17716 .endd
17717 If this feature is used with a port specifier, the port must come last. For
17718 example:
17719 .code
17720 route_list = *  dom1.tld/mx::1225
17721 .endd
17722 If the &%hosts_randomize%& option is set, the order of the items in the list is
17723 randomized before any lookups are done. Exim then scans the list; for any name
17724 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17725 be an interface on the local host and the item is not the first in the list,
17726 Exim discards it and any subsequent items. If it is the first item, what
17727 happens is controlled by the
17728 .oindex "&%self%&" "in &(manualroute)& router"
17729 &%self%& option of the router.
17730
17731 A name on the list that is followed by &`/MX`& is replaced with the list of
17732 hosts obtained by looking up MX records for the name. This is always a DNS
17733 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17734 below) are not relevant here. The order of these hosts is determined by the
17735 preference values in the MX records, according to the usual rules. Because
17736 randomizing happens before the MX lookup, it does not affect the order that is
17737 defined by MX preferences.
17738
17739 If the local host is present in the sublist obtained from MX records, but is
17740 not the most preferred host in that list, it and any equally or less
17741 preferred hosts are removed before the sublist is inserted into the main list.
17742
17743 If the local host is the most preferred host in the MX list, what happens
17744 depends on where in the original list of hosts the &`/MX`& item appears. If it
17745 is not the first item (that is, there are previous hosts in the main list),
17746 Exim discards this name and any subsequent items in the main list.
17747
17748 If the MX item is first in the list of hosts, and the local host is the
17749 most preferred host, what happens is controlled by the &%self%& option of the
17750 router.
17751
17752 DNS failures when lookup up the MX records are treated in the same way as DNS
17753 failures when looking up IP addresses: &%pass_on_timeout%& and
17754 &%host_find_failed%& are used when relevant.
17755
17756 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17757 whether obtained from an MX lookup or not.
17758
17759
17760
17761 .section "How the options are used" "SECThowoptused"
17762 The options are a sequence of words; in practice no more than three are ever
17763 present. One of the words can be the name of a transport; this overrides the
17764 &%transport%& option on the router for this particular routing rule only. The
17765 other words (if present) control randomization of the list of hosts on a
17766 per-rule basis, and how the IP addresses of the hosts are to be found when
17767 routing to a remote transport. These options are as follows:
17768
17769 .ilist
17770 &%randomize%&: randomize the order of the hosts in this list, overriding the
17771 setting of &%hosts_randomize%& for this routing rule only.
17772 .next
17773 &%no_randomize%&: do not randomize the order of the hosts in this list,
17774 overriding the setting of &%hosts_randomize%& for this routing rule only.
17775 .next
17776 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17777 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17778 also look in &_/etc/hosts_& or other sources of information.
17779 .next
17780 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17781 no address records are found. If there is a temporary DNS error (such as a
17782 timeout), delivery is deferred.
17783 .endlist
17784
17785 For example:
17786 .code
17787 route_list = domain1  host1:host2:host3  randomize bydns;\
17788              domain2  host4:host5
17789 .endd
17790 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17791 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17792 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17793 or &[gethostbyname()]&, and the result of the lookup is the result of that
17794 call.
17795
17796 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17797 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17798 instead of TRY_AGAIN. That is why the default action is to try a DNS
17799 lookup first. Only if that gives a definite &"no such host"& is the local
17800 function called.
17801
17802
17803
17804 If no IP address for a host can be found, what happens is controlled by the
17805 &%host_find_failed%& option.
17806
17807 .vindex "&$host$&"
17808 When an address is routed to a local transport, IP addresses are not looked up.
17809 The host list is passed to the transport in the &$host$& variable.
17810
17811
17812
17813 .section "Manualroute examples" "SECID123"
17814 In some of the examples that follow, the presence of the &%remote_smtp%&
17815 transport, as defined in the default configuration file, is assumed:
17816
17817 .ilist
17818 .cindex "smart host" "example router"
17819 The &(manualroute)& router can be used to forward all external mail to a
17820 &'smart host'&. If you have set up, in the main part of the configuration, a
17821 named domain list that contains your local domains, for example:
17822 .code
17823 domainlist local_domains = my.domain.example
17824 .endd
17825 You can arrange for all other domains to be routed to a smart host by making
17826 your first router something like this:
17827 .code
17828 smart_route:
17829   driver = manualroute
17830   domains = !+local_domains
17831   transport = remote_smtp
17832   route_list = * smarthost.ref.example
17833 .endd
17834 This causes all non-local addresses to be sent to the single host
17835 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17836 they are tried in order
17837 (but you can use &%hosts_randomize%& to vary the order each time).
17838 Another way of configuring the same thing is this:
17839 .code
17840 smart_route:
17841   driver = manualroute
17842   transport = remote_smtp
17843   route_list = !+local_domains  smarthost.ref.example
17844 .endd
17845 There is no difference in behaviour between these two routers as they stand.
17846 However, they behave differently if &%no_more%& is added to them. In the first
17847 example, the router is skipped if the domain does not match the &%domains%&
17848 precondition; the following router is always tried. If the router runs, it
17849 always matches the domain and so can never decline. Therefore, &%no_more%&
17850 would have no effect. In the second case, the router is never skipped; it
17851 always runs. However, if it doesn't match the domain, it declines. In this case
17852 &%no_more%& would prevent subsequent routers from running.
17853
17854 .next
17855 .cindex "mail hub example"
17856 A &'mail hub'& is a host which receives mail for a number of domains via MX
17857 records in the DNS and delivers it via its own private routing mechanism. Often
17858 the final destinations are behind a firewall, with the mail hub being the one
17859 machine that can connect to machines both inside and outside the firewall. The
17860 &(manualroute)& router is usually used on a mail hub to route incoming messages
17861 to the correct hosts. For a small number of domains, the routing can be inline,
17862 using the &%route_list%& option, but for a larger number a file or database
17863 lookup is easier to manage.
17864
17865 If the domain names are in fact the names of the machines to which the mail is
17866 to be sent by the mail hub, the configuration can be quite simple. For
17867 example:
17868 .code
17869 hub_route:
17870   driver = manualroute
17871   transport = remote_smtp
17872   route_list = *.rhodes.tvs.example  $domain
17873 .endd
17874 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17875 whose names are the same as the mail domains. A similar approach can be taken
17876 if the host name can be obtained from the domain name by a string manipulation
17877 that the expansion facilities can handle. Otherwise, a lookup based on the
17878 domain can be used to find the host:
17879 .code
17880 through_firewall:
17881   driver = manualroute
17882   transport = remote_smtp
17883   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17884 .endd
17885 The result of the lookup must be the name or IP address of the host (or
17886 hosts) to which the address is to be routed. If the lookup fails, the route
17887 data is empty, causing the router to decline. The address then passes to the
17888 next router.
17889
17890 .next
17891 .cindex "batched SMTP output example"
17892 .cindex "SMTP" "batched outgoing; example"
17893 You can use &(manualroute)& to deliver messages to pipes or files in batched
17894 SMTP format for onward transportation by some other means. This is one way of
17895 storing mail for a dial-up host when it is not connected. The route list entry
17896 can be as simple as a single domain name in a configuration like this:
17897 .code
17898 save_in_file:
17899   driver = manualroute
17900   transport = batchsmtp_appendfile
17901   route_list = saved.domain.example
17902 .endd
17903 though often a pattern is used to pick up more than one domain. If there are
17904 several domains or groups of domains with different transport requirements,
17905 different transports can be listed in the routing information:
17906 .code
17907 save_in_file:
17908   driver = manualroute
17909   route_list = \
17910     *.saved.domain1.example  $domain  batch_appendfile; \
17911     *.saved.domain2.example  \
17912       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17913       batch_pipe
17914 .endd
17915 .vindex "&$domain$&"
17916 .vindex "&$host$&"
17917 The first of these just passes the domain in the &$host$& variable, which
17918 doesn't achieve much (since it is also in &$domain$&), but the second does a
17919 file lookup to find a value to pass, causing the router to decline to handle
17920 the address if the lookup fails.
17921
17922 .next
17923 .cindex "UUCP" "example of router for"
17924 Routing mail directly to UUCP software is a specific case of the use of
17925 &(manualroute)& in a gateway to another mail environment. This is an example of
17926 one way it can be done:
17927 .code
17928 # Transport
17929 uucp:
17930   driver = pipe
17931   user = nobody
17932   command = /usr/local/bin/uux -r - \
17933     ${substr_-5:$host}!rmail ${local_part}
17934   return_fail_output = true
17935
17936 # Router
17937 uucphost:
17938   transport = uucp
17939   driver = manualroute
17940   route_data = \
17941     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17942 .endd
17943 The file &_/usr/local/exim/uucphosts_& contains entries like
17944 .code
17945 darksite.ethereal.example:           darksite.UUCP
17946 .endd
17947 It can be set up more simply without adding and removing &".UUCP"& but this way
17948 makes clear the distinction between the domain name
17949 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17950 .endlist
17951 .ecindex IIDmanrou1
17952 .ecindex IIDmanrou2
17953
17954
17955
17956
17957
17958
17959
17960
17961 . ////////////////////////////////////////////////////////////////////////////
17962 . ////////////////////////////////////////////////////////////////////////////
17963
17964 .chapter "The queryprogram router" "CHAPdriverlast"
17965 .scindex IIDquerou1 "&(queryprogram)& router"
17966 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17967 .cindex "routing" "by external program"
17968 The &(queryprogram)& router routes an address by running an external command
17969 and acting on its output. This is an expensive way to route, and is intended
17970 mainly for use in lightly-loaded systems, or for performing experiments.
17971 However, if it is possible to use the precondition options (&%domains%&,
17972 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17973 be used in special cases, even on a busy host. There are the following private
17974 options:
17975 .cindex "options" "&(queryprogram)& router"
17976
17977 .option command queryprogram string&!! unset
17978 This option must be set. It specifies the command that is to be run. The
17979 command is split up into a command name and arguments, and then each is
17980 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17981 &<<CHAPpipetransport>>&).
17982
17983
17984 .option command_group queryprogram string unset
17985 .cindex "gid (group id)" "in &(queryprogram)& router"
17986 This option specifies a gid to be set when running the command while routing an
17987 address for deliver. It must be set if &%command_user%& specifies a numerical
17988 uid. If it begins with a digit, it is interpreted as the numerical value of the
17989 gid. Otherwise it is looked up using &[getgrnam()]&.
17990
17991
17992 .option command_user queryprogram string unset
17993 .cindex "uid (user id)" "for &(queryprogram)&"
17994 This option must be set. It specifies the uid which is set when running the
17995 command while routing an address for delivery. If the value begins with a digit,
17996 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17997 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17998 not set, a value for the gid also.
17999
18000 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18001 root, which it does during a normal delivery in a conventional configuration.
18002 However, when an address is being verified during message reception, Exim is
18003 usually running as the Exim user, not as root. If the &(queryprogram)& router
18004 is called from a non-root process, Exim cannot change uid or gid before running
18005 the command. In this circumstance the command runs under the current uid and
18006 gid.
18007
18008
18009 .option current_directory queryprogram string /
18010 This option specifies an absolute path which is made the current directory
18011 before running the command.
18012
18013
18014 .option timeout queryprogram time 1h
18015 If the command does not complete within the timeout period, its process group
18016 is killed and the message is frozen. A value of zero time specifies no
18017 timeout.
18018
18019
18020 The standard output of the command is connected to a pipe, which is read when
18021 the command terminates. It should consist of a single line of output,
18022 containing up to five fields, separated by white space. The maximum length of
18023 the line is 1023 characters. Longer lines are silently truncated. The first
18024 field is one of the following words (case-insensitive):
18025
18026 .ilist
18027 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18028 below).
18029 .next
18030 &'Decline'&: the router declines; pass the address to the next router, unless
18031 &%no_more%& is set.
18032 .next
18033 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18034 subsequent text on the line is an error message. If the router is run as part
18035 of address verification during an incoming SMTP message, the message is
18036 included in the SMTP response.
18037 .next
18038 &'Defer'&: routing could not be completed at this time; try again later. Any
18039 subsequent text on the line is an error message which is logged. It is not
18040 included in any SMTP response.
18041 .next
18042 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18043 .next
18044 &'Pass'&: pass the address to the next router (or the router specified by
18045 &%pass_router%&), overriding &%no_more%&.
18046 .next
18047 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18048 new addresses, which are routed independently, starting with the first router,
18049 or the router specified by &%redirect_router%&, if set.
18050 .endlist
18051
18052 When the first word is &'accept'&, the remainder of the line consists of a
18053 number of keyed data values, as follows (split into two lines here, to fit on
18054 the page):
18055 .code
18056 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18057 LOOKUP=byname|bydns DATA=<text>
18058 .endd
18059 The data items can be given in any order, and all are optional. If no transport
18060 is included, the transport specified by the generic &%transport%& option is
18061 used. The list of hosts and the lookup type are needed only if the transport is
18062 an &(smtp)& transport that does not itself supply a list of hosts.
18063
18064 The format of the list of hosts is the same as for the &(manualroute)& router.
18065 As well as host names and IP addresses with optional port numbers, as described
18066 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18067 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18068 (see section &<<SECThostshowused>>&).
18069
18070 If the lookup type is not specified, Exim behaves as follows when trying to
18071 find an IP address for each host: First, a DNS lookup is done. If this yields
18072 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18073 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18074 result of the lookup is the result of that call.
18075
18076 .vindex "&$address_data$&"
18077 If the DATA field is set, its value is placed in the &$address_data$&
18078 variable. For example, this return line
18079 .code
18080 accept hosts=x1.y.example:x2.y.example data="rule1"
18081 .endd
18082 routes the address to the default transport, passing a list of two hosts. When
18083 the transport runs, the string &"rule1"& is in &$address_data$&.
18084 .ecindex IIDquerou1
18085 .ecindex IIDquerou2
18086
18087
18088
18089
18090 . ////////////////////////////////////////////////////////////////////////////
18091 . ////////////////////////////////////////////////////////////////////////////
18092
18093 .chapter "The redirect router" "CHAPredirect"
18094 .scindex IIDredrou1 "&(redirect)& router"
18095 .scindex IIDredrou2 "routers" "&(redirect)&"
18096 .cindex "alias file" "in a &(redirect)& router"
18097 .cindex "address redirection" "&(redirect)& router"
18098 The &(redirect)& router handles several kinds of address redirection. Its most
18099 common uses are for resolving local part aliases from a central alias file
18100 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18101 files, but it has many other potential uses. The incoming address can be
18102 redirected in several different ways:
18103
18104 .ilist
18105 It can be replaced by one or more new addresses which are themselves routed
18106 independently.
18107 .next
18108 It can be routed to be delivered to a given file or directory.
18109 .next
18110 It can be routed to be delivered to a specified pipe command.
18111 .next
18112 It can cause an automatic reply to be generated.
18113 .next
18114 It can be forced to fail, optionally with a custom error message.
18115 .next
18116 It can be temporarily deferred, optionally with a custom message.
18117 .next
18118 It can be discarded.
18119 .endlist
18120
18121 The generic &%transport%& option must not be set for &(redirect)& routers.
18122 However, there are some private options which define transports for delivery to
18123 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18124 &%pipe_transport%& and &%reply_transport%& descriptions below.
18125
18126
18127
18128 .section "Redirection data" "SECID124"
18129 The router operates by interpreting a text string which it obtains either by
18130 expanding the contents of the &%data%& option, or by reading the entire
18131 contents of a file whose name is given in the &%file%& option. These two
18132 options are mutually exclusive. The first is commonly used for handling system
18133 aliases, in a configuration like this:
18134 .code
18135 system_aliases:
18136   driver = redirect
18137   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18138 .endd
18139 If the lookup fails, the expanded string in this example is empty. When the
18140 expansion of &%data%& results in an empty string, the router declines. A forced
18141 expansion failure also causes the router to decline; other expansion failures
18142 cause delivery to be deferred.
18143
18144 A configuration using &%file%& is commonly used for handling users'
18145 &_.forward_& files, like this:
18146 .code
18147 userforward:
18148   driver = redirect
18149   check_local_user
18150   file = $home/.forward
18151   no_verify
18152 .endd
18153 If the file does not exist, or causes no action to be taken (for example, it is
18154 empty or consists only of comments), the router declines. &*Warning*&: This
18155 is not the case when the file contains syntactically valid items that happen to
18156 yield empty addresses, for example, items containing only RFC 2822 address
18157 comments.
18158
18159
18160
18161 .section "Forward files and address verification" "SECID125"
18162 .cindex "address redirection" "while verifying"
18163 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18164 &_.forward_& files, as in the example above. There are two reasons for this:
18165
18166 .ilist
18167 When Exim is receiving an incoming SMTP message from a remote host, it is
18168 running under the Exim uid, not as root. Exim is unable to change uid to read
18169 the file as the user, and it may not be able to read it as the Exim user. So in
18170 practice the router may not be able to operate.
18171 .next
18172 However, even when the router can operate, the existence of a &_.forward_& file
18173 is unimportant when verifying an address. What should be checked is whether the
18174 local part is a valid user name or not. Cutting out the redirection processing
18175 saves some resources.
18176 .endlist
18177
18178
18179
18180
18181
18182
18183 .section "Interpreting redirection data" "SECID126"
18184 .cindex "Sieve filter" "specifying in redirection data"
18185 .cindex "filter" "specifying in redirection data"
18186 The contents of the data string, whether obtained from &%data%& or &%file%&,
18187 can be interpreted in two different ways:
18188
18189 .ilist
18190 If the &%allow_filter%& option is set true, and the data begins with the text
18191 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18192 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18193 respectively. Details of the syntax and semantics of filter files are described
18194 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18195 document is intended for use by end users.
18196 .next
18197 Otherwise, the data must be a comma-separated list of redirection items, as
18198 described in the next section.
18199 .endlist
18200
18201 When a message is redirected to a file (a &"mail folder"&), the file name given
18202 in a non-filter redirection list must always be an absolute path. A filter may
18203 generate a relative path &-- how this is handled depends on the transport's
18204 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18205 for the &(appendfile)& transport.
18206
18207
18208
18209 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18210 .cindex "address redirection" "non-filter list items"
18211 When the redirection data is not an Exim or Sieve filter, for example, if it
18212 comes from a conventional alias or forward file, it consists of a list of
18213 addresses, file names, pipe commands, or certain special items (see section
18214 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18215 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18216 depending on their default values. The items in the list are separated by
18217 commas or newlines.
18218 If a comma is required in an item, the entire item must be enclosed in double
18219 quotes.
18220
18221 Lines starting with a # character are comments, and are ignored, and # may
18222 also appear following a comma, in which case everything between the # and the
18223 next newline character is ignored.
18224
18225 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18226 double quotes are retained because some forms of mail address require their use
18227 (but never to enclose the entire address). In the following description,
18228 &"item"& refers to what remains after any surrounding double quotes have been
18229 removed.
18230
18231 .vindex "&$local_part$&"
18232 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18233 and the expansion contains a reference to &$local_part$&, you should make use
18234 of the &%quote_local_part%& expansion operator, in case the local part contains
18235 special characters. For example, to redirect all mail for the domain
18236 &'obsolete.example'&, retaining the existing local part, you could use this
18237 setting:
18238 .code
18239 data = ${quote_local_part:$local_part}@newdomain.example
18240 .endd
18241
18242
18243 .section "Redirecting to a local mailbox" "SECTredlocmai"
18244 .cindex "routing" "loops in"
18245 .cindex "loop" "while routing, avoidance of"
18246 .cindex "address redirection" "to local mailbox"
18247 A redirection item may safely be the same as the address currently under
18248 consideration. This does not cause a routing loop, because a router is
18249 automatically skipped if any ancestor of the address that is being processed
18250 is the same as the current address and was processed by the current router.
18251 Such an address is therefore passed to the following routers, so it is handled
18252 as if there were no redirection. When making this loop-avoidance test, the
18253 complete local part, including any prefix or suffix, is used.
18254
18255 .cindex "address redirection" "local part without domain"
18256 Specifying the same local part without a domain is a common usage in personal
18257 filter files when the user wants to have messages delivered to the local
18258 mailbox and also forwarded elsewhere. For example, the user whose login is
18259 &'cleo'& might have a &_.forward_& file containing this:
18260 .code
18261 cleo, cleopatra@egypt.example
18262 .endd
18263 .cindex "backslash in alias file"
18264 .cindex "alias file" "backslash in"
18265 For compatibility with other MTAs, such unqualified local parts may be
18266 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18267 it does make a difference if more than one domain is being handled
18268 synonymously.
18269
18270 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18271 2822 address that does not include a domain, the item is qualified using the
18272 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18273 addresses are qualified using the value in &%qualify_recipient%&, but you can
18274 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18275
18276 Care must be taken if there are alias names for local users.
18277 Consider an MTA handling a single local domain where the system alias file
18278 contains:
18279 .code
18280 Sam.Reman: spqr
18281 .endd
18282 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18283 messages in the local mailbox, and also forward copies elsewhere. He creates
18284 this forward file:
18285 .code
18286 Sam.Reman, spqr@reme.elsewhere.example
18287 .endd
18288 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18289 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18290 second time round, because it has previously routed it,
18291 and the following routers presumably cannot handle the alias. The forward file
18292 should really contain
18293 .code
18294 spqr, spqr@reme.elsewhere.example
18295 .endd
18296 but because this is such a common error, the &%check_ancestor%& option (see
18297 below) exists to provide a way to get round it. This is normally set on a
18298 &(redirect)& router that is handling users' &_.forward_& files.
18299
18300
18301
18302 .section "Special items in redirection lists" "SECTspecitredli"
18303 In addition to addresses, the following types of item may appear in redirection
18304 lists (that is, in non-filter redirection data):
18305
18306 .ilist
18307 .cindex "pipe" "in redirection list"
18308 .cindex "address redirection" "to pipe"
18309 An item is treated as a pipe command if it begins with &"|"& and does not parse
18310 as a valid RFC 2822 address that includes a domain. A transport for running the
18311 command must be specified by the &%pipe_transport%& option.
18312 Normally, either the router or the transport specifies a user and a group under
18313 which to run the delivery. The default is to use the Exim user and group.
18314
18315 Single or double quotes can be used for enclosing the individual arguments of
18316 the pipe command; no interpretation of escapes is done for single quotes. If
18317 the command contains a comma character, it is necessary to put the whole item
18318 in double quotes, for example:
18319 .code
18320 "|/some/command ready,steady,go"
18321 .endd
18322 since items in redirection lists are terminated by commas. Do not, however,
18323 quote just the command. An item such as
18324 .code
18325 |"/some/command ready,steady,go"
18326 .endd
18327 is interpreted as a pipe with a rather strange command name, and no arguments.
18328
18329 .next
18330 .cindex "file" "in redirection list"
18331 .cindex "address redirection" "to file"
18332 An item is interpreted as a path name if it begins with &"/"& and does not
18333 parse as a valid RFC 2822 address that includes a domain. For example,
18334 .code
18335 /home/world/minbari
18336 .endd
18337 is treated as a file name, but
18338 .code
18339 /s=molari/o=babylon/@x400gate.way
18340 .endd
18341 is treated as an address. For a file name, a transport must be specified using
18342 the &%file_transport%& option. However, if the generated path name ends with a
18343 forward slash character, it is interpreted as a directory name rather than a
18344 file name, and &%directory_transport%& is used instead.
18345
18346 Normally, either the router or the transport specifies a user and a group under
18347 which to run the delivery. The default is to use the Exim user and group.
18348
18349 .cindex "&_/dev/null_&"
18350 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18351 bypassed at a high level, and the log entry shows &"**bypassed**"&
18352 instead of a transport name. In this case the user and group are not used.
18353
18354 .next
18355 .cindex "included address list"
18356 .cindex "address redirection" "included external list"
18357 If an item is of the form
18358 .code
18359 :include:<path name>
18360 .endd
18361 a list of further items is taken from the given file and included at that
18362 point. &*Note*&: Such a file can not be a filter file; it is just an
18363 out-of-line addition to the list. The items in the included list are separated
18364 by commas or newlines and are not subject to expansion. If this is the first
18365 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18366 the alias name. This example is incorrect:
18367 .code
18368 list1    :include:/opt/lists/list1
18369 .endd
18370 It must be given as
18371 .code
18372 list1:   :include:/opt/lists/list1
18373 .endd
18374 .next
18375 .cindex "address redirection" "to black hole"
18376 Sometimes you want to throw away mail to a particular local part. Making the
18377 &%data%& option expand to an empty string does not work, because that causes
18378 the router to decline. Instead, the alias item
18379 .cindex "black hole"
18380 .cindex "abandoning mail"
18381 &':blackhole:'& can be used. It does what its name implies. No delivery is
18382 done, and no error message is generated. This has the same effect as specifing
18383 &_/dev/null_& as a destination, but it can be independently disabled.
18384
18385 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18386 delivery is done for the original local part, even if other redirection items
18387 are present. If you are generating a multi-item list (for example, by reading a
18388 database) and need the ability to provide a no-op item, you must use
18389 &_/dev/null_&.
18390
18391 .next
18392 .cindex "delivery" "forcing failure"
18393 .cindex "delivery" "forcing deferral"
18394 .cindex "failing delivery" "forcing"
18395 .cindex "deferred delivery, forcing"
18396 .cindex "customizing" "failure message"
18397 An attempt to deliver a particular address can be deferred or forced to fail by
18398 redirection items of the form
18399 .code
18400 :defer:
18401 :fail:
18402 .endd
18403 respectively. When a redirection list contains such an item, it applies
18404 to the entire redirection; any other items in the list are ignored. Any
18405 text following &':fail:'& or &':defer:'& is placed in the error text
18406 associated with the failure. For example, an alias file might contain:
18407 .code
18408 X.Employee:  :fail: Gone away, no forwarding address
18409 .endd
18410 In the case of an address that is being verified from an ACL or as the subject
18411 of a
18412 .cindex "VRFY" "error text, display of"
18413 VRFY command, the text is included in the SMTP error response by
18414 default.
18415 .cindex "EXPN" "error text, display of"
18416 The text is not included in the response to an EXPN command. In non-SMTP cases
18417 the text is included in the error message that Exim generates.
18418
18419 .cindex "SMTP" "error codes"
18420 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18421 &':fail:'&. However, if the message starts with three digits followed by a
18422 space, optionally followed by an extended code of the form &'n.n.n'&, also
18423 followed by a space, and the very first digit is the same as the default error
18424 code, the code from the message is used instead. If the very first digit is
18425 incorrect, a panic error is logged, and the default code is used. You can
18426 suppress the use of the supplied code in a redirect router by setting the
18427 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18428 ignored.
18429
18430 .vindex "&$acl_verify_message$&"
18431 In an ACL, an explicitly provided message overrides the default, but the
18432 default message is available in the variable &$acl_verify_message$& and can
18433 therefore be included in a custom message if this is desired.
18434
18435 Normally the error text is the rest of the redirection list &-- a comma does
18436 not terminate it &-- but a newline does act as a terminator. Newlines are not
18437 normally present in alias expansions. In &(lsearch)& lookups they are removed
18438 as part of the continuation process, but they may exist in other kinds of
18439 lookup and in &':include:'& files.
18440
18441 During routing for message delivery (as opposed to verification), a redirection
18442 containing &':fail:'& causes an immediate failure of the incoming address,
18443 whereas &':defer:'& causes the message to remain on the queue so that a
18444 subsequent delivery attempt can happen at a later time. If an address is
18445 deferred for too long, it will ultimately fail, because the normal retry
18446 rules still apply.
18447
18448 .next
18449 .cindex "alias file" "exception to default"
18450 Sometimes it is useful to use a single-key search type with a default (see
18451 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18452 for exceptions to the default. These can be handled by aliasing them to
18453 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18454 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18455 results in an empty redirection list has the same effect.
18456 .endlist
18457
18458
18459 .section "Duplicate addresses" "SECTdupaddr"
18460 .cindex "duplicate addresses"
18461 .cindex "address duplicate, discarding"
18462 .cindex "pipe" "duplicated"
18463 Exim removes duplicate addresses from the list to which it is delivering, so as
18464 to deliver just one copy to each address. This does not apply to deliveries
18465 routed to pipes by different immediate parent addresses, but an indirect
18466 aliasing scheme of the type
18467 .code
18468 pipe:       |/some/command $local_part
18469 localpart1: pipe
18470 localpart2: pipe
18471 .endd
18472 does not work with a message that is addressed to both local parts, because
18473 when the second is aliased to the intermediate local part &"pipe"& it gets
18474 discarded as being the same as a previously handled address. However, a scheme
18475 such as
18476 .code
18477 localpart1: |/some/command $local_part
18478 localpart2: |/some/command $local_part
18479 .endd
18480 does result in two different pipe deliveries, because the immediate parents of
18481 the pipes are distinct.
18482
18483
18484
18485 .section "Repeated redirection expansion" "SECID128"
18486 .cindex "repeated redirection expansion"
18487 .cindex "address redirection" "repeated for each delivery attempt"
18488 When a message cannot be delivered to all of its recipients immediately,
18489 leading to two or more delivery attempts, redirection expansion is carried out
18490 afresh each time for those addresses whose children were not all previously
18491 delivered. If redirection is being used as a mailing list, this can lead to new
18492 members of the list receiving copies of old messages. The &%one_time%& option
18493 can be used to avoid this.
18494
18495
18496 .section "Errors in redirection lists" "SECID129"
18497 .cindex "address redirection" "errors"
18498 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18499 error is skipped, and an entry is written to the main log. This may be useful
18500 for mailing lists that are automatically managed. Otherwise, if an error is
18501 detected while generating the list of new addresses, the original address is
18502 deferred. See also &%syntax_errors_to%&.
18503
18504
18505
18506 .section "Private options for the redirect router" "SECID130"
18507
18508 .cindex "options" "&(redirect)& router"
18509 The private options for the &(redirect)& router are as follows:
18510
18511
18512 .option allow_defer redirect boolean false
18513 Setting this option allows the use of &':defer:'& in non-filter redirection
18514 data, or the &%defer%& command in an Exim filter file.
18515
18516
18517 .option allow_fail redirect boolean false
18518 .cindex "failing delivery" "from filter"
18519 If this option is true, the &':fail:'& item can be used in a redirection list,
18520 and the &%fail%& command may be used in an Exim filter file.
18521
18522
18523 .option allow_filter redirect boolean false
18524 .cindex "filter" "enabling use of"
18525 .cindex "Sieve filter" "enabling use of"
18526 Setting this option allows Exim to interpret redirection data that starts with
18527 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18528 are some features of Exim filter files that some administrators may wish to
18529 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18530
18531 It is also possible to lock out Exim filters or Sieve filters while allowing
18532 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18533
18534
18535 The filter is run using the uid and gid set by the generic &%user%& and
18536 &%group%& options. These take their defaults from the password data if
18537 &%check_local_user%& is set, so in the normal case of users' personal filter
18538 files, the filter is run as the relevant user. When &%allow_filter%& is set
18539 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18540
18541
18542
18543 .option allow_freeze redirect boolean false
18544 .cindex "freezing messages" "allowing in filter"
18545 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18546 This command is more normally encountered in system filters, and is disabled by
18547 default for redirection filters because it isn't something you usually want to
18548 let ordinary users do.
18549
18550
18551
18552 .option check_ancestor redirect boolean false
18553 This option is concerned with handling generated addresses that are the same
18554 as some address in the list of redirection ancestors of the current address.
18555 Although it is turned off by default in the code, it is set in the default
18556 configuration file for handling users' &_.forward_& files. It is recommended
18557 for this use of the &(redirect)& router.
18558
18559 When &%check_ancestor%& is set, if a generated address (including the domain)
18560 is the same as any ancestor of the current address, it is replaced by a copy of
18561 the current address. This helps in the case where local part A is aliased to B,
18562 and B has a &_.forward_& file pointing back to A. For example, within a single
18563 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18564 &_&~jb/.forward_& contains:
18565 .code
18566 \Joe.Bloggs, <other item(s)>
18567 .endd
18568 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18569 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18570 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18571 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18572 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18573 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18574 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18575 original address. See also the &%repeat_use%& option below.
18576
18577
18578 .option check_group redirect boolean "see below"
18579 When the &%file%& option is used, the group owner of the file is checked only
18580 when this option is set. The permitted groups are those listed in the
18581 &%owngroups%& option, together with the user's default group if
18582 &%check_local_user%& is set. If the file has the wrong group, routing is
18583 deferred. The default setting for this option is true if &%check_local_user%&
18584 is set and the &%modemask%& option permits the group write bit, or if the
18585 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18586
18587
18588
18589 .option check_owner redirect boolean "see below"
18590 When the &%file%& option is used, the owner of the file is checked only when
18591 this option is set. If &%check_local_user%& is set, the local user is
18592 permitted; otherwise the owner must be one of those listed in the &%owners%&
18593 option. The default value for this option is true if &%check_local_user%& or
18594 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18595
18596
18597 .option data redirect string&!! unset
18598 This option is mutually exclusive with &%file%&. One or other of them must be
18599 set, but not both. The contents of &%data%& are expanded, and then used as the
18600 list of forwarding items, or as a set of filtering instructions. If the
18601 expansion is forced to fail, or the result is an empty string or a string that
18602 has no effect (consists entirely of comments), the router declines.
18603
18604 When filtering instructions are used, the string must begin with &"#Exim
18605 filter"&, and all comments in the string, including this initial one, must be
18606 terminated with newline characters. For example:
18607 .code
18608 data = #Exim filter\n\
18609        if $h_to: contains Exim then save $home/mail/exim endif
18610 .endd
18611 If you are reading the data from a database where newlines cannot be included,
18612 you can use the &${sg}$& expansion item to turn the escape string of your
18613 choice into a newline.
18614
18615
18616 .option directory_transport redirect string&!! unset
18617 A &(redirect)& router sets up a direct delivery to a directory when a path name
18618 ending with a slash is specified as a new &"address"&. The transport used is
18619 specified by this option, which, after expansion, must be the name of a
18620 configured transport. This should normally be an &(appendfile)& transport.
18621
18622
18623 .option file redirect string&!! unset
18624 This option specifies the name of a file that contains the redirection data. It
18625 is mutually exclusive with the &%data%& option. The string is expanded before
18626 use; if the expansion is forced to fail, the router declines. Other expansion
18627 failures cause delivery to be deferred. The result of a successful expansion
18628 must be an absolute path. The entire file is read and used as the redirection
18629 data. If the data is an empty string or a string that has no effect (consists
18630 entirely of comments), the router declines.
18631
18632 .cindex "NFS" "checking for file existence"
18633 If the attempt to open the file fails with a &"does not exist"& error, Exim
18634 runs a check on the containing directory,
18635 unless &%ignore_enotdir%& is true (see below).
18636 If the directory does not appear to exist, delivery is deferred. This can
18637 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18638 is a mount problem. If the containing directory does exist, but the file does
18639 not, the router declines.
18640
18641
18642 .option file_transport redirect string&!! unset
18643 .vindex "&$address_file$&"
18644 A &(redirect)& router sets up a direct delivery to a file when a path name not
18645 ending in a slash is specified as a new &"address"&. The transport used is
18646 specified by this option, which, after expansion, must be the name of a
18647 configured transport. This should normally be an &(appendfile)& transport. When
18648 it is running, the file name is in &$address_file$&.
18649
18650
18651 .option filter_prepend_home redirect boolean true
18652 When this option is true, if a &(save)& command in an Exim filter specifies a
18653 relative path, and &$home$& is defined, it is automatically prepended to the
18654 relative path. If this option is set false, this action does not happen. The
18655 relative path is then passed to the transport unmodified.
18656
18657
18658 .option forbid_blackhole redirect boolean false
18659 If this option is true, the &':blackhole:'& item may not appear in a
18660 redirection list.
18661
18662
18663 .option forbid_exim_filter redirect boolean false
18664 If this option is set true, only Sieve filters are permitted when
18665 &%allow_filter%& is true.
18666
18667
18668
18669
18670 .option forbid_file redirect boolean false
18671 .cindex "delivery" "to file; forbidding"
18672 .cindex "Sieve filter" "forbidding delivery to a file"
18673 .cindex "Sieve filter" "&""keep""& facility; disabling"
18674 If this option is true, this router may not generate a new address that
18675 specifies delivery to a local file or directory, either from a filter or from a
18676 conventional forward file. This option is forced to be true if &%one_time%& is
18677 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18678 locks out the Sieve's &"keep"& facility.
18679
18680
18681 .option forbid_filter_dlfunc redirect boolean false
18682 .cindex "filter" "locking out certain features"
18683 If this option is true, string expansions in Exim filters are not allowed to
18684 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18685 functions.
18686
18687 .option forbid_filter_existstest redirect boolean false
18688 .cindex "expansion" "statting a file"
18689 If this option is true, string expansions in Exim filters are not allowed to
18690 make use of the &%exists%& condition or the &%stat%& expansion item.
18691
18692 .option forbid_filter_logwrite redirect boolean false
18693 If this option is true, use of the logging facility in Exim filters is not
18694 permitted. Logging is in any case available only if the filter is being run
18695 under some unprivileged uid (which is normally the case for ordinary users'
18696 &_.forward_& files).
18697
18698
18699 .option forbid_filter_lookup redirect boolean false
18700 If this option is true, string expansions in Exim filter files are not allowed
18701 to make use of &%lookup%& items.
18702
18703
18704 .option forbid_filter_perl redirect boolean false
18705 This option has an effect only if Exim is built with embedded Perl support. If
18706 it is true, string expansions in Exim filter files are not allowed to make use
18707 of the embedded Perl support.
18708
18709
18710 .option forbid_filter_readfile redirect boolean false
18711 If this option is true, string expansions in Exim filter files are not allowed
18712 to make use of &%readfile%& items.
18713
18714
18715 .option forbid_filter_readsocket redirect boolean false
18716 If this option is true, string expansions in Exim filter files are not allowed
18717 to make use of &%readsocket%& items.
18718
18719
18720 .option forbid_filter_reply redirect boolean false
18721 If this option is true, this router may not generate an automatic reply
18722 message. Automatic replies can be generated only from Exim or Sieve filter
18723 files, not from traditional forward files. This option is forced to be true if
18724 &%one_time%& is set.
18725
18726
18727 .option forbid_filter_run redirect boolean false
18728 If this option is true, string expansions in Exim filter files are not allowed
18729 to make use of &%run%& items.
18730
18731
18732 .option forbid_include redirect boolean false
18733 If this option is true, items of the form
18734 .code
18735 :include:<path name>
18736 .endd
18737 are not permitted in non-filter redirection lists.
18738
18739
18740 .option forbid_pipe redirect boolean false
18741 .cindex "delivery" "to pipe; forbidding"
18742 If this option is true, this router may not generate a new address which
18743 specifies delivery to a pipe, either from an Exim filter or from a conventional
18744 forward file. This option is forced to be true if &%one_time%& is set.
18745
18746
18747 .option forbid_sieve_filter redirect boolean false
18748 If this option is set true, only Exim filters are permitted when
18749 &%allow_filter%& is true.
18750
18751
18752 .cindex "SMTP" "error codes"
18753 .option forbid_smtp_code redirect boolean false
18754 If this option is set true, any SMTP error codes that are present at the start
18755 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18756 the default codes (451 and 550, respectively) are always used.
18757
18758
18759
18760
18761 .option hide_child_in_errmsg redirect boolean false
18762 .cindex "bounce message" "redirection details; suppressing"
18763 If this option is true, it prevents Exim from quoting a child address if it
18764 generates a bounce or delay message for it. Instead it says &"an address
18765 generated from <&'the top level address'&>"&. Of course, this applies only to
18766 bounces generated locally. If a message is forwarded to another host, &'its'&
18767 bounce may well quote the generated address.
18768
18769
18770 .option ignore_eacces redirect boolean false
18771 .cindex "EACCES"
18772 If this option is set and an attempt to open a redirection file yields the
18773 EACCES error (permission denied), the &(redirect)& router behaves as if the
18774 file did not exist.
18775
18776
18777 .option ignore_enotdir redirect boolean false
18778 .cindex "ENOTDIR"
18779 If this option is set and an attempt to open a redirection file yields the
18780 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18781 router behaves as if the file did not exist.
18782
18783 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18784 router that has the &%file%& option set discovers that the file does not exist
18785 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18786 against unmounted NFS directories. If the parent can not be statted, delivery
18787 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18788 is set, because that option tells Exim to ignore &"something on the path is not
18789 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18790 that some operating systems give ENOENT where others give ENOTDIR.
18791
18792
18793
18794 .option include_directory redirect string unset
18795 If this option is set, the path names of any &':include:'& items in a
18796 redirection list must start with this directory.
18797
18798
18799 .option modemask redirect "octal integer" 022
18800 This specifies mode bits which must not be set for a file specified by the
18801 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18802
18803
18804 .option one_time redirect boolean false
18805 .cindex "one-time aliasing/forwarding expansion"
18806 .cindex "alias file" "one-time expansion"
18807 .cindex "forward file" "one-time expansion"
18808 .cindex "mailing lists" "one-time expansion"
18809 .cindex "address redirection" "one-time expansion"
18810 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18811 files each time it tries to deliver a message causes a problem when one or more
18812 of the generated addresses fails be delivered at the first attempt. The problem
18813 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18814 but of what happens when the redirection list changes during the time that the
18815 message is on Exim's queue. This is particularly true in the case of mailing
18816 lists, where new subscribers might receive copies of messages that were posted
18817 before they subscribed.
18818
18819 If &%one_time%& is set and any addresses generated by the router fail to
18820 deliver at the first attempt, the failing addresses are added to the message as
18821 &"top level"& addresses, and the parent address that generated them is marked
18822 &"delivered"&. Thus, redirection does not happen again at the next delivery
18823 attempt.
18824
18825 &*Warning 1*&: Any header line addition or removal that is specified by this
18826 router would be lost if delivery did not succeed at the first attempt. For this
18827 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18828 permitted when &%one_time%& is set.
18829
18830 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18831 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18832 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18833
18834 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18835 &%one_time%&.
18836
18837 The original top-level address is remembered with each of the generated
18838 addresses, and is output in any log messages. However, any intermediate parent
18839 addresses are not recorded. This makes a difference to the log only if
18840 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18841 typically be used for mailing lists, where there is normally just one level of
18842 expansion.
18843
18844
18845 .option owners redirect "string list" unset
18846 .cindex "ownership" "alias file"
18847 .cindex "ownership" "forward file"
18848 .cindex "alias file" "ownership"
18849 .cindex "forward file" "ownership"
18850 This specifies a list of permitted owners for the file specified by &%file%&.
18851 This list is in addition to the local user when &%check_local_user%& is set.
18852 See &%check_owner%& above.
18853
18854
18855 .option owngroups redirect "string list" unset
18856 This specifies a list of permitted groups for the file specified by &%file%&.
18857 The list is in addition to the local user's primary group when
18858 &%check_local_user%& is set. See &%check_group%& above.
18859
18860
18861 .option pipe_transport redirect string&!! unset
18862 .vindex "&$address_pipe$&"
18863 A &(redirect)& router sets up a direct delivery to a pipe when a string
18864 starting with a vertical bar character is specified as a new &"address"&. The
18865 transport used is specified by this option, which, after expansion, must be the
18866 name of a configured transport. This should normally be a &(pipe)& transport.
18867 When the transport is run, the pipe command is in &$address_pipe$&.
18868
18869
18870 .option qualify_domain redirect string&!! unset
18871 .vindex "&$qualify_recipient$&"
18872 If this option is set, and an unqualified address (one without a domain) is
18873 generated, and that address would normally be qualified by the global setting
18874 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18875 expanding this string. If the expansion fails, the router declines. If you want
18876 to revert to the default, you can have the expansion generate
18877 &$qualify_recipient$&.
18878
18879 This option applies to all unqualified addresses generated by Exim filters,
18880 but for traditional &_.forward_& files, it applies only to addresses that are
18881 not preceded by a backslash. Sieve filters cannot generate unqualified
18882 addresses.
18883
18884 .option qualify_preserve_domain redirect boolean false
18885 .cindex "domain" "in redirection; preserving"
18886 .cindex "preserving domain in redirection"
18887 .cindex "address redirection" "domain; preserving"
18888 If this option is set, the router's local &%qualify_domain%& option must not be
18889 set (a configuration error occurs if it is). If an unqualified address (one
18890 without a domain) is generated, it is qualified with the domain of the parent
18891 address (the immediately preceding ancestor) instead of the global
18892 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18893 this applies whether or not the address is preceded by a backslash.
18894
18895
18896 .option repeat_use redirect boolean true
18897 If this option is set false, the router is skipped for a child address that has
18898 any ancestor that was routed by this router. This test happens before any of
18899 the other preconditions are tested. Exim's default anti-looping rules skip
18900 only when the ancestor is the same as the current address. See also
18901 &%check_ancestor%& above and the generic &%redirect_router%& option.
18902
18903
18904 .option reply_transport redirect string&!! unset
18905 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18906 &%vacation%& command is used in a filter file. The transport used is specified
18907 by this option, which, after expansion, must be the name of a configured
18908 transport. This should normally be an &(autoreply)& transport. Other transports
18909 are unlikely to do anything sensible or useful.
18910
18911
18912 .option rewrite redirect boolean true
18913 .cindex "address redirection" "disabling rewriting"
18914 If this option is set false, addresses generated by the router are not
18915 subject to address rewriting. Otherwise, they are treated like new addresses
18916 and are rewritten according to the global rewriting rules.
18917
18918
18919 .option sieve_subaddress redirect string&!! unset
18920 The value of this option is passed to a Sieve filter to specify the
18921 :subaddress part of an address.
18922
18923 .option sieve_useraddress redirect string&!! unset
18924 The value of this option is passed to a Sieve filter to specify the :user part
18925 of an address. However, if it is unset, the entire original local part
18926 (including any prefix or suffix) is used for :user.
18927
18928
18929 .option sieve_vacation_directory redirect string&!! unset
18930 .cindex "Sieve filter" "vacation directory"
18931 To enable the &"vacation"& extension for Sieve filters, you must set
18932 &%sieve_vacation_directory%& to the directory where vacation databases are held
18933 (do not put anything else in that directory), and ensure that the
18934 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18935 needs their own directory; Exim will create it if necessary.
18936
18937
18938
18939 .option skip_syntax_errors redirect boolean false
18940 .cindex "forward file" "broken"
18941 .cindex "address redirection" "broken files"
18942 .cindex "alias file" "broken"
18943 .cindex "broken alias or forward files"
18944 .cindex "ignoring faulty addresses"
18945 .cindex "skipping faulty addresses"
18946 .cindex "error" "skipping bad syntax"
18947 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18948 non-filter redirection data are skipped, and each failing address is logged. If
18949 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18950 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18951 are expanded and placed at the head of the error message generated by
18952 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18953 be the same address as the generic &%errors_to%& option. The
18954 &%skip_syntax_errors%& option is often used when handling mailing lists.
18955
18956 If all the addresses in a redirection list are skipped because of syntax
18957 errors, the router declines to handle the original address, and it is passed to
18958 the following routers.
18959
18960 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18961 error in the filter causes filtering to be abandoned without any action being
18962 taken. The incident is logged, and the router declines to handle the address,
18963 so it is passed to the following routers.
18964
18965 .cindex "Sieve filter" "syntax errors in"
18966 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18967 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18968 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18969
18970 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18971 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18972 option, used with an address that does not get redirected, can be used to
18973 notify users of these errors, by means of a router like this:
18974 .code
18975 userforward:
18976   driver = redirect
18977   allow_filter
18978   check_local_user
18979   file = $home/.forward
18980   file_transport = address_file
18981   pipe_transport = address_pipe
18982   reply_transport = address_reply
18983   no_verify
18984   skip_syntax_errors
18985   syntax_errors_to = real-$local_part@$domain
18986   syntax_errors_text = \
18987    This is an automatically generated message. An error has\n\
18988    been found in your .forward file. Details of the error are\n\
18989    reported below. While this error persists, you will receive\n\
18990    a copy of this message for every message that is addressed\n\
18991    to you. If your .forward file is a filter file, or if it is\n\
18992    a non-filter file containing no valid forwarding addresses,\n\
18993    a copy of each incoming message will be put in your normal\n\
18994    mailbox. If a non-filter file contains at least one valid\n\
18995    forwarding address, forwarding to the valid addresses will\n\
18996    happen, and those will be the only deliveries that occur.
18997 .endd
18998 You also need a router to ensure that local addresses that are prefixed by
18999 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19000 put this immediately before the &(userforward)& router:
19001 .code
19002 real_localuser:
19003   driver = accept
19004   check_local_user
19005   local_part_prefix = real-
19006   transport = local_delivery
19007 .endd
19008 For security, it would probably be a good idea to restrict the use of this
19009 router to locally-generated messages, using a condition such as this:
19010 .code
19011   condition = ${if match {$sender_host_address}\
19012                          {\N^(|127\.0\.0\.1)$\N}}
19013 .endd
19014
19015
19016 .option syntax_errors_text redirect string&!! unset
19017 See &%skip_syntax_errors%& above.
19018
19019
19020 .option syntax_errors_to redirect string unset
19021 See &%skip_syntax_errors%& above.
19022 .ecindex IIDredrou1
19023 .ecindex IIDredrou2
19024
19025
19026
19027
19028
19029
19030 . ////////////////////////////////////////////////////////////////////////////
19031 . ////////////////////////////////////////////////////////////////////////////
19032
19033 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19034          "Environment for local transports"
19035 .scindex IIDenvlotra1 "local transports" "environment for"
19036 .scindex IIDenvlotra2 "environment for local transports"
19037 .scindex IIDenvlotra3 "transport" "local; environment for"
19038 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19039 transport can be thought of as similar to a pipe.) Exim always runs transports
19040 in subprocesses, under specified uids and gids. Typical deliveries to local
19041 mailboxes run under the uid and gid of the local user.
19042
19043 Exim also sets a specific current directory while running the transport; for
19044 some transports a home directory setting is also relevant. The &(pipe)&
19045 transport is the only one that sets up environment variables; see section
19046 &<<SECTpipeenv>>& for details.
19047
19048 The values used for the uid, gid, and the directories may come from several
19049 different places. In many cases, the router that handles the address associates
19050 settings with that address as a result of its &%check_local_user%&, &%group%&,
19051 or &%user%& options. However, values may also be given in the transport's own
19052 configuration, and these override anything that comes from the router.
19053
19054
19055
19056 .section "Concurrent deliveries" "SECID131"
19057 .cindex "concurrent deliveries"
19058 .cindex "simultaneous deliveries"
19059 If two different messages for the same local recipient arrive more or less
19060 simultaneously, the two delivery processes are likely to run concurrently. When
19061 the &(appendfile)& transport is used to write to a file, Exim applies locking
19062 rules to stop concurrent processes from writing to the same file at the same
19063 time.
19064
19065 However, when you use a &(pipe)& transport, it is up to you to arrange any
19066 locking that is needed. Here is a silly example:
19067 .code
19068 my_transport:
19069   driver = pipe
19070   command = /bin/sh -c 'cat >>/some/file'
19071 .endd
19072 This is supposed to write the message at the end of the file. However, if two
19073 messages arrive at the same time, the file will be scrambled. You can use the
19074 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19075 file using the same algorithm that Exim itself uses.
19076
19077
19078
19079
19080 .section "Uids and gids" "SECTenvuidgid"
19081 .cindex "local transports" "uid and gid"
19082 .cindex "transport" "local; uid and gid"
19083 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19084 overrides any group that the router set in the address, even if &%user%& is not
19085 set for the transport. This makes it possible, for example, to run local mail
19086 delivery under the uid of the recipient (set by the router), but in a special
19087 group (set by the transport). For example:
19088 .code
19089 # Routers ...
19090 # User/group are set by check_local_user in this router
19091 local_users:
19092   driver = accept
19093   check_local_user
19094   transport = group_delivery
19095
19096 # Transports ...
19097 # This transport overrides the group
19098 group_delivery:
19099   driver = appendfile
19100   file = /var/spool/mail/$local_part
19101   group = mail
19102 .endd
19103 If &%user%& is set for a transport, its value overrides what is set in the
19104 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19105 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19106 set.
19107
19108 .oindex "&%initgroups%&"
19109 When the uid is taken from the transport's configuration, the &[initgroups()]&
19110 function is called for the groups associated with that uid if the
19111 &%initgroups%& option is set for the transport. When the uid is not specified
19112 by the transport, but is associated with the address by a router, the option
19113 for calling &[initgroups()]& is taken from the router configuration.
19114
19115 .cindex "&(pipe)& transport" "uid for"
19116 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19117 is set and &%user%& is not set, the uid of the process that called Exim to
19118 receive the message is used, and if &%group%& is not set, the corresponding
19119 original gid is also used.
19120
19121 This is the detailed preference order for obtaining a gid; the first of the
19122 following that is set is used:
19123
19124 .ilist
19125 A &%group%& setting of the transport;
19126 .next
19127 A &%group%& setting of the router;
19128 .next
19129 A gid associated with a user setting of the router, either as a result of
19130 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19131 .next
19132 The group associated with a non-numeric &%user%& setting of the transport;
19133 .next
19134 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19135 the uid is the creator's uid;
19136 .next
19137 The Exim gid if the Exim uid is being used as a default.
19138 .endlist
19139
19140 If, for example, the user is specified numerically on the router and there are
19141 no group settings, no gid is available. In this situation, an error occurs.
19142 This is different for the uid, for which there always is an ultimate default.
19143 The first of the following that is set is used:
19144
19145 .ilist
19146 A &%user%& setting of the transport;
19147 .next
19148 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19149 .next
19150 A &%user%& setting of the router;
19151 .next
19152 A &%check_local_user%& setting of the router;
19153 .next
19154 The Exim uid.
19155 .endlist
19156
19157 Of course, an error will still occur if the uid that is chosen is on the
19158 &%never_users%& list.
19159
19160
19161
19162
19163
19164 .section "Current and home directories" "SECID132"
19165 .cindex "current directory for local transport"
19166 .cindex "home directory" "for local transport"
19167 .cindex "transport" "local; home directory for"
19168 .cindex "transport" "local; current directory for"
19169 Routers may set current and home directories for local transports by means of
19170 the &%transport_current_directory%& and &%transport_home_directory%& options.
19171 However, if the transport's &%current_directory%& or &%home_directory%& options
19172 are set, they override the router's values. In detail, the home directory
19173 for a local transport is taken from the first of these values that is set:
19174
19175 .ilist
19176 The &%home_directory%& option on the transport;
19177 .next
19178 The &%transport_home_directory%& option on the router;
19179 .next
19180 The password data if &%check_local_user%& is set on the router;
19181 .next
19182 The &%router_home_directory%& option on the router.
19183 .endlist
19184
19185 The current directory is taken from the first of these values that is set:
19186
19187 .ilist
19188 The &%current_directory%& option on the transport;
19189 .next
19190 The &%transport_current_directory%& option on the router.
19191 .endlist
19192
19193
19194 If neither the router nor the transport sets a current directory, Exim uses the
19195 value of the home directory, if it is set. Otherwise it sets the current
19196 directory to &_/_& before running a local transport.
19197
19198
19199
19200 .section "Expansion variables derived from the address" "SECID133"
19201 .vindex "&$domain$&"
19202 .vindex "&$local_part$&"
19203 .vindex "&$original_domain$&"
19204 Normally a local delivery is handling a single address, and in that case the
19205 variables such as &$domain$& and &$local_part$& are set during local
19206 deliveries. However, in some circumstances more than one address may be handled
19207 at once (for example, while writing batch SMTP for onward transmission by some
19208 other means). In this case, the variables associated with the local part are
19209 never set, &$domain$& is set only if all the addresses have the same domain,
19210 and &$original_domain$& is never set.
19211 .ecindex IIDenvlotra1
19212 .ecindex IIDenvlotra2
19213 .ecindex IIDenvlotra3
19214
19215
19216
19217
19218
19219
19220
19221 . ////////////////////////////////////////////////////////////////////////////
19222 . ////////////////////////////////////////////////////////////////////////////
19223
19224 .chapter "Generic options for transports" "CHAPtransportgeneric"
19225 .scindex IIDgenoptra1 "generic options" "transport"
19226 .scindex IIDgenoptra2 "options" "generic; for transports"
19227 .scindex IIDgenoptra3 "transport" "generic options for"
19228 The following generic options apply to all transports:
19229
19230
19231 .option body_only transports boolean false
19232 .cindex "transport" "body only"
19233 .cindex "message" "transporting body only"
19234 .cindex "body of message" "transporting"
19235 If this option is set, the message's headers are not transported. It is
19236 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19237 or &(pipe)& transports, the settings of &%message_prefix%& and
19238 &%message_suffix%& should be checked, because this option does not
19239 automatically suppress them.
19240
19241
19242 .option current_directory transports string&!! unset
19243 .cindex "transport" "current directory for"
19244 This specifies the current directory that is to be set while running the
19245 transport, overriding any value that may have been set by the router.
19246 If the expansion fails for any reason, including forced failure, an error is
19247 logged, and delivery is deferred.
19248
19249
19250 .option disable_logging transports boolean false
19251 If this option is set true, nothing is logged for any
19252 deliveries by the transport or for any
19253 transport errors. You should not set this option unless you really, really know
19254 what you are doing.
19255
19256
19257 .option debug_print transports string&!! unset
19258 .cindex "testing" "variables in drivers"
19259 If this option is set and debugging is enabled (see the &%-d%& command line
19260 option), the string is expanded and included in the debugging output when the
19261 transport is run.
19262 If expansion of the string fails, the error message is written to the debugging
19263 output, and Exim carries on processing.
19264 This facility is provided to help with checking out the values of variables and
19265 so on when debugging driver configurations. For example, if a &%headers_add%&
19266 option is not working properly, &%debug_print%& could be used to output the
19267 variables it references. A newline is added to the text if it does not end with
19268 one.
19269
19270
19271 .option delivery_date_add transports boolean false
19272 .cindex "&'Delivery-date:'& header line"
19273 If this option is true, a &'Delivery-date:'& header is added to the message.
19274 This gives the actual time the delivery was made. As this is not a standard
19275 header, Exim has a configuration option (&%delivery_date_remove%&) which
19276 requests its removal from incoming messages, so that delivered messages can
19277 safely be resent to other recipients.
19278
19279
19280 .option driver transports string unset
19281 This specifies which of the available transport drivers is to be used.
19282 There is no default, and this option must be set for every transport.
19283
19284
19285 .option envelope_to_add transports boolean false
19286 .cindex "&'Envelope-to:'& header line"
19287 If this option is true, an &'Envelope-to:'& header is added to the message.
19288 This gives the original address(es) in the incoming envelope that caused this
19289 delivery to happen. More than one address may be present if the transport is
19290 configured to handle several addresses at once, or if more than one original
19291 address was redirected to the same final address. As this is not a standard
19292 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19293 its removal from incoming messages, so that delivered messages can safely be
19294 resent to other recipients.
19295
19296
19297 .option group transports string&!! "Exim group"
19298 .cindex "transport" "group; specifying"
19299 This option specifies a gid for running the transport process, overriding any
19300 value that the router supplies, and also overriding any value associated with
19301 &%user%& (see below).
19302
19303
19304 .option headers_add transports string&!! unset
19305 .cindex "header lines" "adding in transport"
19306 .cindex "transport" "header lines; adding"
19307 This option specifies a string of text that is expanded and added to the header
19308 portion of a message as it is transported, as described in section
19309 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19310 routers. If the result of the expansion is an empty string, or if the expansion
19311 is forced to fail, no action is taken. Other expansion failures are treated as
19312 errors and cause the delivery to be deferred.
19313
19314
19315
19316 .option headers_only transports boolean false
19317 .cindex "transport" "header lines only"
19318 .cindex "message" "transporting headers only"
19319 .cindex "header lines" "transporting"
19320 If this option is set, the message's body is not transported. It is mutually
19321 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19322 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19323 checked, since this option does not automatically suppress them.
19324
19325
19326 .option headers_remove transports string&!! unset
19327 .cindex "header lines" "removing"
19328 .cindex "transport" "header lines; removing"
19329 This option specifies a string that is expanded into a list of header names;
19330 these headers are omitted from the message as it is transported, as described
19331 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19332 routers. If the result of the expansion is an empty string, or if the expansion
19333 is forced to fail, no action is taken. Other expansion failures are treated as
19334 errors and cause the delivery to be deferred.
19335
19336
19337
19338 .option headers_rewrite transports string unset
19339 .cindex "transport" "header lines; rewriting"
19340 .cindex "rewriting" "at transport time"
19341 This option allows addresses in header lines to be rewritten at transport time,
19342 that is, as the message is being copied to its destination. The contents of the
19343 option are a colon-separated list of rewriting rules. Each rule is in exactly
19344 the same form as one of the general rewriting rules that are applied when a
19345 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19346 example,
19347 .code
19348 headers_rewrite = a@b c@d f : \
19349                   x@y w@z
19350 .endd
19351 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19352 &'w@z'& in all address-bearing header lines. The rules are applied to the
19353 header lines just before they are written out at transport time, so they affect
19354 only those copies of the message that pass through the transport. However, only
19355 the message's original header lines, and any that were added by a system
19356 filter, are rewritten. If a router or transport adds header lines, they are not
19357 affected by this option. These rewriting rules are &'not'& applied to the
19358 envelope. You can change the return path using &%return_path%&, but you cannot
19359 change envelope recipients at this time.
19360
19361
19362 .option home_directory transports string&!! unset
19363 .cindex "transport" "home directory for"
19364 .vindex "&$home$&"
19365 This option specifies a home directory setting for a local transport,
19366 overriding any value that may be set by the router. The home directory is
19367 placed in &$home$& while expanding the transport's private options. It is also
19368 used as the current directory if no current directory is set by the
19369 &%current_directory%& option on the transport or the
19370 &%transport_current_directory%& option on the router. If the expansion fails
19371 for any reason, including forced failure, an error is logged, and delivery is
19372 deferred.
19373
19374
19375 .option initgroups transports boolean false
19376 .cindex "additional groups"
19377 .cindex "groups" "additional"
19378 .cindex "transport" "group; additional"
19379 If this option is true and the uid for the delivery process is provided by the
19380 transport, the &[initgroups()]& function is called when running the transport
19381 to ensure that any additional groups associated with the uid are set up.
19382
19383
19384 .option message_size_limit transports string&!! 0
19385 .cindex "limit" "message size per transport"
19386 .cindex "size" "of message, limit"
19387 .cindex "transport" "message size; limiting"
19388 This option controls the size of messages passed through the transport. It is
19389 expanded before use; the result of the expansion must be a sequence of decimal
19390 digits, optionally followed by K or M. If the expansion fails for any reason,
19391 including forced failure, or if the result is not of the required form,
19392 delivery is deferred. If the value is greater than zero and the size of a
19393 message exceeds this limit, the address is failed. If there is any chance that
19394 the resulting bounce message could be routed to the same transport, you should
19395 ensure that &%return_size_limit%& is less than the transport's
19396 &%message_size_limit%&, as otherwise the bounce message will fail to get
19397 delivered.
19398
19399
19400
19401 .option rcpt_include_affixes transports boolean false
19402 .cindex "prefix" "for local part, including in envelope"
19403 .cindex "suffix for local part" "including in envelope"
19404 .cindex "local part" "prefix"
19405 .cindex "local part" "suffix"
19406 When this option is false (the default), and an address that has had any
19407 affixes (prefixes or suffixes) removed from the local part is delivered by any
19408 form of SMTP or LMTP, the affixes are not included. For example, if a router
19409 that contains
19410 .code
19411 local_part_prefix = *-
19412 .endd
19413 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19414 is delivered with
19415 .code
19416 RCPT TO:<xyz@some.domain>
19417 .endd
19418 This is also the case when an ACL-time callout is being used to verify a
19419 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19420 whole local part is included in the RCPT command. This option applies to BSMTP
19421 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19422 &(lmtp)& and &(smtp)& transports.
19423
19424
19425 .option retry_use_local_part transports boolean "see below"
19426 .cindex "hints database" "retry keys"
19427 When a delivery suffers a temporary failure, a retry record is created
19428 in Exim's hints database. For remote deliveries, the key for the retry record
19429 is based on the name and/or IP address of the failing remote host. For local
19430 deliveries, the key is normally the entire address, including both the local
19431 part and the domain. This is suitable for most common cases of local delivery
19432 temporary failure &-- for example, exceeding a mailbox quota should delay only
19433 deliveries to that mailbox, not to the whole domain.
19434
19435 However, in some special cases you may want to treat a temporary local delivery
19436 as a failure associated with the domain, and not with a particular local part.
19437 (For example, if you are storing all mail for some domain in files.) You can do
19438 this by setting &%retry_use_local_part%& false.
19439
19440 For all the local transports, its default value is true. For remote transports,
19441 the default value is false for tidiness, but changing the value has no effect
19442 on a remote transport in the current implementation.
19443
19444
19445 .option return_path transports string&!! unset
19446 .cindex "envelope sender"
19447 .cindex "transport" "return path; changing"
19448 .cindex "return path" "changing in transport"
19449 If this option is set, the string is expanded at transport time and replaces
19450 the existing return path (envelope sender) value in the copy of the message
19451 that is being delivered. An empty return path is permitted. This feature is
19452 designed for remote deliveries, where the value of this option is used in the
19453 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19454 only effect is to change the address that is placed in the &'Return-path:'&
19455 header line, if one is added to the message (see the next option).
19456
19457 &*Note:*& A changed return path is not logged unless you add
19458 &%return_path_on_delivery%& to the log selector.
19459
19460 .vindex "&$return_path$&"
19461 The expansion can refer to the existing value via &$return_path$&. This is
19462 either the message's envelope sender, or an address set by the
19463 &%errors_to%& option on a router. If the expansion is forced to fail, no
19464 replacement occurs; if it fails for another reason, delivery is deferred. This
19465 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19466 section &<<SECTverp>>&.
19467
19468 &*Note*&: If a delivery error is detected locally, including the case when a
19469 remote server rejects a message at SMTP time, the bounce message is not sent to
19470 the value of this option. It is sent to the previously set errors address.
19471 This defaults to the incoming sender address, but can be changed by setting
19472 &%errors_to%& in a router.
19473
19474
19475
19476 .option return_path_add transports boolean false
19477 .cindex "&'Return-path:'& header line"
19478 If this option is true, a &'Return-path:'& header is added to the message.
19479 Although the return path is normally available in the prefix line of BSD
19480 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19481 have easy access to it.
19482
19483 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19484 the delivery SMTP server makes the final delivery"&. This implies that this
19485 header should not be present in incoming messages. Exim has a configuration
19486 option, &%return_path_remove%&, which requests removal of this header from
19487 incoming messages, so that delivered messages can safely be resent to other
19488 recipients.
19489
19490
19491 .option shadow_condition transports string&!! unset
19492 See &%shadow_transport%& below.
19493
19494
19495 .option shadow_transport transports string unset
19496 .cindex "shadow transport"
19497 .cindex "transport" "shadow"
19498 A local transport may set the &%shadow_transport%& option to the name of
19499 another local transport. Shadow remote transports are not supported.
19500
19501 Whenever a delivery to the main transport succeeds, and either
19502 &%shadow_condition%& is unset, or its expansion does not result in the empty
19503 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19504 passed to the shadow transport, with the same delivery address or addresses. If
19505 expansion fails, no action is taken except that non-forced expansion failures
19506 cause a log line to be written.
19507
19508 The result of the shadow transport is discarded and does not affect the
19509 subsequent processing of the message. Only a single level of shadowing is
19510 provided; the &%shadow_transport%& option is ignored on any transport when it
19511 is running as a shadow. Options concerned with output from pipes are also
19512 ignored. The log line for the successful delivery has an item added on the end,
19513 of the form
19514 .code
19515 ST=<shadow transport name>
19516 .endd
19517 If the shadow transport did not succeed, the error message is put in
19518 parentheses afterwards. Shadow transports can be used for a number of different
19519 purposes, including keeping more detailed log information than Exim normally
19520 provides, and implementing automatic acknowledgment policies based on message
19521 headers that some sites insist on.
19522
19523
19524 .option transport_filter transports string&!! unset
19525 .cindex "transport" "filter"
19526 .cindex "filter" "transport filter"
19527 This option sets up a filtering (in the Unix shell sense) process for messages
19528 at transport time. It should not be confused with mail filtering as set up by
19529 individual users or via a system filter.
19530
19531 When the message is about to be written out, the command specified by
19532 &%transport_filter%& is started up in a separate, parallel process, and
19533 the entire message, including the header lines, is passed to it on its standard
19534 input (this in fact is done from a third process, to avoid deadlock). The
19535 command must be specified as an absolute path.
19536
19537 The lines of the message that are written to the transport filter are
19538 terminated by newline (&"\n"&). The message is passed to the filter before any
19539 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19540 lines beginning with a dot, and also before any processing implied by the
19541 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19542 &(pipe)& transports.
19543
19544 The standard error for the filter process is set to the same destination as its
19545 standard output; this is read and written to the message's ultimate
19546 destination. The process that writes the message to the filter, the
19547 filter itself, and the original process that reads the result and delivers it
19548 are all run in parallel, like a shell pipeline.
19549
19550 The filter can perform any transformations it likes, but of course should take
19551 care not to break RFC 2822 syntax. Exim does not check the result, except to
19552 test for a final newline when SMTP is in use. All messages transmitted over
19553 SMTP must end with a newline, so Exim supplies one if it is missing.
19554
19555 .cindex "content scanning" "per user"
19556 A transport filter can be used to provide content-scanning on a per-user basis
19557 at delivery time if the only required effect of the scan is to modify the
19558 message. For example, a content scan could insert a new header line containing
19559 a spam score. This could be interpreted by a filter in the user's MUA. It is
19560 not possible to discard a message at this stage.
19561
19562 .cindex "SMTP" "SIZE"
19563 A problem might arise if the filter increases the size of a message that is
19564 being sent down an SMTP connection. If the receiving SMTP server has indicated
19565 support for the SIZE parameter, Exim will have sent the size of the message
19566 at the start of the SMTP session. If what is actually sent is substantially
19567 more, the server might reject the message. This can be worked round by setting
19568 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19569 additions to the message, or to disable the use of SIZE altogether.
19570
19571 .vindex "&$pipe_addresses$&"
19572 The value of the &%transport_filter%& option is the command string for starting
19573 the filter, which is run directly from Exim, not under a shell. The string is
19574 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19575 Exim breaks it up into arguments and then expands each argument separately (see
19576 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19577 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19578 of arguments, one for each address that applies to this delivery. (This isn't
19579 an ideal name for this feature here, but as it was already implemented for the
19580 &(pipe)& transport, it seemed sensible not to change it.)
19581
19582 .vindex "&$host$&"
19583 .vindex "&$host_address$&"
19584 The expansion variables &$host$& and &$host_address$& are available when the
19585 transport is a remote one. They contain the name and IP address of the host to
19586 which the message is being sent. For example:
19587 .code
19588 transport_filter = /some/directory/transport-filter.pl \
19589   $host $host_address $sender_address $pipe_addresses
19590 .endd
19591
19592 Two problems arise if you want to use more complicated expansion items to
19593 generate transport filter commands, both of which due to the fact that the
19594 command is split up &'before'& expansion.
19595 .ilist
19596 If an expansion item contains white space, you must quote it, so that it is all
19597 part of the same command item. If the entire option setting is one such
19598 expansion item, you have to take care what kind of quoting you use. For
19599 example:
19600 .code
19601 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19602 .endd
19603 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19604 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19605 stripped by Exim when it read the option's value. When the value is used, if
19606 the single quotes were missing, the line would be split into two items,
19607 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19608 Exim tried to expand the first one.
19609 .next
19610 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19611 expansion cannot generate multiple arguments, or a command name followed by
19612 arguments. Consider this example:
19613 .code
19614 transport_filter = ${lookup{$host}lsearch{/a/file}\
19615                     {$value}{/bin/cat}}
19616 .endd
19617 The result of the lookup is interpreted as the name of the command, even
19618 if it contains white space. The simplest way round this is to use a shell:
19619 .code
19620 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19621                                {$value}{/bin/cat}}
19622 .endd
19623 .endlist
19624
19625 The filter process is run under the same uid and gid as the normal delivery.
19626 For remote deliveries this is the Exim uid/gid by default. The command should
19627 normally yield a zero return code. Transport filters are not supposed to fail.
19628 A non-zero code is taken to mean that the transport filter encountered some
19629 serious problem. Delivery of the message is deferred; the message remains on
19630 the queue and is tried again later. It is not possible to cause a message to be
19631 bounced from a transport filter.
19632
19633 If a transport filter is set on an autoreply transport, the original message is
19634 passed through the filter as it is being copied into the newly generated
19635 message, which happens if the &%return_message%& option is set.
19636
19637
19638 .option transport_filter_timeout transports time 5m
19639 .cindex "transport" "filter, timeout"
19640 When Exim is reading the output of a transport filter, it a applies a timeout
19641 that can be set by this option. Exceeding the timeout is normally treated as a
19642 temporary delivery failure. However, if a transport filter is used with a
19643 &(pipe)& transport, a timeout in the transport filter is treated in the same
19644 way as a timeout in the pipe command itself. By default, a timeout is a hard
19645 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19646 becomes a temporary error.
19647
19648
19649 .option user transports string&!! "Exim user"
19650 .cindex "uid (user id)" "local delivery"
19651 .cindex "transport" "user, specifying"
19652 This option specifies the user under whose uid the delivery process is to be
19653 run, overriding any uid that may have been set by the router. If the user is
19654 given as a name, the uid is looked up from the password data, and the
19655 associated group is taken as the value of the gid to be used if the &%group%&
19656 option is not set.
19657
19658 For deliveries that use local transports, a user and group are normally
19659 specified explicitly or implicitly (for example, as a result of
19660 &%check_local_user%&) by the router or transport.
19661
19662 .cindex "hints database" "access by remote transport"
19663 For remote transports, you should leave this option unset unless you really are
19664 sure you know what you are doing. When a remote transport is running, it needs
19665 to be able to access Exim's hints databases, because each host may have its own
19666 retry data.
19667 .ecindex IIDgenoptra1
19668 .ecindex IIDgenoptra2
19669 .ecindex IIDgenoptra3
19670
19671
19672
19673
19674
19675
19676 . ////////////////////////////////////////////////////////////////////////////
19677 . ////////////////////////////////////////////////////////////////////////////
19678
19679 .chapter "Address batching in local transports" "CHAPbatching" &&&
19680          "Address batching"
19681 .cindex "transport" "local; address batching in"
19682 The only remote transport (&(smtp)&) is normally configured to handle more than
19683 one address at a time, so that when several addresses are routed to the same
19684 remote host, just one copy of the message is sent. Local transports, however,
19685 normally handle one address at a time. That is, a separate instance of the
19686 transport is run for each address that is routed to the transport. A separate
19687 copy of the message is delivered each time.
19688
19689 .cindex "batched local delivery"
19690 .oindex "&%batch_max%&"
19691 .oindex "&%batch_id%&"
19692 In special cases, it may be desirable to handle several addresses at once in a
19693 local transport, for example:
19694
19695 .ilist
19696 In an &(appendfile)& transport, when storing messages in files for later
19697 delivery by some other means, a single copy of the message with multiple
19698 recipients saves space.
19699 .next
19700 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19701 a single copy saves time, and is the normal way LMTP is expected to work.
19702 .next
19703 In a &(pipe)& transport, when passing the message
19704 to a scanner program or
19705 to some other delivery mechanism such as UUCP, multiple recipients may be
19706 acceptable.
19707 .endlist
19708
19709 These three local transports all have the same options for controlling multiple
19710 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19711 repeating the information for each transport, these options are described here.
19712
19713 The &%batch_max%& option specifies the maximum number of addresses that can be
19714 delivered together in a single run of the transport. Its default value is one
19715 (no batching). When more than one address is routed to a transport that has a
19716 &%batch_max%& value greater than one, the addresses are delivered in a batch
19717 (that is, in a single run of the transport with multiple recipients), subject
19718 to certain conditions:
19719
19720 .ilist
19721 .vindex "&$local_part$&"
19722 If any of the transport's options contain a reference to &$local_part$&, no
19723 batching is possible.
19724 .next
19725 .vindex "&$domain$&"
19726 If any of the transport's options contain a reference to &$domain$&, only
19727 addresses with the same domain are batched.
19728 .next
19729 .cindex "customizing" "batching condition"
19730 If &%batch_id%& is set, it is expanded for each address, and only those
19731 addresses with the same expanded value are batched. This allows you to specify
19732 customized batching conditions. Failure of the expansion for any reason,
19733 including forced failure, disables batching, but it does not stop the delivery
19734 from taking place.
19735 .next
19736 Batched addresses must also have the same errors address (where to send
19737 delivery errors), the same header additions and removals, the same user and
19738 group for the transport, and if a host list is present, the first host must
19739 be the same.
19740 .endlist
19741
19742 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19743 both when the file or pipe command is specified in the transport, and when it
19744 is specified by a &(redirect)& router, but all the batched addresses must of
19745 course be routed to the same file or pipe command. These two transports have an
19746 option called &%use_bsmtp%&, which causes them to deliver the message in
19747 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19748 &%check_string%& and &%escape_string%& options are forced to the values
19749 .code
19750 check_string = "."
19751 escape_string = ".."
19752 .endd
19753 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19754 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19755 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19756
19757 .cindex "&'Envelope-to:'& header line"
19758 If the generic &%envelope_to_add%& option is set for a batching transport, the
19759 &'Envelope-to:'& header that is added to the message contains all the addresses
19760 that are being processed together. If you are using a batching &(appendfile)&
19761 transport without &%use_bsmtp%&, the only way to preserve the recipient
19762 addresses is to set the &%envelope_to_add%& option.
19763
19764 .cindex "&(pipe)& transport" "with multiple addresses"
19765 .vindex "&$pipe_addresses$&"
19766 If you are using a &(pipe)& transport without BSMTP, and setting the
19767 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19768 the command. This is not a true variable; it is a bit of magic that causes each
19769 of the recipient addresses to be inserted into the command as a separate
19770 argument. This provides a way of accessing all the addresses that are being
19771 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19772 are specified by a &(redirect)& router.
19773
19774
19775
19776
19777 . ////////////////////////////////////////////////////////////////////////////
19778 . ////////////////////////////////////////////////////////////////////////////
19779
19780 .chapter "The appendfile transport" "CHAPappendfile"
19781 .scindex IIDapptra1 "&(appendfile)& transport"
19782 .scindex IIDapptra2 "transports" "&(appendfile)&"
19783 .cindex "directory creation"
19784 .cindex "creating directories"
19785 The &(appendfile)& transport delivers a message by appending it to an existing
19786 file, or by creating an entirely new file in a specified directory. Single
19787 files to which messages are appended can be in the traditional Unix mailbox
19788 format, or optionally in the MBX format supported by the Pine MUA and
19789 University of Washington IMAP daemon, &'inter alia'&. When each message is
19790 being delivered as a separate file, &"maildir"& format can optionally be used
19791 to give added protection against failures that happen part-way through the
19792 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19793 supported. For all file formats, Exim attempts to create as many levels of
19794 directory as necessary, provided that &%create_directory%& is set.
19795
19796 The code for the optional formats is not included in the Exim binary by
19797 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19798 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19799 included.
19800
19801 .cindex "quota" "system"
19802 Exim recognizes system quota errors, and generates an appropriate message. Exim
19803 also supports its own quota control within the transport, for use when the
19804 system facility is unavailable or cannot be used for some reason.
19805
19806 If there is an error while appending to a file (for example, quota exceeded or
19807 partition filled), Exim attempts to reset the file's length and last
19808 modification time back to what they were before. If there is an error while
19809 creating an entirely new file, the new file is removed.
19810
19811 Before appending to a file, a number of security checks are made, and the
19812 file is locked. A detailed description is given below, after the list of
19813 private options.
19814
19815 The &(appendfile)& transport is most commonly used for local deliveries to
19816 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19817 putting messages into files for remote delivery by some means other than Exim.
19818 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19819 option).
19820
19821
19822
19823 .section "The file and directory options" "SECTfildiropt"
19824 The &%file%& option specifies a single file, to which the message is appended;
19825 the &%directory%& option specifies a directory, in which a new file containing
19826 the message is created. Only one of these two options can be set, and for
19827 normal deliveries to mailboxes, one of them &'must'& be set.
19828
19829 .vindex "&$address_file$&"
19830 .vindex "&$local_part$&"
19831 However, &(appendfile)& is also used for delivering messages to files or
19832 directories whose names (or parts of names) are obtained from alias,
19833 forwarding, or filtering operations (for example, a &%save%& command in a
19834 user's Exim filter). When such a transport is running, &$local_part$& contains
19835 the local part that was aliased or forwarded, and &$address_file$& contains the
19836 name (or partial name) of the file or directory generated by the redirection
19837 operation. There are two cases:
19838
19839 .ilist
19840 If neither &%file%& nor &%directory%& is set, the redirection operation
19841 must specify an absolute path (one that begins with &`/`&). This is the most
19842 common case when users with local accounts use filtering to sort mail into
19843 different folders. See for example, the &(address_file)& transport in the
19844 default configuration. If the path ends with a slash, it is assumed to be the
19845 name of a directory. A delivery to a directory can also be forced by setting
19846 &%maildir_format%& or &%mailstore_format%&.
19847 .next
19848 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19849 used to determine the file or directory name for the delivery. Normally, the
19850 contents of &$address_file$& are used in some way in the string expansion.
19851 .endlist
19852
19853
19854 .cindex "Sieve filter" "configuring &(appendfile)&"
19855 .cindex "Sieve filter" "relative mailbox path handling"
19856 As an example of the second case, consider an environment where users do not
19857 have home directories. They may be permitted to use Exim filter commands of the
19858 form:
19859 .code
19860 save folder23
19861 .endd
19862 or Sieve filter commands of the form:
19863 .code
19864 require "fileinto";
19865 fileinto "folder23";
19866 .endd
19867 In this situation, the expansion of &%file%& or &%directory%& in the transport
19868 must transform the relative path into an appropriate absolute file name. In the
19869 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19870 is used as a result of a &"keep"& action in the filter. This example shows one
19871 way of handling this requirement:
19872 .code
19873 file = ${if eq{$address_file}{inbox} \
19874             {/var/mail/$local_part} \
19875             {${if eq{${substr_0_1:$address_file}}{/} \
19876                   {$address_file} \
19877                   {$home/mail/$address_file} \
19878             }} \
19879        }
19880 .endd
19881 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19882 location, absolute paths are used without change, and other folders are in the
19883 &_mail_& directory within the home directory.
19884
19885 &*Note 1*&: While processing an Exim filter, a relative path such as
19886 &_folder23_& is turned into an absolute path if a home directory is known to
19887 the router. In particular, this is the case if &%check_local_user%& is set. If
19888 you want to prevent this happening at routing time, you can set
19889 &%router_home_directory%& empty. This forces the router to pass the relative
19890 path to the transport.
19891
19892 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19893 the &%file%& or &%directory%& option is still used if it is set.
19894
19895
19896
19897
19898 .section "Private options for appendfile" "SECID134"
19899 .cindex "options" "&(appendfile)& transport"
19900
19901
19902
19903 .option allow_fifo appendfile boolean false
19904 .cindex "fifo (named pipe)"
19905 .cindex "named pipe (fifo)"
19906 .cindex "pipe" "named (fifo)"
19907 Setting this option permits delivery to named pipes (FIFOs) as well as to
19908 regular files. If no process is reading the named pipe at delivery time, the
19909 delivery is deferred.
19910
19911
19912 .option allow_symlink appendfile boolean false
19913 .cindex "symbolic link" "to mailbox"
19914 .cindex "mailbox" "symbolic link"
19915 By default, &(appendfile)& will not deliver if the path name for the file is
19916 that of a symbolic link. Setting this option relaxes that constraint, but there
19917 are security issues involved in the use of symbolic links. Be sure you know
19918 what you are doing if you set this. Details of exactly what this option affects
19919 are included in the discussion which follows this list of options.
19920
19921
19922 .option batch_id appendfile string&!! unset
19923 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19924 However, batching is automatically disabled for &(appendfile)& deliveries that
19925 happen as a result of forwarding or aliasing or other redirection directly to a
19926 file.
19927
19928
19929 .option batch_max appendfile integer 1
19930 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19931
19932
19933 .option check_group appendfile boolean false
19934 When this option is set, the group owner of the file defined by the &%file%&
19935 option is checked to see that it is the same as the group under which the
19936 delivery process is running. The default setting is false because the default
19937 file mode is 0600, which means that the group is irrelevant.
19938
19939
19940 .option check_owner appendfile boolean true
19941 When this option is set, the owner of the file defined by the &%file%& option
19942 is checked to ensure that it is the same as the user under which the delivery
19943 process is running.
19944
19945
19946 .option check_string appendfile string "see below"
19947 .cindex "&""From""& line"
19948 As &(appendfile)& writes the message, the start of each line is tested for
19949 matching &%check_string%&, and if it does, the initial matching characters are
19950 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19951 a literal string, not a regular expression, and the case of any letters it
19952 contains is significant.
19953
19954 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19955 are forced to &"."& and &".."& respectively, and any settings in the
19956 configuration are ignored. Otherwise, they default to &"From&~"& and
19957 &">From&~"& when the &%file%& option is set, and unset when any of the
19958 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19959
19960 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19961 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19962 &"From&~"& indicates the start of a new message. All four options need changing
19963 if another format is used. For example, to deliver to mailboxes in MMDF format:
19964 .cindex "MMDF format mailbox"
19965 .cindex "mailbox" "MMDF format"
19966 .code
19967 check_string = "\1\1\1\1\n"
19968 escape_string = "\1\1\1\1 \n"
19969 message_prefix = "\1\1\1\1\n"
19970 message_suffix = "\1\1\1\1\n"
19971 .endd
19972 .option create_directory appendfile boolean true
19973 .cindex "directory creation"
19974 When this option is true, Exim attempts to create any missing superior
19975 directories for the file that it is about to write. A created directory's mode
19976 is given by the &%directory_mode%& option.
19977
19978 The group ownership of a newly created directory is highly dependent on the
19979 operating system (and possibly the file system) that is being used. For
19980 example, in Solaris, if the parent directory has the setgid bit set, its group
19981 is propagated to the child; if not, the currently set group is used. However,
19982 in FreeBSD, the parent's group is always used.
19983
19984
19985
19986 .option create_file appendfile string anywhere
19987 This option constrains the location of files and directories that are created
19988 by this transport. It applies to files defined by the &%file%& option and
19989 directories defined by the &%directory%& option. In the case of maildir
19990 delivery, it applies to the top level directory, not the maildir directories
19991 beneath.
19992
19993 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19994 &"belowhome"&. In the second and third cases, a home directory must have been
19995 set for the transport. This option is not useful when an explicit file name is
19996 given for normal mailbox deliveries. It is intended for the case when file
19997 names are generated from users' &_.forward_& files. These are usually handled
19998 by an &(appendfile)& transport called &%address_file%&. See also
19999 &%file_must_exist%&.
20000
20001
20002 .option directory appendfile string&!! unset
20003 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20004 or &%directory%& must be set, unless the delivery is the direct result of a
20005 redirection (see section &<<SECTfildiropt>>&).
20006
20007 When &%directory%& is set, the string is expanded, and the message is delivered
20008 into a new file or files in or below the given directory, instead of being
20009 appended to a single mailbox file. A number of different formats are provided
20010 (see &%maildir_format%& and &%mailstore_format%&), and see section
20011 &<<SECTopdir>>& for further details of this form of delivery.
20012
20013
20014 .option directory_file appendfile string&!! "see below"
20015 .cindex "base62"
20016 .vindex "&$inode$&"
20017 When &%directory%& is set, but neither &%maildir_format%& nor
20018 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20019 whose name is obtained by expanding this string. The default value is:
20020 .code
20021 q${base62:$tod_epoch}-$inode
20022 .endd
20023 This generates a unique name from the current time, in base 62 form, and the
20024 inode of the file. The variable &$inode$& is available only when expanding this
20025 option.
20026
20027
20028 .option directory_mode appendfile "octal integer" 0700
20029 If &(appendfile)& creates any directories as a result of the
20030 &%create_directory%& option, their mode is specified by this option.
20031
20032
20033 .option escape_string appendfile string "see description"
20034 See &%check_string%& above.
20035
20036
20037 .option file appendfile string&!! unset
20038 This option is mutually exclusive with the &%directory%& option, but one of
20039 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20040 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20041 specifies a single file, to which the message is appended. One or more of
20042 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20043 &%file%&.
20044
20045 .cindex "NFS" "lock file"
20046 .cindex "locking files"
20047 .cindex "lock files"
20048 If you are using more than one host to deliver over NFS into the same
20049 mailboxes, you should always use lock files.
20050
20051 The string value is expanded for each delivery, and must yield an absolute
20052 path. The most common settings of this option are variations on one of these
20053 examples:
20054 .code
20055 file = /var/spool/mail/$local_part
20056 file = /home/$local_part/inbox
20057 file = $home/inbox
20058 .endd
20059 .cindex "&""sticky""& bit"
20060 In the first example, all deliveries are done into the same directory. If Exim
20061 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20062 create a file in the directory, so the &"sticky"& bit must be turned on for
20063 deliveries to be possible, or alternatively the &%group%& option can be used to
20064 run the delivery under a group id which has write access to the directory.
20065
20066
20067
20068 .option file_format appendfile string unset
20069 .cindex "file" "mailbox; checking existing format"
20070 This option requests the transport to check the format of an existing file
20071 before adding to it. The check consists of matching a specific string at the
20072 start of the file. The value of the option consists of an even number of
20073 colon-separated strings. The first of each pair is the test string, and the
20074 second is the name of a transport. If the transport associated with a matched
20075 string is not the current transport, control is passed over to the other
20076 transport. For example, suppose the standard &(local_delivery)& transport has
20077 this added to it:
20078 .code
20079 file_format = "From       : local_delivery :\
20080                \1\1\1\1\n : local_mmdf_delivery"
20081 .endd
20082 Mailboxes that begin with &"From"& are still handled by this transport, but if
20083 a mailbox begins with four binary ones followed by a newline, control is passed
20084 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20085 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20086 is assumed to match the current transport. If the start of a mailbox doesn't
20087 match any string, or if the transport named for a given string is not defined,
20088 delivery is deferred.
20089
20090
20091 .option file_must_exist appendfile boolean false
20092 If this option is true, the file specified by the &%file%& option must exist.
20093 A temporary error occurs if it does not, causing delivery to be deferred.
20094 If this option is false, the file is created if it does not exist.
20095
20096
20097 .option lock_fcntl_timeout appendfile time 0s
20098 .cindex "timeout" "mailbox locking"
20099 .cindex "mailbox" "locking, blocking and non-blocking"
20100 .cindex "locking files"
20101 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20102 when locking an open mailbox file. If the call fails, the delivery process
20103 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20104 Non-blocking calls are used so that the file is not kept open during the wait
20105 for the lock; the reason for this is to make it as safe as possible for
20106 deliveries over NFS in the case when processes might be accessing an NFS
20107 mailbox without using a lock file. This should not be done, but
20108 misunderstandings and hence misconfigurations are not unknown.
20109
20110 On a busy system, however, the performance of a non-blocking lock approach is
20111 not as good as using a blocking lock with a timeout. In this case, the waiting
20112 is done inside the system call, and Exim's delivery process acquires the lock
20113 and can proceed as soon as the previous lock holder releases it.
20114
20115 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20116 timeout, are used. There may still be some retrying: the maximum number of
20117 retries is
20118 .code
20119 (lock_retries * lock_interval) / lock_fcntl_timeout
20120 .endd
20121 rounded up to the next whole number. In other words, the total time during
20122 which &(appendfile)& is trying to get a lock is roughly the same, unless
20123 &%lock_fcntl_timeout%& is set very large.
20124
20125 You should consider setting this option if you are getting a lot of delayed
20126 local deliveries because of errors of the form
20127 .code
20128 failed to lock mailbox /some/file (fcntl)
20129 .endd
20130
20131 .option lock_flock_timeout appendfile time 0s
20132 This timeout applies to file locking when using &[flock()]& (see
20133 &%use_flock%&); the timeout operates in a similar manner to
20134 &%lock_fcntl_timeout%&.
20135
20136
20137 .option lock_interval appendfile time 3s
20138 This specifies the time to wait between attempts to lock the file. See below
20139 for details of locking.
20140
20141
20142 .option lock_retries appendfile integer 10
20143 This specifies the maximum number of attempts to lock the file. A value of zero
20144 is treated as 1. See below for details of locking.
20145
20146
20147 .option lockfile_mode appendfile "octal integer" 0600
20148 This specifies the mode of the created lock file, when a lock file is being
20149 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20150
20151
20152 .option lockfile_timeout appendfile time 30m
20153 .cindex "timeout" "mailbox locking"
20154 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20155 exists and is older than this value, it is assumed to have been left behind by
20156 accident, and Exim attempts to remove it.
20157
20158
20159 .option mailbox_filecount appendfile string&!! unset
20160 .cindex "mailbox" "specifying size of"
20161 .cindex "size" "of mailbox"
20162 If this option is set, it is expanded, and the result is taken as the current
20163 number of files in the mailbox. It must be a decimal number, optionally
20164 followed by K or M. This provides a way of obtaining this information from an
20165 external source that maintains the data.
20166
20167
20168 .option mailbox_size appendfile string&!! unset
20169 .cindex "mailbox" "specifying size of"
20170 .cindex "size" "of mailbox"
20171 If this option is set, it is expanded, and the result is taken as the current
20172 size the mailbox. It must be a decimal number, optionally followed by K or M.
20173 This provides a way of obtaining this information from an external source that
20174 maintains the data. This is likely to be helpful for maildir deliveries where
20175 it is computationally expensive to compute the size of a mailbox.
20176
20177
20178
20179 .option maildir_format appendfile boolean false
20180 .cindex "maildir format" "specifying"
20181 If this option is set with the &%directory%& option, the delivery is into a new
20182 file, in the &"maildir"& format that is used by other mail software. When the
20183 transport is activated directly from a &(redirect)& router (for example, the
20184 &(address_file)& transport in the default configuration), setting
20185 &%maildir_format%& causes the path received from the router to be treated as a
20186 directory, whether or not it ends with &`/`&. This option is available only if
20187 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20188 &<<SECTmaildirdelivery>>& below for further details.
20189
20190
20191 .option maildir_quota_directory_regex appendfile string "See below"
20192 .cindex "maildir format" "quota; directories included in"
20193 .cindex "quota" "maildir; directories included in"
20194 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20195 a regular expression for specifying directories, relative to the quota
20196 directory (see &%quota_directory%&), that should be included in the quota
20197 calculation. The default value is:
20198 .code
20199 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20200 .endd
20201 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20202 (directories whose names begin with a dot). If you want to exclude the
20203 &_Trash_&
20204 folder from the count (as some sites do), you need to change this setting to
20205 .code
20206 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20207 .endd
20208 This uses a negative lookahead in the regular expression to exclude the
20209 directory whose name is &_.Trash_&. When a directory is excluded from quota
20210 calculations, quota processing is bypassed for any messages that are delivered
20211 directly into that directory.
20212
20213
20214 .option maildir_retries appendfile integer 10
20215 This option specifies the number of times to retry when writing a file in
20216 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20217
20218
20219 .option maildir_tag appendfile string&!! unset
20220 This option applies only to deliveries in maildir format, and is described in
20221 section &<<SECTmaildirdelivery>>& below.
20222
20223
20224 .new
20225 .option maildir_use_size_file appendfile&!! boolean false
20226 .cindex "maildir format" "&_maildirsize_& file"
20227 The result of string expansion for this option must be a valid boolean value.
20228 If it is true, it enables support for &_maildirsize_& files. Exim
20229 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20230 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20231 value is zero. See &%maildir_quota_directory_regex%& above and section
20232 &<<SECTmaildirdelivery>>& below for further details.
20233 .wen
20234
20235 .option maildirfolder_create_regex appendfile string unset
20236 .cindex "maildir format" "&_maildirfolder_& file"
20237 .cindex "&_maildirfolder_&, creating"
20238 The value of this option is a regular expression. If it is unset, it has no
20239 effect. Otherwise, before a maildir delivery takes place, the pattern is
20240 matched against the name of the maildir directory, that is, the directory
20241 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20242 delivery. If there is a match, Exim checks for the existence of a file called
20243 &_maildirfolder_& in the directory, and creates it if it does not exist.
20244 See section &<<SECTmaildirdelivery>>& for more details.
20245
20246
20247 .option mailstore_format appendfile boolean false
20248 .cindex "mailstore format" "specifying"
20249 If this option is set with the &%directory%& option, the delivery is into two
20250 new files in  &"mailstore"& format. The option is available only if
20251 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20252 below for further details.
20253
20254
20255 .option mailstore_prefix appendfile string&!! unset
20256 This option applies only to deliveries in mailstore format, and is described in
20257 section &<<SECTopdir>>& below.
20258
20259
20260 .option mailstore_suffix appendfile string&!! unset
20261 This option applies only to deliveries in mailstore format, and is described in
20262 section &<<SECTopdir>>& below.
20263
20264
20265 .option mbx_format appendfile boolean false
20266 .cindex "locking files"
20267 .cindex "file" "locking"
20268 .cindex "file" "MBX format"
20269 .cindex "MBX format, specifying"
20270 This option is available only if Exim has been compiled with SUPPORT_MBX
20271 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20272 the message is appended to the mailbox file in MBX format instead of
20273 traditional Unix format. This format is supported by Pine4 and its associated
20274 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20275
20276 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20277 automatically changed by the use of &%mbx_format%&. They should normally be set
20278 empty when using MBX format, so this option almost always appears in this
20279 combination:
20280 .code
20281 mbx_format = true
20282 message_prefix =
20283 message_suffix =
20284 .endd
20285 If none of the locking options are mentioned in the configuration,
20286 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20287 is possible to specify the other kinds of locking with &%mbx_format%&, but
20288 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20289 interworks with &'c-client'&, providing for shared access to the mailbox. It
20290 should not be used if any program that does not use this form of locking is
20291 going to access the mailbox, nor should it be used if the mailbox file is NFS
20292 mounted, because it works only when the mailbox is accessed from a single host.
20293
20294 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20295 the standard version of &'c-client'&, because as long as it has a mailbox open
20296 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20297 append messages to it.
20298
20299
20300 .option message_prefix appendfile string&!! "see below"
20301 .cindex "&""From""& line"
20302 The string specified here is expanded and output at the start of every message.
20303 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20304 in which case it is:
20305 .code
20306 message_prefix = "From ${if def:return_path{$return_path}\
20307   {MAILER-DAEMON}} $tod_bsdinbox\n"
20308 .endd
20309 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20310 &`\n`& to &`\r\n`& in &%message_prefix%&.
20311
20312 .option message_suffix appendfile string&!! "see below"
20313 The string specified here is expanded and output at the end of every message.
20314 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20315 in which case it is a single newline character. The suffix can be suppressed by
20316 setting
20317 .code
20318 message_suffix =
20319 .endd
20320 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20321 &`\n`& to &`\r\n`& in &%message_suffix%&.
20322
20323 .option mode appendfile "octal integer" 0600
20324 If the output file is created, it is given this mode. If it already exists and
20325 has wider permissions, they are reduced to this mode. If it has narrower
20326 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20327 if the delivery is the result of a &%save%& command in a filter file specifying
20328 a particular mode, the mode of the output file is always forced to take that
20329 value, and this option is ignored.
20330
20331
20332 .option mode_fail_narrower appendfile boolean true
20333 This option applies in the case when an existing mailbox file has a narrower
20334 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20335 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20336 continues with the delivery attempt, using the existing mode of the file.
20337
20338
20339 .option notify_comsat appendfile boolean false
20340 If this option is true, the &'comsat'& daemon is notified after every
20341 successful delivery to a user mailbox. This is the daemon that notifies logged
20342 on users about incoming mail.
20343
20344
20345 .option quota appendfile string&!! unset
20346 .cindex "quota" "imposed by Exim"
20347 This option imposes a limit on the size of the file to which Exim is appending,
20348 or to the total space used in the directory tree when the &%directory%& option
20349 is set. In the latter case, computation of the space used is expensive, because
20350 all the files in the directory (and any sub-directories) have to be
20351 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20352 &%maildir_use_size_file%& for ways to avoid this in environments where users
20353 have no shell access to their mailboxes).
20354
20355 As there is no interlock against two simultaneous deliveries into a
20356 multi-file mailbox, it is possible for the quota to be overrun in this case.
20357 For single-file mailboxes, of course, an interlock is a necessity.
20358
20359 A file's size is taken as its &'used'& value. Because of blocking effects, this
20360 may be a lot less than the actual amount of disk space allocated to the file.
20361 If the sizes of a number of files are being added up, the rounding effect can
20362 become quite noticeable, especially on systems that have large block sizes.
20363 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20364 the obvious value which users understand most easily.
20365
20366 The value of the option is expanded, and must then be a numerical value
20367 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20368 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20369 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20370 be handled.
20371
20372 &*Note*&: A value of zero is interpreted as &"no quota"&.
20373
20374 The expansion happens while Exim is running as root, before it changes uid for
20375 the delivery. This means that files that are inaccessible to the end user can
20376 be used to hold quota values that are looked up in the expansion. When delivery
20377 fails because this quota is exceeded, the handling of the error is as for
20378 system quota failures.
20379
20380 By default, Exim's quota checking mimics system quotas, and restricts the
20381 mailbox to the specified maximum size, though the value is not accurate to the
20382 last byte, owing to separator lines and additional headers that may get added
20383 during message delivery. When a mailbox is nearly full, large messages may get
20384 refused even though small ones are accepted, because the size of the current
20385 message is added to the quota when the check is made. This behaviour can be
20386 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20387 for exceeding the quota does not include the current message. Thus, deliveries
20388 continue until the quota has been exceeded; thereafter, no further messages are
20389 delivered. See also &%quota_warn_threshold%&.
20390
20391
20392 .option quota_directory appendfile string&!! unset
20393 This option defines the directory to check for quota purposes when delivering
20394 into individual files. The default is the delivery directory, or, if a file
20395 called &_maildirfolder_& exists in a maildir directory, the parent of the
20396 delivery directory.
20397
20398
20399 .option quota_filecount appendfile string&!! 0
20400 This option applies when the &%directory%& option is set. It limits the total
20401 number of files in the directory (compare the inode limit in system quotas). It
20402 can only be used if &%quota%& is also set. The value is expanded; an expansion
20403 failure causes delivery to be deferred. A value of zero is interpreted as
20404 &"no quota"&.
20405
20406
20407 .option quota_is_inclusive appendfile boolean true
20408 See &%quota%& above.
20409
20410
20411 .option quota_size_regex appendfile string unset
20412 This option applies when one of the delivery modes that writes a separate file
20413 for each message is being used. When Exim wants to find the size of one of
20414 these files in order to test the quota, it first checks &%quota_size_regex%&.
20415 If this is set to a regular expression that matches the file name, and it
20416 captures one string, that string is interpreted as a representation of the
20417 file's size. The value of &%quota_size_regex%& is not expanded.
20418
20419 This feature is useful only when users have no shell access to their mailboxes
20420 &-- otherwise they could defeat the quota simply by renaming the files. This
20421 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20422 the file length to the file name. For example:
20423 .code
20424 maildir_tag = ,S=$message_size
20425 quota_size_regex = ,S=(\d+)
20426 .endd
20427 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20428 number of lines in the message.
20429
20430 The regular expression should not assume that the length is at the end of the
20431 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20432 sometimes add other information onto the ends of message file names.
20433
20434 Section &<<SECID136>>& contains further information.
20435
20436
20437 .option quota_warn_message appendfile string&!! "see below"
20438 See below for the use of this option. If it is not set when
20439 &%quota_warn_threshold%& is set, it defaults to
20440 .code
20441 quota_warn_message = "\
20442   To: $local_part@$domain\n\
20443   Subject: Your mailbox\n\n\
20444   This message is automatically created \
20445   by mail delivery software.\n\n\
20446   The size of your mailbox has exceeded \
20447   a warning threshold that is\n\
20448   set by the system administrator.\n"
20449 .endd
20450
20451
20452 .option quota_warn_threshold appendfile string&!! 0
20453 .cindex "quota" "warning threshold"
20454 .cindex "mailbox" "size warning"
20455 .cindex "size" "of mailbox"
20456 This option is expanded in the same way as &%quota%& (see above). If the
20457 resulting value is greater than zero, and delivery of the message causes the
20458 size of the file or total space in the directory tree to cross the given
20459 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20460 may be specified as a percentage of it by following the value with a percent
20461 sign. For example:
20462 .code
20463 quota = 10M
20464 quota_warn_threshold = 75%
20465 .endd
20466 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20467 percent sign is ignored.
20468
20469 The warning message itself is specified by the &%quota_warn_message%& option,
20470 and it must start with a &'To:'& header line containing the recipient(s) of the
20471 warning message. These do not necessarily have to include the recipient(s) of
20472 the original message. A &'Subject:'& line should also normally be supplied. You
20473 can include any other header lines that you want. If you do not include a
20474 &'From:'& line, the default is:
20475 .code
20476 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20477 .endd
20478 .oindex &%errors_reply_to%&
20479 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20480 option.
20481
20482 The &%quota%& option does not have to be set in order to use this option; they
20483 are independent of one another except when the threshold is specified as a
20484 percentage.
20485
20486
20487 .option use_bsmtp appendfile boolean false
20488 .cindex "envelope sender"
20489 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20490 format, with the envelope sender and recipient(s) included as SMTP commands. If
20491 you want to include a leading HELO command with such messages, you can do
20492 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20493 for details of batch SMTP.
20494
20495
20496 .option use_crlf appendfile boolean false
20497 .cindex "carriage return"
20498 .cindex "linefeed"
20499 This option causes lines to be terminated with the two-character CRLF sequence
20500 (carriage return, linefeed) instead of just a linefeed character. In the case
20501 of batched SMTP, the byte sequence written to the file is then an exact image
20502 of what would be sent down a real SMTP connection.
20503
20504 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20505 (which are used to supply the traditional &"From&~"& and blank line separators
20506 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20507 carriage return characters if these are needed. In cases where these options
20508 have non-empty defaults, the values end with a single linefeed, so they must be
20509 changed to end with &`\r\n`& if &%use_crlf%& is set.
20510
20511
20512 .option use_fcntl_lock appendfile boolean "see below"
20513 This option controls the use of the &[fcntl()]& function to lock a file for
20514 exclusive use when a message is being appended. It is set by default unless
20515 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20516 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20517 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20518
20519
20520 .option use_flock_lock appendfile boolean false
20521 This option is provided to support the use of &[flock()]& for file locking, for
20522 the few situations where it is needed. Most modern operating systems support
20523 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20524 each other. Exim uses &[fcntl()]& locking by default.
20525
20526 This option is required only if you are using an operating system where
20527 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20528 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20529 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20530
20531 .cindex "Solaris" "&[flock()]& support"
20532 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20533 have it (and some, I think, provide a not quite right version built on top of
20534 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20535 the ability to use it, and any attempt to do so will cause a configuration
20536 error.
20537
20538 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20539 is just being mapped onto &[fcntl()]& by the OS).
20540
20541
20542 .option use_lockfile appendfile boolean "see below"
20543 If this option is turned off, Exim does not attempt to create a lock file when
20544 appending to a mailbox file. In this situation, the only locking is by
20545 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20546 sure that every MUA that is ever going to look at your users' mailboxes uses
20547 &[fcntl()]& rather than a lock file, and even then only when you are not
20548 delivering over NFS from more than one host.
20549
20550 .cindex "NFS" "lock file"
20551 In order to append to an NFS file safely from more than one host, it is
20552 necessary to take out a lock &'before'& opening the file, and the lock file
20553 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20554 file corruption.
20555
20556 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20557 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20558 except when &%mbx_format%& is set.
20559
20560
20561 .option use_mbx_lock appendfile boolean "see below"
20562 This option is available only if Exim has been compiled with SUPPORT_MBX
20563 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20564 locking rules be used. It is set by default if &%mbx_format%& is set and none
20565 of the locking options are mentioned in the configuration. The locking rules
20566 are the same as are used by the &'c-client'& library that underlies Pine and
20567 the IMAP4 and POP daemons that come with it (see the discussion below). The
20568 rules allow for shared access to the mailbox. However, this kind of locking
20569 does not work when the mailbox is NFS mounted.
20570
20571 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20572 &%use_flock_lock%& to control what kind of locking is used in implementing the
20573 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20574 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20575
20576
20577
20578
20579 .section "Operational details for appending" "SECTopappend"
20580 .cindex "appending to a file"
20581 .cindex "file" "appending"
20582 Before appending to a file, the following preparations are made:
20583
20584 .ilist
20585 If the name of the file is &_/dev/null_&, no action is taken, and a success
20586 return is given.
20587
20588 .next
20589 .cindex "directory creation"
20590 If any directories on the file's path are missing, Exim creates them if the
20591 &%create_directory%& option is set. A created directory's mode is given by the
20592 &%directory_mode%& option.
20593
20594 .next
20595 If &%file_format%& is set, the format of an existing file is checked. If this
20596 indicates that a different transport should be used, control is passed to that
20597 transport.
20598
20599 .next
20600 .cindex "file" "locking"
20601 .cindex "locking files"
20602 .cindex "NFS" "lock file"
20603 If &%use_lockfile%& is set, a lock file is built in a way that will work
20604 reliably over NFS, as follows:
20605
20606 .olist
20607 Create a &"hitching post"& file whose name is that of the lock file with the
20608 current time, primary host name, and process id added, by opening for writing
20609 as a new file. If this fails with an access error, delivery is deferred.
20610 .next
20611 Close the hitching post file, and hard link it to the lock file name.
20612 .next
20613 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20614 Unlink the hitching post name.
20615 .next
20616 Otherwise, use &[stat()]& to get information about the hitching post file, and
20617 then unlink hitching post name. If the number of links is exactly two, creation
20618 of the lock file succeeded but something (for example, an NFS server crash and
20619 restart) caused this fact not to be communicated to the &[link()]& call.
20620 .next
20621 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20622 up to &%lock_retries%& times. However, since any program that writes to a
20623 mailbox should complete its task very quickly, it is reasonable to time out old
20624 lock files that are normally the result of user agent and system crashes. If an
20625 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20626 it before trying again.
20627 .endlist olist
20628
20629 .next
20630 A call is made to &[lstat()]& to discover whether the main file exists, and if
20631 so, what its characteristics are. If &[lstat()]& fails for any reason other
20632 than non-existence, delivery is deferred.
20633
20634 .next
20635 .cindex "symbolic link" "to mailbox"
20636 .cindex "mailbox" "symbolic link"
20637 If the file does exist and is a symbolic link, delivery is deferred, unless the
20638 &%allow_symlink%& option is set, in which case the ownership of the link is
20639 checked, and then &[stat()]& is called to find out about the real file, which
20640 is then subjected to the checks below. The check on the top-level link
20641 ownership prevents one user creating a link for another's mailbox in a sticky
20642 directory, though allowing symbolic links in this case is definitely not a good
20643 idea. If there is a chain of symbolic links, the intermediate ones are not
20644 checked.
20645
20646 .next
20647 If the file already exists but is not a regular file, or if the file's owner
20648 and group (if the group is being checked &-- see &%check_group%& above) are
20649 different from the user and group under which the delivery is running,
20650 delivery is deferred.
20651
20652 .next
20653 If the file's permissions are more generous than specified, they are reduced.
20654 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20655 is set false, in which case the delivery is tried using the existing
20656 permissions.
20657
20658 .next
20659 The file's inode number is saved, and the file is then opened for appending.
20660 If this fails because the file has vanished, &(appendfile)& behaves as if it
20661 hadn't existed (see below). For any other failures, delivery is deferred.
20662
20663 .next
20664 If the file is opened successfully, check that the inode number hasn't
20665 changed, that it is still a regular file, and that the owner and permissions
20666 have not changed. If anything is wrong, defer delivery and freeze the message.
20667
20668 .next
20669 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20670 option is set. Otherwise, check that the file is being created in a permitted
20671 directory if the &%create_file%& option is set (deferring on failure), and then
20672 open for writing as a new file, with the O_EXCL and O_CREAT options,
20673 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20674 set). In this case, which can happen if the link points to a non-existent file,
20675 the file is opened for writing using O_CREAT but not O_EXCL, because
20676 that prevents link following.
20677
20678 .next
20679 .cindex "loop" "while file testing"
20680 If opening fails because the file exists, obey the tests given above for
20681 existing files. However, to avoid looping in a situation where the file is
20682 being continuously created and destroyed, the exists/not-exists loop is broken
20683 after 10 repetitions, and the message is then frozen.
20684
20685 .next
20686 If opening fails with any other error, defer delivery.
20687
20688 .next
20689 .cindex "file" "locking"
20690 .cindex "locking files"
20691 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20692 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20693 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20694 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20695 file, and an exclusive lock on the file whose name is
20696 .code
20697 /tmp/.<device-number>.<inode-number>
20698 .endd
20699 using the device and inode numbers of the open mailbox file, in accordance with
20700 the MBX locking rules. This file is created with a mode that is specified by
20701 the &%lockfile_mode%& option.
20702
20703 If Exim fails to lock the file, there are two possible courses of action,
20704 depending on the value of the locking timeout. This is obtained from
20705 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20706
20707 If the timeout value is zero, the file is closed, Exim waits for
20708 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20709 to lock it again. This happens up to &%lock_retries%& times, after which the
20710 delivery is deferred.
20711
20712 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20713 &[flock()]& are used (with the given timeout), so there has already been some
20714 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20715 immediately. It retries up to
20716 .code
20717 (lock_retries * lock_interval) / <timeout>
20718 .endd
20719 times (rounded up).
20720 .endlist
20721
20722 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20723 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20724
20725
20726 .section "Operational details for delivery to a new file" "SECTopdir"
20727 .cindex "delivery" "to single file"
20728 .cindex "&""From""& line"
20729 When the &%directory%& option is set instead of &%file%&, each message is
20730 delivered into a newly-created file or set of files. When &(appendfile)& is
20731 activated directly from a &(redirect)& router, neither &%file%& nor
20732 &%directory%& is normally set, because the path for delivery is supplied by the
20733 router. (See for example, the &(address_file)& transport in the default
20734 configuration.) In this case, delivery is to a new file if either the path name
20735 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20736
20737 No locking is required while writing the message to a new file, so the various
20738 locking options of the transport are ignored. The &"From"& line that by default
20739 separates messages in a single file is not normally needed, nor is the escaping
20740 of message lines that start with &"From"&, and there is no need to ensure a
20741 newline at the end of each message. Consequently, the default values for
20742 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20743 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20744
20745 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20746 the files in the delivery directory by default. However, you can specify a
20747 different directory by setting &%quota_directory%&. Also, for maildir
20748 deliveries (see below) the &_maildirfolder_& convention is honoured.
20749
20750
20751 .cindex "maildir format"
20752 .cindex "mailstore format"
20753 There are three different ways in which delivery to individual files can be
20754 done, controlled by the settings of the &%maildir_format%& and
20755 &%mailstore_format%& options. Note that code to support maildir or mailstore
20756 formats is not included in the binary unless SUPPORT_MAILDIR or
20757 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20758
20759 .cindex "directory creation"
20760 In all three cases an attempt is made to create the directory and any necessary
20761 sub-directories if they do not exist, provided that the &%create_directory%&
20762 option is set (the default). The location of a created directory can be
20763 constrained by setting &%create_file%&. A created directory's mode is given by
20764 the &%directory_mode%& option. If creation fails, or if the
20765 &%create_directory%& option is not set when creation is required, delivery is
20766 deferred.
20767
20768
20769
20770 .section "Maildir delivery" "SECTmaildirdelivery"
20771 .cindex "maildir format" "description of"
20772 If the &%maildir_format%& option is true, Exim delivers each message by writing
20773 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20774 directory that is defined by the &%directory%& option (the &"delivery
20775 directory"&). If the delivery is successful, the file is renamed into the
20776 &_new_& subdirectory.
20777
20778 In the file name, <&'stime'&> is the current time of day in seconds, and
20779 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20780 Exim checks that the time-of-day clock has moved on by at least one microsecond
20781 before terminating the delivery process. This guarantees uniqueness for the
20782 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20783 opening it. If any response other than ENOENT (does not exist) is given,
20784 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20785
20786 Before Exim carries out a maildir delivery, it ensures that subdirectories
20787 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20788 do not exist, Exim tries to create them and any superior directories in their
20789 path, subject to the &%create_directory%& and &%create_file%& options. If the
20790 &%maildirfolder_create_regex%& option is set, and the regular expression it
20791 contains matches the delivery directory, Exim also ensures that a file called
20792 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20793 &_maildirfolder_& file cannot be created, delivery is deferred.
20794
20795 These features make it possible to use Exim to create all the necessary files
20796 and directories in a maildir mailbox, including subdirectories for maildir++
20797 folders. Consider this example:
20798 .code
20799 maildir_format = true
20800 directory = /var/mail/$local_part\
20801            ${if eq{$local_part_suffix}{}{}\
20802            {/.${substr_1:$local_part_suffix}}}
20803 maildirfolder_create_regex = /\.[^/]+$
20804 .endd
20805 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20806 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20807 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20808 not match this name, so Exim will not look for or create the file
20809 &_/var/mail/pimbo/maildirfolder_&, though it will create
20810 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20811
20812 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20813 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20814 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20815 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20816 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20817
20818 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20819 not inadvertently match the toplevel maildir directory, because a
20820 &_maildirfolder_& file at top level would completely break quota calculations.
20821
20822 .cindex "quota" "in maildir delivery"
20823 .cindex "maildir++"
20824 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20825 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20826 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20827 Exim assumes the directory is a maildir++ folder directory, which is one level
20828 down from the user's top level mailbox directory. This causes it to start at
20829 the parent directory instead of the current directory when calculating the
20830 amount of space used.
20831
20832 One problem with delivering into a multi-file mailbox is that it is
20833 computationally expensive to compute the size of the mailbox for quota
20834 checking. Various approaches have been taken to reduce the amount of work
20835 needed. The next two sections describe two of them. A third alternative is to
20836 use some external process for maintaining the size data, and use the expansion
20837 of the &%mailbox_size%& option as a way of importing it into Exim.
20838
20839
20840
20841
20842 .section "Using tags to record message sizes" "SECID135"
20843 If &%maildir_tag%& is set, the string is expanded for each delivery.
20844 When the maildir file is renamed into the &_new_& sub-directory, the
20845 tag is added to its name. However, if adding the tag takes the length of the
20846 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20847 the tag is dropped and the maildir file is created with no tag.
20848
20849
20850 .vindex "&$message_size$&"
20851 Tags can be used to encode the size of files in their names; see
20852 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20853 happens after the message has been written. The value of the &$message_size$&
20854 variable is set to the number of bytes actually written. If the expansion is
20855 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20856 be deferred. The expanded tag may contain any printing characters except &"/"&.
20857 Non-printing characters in the string are ignored; if the resulting string is
20858 empty, it is ignored. If it starts with an alphanumeric character, a leading
20859 colon is inserted; this default has not proven to be the path that popular
20860 maildir implementations have chosen (but changing it in Exim would break
20861 backwards compatibility).
20862
20863 For one common implementation, you might set:
20864 .code
20865 maildir_tag = ,S=${message_size}
20866 .endd
20867 but you should check the documentation of the other software to be sure.
20868
20869 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
20870 as this allows Exim to extract the size from your tag, instead of having to
20871 &[stat()]& each message file.
20872
20873
20874 .section "Using a maildirsize file" "SECID136"
20875 .cindex "quota" "in maildir delivery"
20876 .cindex "maildir format" "&_maildirsize_& file"
20877 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20878 storing quota and message size information in a file called &_maildirsize_&
20879 within the toplevel maildir directory. If this file does not exist, Exim
20880 creates it, setting the quota from the &%quota%& option of the transport. If
20881 the maildir directory itself does not exist, it is created before any attempt
20882 to write a &_maildirsize_& file.
20883
20884 The &_maildirsize_& file is used to hold information about the sizes of
20885 messages in the maildir, thus speeding up quota calculations. The quota value
20886 in the file is just a cache; if the quota is changed in the transport, the new
20887 value overrides the cached value when the next message is delivered. The cache
20888 is maintained for the benefit of other programs that access the maildir and
20889 need to know the quota.
20890
20891 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20892 file is maintained (with a zero quota setting), but no quota is imposed.
20893
20894 A regular expression is available for controlling which directories in the
20895 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20896 See the description of the &%maildir_quota_directory_regex%& option above for
20897 details.
20898
20899
20900 .section "Mailstore delivery" "SECID137"
20901 .cindex "mailstore format" "description of"
20902 If the &%mailstore_format%& option is true, each message is written as two
20903 files in the given directory. A unique base name is constructed from the
20904 message id and the current delivery process, and the files that are written use
20905 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20906 contains the message's envelope, and the &_.msg_& file contains the message
20907 itself. The base name is placed in the variable &$mailstore_basename$&.
20908
20909 During delivery, the envelope is first written to a file with the suffix
20910 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20911 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20912 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20913 file before accessing either of them. An alternative approach is to wait for
20914 the absence of a &_.tmp_& file.
20915
20916 The envelope file starts with any text defined by the &%mailstore_prefix%&
20917 option, expanded and terminated by a newline if there isn't one. Then follows
20918 the sender address on one line, then all the recipient addresses, one per line.
20919 There can be more than one recipient only if the &%batch_max%& option is set
20920 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20921 appended to the file, followed by a newline if it does not end with one.
20922
20923 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20924 failure, it is ignored. Other expansion errors are treated as serious
20925 configuration errors, and delivery is deferred. The variable
20926 &$mailstore_basename$& is available for use during these expansions.
20927
20928
20929 .section "Non-special new file delivery" "SECID138"
20930 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20931 file is created directly in the named directory. For example, when delivering
20932 messages into files in batched SMTP format for later delivery to some host (see
20933 section &<<SECTbatchSMTP>>&), a setting such as
20934 .code
20935 directory = /var/bsmtp/$host
20936 .endd
20937 might be used. A message is written to a file with a temporary name, which is
20938 then renamed when the delivery is complete. The final name is obtained by
20939 expanding the contents of the &%directory_file%& option.
20940 .ecindex IIDapptra1
20941 .ecindex IIDapptra2
20942
20943
20944
20945
20946
20947
20948 . ////////////////////////////////////////////////////////////////////////////
20949 . ////////////////////////////////////////////////////////////////////////////
20950
20951 .chapter "The autoreply transport" "CHID8"
20952 .scindex IIDauttra1 "transports" "&(autoreply)&"
20953 .scindex IIDauttra2 "&(autoreply)& transport"
20954 The &(autoreply)& transport is not a true transport in that it does not cause
20955 the message to be transmitted. Instead, it generates a new mail message as an
20956 automatic reply to the incoming message. &'References:'& and
20957 &'Auto-Submitted:'& header lines are included. These are constructed according
20958 to the rules in RFCs 2822 and 3834, respectively.
20959
20960 If the router that passes the message to this transport does not have the
20961 &%unseen%& option set, the original message (for the current recipient) is not
20962 delivered anywhere. However, when the &%unseen%& option is set on the router
20963 that passes the message to this transport, routing of the address continues, so
20964 another router can set up a normal message delivery.
20965
20966
20967 The &(autoreply)& transport is usually run as the result of mail filtering, a
20968 &"vacation"& message being the standard example. However, it can also be run
20969 directly from a router like any other transport. To reduce the possibility of
20970 message cascades, messages created by the &(autoreply)& transport always have
20971 empty envelope sender addresses, like bounce messages.
20972
20973 The parameters of the message to be sent can be specified in the configuration
20974 by options described below. However, these are used only when the address
20975 passed to the transport does not contain its own reply information. When the
20976 transport is run as a consequence of a
20977 &%mail%&
20978 or &%vacation%& command in a filter file, the parameters of the message are
20979 supplied by the filter, and passed with the address. The transport's options
20980 that define the message are then ignored (so they are not usually set in this
20981 case). The message is specified entirely by the filter or by the transport; it
20982 is never built from a mixture of options. However, the &%file_optional%&,
20983 &%mode%&, and &%return_message%& options apply in all cases.
20984
20985 &(Autoreply)& is implemented as a local transport. When used as a result of a
20986 command in a user's filter file, &(autoreply)& normally runs under the uid and
20987 gid of the user, and with appropriate current and home directories (see chapter
20988 &<<CHAPenvironment>>&).
20989
20990 There is a subtle difference between routing a message to a &(pipe)& transport
20991 that generates some text to be returned to the sender, and routing it to an
20992 &(autoreply)& transport. This difference is noticeable only if more than one
20993 address from the same message is so handled. In the case of a pipe, the
20994 separate outputs from the different addresses are gathered up and returned to
20995 the sender in a single message, whereas if &(autoreply)& is used, a separate
20996 message is generated for each address that is passed to it.
20997
20998 Non-printing characters are not permitted in the header lines generated for the
20999 message that &(autoreply)& creates, with the exception of newlines that are
21000 immediately followed by white space. If any non-printing characters are found,
21001 the transport defers.
21002 Whether characters with the top bit set count as printing characters or not is
21003 controlled by the &%print_topbitchars%& global option.
21004
21005 If any of the generic options for manipulating headers (for example,
21006 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21007 of the original message that is included in the generated message when
21008 &%return_message%& is set. They do not apply to the generated message itself.
21009
21010 .vindex "&$sender_address$&"
21011 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21012 the message, indicating that there were no recipients, it does not treat this
21013 as an error. This means that autoreplies sent to &$sender_address$& when this
21014 is empty (because the incoming message is a bounce message) do not cause
21015 problems. They are just discarded.
21016
21017
21018
21019 .section "Private options for autoreply" "SECID139"
21020 .cindex "options" "&(autoreply)& transport"
21021
21022 .option bcc autoreply string&!! unset
21023 This specifies the addresses that are to receive &"blind carbon copies"& of the
21024 message when the message is specified by the transport.
21025
21026
21027 .option cc autoreply string&!! unset
21028 This specifies recipients of the message and the contents of the &'Cc:'& header
21029 when the message is specified by the transport.
21030
21031
21032 .option file autoreply string&!! unset
21033 The contents of the file are sent as the body of the message when the message
21034 is specified by the transport. If both &%file%& and &%text%& are set, the text
21035 string comes first.
21036
21037
21038 .option file_expand autoreply boolean false
21039 If this is set, the contents of the file named by the &%file%& option are
21040 subjected to string expansion as they are added to the message.
21041
21042
21043 .option file_optional autoreply boolean false
21044 If this option is true, no error is generated if the file named by the &%file%&
21045 option or passed with the address does not exist or cannot be read.
21046
21047
21048 .option from autoreply string&!! unset
21049 This specifies the contents of the &'From:'& header when the message is
21050 specified by the transport.
21051
21052
21053 .option headers autoreply string&!! unset
21054 This specifies additional RFC 2822 headers that are to be added to the message
21055 when the message is specified by the transport. Several can be given by using
21056 &"\n"& to separate them. There is no check on the format.
21057
21058
21059 .option log autoreply string&!! unset
21060 This option names a file in which a record of every message sent is logged when
21061 the message is specified by the transport.
21062
21063
21064 .option mode autoreply "octal integer" 0600
21065 If either the log file or the &"once"& file has to be created, this mode is
21066 used.
21067
21068
21069 .option never_mail autoreply "address list&!!" unset
21070 If any run of the transport creates a message with a recipient that matches any
21071 item in the list, that recipient is quietly discarded. If all recipients are
21072 discarded, no message is created. This applies both when the recipients are
21073 generated by a filter and when they are specified in the transport.
21074
21075
21076
21077 .option once autoreply string&!! unset
21078 This option names a file or DBM database in which a record of each &'To:'&
21079 recipient is kept when the message is specified by the transport. &*Note*&:
21080 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21081
21082 If &%once%& is unset, or is set to an empty string, the message is always sent.
21083 By default, if &%once%& is set to a non-empty file name, the message
21084 is not sent if a potential recipient is already listed in the database.
21085 However, if the &%once_repeat%& option specifies a time greater than zero, the
21086 message is sent if that much time has elapsed since a message was last sent to
21087 this recipient. A setting of zero time for &%once_repeat%& (the default)
21088 prevents a message from being sent a second time &-- in this case, zero means
21089 infinity.
21090
21091 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21092 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21093 greater than zero, it changes the way Exim implements the &%once%& option.
21094 Instead of using a DBM file to record every recipient it sends to, it uses a
21095 regular file, whose size will never get larger than the given value.
21096
21097 In the file, Exim keeps a linear list of recipient addresses and the times at
21098 which they were sent messages. If the file is full when a new address needs to
21099 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21100 means that a given recipient may receive multiple messages, but at
21101 unpredictable intervals that depend on the rate of turnover of addresses in the
21102 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21103
21104
21105 .option once_file_size autoreply integer 0
21106 See &%once%& above.
21107
21108
21109 .option once_repeat autoreply time&!! 0s
21110 See &%once%& above.
21111 After expansion, the value of this option must be a valid time value.
21112
21113
21114 .option reply_to autoreply string&!! unset
21115 This specifies the contents of the &'Reply-To:'& header when the message is
21116 specified by the transport.
21117
21118
21119 .option return_message autoreply boolean false
21120 If this is set, a copy of the original message is returned with the new
21121 message, subject to the maximum size set in the &%return_size_limit%& global
21122 configuration option.
21123
21124
21125 .option subject autoreply string&!! unset
21126 This specifies the contents of the &'Subject:'& header when the message is
21127 specified by the transport. It is tempting to quote the original subject in
21128 automatic responses. For example:
21129 .code
21130 subject = Re: $h_subject:
21131 .endd
21132 There is a danger in doing this, however. It may allow a third party to
21133 subscribe your users to an opt-in mailing list, provided that the list accepts
21134 bounce messages as subscription confirmations. Well-managed lists require a
21135 non-bounce message to confirm a subscription, so the danger is relatively
21136 small.
21137
21138
21139
21140 .option text autoreply string&!! unset
21141 This specifies a single string to be used as the body of the message when the
21142 message is specified by the transport. If both &%text%& and &%file%& are set,
21143 the text comes first.
21144
21145
21146 .option to autoreply string&!! unset
21147 This specifies recipients of the message and the contents of the &'To:'& header
21148 when the message is specified by the transport.
21149 .ecindex IIDauttra1
21150 .ecindex IIDauttra2
21151
21152
21153
21154
21155 . ////////////////////////////////////////////////////////////////////////////
21156 . ////////////////////////////////////////////////////////////////////////////
21157
21158 .chapter "The lmtp transport" "CHAPLMTP"
21159 .cindex "transports" "&(lmtp)&"
21160 .cindex "&(lmtp)& transport"
21161 .cindex "LMTP" "over a pipe"
21162 .cindex "LMTP" "over a socket"
21163 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21164 specified command
21165 or by interacting with a Unix domain socket.
21166 This transport is something of a cross between the &(pipe)& and &(smtp)&
21167 transports. Exim also has support for using LMTP over TCP/IP; this is
21168 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21169 to be of minority interest, the default build-time configure in &_src/EDITME_&
21170 has it commented out. You need to ensure that
21171 .code
21172 TRANSPORT_LMTP=yes
21173 .endd
21174 .cindex "options" "&(lmtp)& transport"
21175 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21176 included in the Exim binary. The private options of the &(lmtp)& transport are
21177 as follows:
21178
21179 .option batch_id lmtp string&!! unset
21180 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21181
21182
21183 .option batch_max lmtp integer 1
21184 This limits the number of addresses that can be handled in a single delivery.
21185 Most LMTP servers can handle several addresses at once, so it is normally a
21186 good idea to increase this value. See the description of local delivery
21187 batching in chapter &<<CHAPbatching>>&.
21188
21189
21190 .option command lmtp string&!! unset
21191 This option must be set if &%socket%& is not set. The string is a command which
21192 is run in a separate process. It is split up into a command name and list of
21193 arguments, each of which is separately expanded (so expansion cannot change the
21194 number of arguments). The command is run directly, not via a shell. The message
21195 is passed to the new process using the standard input and output to operate the
21196 LMTP protocol.
21197
21198 .option ignore_quota lmtp boolean false
21199 .cindex "LMTP" "ignoring quota errors"
21200 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21201 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21202 in its response to the LHLO command.
21203
21204 .option socket lmtp string&!! unset
21205 This option must be set if &%command%& is not set. The result of expansion must
21206 be the name of a Unix domain socket. The transport connects to the socket and
21207 delivers the message to it using the LMTP protocol.
21208
21209
21210 .option timeout lmtp time 5m
21211 The transport is aborted if the created process or Unix domain socket does not
21212 respond to LMTP commands or message input within this timeout. Delivery
21213 is deferred, and will be tried again later. Here is an example of a typical
21214 LMTP transport:
21215 .code
21216 lmtp:
21217   driver = lmtp
21218   command = /some/local/lmtp/delivery/program
21219   batch_max = 20
21220   user = exim
21221 .endd
21222 This delivers up to 20 addresses at a time, in a mixture of domains if
21223 necessary, running as the user &'exim'&.
21224
21225
21226
21227 . ////////////////////////////////////////////////////////////////////////////
21228 . ////////////////////////////////////////////////////////////////////////////
21229
21230 .chapter "The pipe transport" "CHAPpipetransport"
21231 .scindex IIDpiptra1 "transports" "&(pipe)&"
21232 .scindex IIDpiptra2 "&(pipe)& transport"
21233 The &(pipe)& transport is used to deliver messages via a pipe to a command
21234 running in another process. One example is the use of &(pipe)& as a
21235 pseudo-remote transport for passing messages to some other delivery mechanism
21236 (such as UUCP). Another is the use by individual users to automatically process
21237 their incoming messages. The &(pipe)& transport can be used in one of the
21238 following ways:
21239
21240 .ilist
21241 .vindex "&$local_part$&"
21242 A router routes one address to a transport in the normal way, and the
21243 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21244 contains the local part of the address (as usual), and the command that is run
21245 is specified by the &%command%& option on the transport.
21246 .next
21247 .vindex "&$pipe_addresses$&"
21248 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21249 transport can handle more than one address in a single run. In this case, when
21250 more than one address is routed to the transport, &$local_part$& is not set
21251 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21252 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21253 that are routed to the transport.
21254 .next
21255 .vindex "&$address_pipe$&"
21256 A router redirects an address directly to a pipe command (for example, from an
21257 alias or forward file). In this case, &$address_pipe$& contains the text of the
21258 pipe command, and the &%command%& option on the transport is ignored. If only
21259 one address is being transported (&%batch_max%& is not greater than one, or
21260 only one address was redirected to this pipe command), &$local_part$& contains
21261 the local part that was redirected.
21262 .endlist
21263
21264
21265 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21266 deliver messages over pipes using the LMTP interactive protocol. This is
21267 implemented by the &(lmtp)& transport.
21268
21269 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21270 &_.forward_& file, the command runs under the uid and gid of that user. In
21271 other cases, the uid and gid have to be specified explicitly, either on the
21272 transport or on the router that handles the address. Current and &"home"&
21273 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21274 details of the local delivery environment and chapter &<<CHAPbatching>>&
21275 for a discussion of local delivery batching.
21276
21277
21278 .section "Concurrent delivery" "SECID140"
21279 If two messages arrive at almost the same time, and both are routed to a pipe
21280 delivery, the two pipe transports may be run concurrently. You must ensure that
21281 any pipe commands you set up are robust against this happening. If the commands
21282 write to a file, the &%exim_lock%& utility might be of use.
21283
21284
21285
21286
21287 .section "Returned status and data" "SECID141"
21288 .cindex "&(pipe)& transport" "returned data"
21289 If the command exits with a non-zero return code, the delivery is deemed to
21290 have failed, unless either the &%ignore_status%& option is set (in which case
21291 the return code is treated as zero), or the return code is one of those listed
21292 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21293 later"&. In this case, delivery is deferred. Details of a permanent failure are
21294 logged, but are not included in the bounce message, which merely contains
21295 &"local delivery failed"&.
21296
21297 If the command exits on a signal and the &%freeze_signal%& option is set then
21298 the message will be frozen in the queue. If that option is not set, a bounce
21299 will be sent as normal.
21300
21301 If the return code is greater than 128 and the command being run is a shell
21302 script, it normally means that the script was terminated by a signal whose
21303 value is the return code minus 128. The &%freeze_signal%& option does not
21304 apply in this case.
21305
21306 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21307 return code is set to 127. This is the value that a shell returns if it is
21308 asked to run a non-existent command. The wording for the log line suggests that
21309 a non-existent command may be the problem.
21310
21311 The &%return_output%& option can affect the result of a pipe delivery. If it is
21312 set and the command produces any output on its standard output or standard
21313 error streams, the command is considered to have failed, even if it gave a zero
21314 return code or if &%ignore_status%& is set. The output from the command is
21315 included as part of the bounce message. The &%return_fail_output%& option is
21316 similar, except that output is returned only when the command exits with a
21317 failure return code, that is, a value other than zero or a code that matches
21318 &%temp_errors%&.
21319
21320
21321
21322 .section "How the command is run" "SECThowcommandrun"
21323 .cindex "&(pipe)& transport" "path for command"
21324 The command line is (by default) broken down into a command name and arguments
21325 by the &(pipe)& transport itself. The &%allow_commands%& and
21326 &%restrict_to_path%& options can be used to restrict the commands that may be
21327 run.
21328
21329 .cindex "quoting" "in pipe command"
21330 Unquoted arguments are delimited by white space. If an argument appears in
21331 double quotes, backslash is interpreted as an escape character in the usual
21332 way. If an argument appears in single quotes, no escaping is done.
21333
21334 String expansion is applied to the command line except when it comes from a
21335 traditional &_.forward_& file (commands from a filter file are expanded). The
21336 expansion is applied to each argument in turn rather than to the whole line.
21337 For this reason, any string expansion item that contains white space must be
21338 quoted so as to be contained within a single argument. A setting such as
21339 .code
21340 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21341 .endd
21342 will not work, because the expansion item gets split between several
21343 arguments. You have to write
21344 .code
21345 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21346 .endd
21347 to ensure that it is all in one argument. The expansion is done in this way,
21348 argument by argument, so that the number of arguments cannot be changed as a
21349 result of expansion, and quotes or backslashes in inserted variables do not
21350 interact with external quoting. However, this leads to problems if you want to
21351 generate multiple arguments (or the command name plus arguments) from a single
21352 expansion. In this situation, the simplest solution is to use a shell. For
21353 example:
21354 .code
21355 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21356 .endd
21357
21358 .cindex "transport" "filter"
21359 .cindex "filter" "transport filter"
21360 .vindex "&$pipe_addresses$&"
21361 Special handling takes place when an argument consists of precisely the text
21362 &`$pipe_addresses`&. This is not a general expansion variable; the only
21363 place this string is recognized is when it appears as an argument for a pipe or
21364 transport filter command. It causes each address that is being handled to be
21365 inserted in the argument list at that point &'as a separate argument'&. This
21366 avoids any problems with spaces or shell metacharacters, and is of use when a
21367 &(pipe)& transport is handling groups of addresses in a batch.
21368
21369 After splitting up into arguments and expansion, the resulting command is run
21370 in a subprocess directly from the transport, &'not'& under a shell. The
21371 message that is being delivered is supplied on the standard input, and the
21372 standard output and standard error are both connected to a single pipe that is
21373 read by Exim. The &%max_output%& option controls how much output the command
21374 may produce, and the &%return_output%& and &%return_fail_output%& options
21375 control what is done with it.
21376
21377 Not running the command under a shell (by default) lessens the security risks
21378 in cases when a command from a user's filter file is built out of data that was
21379 taken from an incoming message. If a shell is required, it can of course be
21380 explicitly specified as the command to be run. However, there are circumstances
21381 where existing commands (for example, in &_.forward_& files) expect to be run
21382 under a shell and cannot easily be modified. To allow for these cases, there is
21383 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21384 works. Instead of breaking up the command line as just described, it expands it
21385 as a single string and passes the result to &_/bin/sh_&. The
21386 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21387 with &%use_shell%&, and the whole mechanism is inherently less secure.
21388
21389
21390
21391 .section "Environment variables" "SECTpipeenv"
21392 .cindex "&(pipe)& transport" "environment for command"
21393 .cindex "environment for pipe transport"
21394 The environment variables listed below are set up when the command is invoked.
21395 This list is a compromise for maximum compatibility with other MTAs. Note that
21396 the &%environment%& option can be used to add additional variables to this
21397 environment.
21398 .display
21399 &`DOMAIN            `&   the domain of the address
21400 &`HOME              `&   the home directory, if set
21401 &`HOST              `&   the host name when called from a router (see below)
21402 &`LOCAL_PART        `&   see below
21403 &`LOCAL_PART_PREFIX `&   see below
21404 &`LOCAL_PART_SUFFIX `&   see below
21405 &`LOGNAME           `&   see below
21406 &`MESSAGE_ID        `&   Exim's local ID for the message
21407 &`PATH              `&   as specified by the &%path%& option below
21408 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21409 &`RECIPIENT         `&   the complete recipient address
21410 &`SENDER            `&   the sender of the message (empty if a bounce)
21411 &`SHELL             `&   &`/bin/sh`&
21412 &`TZ                `&   the value of the &%timezone%& option, if set
21413 &`USER              `&   see below
21414 .endd
21415 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21416 router, LOCAL_PART is set to the local part of the address. When it is
21417 called as a result of a forward or alias expansion, LOCAL_PART is set to
21418 the local part of the address that was expanded. In both cases, any affixes are
21419 removed from the local part, and made available in LOCAL_PART_PREFIX and
21420 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21421 same value as LOCAL_PART for compatibility with other MTAs.
21422
21423 .cindex "HOST"
21424 HOST is set only when a &(pipe)& transport is called from a router that
21425 associates hosts with an address, typically when using &(pipe)& as a
21426 pseudo-remote transport. HOST is set to the first host name specified by
21427 the router.
21428
21429 .cindex "HOME"
21430 If the transport's generic &%home_directory%& option is set, its value is used
21431 for the HOME environment variable. Otherwise, a home directory may be set
21432 by the router's &%transport_home_directory%& option, which defaults to the
21433 user's home directory if &%check_local_user%& is set.
21434
21435
21436 .section "Private options for pipe" "SECID142"
21437 .cindex "options" "&(pipe)& transport"
21438
21439
21440
21441 .option allow_commands pipe "string list&!!" unset
21442 .cindex "&(pipe)& transport" "permitted commands"
21443 The string is expanded, and is then interpreted as a colon-separated list of
21444 permitted commands. If &%restrict_to_path%& is not set, the only commands
21445 permitted are those in the &%allow_commands%& list. They need not be absolute
21446 paths; the &%path%& option is still used for relative paths. If
21447 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21448 in the &%allow_commands%& list, or a name without any slashes that is found on
21449 the path. In other words, if neither &%allow_commands%& nor
21450 &%restrict_to_path%& is set, there is no restriction on the command, but
21451 otherwise only commands that are permitted by one or the other are allowed. For
21452 example, if
21453 .code
21454 allow_commands = /usr/bin/vacation
21455 .endd
21456 and &%restrict_to_path%& is not set, the only permitted command is
21457 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21458 &%use_shell%& is set.
21459
21460
21461 .option batch_id pipe string&!! unset
21462 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21463
21464
21465 .option batch_max pipe integer 1
21466 This limits the number of addresses that can be handled in a single delivery.
21467 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21468
21469
21470 .option check_string pipe string unset
21471 As &(pipe)& writes the message, the start of each line is tested for matching
21472 &%check_string%&, and if it does, the initial matching characters are replaced
21473 by the contents of &%escape_string%&, provided both are set. The value of
21474 &%check_string%& is a literal string, not a regular expression, and the case of
21475 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21476 of &%check_string%& and &%escape_string%& are forced to values that implement
21477 the SMTP escaping protocol. Any settings made in the configuration file are
21478 ignored.
21479
21480
21481 .option command pipe string&!! unset
21482 This option need not be set when &(pipe)& is being used to deliver to pipes
21483 obtained directly from address redirections. In other cases, the option must be
21484 set, to provide a command to be run. It need not yield an absolute path (see
21485 the &%path%& option below). The command is split up into separate arguments by
21486 Exim, and each argument is separately expanded, as described in section
21487 &<<SECThowcommandrun>>& above.
21488
21489
21490 .option environment pipe string&!! unset
21491 .cindex "&(pipe)& transport" "environment for command"
21492 .cindex "environment for &(pipe)& transport"
21493 This option is used to add additional variables to the environment in which the
21494 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21495 a string which is expanded, and then interpreted as a colon-separated list of
21496 environment settings of the form <&'name'&>=<&'value'&>.
21497
21498
21499 .option escape_string pipe string unset
21500 See &%check_string%& above.
21501
21502
21503 .option freeze_exec_fail pipe boolean false
21504 .cindex "exec failure"
21505 .cindex "failure of exec"
21506 .cindex "&(pipe)& transport" "failure of exec"
21507 Failure to exec the command in a pipe transport is by default treated like
21508 any other failure while running the command. However, if &%freeze_exec_fail%&
21509 is set, failure to exec is treated specially, and causes the message to be
21510 frozen, whatever the setting of &%ignore_status%&.
21511
21512
21513 .option freeze_signal pipe boolean false
21514 .cindex "signal exit"
21515 .cindex "&(pipe)& transport", "signal exit"
21516 Normally if the process run by a command in a pipe transport exits on a signal,
21517 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21518 frozen in Exim's queue instead.
21519
21520
21521 .option ignore_status pipe boolean false
21522 If this option is true, the status returned by the subprocess that is set up to
21523 run the command is ignored, and Exim behaves as if zero had been returned.
21524 Otherwise, a non-zero status or termination by signal causes an error return
21525 from the transport unless the status value is one of those listed in
21526 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21527
21528 &*Note*&: This option does not apply to timeouts, which do not return a status.
21529 See the &%timeout_defer%& option for how timeouts are handled.
21530
21531 .option log_defer_output pipe boolean false
21532 .cindex "&(pipe)& transport" "logging output"
21533 If this option is set, and the status returned by the command is
21534 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21535 and any output was produced, the first line of it is written to the main log.
21536
21537
21538 .option log_fail_output pipe boolean false
21539 If this option is set, and the command returns any output, and also ends with a
21540 return code that is neither zero nor one of the return codes listed in
21541 &%temp_errors%& (that is, the delivery failed), the first line of output is
21542 written to the main log. This option and &%log_output%& are mutually exclusive.
21543 Only one of them may be set.
21544
21545
21546
21547 .option log_output pipe boolean false
21548 If this option is set and the command returns any output, the first line of
21549 output is written to the main log, whatever the return code. This option and
21550 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21551
21552
21553
21554 .option max_output pipe integer 20K
21555 This specifies the maximum amount of output that the command may produce on its
21556 standard output and standard error file combined. If the limit is exceeded, the
21557 process running the command is killed. This is intended as a safety measure to
21558 catch runaway processes. The limit is applied independently of the settings of
21559 the options that control what is done with such output (for example,
21560 &%return_output%&). Because of buffering effects, the amount of output may
21561 exceed the limit by a small amount before Exim notices.
21562
21563
21564 .option message_prefix pipe string&!! "see below"
21565 The string specified here is expanded and output at the start of every message.
21566 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21567 .code
21568 message_prefix = \
21569   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21570   ${tod_bsdinbox}\n
21571 .endd
21572 .cindex "Cyrus"
21573 .cindex "&%tmail%&"
21574 .cindex "&""From""& line"
21575 This is required by the commonly used &_/usr/bin/vacation_& program.
21576 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21577 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21578 setting
21579 .code
21580 message_prefix =
21581 .endd
21582 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21583 &`\n`& to &`\r\n`& in &%message_prefix%&.
21584
21585
21586 .option message_suffix pipe string&!! "see below"
21587 The string specified here is expanded and output at the end of every message.
21588 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21589 The suffix can be suppressed by setting
21590 .code
21591 message_suffix =
21592 .endd
21593 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21594 &`\n`& to &`\r\n`& in &%message_suffix%&.
21595
21596
21597 .option path pipe string "see below"
21598 This option specifies the string that is set up in the PATH environment
21599 variable of the subprocess. The default is:
21600 .code
21601 /bin:/usr/bin
21602 .endd
21603 If the &%command%& option does not yield an absolute path name, the command is
21604 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21605 apply to a command specified as a transport filter.
21606
21607
21608 .option permit_coredump pipe boolean false
21609 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21610 a core-dump of a pipe command, enable this command.  This enables core-dumps
21611 during delivery and affects both the Exim binary and the pipe command run.
21612 It is recommended that this option remain off unless and until you have a need
21613 for it and that this only be enabled when needed, as the risk of excessive
21614 resource consumption can be quite high.  Note also that Exim is typically
21615 installed as a setuid binary and most operating systems will inhibit coredumps
21616 of these by default, so further OS-specific action may be required.
21617
21618
21619 .option pipe_as_creator pipe boolean false
21620 .cindex "uid (user id)" "local delivery"
21621 If the generic &%user%& option is not set and this option is true, the delivery
21622 process is run under the uid that was in force when Exim was originally called
21623 to accept the message. If the group id is not otherwise set (via the generic
21624 &%group%& option), the gid that was in force when Exim was originally called to
21625 accept the message is used.
21626
21627
21628 .option restrict_to_path pipe boolean false
21629 When this option is set, any command name not listed in &%allow_commands%& must
21630 contain no slashes. The command is searched for only in the directories listed
21631 in the &%path%& option. This option is intended for use in the case when a pipe
21632 command has been generated from a user's &_.forward_& file. This is usually
21633 handled by a &(pipe)& transport called &%address_pipe%&.
21634
21635
21636 .option return_fail_output pipe boolean false
21637 If this option is true, and the command produced any output and ended with a
21638 return code other than zero or one of the codes listed in &%temp_errors%& (that
21639 is, the delivery failed), the output is returned in the bounce message.
21640 However, if the message has a null sender (that is, it is itself a bounce
21641 message), output from the command is discarded. This option and
21642 &%return_output%& are mutually exclusive. Only one of them may be set.
21643
21644
21645
21646 .option return_output pipe boolean false
21647 If this option is true, and the command produced any output, the delivery is
21648 deemed to have failed whatever the return code from the command, and the output
21649 is returned in the bounce message. Otherwise, the output is just discarded.
21650 However, if the message has a null sender (that is, it is a bounce message),
21651 output from the command is always discarded, whatever the setting of this
21652 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21653 of them may be set.
21654
21655
21656
21657 .option temp_errors pipe "string list" "see below"
21658 .cindex "&(pipe)& transport" "temporary failure"
21659 This option contains either a colon-separated list of numbers, or a single
21660 asterisk. If &%ignore_status%& is false
21661 and &%return_output%& is not set,
21662 and the command exits with a non-zero return code, the failure is treated as
21663 temporary and the delivery is deferred if the return code matches one of the
21664 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21665 codes are treated as permanent errors. The default setting contains the codes
21666 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21667 compiled on a system that does not define these macros, it assumes values of 75
21668 and 73, respectively.
21669
21670
21671 .option timeout pipe time 1h
21672 If the command fails to complete within this time, it is killed. This normally
21673 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21674 specifies no timeout. In order to ensure that any subprocesses created by the
21675 command are also killed, Exim makes the initial process a process group leader,
21676 and kills the whole process group on a timeout. However, this can be defeated
21677 if one of the processes starts a new process group.
21678
21679 .option timeout_defer pipe boolean false
21680 A timeout in a &(pipe)& transport, either in the command that the transport
21681 runs, or in a transport filter that is associated with it, is by default
21682 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21683 is set true, both kinds of timeout become temporary errors, causing the
21684 delivery to be deferred.
21685
21686 .option umask pipe "octal integer" 022
21687 This specifies the umask setting for the subprocess that runs the command.
21688
21689
21690 .option use_bsmtp pipe boolean false
21691 .cindex "envelope sender"
21692 If this option is set true, the &(pipe)& transport writes messages in &"batch
21693 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21694 commands. If you want to include a leading HELO command with such messages,
21695 you can do so by setting the &%message_prefix%& option. See section
21696 &<<SECTbatchSMTP>>& for details of batch SMTP.
21697
21698 .option use_classresources pipe boolean false
21699 .cindex "class resources (BSD)"
21700 This option is available only when Exim is running on FreeBSD, NetBSD, or
21701 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21702 resource limits when a &(pipe)& transport is run to perform a delivery. The
21703 limits for the uid under which the pipe is to run are obtained from the login
21704 class database.
21705
21706
21707 .option use_crlf pipe boolean false
21708 .cindex "carriage return"
21709 .cindex "linefeed"
21710 This option causes lines to be terminated with the two-character CRLF sequence
21711 (carriage return, linefeed) instead of just a linefeed character. In the case
21712 of batched SMTP, the byte sequence written to the pipe is then an exact image
21713 of what would be sent down a real SMTP connection.
21714
21715 The contents of the &%message_prefix%& and &%message_suffix%& options are
21716 written verbatim, so must contain their own carriage return characters if these
21717 are needed. When &%use_bsmtp%& is not set, the default values for both
21718 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21719 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21720
21721
21722 .option use_shell pipe boolean false
21723 .vindex "&$pipe_addresses$&"
21724 If this option is set, it causes the command to be passed to &_/bin/sh_&
21725 instead of being run directly from the transport, as described in section
21726 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21727 where the command is expected to be run under a shell and cannot easily be
21728 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21729 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21730 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21731 its &%-c%& option.
21732
21733
21734
21735 .section "Using an external local delivery agent" "SECID143"
21736 .cindex "local delivery" "using an external agent"
21737 .cindex "&'procmail'&"
21738 .cindex "external local delivery"
21739 .cindex "delivery" "&'procmail'&"
21740 .cindex "delivery" "by external agent"
21741 The &(pipe)& transport can be used to pass all messages that require local
21742 delivery to a separate local delivery agent such as &%procmail%&. When doing
21743 this, care must be taken to ensure that the pipe is run under an appropriate
21744 uid and gid. In some configurations one wants this to be a uid that is trusted
21745 by the delivery agent to supply the correct sender of the message. It may be
21746 necessary to recompile or reconfigure the delivery agent so that it trusts an
21747 appropriate user. The following is an example transport and router
21748 configuration for &%procmail%&:
21749 .code
21750 # transport
21751 procmail_pipe:
21752   driver = pipe
21753   command = /usr/local/bin/procmail -d $local_part
21754   return_path_add
21755   delivery_date_add
21756   envelope_to_add
21757   check_string = "From "
21758   escape_string = ">From "
21759   umask = 077
21760   user = $local_part
21761   group = mail
21762
21763 # router
21764 procmail:
21765   driver = accept
21766   check_local_user
21767   transport = procmail_pipe
21768 .endd
21769 In this example, the pipe is run as the local user, but with the group set to
21770 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21771 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21772 user to supply a correct sender address. If you do not specify either a
21773 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21774 home directory is the user's home directory by default.
21775
21776 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21777 .code
21778 IFS=" "
21779 .endd
21780 as shown in some &%procmail%& documentation, because Exim does not by default
21781 use a shell to run pipe commands.
21782
21783 .cindex "Cyrus"
21784 The next example shows a transport and a router for a system where local
21785 deliveries are handled by the Cyrus IMAP server.
21786 .code
21787 # transport
21788 local_delivery_cyrus:
21789   driver = pipe
21790   command = /usr/cyrus/bin/deliver \
21791             -m ${substr_1:$local_part_suffix} -- $local_part
21792   user = cyrus
21793   group = mail
21794   return_output
21795   log_output
21796   message_prefix =
21797   message_suffix =
21798
21799 # router
21800 local_user_cyrus:
21801   driver = accept
21802   check_local_user
21803   local_part_suffix = .*
21804   transport = local_delivery_cyrus
21805 .endd
21806 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21807 &%return_output%& to cause any text written by Cyrus to be returned to the
21808 sender.
21809 .ecindex IIDpiptra1
21810 .ecindex IIDpiptra2
21811
21812
21813 . ////////////////////////////////////////////////////////////////////////////
21814 . ////////////////////////////////////////////////////////////////////////////
21815
21816 .chapter "The smtp transport" "CHAPsmtptrans"
21817 .scindex IIDsmttra1 "transports" "&(smtp)&"
21818 .scindex IIDsmttra2 "&(smtp)& transport"
21819 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21820 or LMTP protocol. The list of hosts to try can either be taken from the address
21821 that is being processed (having been set up by the router), or specified
21822 explicitly for the transport. Timeout and retry processing (see chapter
21823 &<<CHAPretry>>&) is applied to each IP address independently.
21824
21825
21826 .section "Multiple messages on a single connection" "SECID144"
21827 The sending of multiple messages over a single TCP/IP connection can arise in
21828 two ways:
21829
21830 .ilist
21831 If a message contains more than &%max_rcpt%& (see below) addresses that are
21832 routed to the same host, more than one copy of the message has to be sent to
21833 that host. In this situation, multiple copies may be sent in a single run of
21834 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21835 does when it has too many addresses to send in one message also depends on the
21836 value of the global &%remote_max_parallel%& option. Details are given in
21837 section &<<SECToutSMTPTCP>>&.)
21838 .next
21839 .cindex "hints database" "remembering routing"
21840 When a message has been successfully delivered over a TCP/IP connection, Exim
21841 looks in its hints database to see if there are any other messages awaiting a
21842 connection to the same host. If there are, a new delivery process is started
21843 for one of them, and the current TCP/IP connection is passed on to it. The new
21844 process may in turn send multiple copies and possibly create yet another
21845 process.
21846 .endlist
21847
21848
21849 For each copy sent over the same TCP/IP connection, a sequence counter is
21850 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21851 no further messages are sent over that connection.
21852
21853
21854
21855 .section "Use of the $host and $host_address variables" "SECID145"
21856 .vindex "&$host$&"
21857 .vindex "&$host_address$&"
21858 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21859 &$host_address$& are the name and IP address of the first host on the host list
21860 passed by the router. However, when the transport is about to connect to a
21861 specific host, and while it is connected to that host, &$host$& and
21862 &$host_address$& are set to the values for that host. These are the values
21863 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21864 &%serialize_hosts%&, and the various TLS options are expanded.
21865
21866
21867 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21868 .vindex &$tls_bits$&
21869 .vindex &$tls_cipher$&
21870 .vindex &$tls_peerdn$&
21871 .vindex &$tls_sni$&
21872 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
21873 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
21874 are the values that were set when the message was received.
21875 These are the values that are used for options that are expanded before any
21876 SMTP connections are made. Just before each connection is made, these four
21877 variables are emptied. If TLS is subsequently started, they are set to the
21878 appropriate values for the outgoing connection, and these are the values that
21879 are in force when any authenticators are run and when the
21880 &%authenticated_sender%& option is expanded.
21881
21882
21883 .section "Private options for smtp" "SECID146"
21884 .cindex "options" "&(smtp)& transport"
21885 The private options of the &(smtp)& transport are as follows:
21886
21887
21888 .option address_retry_include_sender smtp boolean true
21889 .cindex "4&'xx'& responses" "retrying after"
21890 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21891 is the combination of sender and recipient that is delayed in subsequent queue
21892 runs until the retry time is reached. You can delay the recipient without
21893 reference to the sender (which is what earlier versions of Exim did), by
21894 setting &%address_retry_include_sender%& false. However, this can lead to
21895 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21896
21897 .option allow_localhost smtp boolean false
21898 .cindex "local host" "sending to"
21899 .cindex "fallback" "hosts specified on transport"
21900 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21901 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21902 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21903 the delivery anyway. This should be used only in special cases when the
21904 configuration ensures that no looping will result (for example, a differently
21905 configured Exim is listening on the port to which the message is sent).
21906
21907
21908 .option authenticated_sender smtp string&!! unset
21909 .cindex "Cyrus"
21910 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21911 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21912 overriding any existing authenticated sender value. If the string expansion is
21913 forced to fail, the option is ignored. Other expansion failures cause delivery
21914 to be deferred. If the result of expansion is an empty string, that is also
21915 ignored.
21916
21917 The expansion happens after the outgoing connection has been made and TLS
21918 started, if required. This means that the &$host$&, &$host_address$&,
21919 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21920 particular connection.
21921
21922 If the SMTP session is not authenticated, the expansion of
21923 &%authenticated_sender%& still happens (and can cause the delivery to be
21924 deferred if it fails), but no AUTH= item is added to MAIL commands
21925 unless &%authenticated_sender_force%& is true.
21926
21927 This option allows you to use the &(smtp)& transport in LMTP mode to
21928 deliver mail to Cyrus IMAP and provide the proper local part as the
21929 &"authenticated sender"&, via a setting such as:
21930 .code
21931 authenticated_sender = $local_part
21932 .endd
21933 This removes the need for IMAP subfolders to be assigned special ACLs to
21934 allow direct delivery to those subfolders.
21935
21936 Because of expected uses such as that just described for Cyrus (when no
21937 domain is involved), there is no checking on the syntax of the provided
21938 value.
21939
21940
21941 .option authenticated_sender_force smtp boolean false
21942 If this option is set true, the &%authenticated_sender%& option's value
21943 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21944 authenticated as a client.
21945
21946
21947 .option command_timeout smtp time 5m
21948 This sets a timeout for receiving a response to an SMTP command that has been
21949 sent out. It is also used when waiting for the initial banner line from the
21950 remote host. Its value must not be zero.
21951
21952
21953 .option connect_timeout smtp time 5m
21954 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21955 to a remote host. A setting of zero allows the system timeout (typically
21956 several minutes) to act. To have any effect, the value of this option must be
21957 less than the system timeout. However, it has been observed that on some
21958 systems there is no system timeout, which is why the default value for this
21959 option is 5 minutes, a value recommended by RFC 1123.
21960
21961
21962 .option connection_max_messages smtp integer 500
21963 .cindex "SMTP" "passed connection"
21964 .cindex "SMTP" "multiple deliveries"
21965 .cindex "multiple SMTP deliveries"
21966 This controls the maximum number of separate message deliveries that are sent
21967 over a single TCP/IP connection. If the value is zero, there is no limit.
21968 For testing purposes, this value can be overridden by the &%-oB%& command line
21969 option.
21970
21971
21972 .option data_timeout smtp time 5m
21973 This sets a timeout for the transmission of each block in the data portion of
21974 the message. As a result, the overall timeout for a message depends on the size
21975 of the message. Its value must not be zero. See also &%final_timeout%&.
21976
21977
21978 .option delay_after_cutoff smtp boolean true
21979 This option controls what happens when all remote IP addresses for a given
21980 domain have been inaccessible for so long that they have passed their retry
21981 cutoff times.
21982
21983 In the default state, if the next retry time has not been reached for any of
21984 them, the address is bounced without trying any deliveries. In other words,
21985 Exim delays retrying an IP address after the final cutoff time until a new
21986 retry time is reached, and can therefore bounce an address without ever trying
21987 a delivery, when machines have been down for a long time. Some people are
21988 unhappy at this prospect, so...
21989
21990 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21991 addresses are past their final cutoff time, Exim tries to deliver to those
21992 IP addresses that have not been tried since the message arrived. If there are
21993 none, of if they all fail, the address is bounced. In other words, it does not
21994 delay when a new message arrives, but immediately tries those expired IP
21995 addresses that haven't been tried since the message arrived. If there is a
21996 continuous stream of messages for the dead hosts, unsetting
21997 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21998 to them.
21999
22000
22001 .option dns_qualify_single smtp boolean true
22002 If the &%hosts%& or &%fallback_hosts%& option is being used,
22003 and the &%gethostbyname%& option is false,
22004 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22005 in chapter &<<CHAPdnslookup>>& for more details.
22006
22007
22008 .option dns_search_parents smtp boolean false
22009 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22010 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22011 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22012 details.
22013
22014
22015
22016 .option fallback_hosts smtp "string list" unset
22017 .cindex "fallback" "hosts specified on transport"
22018 String expansion is not applied to this option. The argument must be a
22019 colon-separated list of host names or IP addresses, optionally also including
22020 port numbers, though the separator can be changed, as described in section
22021 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22022 item in a &%route_list%& setting for the &(manualroute)& router, as described
22023 in section &<<SECTformatonehostitem>>&.
22024
22025 Fallback hosts can also be specified on routers, which associate them with the
22026 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22027 &%fallback_hosts%& specified on the transport is used only if the address does
22028 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22029 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22030 However, &%hosts_randomize%& does apply to fallback host lists.
22031
22032 If Exim is unable to deliver to any of the hosts for a particular address, and
22033 the errors are not permanent rejections, the address is put on a separate
22034 transport queue with its host list replaced by the fallback hosts, unless the
22035 address was routed via MX records and the current host was in the original MX
22036 list. In that situation, the fallback host list is not used.
22037
22038 Once normal deliveries are complete, the fallback queue is delivered by
22039 re-running the same transports with the new host lists. If several failing
22040 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22041 copy of the message is sent.
22042
22043 The resolution of the host names on the fallback list is controlled by the
22044 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22045 both to cases when the host list comes with the address and when it is taken
22046 from &%hosts%&. This option provides a &"use a smart host only if delivery
22047 fails"& facility.
22048
22049
22050 .option final_timeout smtp time 10m
22051 This is the timeout that applies while waiting for the response to the final
22052 line containing just &"."& that terminates a message. Its value must not be
22053 zero.
22054
22055 .option gethostbyname smtp boolean false
22056 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22057 being used, names are looked up using &[gethostbyname()]&
22058 (or &[getipnodebyname()]& when available)
22059 instead of using the DNS. Of course, that function may in fact use the DNS, but
22060 it may also consult other sources of information such as &_/etc/hosts_&.
22061
22062 .option gnutls_compat_mode smtp boolean unset
22063 This option controls whether GnuTLS is used in compatibility mode in an Exim
22064 server. This reduces security slightly, but improves interworking with older
22065 implementations of TLS.
22066
22067 .option helo_data smtp string&!! "see below"
22068 .cindex "HELO" "argument, setting"
22069 .cindex "EHLO" "argument, setting"
22070 .cindex "LHLO argument setting"
22071 The value of this option is expanded after a connection to a another host has
22072 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22073 command that starts the outgoing SMTP or LMTP session. The default value of the
22074 option is:
22075 .code
22076 $primary_hostname
22077 .endd
22078 During the expansion, the variables &$host$& and &$host_address$& are set to
22079 the identity of the remote host, and the variables &$sending_ip_address$& and
22080 &$sending_port$& are set to the local IP address and port number that are being
22081 used. These variables can be used to generate different values for different
22082 servers or different local IP addresses. For example, if you want the string
22083 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22084 interface address, you could use this:
22085 .code
22086 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22087   {$primary_hostname}}
22088 .endd
22089 The use of &%helo_data%& applies both to sending messages and when doing
22090 callouts.
22091
22092 .option hosts smtp "string list&!!" unset
22093 Hosts are associated with an address by a router such as &(dnslookup)&, which
22094 finds the hosts by looking up the address domain in the DNS, or by
22095 &(manualroute)&, which has lists of hosts in its configuration. However,
22096 email addresses can be passed to the &(smtp)& transport by any router, and not
22097 all of them can provide an associated list of hosts.
22098
22099 The &%hosts%& option specifies a list of hosts to be used if the address being
22100 processed does not have any hosts associated with it. The hosts specified by
22101 &%hosts%& are also used, whether or not the address has its own hosts, if
22102 &%hosts_override%& is set.
22103
22104 The string is first expanded, before being interpreted as a colon-separated
22105 list of host names or IP addresses, possibly including port numbers. The
22106 separator may be changed to something other than colon, as described in section
22107 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22108 item in a &%route_list%& setting for the &(manualroute)& router, as described
22109 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22110 of the &(manualroute)& router is not available here.
22111
22112 If the expansion fails, delivery is deferred. Unless the failure was caused by
22113 the inability to complete a lookup, the error is logged to the panic log as
22114 well as the main log. Host names are looked up either by searching directly for
22115 address records in the DNS or by calling &[gethostbyname()]& (or
22116 &[getipnodebyname()]& when available), depending on the setting of the
22117 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22118 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22119 address are used.
22120
22121 During delivery, the hosts are tried in order, subject to their retry status,
22122 unless &%hosts_randomize%& is set.
22123
22124
22125 .option hosts_avoid_esmtp smtp "host list&!!" unset
22126 .cindex "ESMTP, avoiding use of"
22127 .cindex "HELO" "forcing use of"
22128 .cindex "EHLO" "avoiding use of"
22129 .cindex "PIPELINING" "avoiding the use of"
22130 This option is for use with broken hosts that announce ESMTP facilities (for
22131 example, PIPELINING) and then fail to implement them properly. When a host
22132 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22133 start of the SMTP session. This means that it cannot use any of the ESMTP
22134 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22135
22136
22137 .option hosts_avoid_pipelining smtp "host list&!!" unset
22138 .cindex "PIPELINING" "avoiding the use of"
22139 Exim will not use the SMTP PIPELINING extension when delivering to any host
22140 that matches this list, even if the server host advertises PIPELINING support.
22141
22142
22143 .option hosts_avoid_tls smtp "host list&!!" unset
22144 .cindex "TLS" "avoiding for certain hosts"
22145 Exim will not try to start a TLS session when delivering to any host that
22146 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22147
22148
22149 .option hosts_max_try smtp integer 5
22150 .cindex "host" "maximum number to try"
22151 .cindex "limit" "number of hosts tried"
22152 .cindex "limit" "number of MX tried"
22153 .cindex "MX record" "maximum tried"
22154 This option limits the number of IP addresses that are tried for any one
22155 delivery in cases where there are temporary delivery errors. Section
22156 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22157
22158
22159 .option hosts_max_try_hardlimit smtp integer 50
22160 This is an additional check on the maximum number of IP addresses that Exim
22161 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22162 why it exists.
22163
22164
22165
22166 .option hosts_nopass_tls smtp "host list&!!" unset
22167 .cindex "TLS" "passing connection"
22168 .cindex "multiple SMTP deliveries"
22169 .cindex "TLS" "multiple message deliveries"
22170 For any host that matches this list, a connection on which a TLS session has
22171 been started will not be passed to a new delivery process for sending another
22172 message on the same connection. See section &<<SECTmulmessam>>& for an
22173 explanation of when this might be needed.
22174
22175
22176 .option hosts_override smtp boolean false
22177 If this option is set and the &%hosts%& option is also set, any hosts that are
22178 attached to the address are ignored, and instead the hosts specified by the
22179 &%hosts%& option are always used. This option does not apply to
22180 &%fallback_hosts%&.
22181
22182
22183 .option hosts_randomize smtp boolean false
22184 .cindex "randomized host list"
22185 .cindex "host" "list of; randomized"
22186 .cindex "fallback" "randomized hosts"
22187 If this option is set, and either the list of hosts is taken from the
22188 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22189 were not obtained from MX records (this includes fallback hosts from the
22190 router), and were not randomized by the router, the order of trying the hosts
22191 is randomized each time the transport runs. Randomizing the order of a host
22192 list can be used to do crude load sharing.
22193
22194 When &%hosts_randomize%& is true, a host list may be split into groups whose
22195 order is separately randomized. This makes it possible to set up MX-like
22196 behaviour. The boundaries between groups are indicated by an item that is just
22197 &`+`& in the host list. For example:
22198 .code
22199 hosts = host1:host2:host3:+:host4:host5
22200 .endd
22201 The order of the first three hosts and the order of the last two hosts is
22202 randomized for each use, but the first three always end up before the last two.
22203 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22204
22205 .option hosts_require_auth smtp "host list&!!" unset
22206 .cindex "authentication" "required by client"
22207 This option provides a list of servers for which authentication must succeed
22208 before Exim will try to transfer a message. If authentication fails for
22209 servers which are not in this list, Exim tries to send unauthenticated. If
22210 authentication fails for one of these servers, delivery is deferred. This
22211 temporary error is detectable in the retry rules, so it can be turned into a
22212 hard failure if required. See also &%hosts_try_auth%&, and chapter
22213 &<<CHAPSMTPAUTH>>& for details of authentication.
22214
22215
22216 .option hosts_require_tls smtp "host list&!!" unset
22217 .cindex "TLS" "requiring for certain servers"
22218 Exim will insist on using a TLS session when delivering to any host that
22219 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22220 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22221 incoming messages, use an appropriate ACL.
22222
22223 .option hosts_try_auth smtp "host list&!!" unset
22224 .cindex "authentication" "optional in client"
22225 This option provides a list of servers to which, provided they announce
22226 authentication support, Exim will attempt to authenticate as a client when it
22227 connects. If authentication fails, Exim will try to transfer the message
22228 unauthenticated. See also &%hosts_require_auth%&, and chapter
22229 &<<CHAPSMTPAUTH>>& for details of authentication.
22230
22231 .option interface smtp "string list&!!" unset
22232 .cindex "bind IP address"
22233 .cindex "IP address" "binding"
22234 .vindex "&$host$&"
22235 .vindex "&$host_address$&"
22236 This option specifies which interface to bind to when making an outgoing SMTP
22237 call. The value is an IP address, not an interface name such as
22238 &`eth0`&. Do not confuse this with the interface address that was used when a
22239 message was received, which is in &$received_ip_address$&, formerly known as
22240 &$interface_address$&. The name was changed to minimize confusion with the
22241 outgoing interface address. There is no variable that contains an outgoing
22242 interface address because, unless it is set by this option, its value is
22243 unknown.
22244
22245 During the expansion of the &%interface%& option the variables &$host$& and
22246 &$host_address$& refer to the host to which a connection is about to be made
22247 during the expansion of the string. Forced expansion failure, or an empty
22248 string result causes the option to be ignored. Otherwise, after expansion, the
22249 string must be a list of IP addresses, colon-separated by default, but the
22250 separator can be changed in the usual way. For example:
22251 .code
22252 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22253 .endd
22254 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22255 connection. If none of them are the correct type, the option is ignored. If
22256 &%interface%& is not set, or is ignored, the system's IP functions choose which
22257 interface to use if the host has more than one.
22258
22259
22260 .option keepalive smtp boolean true
22261 .cindex "keepalive" "on outgoing connection"
22262 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22263 connections. When set, it causes the kernel to probe idle connections
22264 periodically, by sending packets with &"old"& sequence numbers. The other end
22265 of the connection should send a acknowledgment if the connection is still okay
22266 or a reset if the connection has been aborted. The reason for doing this is
22267 that it has the beneficial effect of freeing up certain types of connection
22268 that can get stuck when the remote host is disconnected without tidying up the
22269 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22270 unreachable hosts.
22271
22272
22273 .option lmtp_ignore_quota smtp boolean false
22274 .cindex "LMTP" "ignoring quota errors"
22275 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22276 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22277 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22278
22279 .option max_rcpt smtp integer 100
22280 .cindex "RCPT" "maximum number of outgoing"
22281 This option limits the number of RCPT commands that are sent in a single
22282 SMTP message transaction. Each set of addresses is treated independently, and
22283 so can cause parallel connections to the same host if &%remote_max_parallel%&
22284 permits this.
22285
22286
22287 .option multi_domain smtp boolean true
22288 .vindex "&$domain$&"
22289 When this option is set, the &(smtp)& transport can handle a number of
22290 addresses containing a mixture of different domains provided they all resolve
22291 to the same list of hosts. Turning the option off restricts the transport to
22292 handling only one domain at a time. This is useful if you want to use
22293 &$domain$& in an expansion for the transport, because it is set only when there
22294 is a single domain involved in a remote delivery.
22295
22296
22297 .option port smtp string&!! "see below"
22298 .cindex "port" "sending TCP/IP"
22299 .cindex "TCP/IP" "setting outgoing port"
22300 This option specifies the TCP/IP port on the server to which Exim connects.
22301 &*Note:*& Do not confuse this with the port that was used when a message was
22302 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22303 The name was changed to minimize confusion with the outgoing port. There is no
22304 variable that contains an outgoing port.
22305
22306 If the value of this option begins with a digit it is taken as a port number;
22307 otherwise it is looked up using &[getservbyname()]&. The default value is
22308 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22309 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22310 is deferred.
22311
22312
22313
22314 .option protocol smtp string smtp
22315 .cindex "LMTP" "over TCP/IP"
22316 .cindex "ssmtp protocol" "outbound"
22317 .cindex "TLS" "SSL-on-connect outbound"
22318 .vindex "&$port$&"
22319 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22320 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22321 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22322 deliveries into closed message stores. Exim also has support for running LMTP
22323 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22324
22325 .new
22326 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22327 changes to &"smtps"&, and the transport initiates TLS immediately after
22328 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22329 The Internet standards bodies strongly discourage use of this mode.
22330 .wen
22331
22332
22333 .option retry_include_ip_address smtp boolean true
22334 Exim normally includes both the host name and the IP address in the key it
22335 constructs for indexing retry data after a temporary delivery failure. This
22336 means that when one of several IP addresses for a host is failing, it gets
22337 tried periodically (controlled by the retry rules), but use of the other IP
22338 addresses is not affected.
22339
22340 However, in some dialup environments hosts are assigned a different IP address
22341 each time they connect. In this situation the use of the IP address as part of
22342 the retry key leads to undesirable behaviour. Setting this option false causes
22343 Exim to use only the host name. This should normally be done on a separate
22344 instance of the &(smtp)& transport, set up specially to handle the dialup
22345 hosts.
22346
22347
22348 .option serialize_hosts smtp "host list&!!" unset
22349 .cindex "serializing connections"
22350 .cindex "host" "serializing connections"
22351 Because Exim operates in a distributed manner, if several messages for the same
22352 host arrive at around the same time, more than one simultaneous connection to
22353 the remote host can occur. This is not usually a problem except when there is a
22354 slow link between the hosts. In that situation it may be helpful to restrict
22355 Exim to one connection at a time. This can be done by setting
22356 &%serialize_hosts%& to match the relevant hosts.
22357
22358 .cindex "hints database" "serializing deliveries to a host"
22359 Exim implements serialization by means of a hints database in which a record is
22360 written whenever a process connects to one of the restricted hosts. The record
22361 is deleted when the connection is completed. Obviously there is scope for
22362 records to get left lying around if there is a system or program crash. To
22363 guard against this, Exim ignores any records that are more than six hours old.
22364
22365 If you set up this kind of serialization, you should also arrange to delete the
22366 relevant hints database whenever your system reboots. The names of the files
22367 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22368 may be one or two files, depending on the type of DBM in use. The same files
22369 are used for ETRN serialization.
22370
22371
22372 .option size_addition smtp integer 1024
22373 .cindex "SMTP" "SIZE"
22374 .cindex "message" "size issue for transport filter"
22375 .cindex "size" "of message"
22376 .cindex "transport" "filter"
22377 .cindex "filter" "transport filter"
22378 If a remote SMTP server indicates that it supports the SIZE option of the
22379 MAIL command, Exim uses this to pass over the message size at the start of
22380 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22381 sends, to allow for headers and other text that may be added during delivery by
22382 configuration options or in a transport filter. It may be necessary to increase
22383 this if a lot of text is added to messages.
22384
22385 Alternatively, if the value of &%size_addition%& is set negative, it disables
22386 the use of the SIZE option altogether.
22387
22388
22389 .option tls_certificate smtp string&!! unset
22390 .cindex "TLS" "client certificate, location of"
22391 .cindex "certificate" "client, location of"
22392 .vindex "&$host$&"
22393 .vindex "&$host_address$&"
22394 The value of this option must be the absolute path to a file which contains the
22395 client's certificate, for possible use when sending a message over an encrypted
22396 connection. The values of &$host$& and &$host_address$& are set to the name and
22397 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22398 details of TLS.
22399
22400 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22401 certificate when sending messages as a client. The global option of the same
22402 name specifies the certificate for Exim as a server; it is not automatically
22403 assumed that the same certificate should be used when Exim is operating as a
22404 client.
22405
22406
22407 .option tls_crl smtp string&!! unset
22408 .cindex "TLS" "client certificate revocation list"
22409 .cindex "certificate" "revocation list for client"
22410 This option specifies a certificate revocation list. The expanded value must
22411 be the name of a file that contains a CRL in PEM format.
22412
22413
22414 .option tls_privatekey smtp string&!! unset
22415 .cindex "TLS" "client private key, location of"
22416 .vindex "&$host$&"
22417 .vindex "&$host_address$&"
22418 The value of this option must be the absolute path to a file which contains the
22419 client's private key. This is used when sending a message over an encrypted
22420 connection using a client certificate. The values of &$host$& and
22421 &$host_address$& are set to the name and address of the server during the
22422 expansion. If this option is unset, or the expansion is forced to fail, or the
22423 result is an empty string, the private key is assumed to be in the same file as
22424 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22425
22426
22427 .option tls_require_ciphers smtp string&!! unset
22428 .cindex "TLS" "requiring specific ciphers"
22429 .cindex "cipher" "requiring specific"
22430 .vindex "&$host$&"
22431 .vindex "&$host_address$&"
22432 The value of this option must be a list of permitted cipher suites, for use
22433 when setting up an outgoing encrypted connection. (There is a global option of
22434 the same name for controlling incoming connections.) The values of &$host$& and
22435 &$host_address$& are set to the name and address of the server during the
22436 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22437 is used in different ways by OpenSSL and GnuTLS (see sections
22438 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22439 ciphers is a preference order.
22440
22441
22442
22443 .new
22444 .option tls_sni smtp string&!! unset
22445 .cindex "TLS" "Server Name Indication"
22446 .vindex "&$tls_sni$&"
22447 If this option is set then it sets the $tls_sni variable and causes any
22448 TLS session to pass this value as the Server Name Indication extension to
22449 the remote side, which can be used by the remote side to select an appropriate
22450 certificate and private key for the session.
22451
22452 See &<<SECTtlssni>>& for more information.
22453
22454 OpenSSL only, also requiring a build of OpenSSL that supports TLS extensions.
22455 .wen
22456
22457
22458
22459 .option tls_tempfail_tryclear smtp boolean true
22460 .cindex "4&'xx'& responses" "to STARTTLS"
22461 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22462 setting up a TLS session, this option determines whether or not Exim should try
22463 to deliver the message unencrypted. If it is set false, delivery to the
22464 current host is deferred; if there are other hosts, they are tried. If this
22465 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22466 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22467 TLS negotiation fails, Exim closes the current connection (because it is in an
22468 unknown state), opens a new one to the same host, and then tries the delivery
22469 in clear.
22470
22471
22472 .option tls_verify_certificates smtp string&!! unset
22473 .cindex "TLS" "server certificate verification"
22474 .cindex "certificate" "verification of server"
22475 .vindex "&$host$&"
22476 .vindex "&$host_address$&"
22477 The value of this option must be the absolute path to a file containing
22478 permitted server certificates, for use when setting up an encrypted connection.
22479 Alternatively, if you are using OpenSSL, you can set
22480 &%tls_verify_certificates%& to the name of a directory containing certificate
22481 files. This does not work with GnuTLS; the option must be set to the name of a
22482 single file if you are using GnuTLS. The values of &$host$& and
22483 &$host_address$& are set to the name and address of the server during the
22484 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22485
22486
22487
22488
22489 .section "How the limits for the number of hosts to try are used" &&&
22490          "SECTvalhosmax"
22491 .cindex "host" "maximum number to try"
22492 .cindex "limit" "hosts; maximum number tried"
22493 There are two options that are concerned with the number of hosts that are
22494 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22495 &%hosts_max_try_hardlimit%&.
22496
22497
22498 The &%hosts_max_try%& option limits the number of hosts that are tried
22499 for a single delivery. However, despite the term &"host"& in its name, the
22500 option actually applies to each IP address independently. In other words, a
22501 multihomed host is treated as several independent hosts, just as it is for
22502 retrying.
22503
22504 Many of the larger ISPs have multiple MX records which often point to
22505 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22506 created as a result of routing one of these domains.
22507
22508 Trying every single IP address on such a long list does not seem sensible; if
22509 several at the top of the list fail, it is reasonable to assume there is some
22510 problem that is likely to affect all of them. Roughly speaking, the value of
22511 &%hosts_max_try%& is the maximum number that are tried before deferring the
22512 delivery. However, the logic cannot be quite that simple.
22513
22514 Firstly, IP addresses that are skipped because their retry times have not
22515 arrived do not count, and in addition, addresses that are past their retry
22516 limits are also not counted, even when they are tried. This means that when
22517 some IP addresses are past their retry limits, more than the value of
22518 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22519 that all IP addresses are considered before timing out an email address (but
22520 see below for an exception).
22521
22522 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22523 list to see if there is a subsequent host with a different (higher valued) MX.
22524 If there is, that host is considered next, and the current IP address is used
22525 but not counted. This behaviour helps in the case of a domain with a retry rule
22526 that hardly ever delays any hosts, as is now explained:
22527
22528 Consider the case of a long list of hosts with one MX value, and a few with a
22529 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22530 hosts at the top of the list are tried at first. With the default retry rule,
22531 which specifies increasing retry times, the higher MX hosts are eventually
22532 tried when those at the top of the list are skipped because they have not
22533 reached their retry times.
22534
22535 However, it is common practice to put a fixed short retry time on domains for
22536 large ISPs, on the grounds that their servers are rarely down for very long.
22537 Unfortunately, these are exactly the domains that tend to resolve to long lists
22538 of hosts. The short retry time means that the lowest MX hosts are tried every
22539 time. The attempts may be in a different order because of random sorting, but
22540 without the special MX check, the higher MX hosts would never be tried until
22541 all the lower MX hosts had timed out (which might be several days), because
22542 there are always some lower MX hosts that have reached their retry times. With
22543 the special check, Exim considers at least one IP address from each MX value at
22544 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22545 reached.
22546
22547 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22548 particular, Exim normally eventually tries all the IP addresses before timing
22549 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22550 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22551 been set up with hundreds of IP addresses for some domains. It can
22552 take a very long time indeed for an address to time out in these cases.
22553
22554 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22555 Exim never tries more than this number of IP addresses; if it hits this limit
22556 and they are all timed out, the email address is bounced, even though not all
22557 possible IP addresses have been tried.
22558 .ecindex IIDsmttra1
22559 .ecindex IIDsmttra2
22560
22561
22562
22563
22564
22565 . ////////////////////////////////////////////////////////////////////////////
22566 . ////////////////////////////////////////////////////////////////////////////
22567
22568 .chapter "Address rewriting" "CHAPrewrite"
22569 .scindex IIDaddrew "rewriting" "addresses"
22570 There are some circumstances in which Exim automatically rewrites domains in
22571 addresses. The two most common are when an address is given without a domain
22572 (referred to as an &"unqualified address"&) or when an address contains an
22573 abbreviated domain that is expanded by DNS lookup.
22574
22575 Unqualified envelope addresses are accepted only for locally submitted
22576 messages, or for messages that are received from hosts matching
22577 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22578 appropriate. Unqualified addresses in header lines are qualified if they are in
22579 locally submitted messages, or messages from hosts that are permitted to send
22580 unqualified envelope addresses. Otherwise, unqualified addresses in header
22581 lines are neither qualified nor rewritten.
22582
22583 One situation in which Exim does &'not'& automatically rewrite a domain is
22584 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22585 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22586 do this. The new RFCs do not contain this suggestion.
22587
22588
22589 .section "Explicitly configured address rewriting" "SECID147"
22590 This chapter describes the rewriting rules that can be used in the
22591 main rewrite section of the configuration file, and also in the generic
22592 &%headers_rewrite%& option that can be set on any transport.
22593
22594 Some people believe that configured address rewriting is a Mortal Sin.
22595 Others believe that life is not possible without it. Exim provides the
22596 facility; you do not have to use it.
22597
22598 The main rewriting rules that appear in the &"rewrite"& section of the
22599 configuration file are applied to addresses in incoming messages, both envelope
22600 addresses and addresses in header lines. Each rule specifies the types of
22601 address to which it applies.
22602
22603 Whether or not addresses in header lines are rewritten depends on the origin of
22604 the headers and the type of rewriting. Global rewriting, that is, rewriting
22605 rules from the rewrite section of the configuration file, is applied only to
22606 those headers that were received with the message. Header lines that are added
22607 by ACLs or by a system filter or by individual routers or transports (which
22608 are specific to individual recipient addresses) are not rewritten by the global
22609 rules.
22610
22611 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22612 applies all headers except those added by routers and transports. That is, as
22613 well as the headers that were received with the message, it also applies to
22614 headers that were added by an ACL or a system filter.
22615
22616
22617 In general, rewriting addresses from your own system or domain has some
22618 legitimacy. Rewriting other addresses should be done only with great care and
22619 in special circumstances. The author of Exim believes that rewriting should be
22620 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22621 Although it can sometimes be used as a routing tool, this is very strongly
22622 discouraged.
22623
22624 There are two commonly encountered circumstances where rewriting is used, as
22625 illustrated by these examples:
22626
22627 .ilist
22628 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22629 exchange mail with each other behind a firewall, but there is only a single
22630 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22631 &'hitch.fict.example'& when sending mail off-site.
22632 .next
22633 A host rewrites the local parts of its own users so that, for example,
22634 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22635 .endlist
22636
22637
22638
22639 .section "When does rewriting happen?" "SECID148"
22640 .cindex "rewriting" "timing of"
22641 .cindex "&ACL;" "rewriting addresses in"
22642 Configured address rewriting can take place at several different stages of a
22643 message's processing.
22644
22645 .vindex "&$sender_address$&"
22646 At the start of an ACL for MAIL, the sender address may have been rewritten
22647 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22648 ordinary rewrite rules have yet been applied. If, however, the sender address
22649 is verified in the ACL, it is rewritten before verification, and remains
22650 rewritten thereafter. The subsequent value of &$sender_address$& is the
22651 rewritten address. This also applies if sender verification happens in a
22652 RCPT ACL. Otherwise, when the sender address is not verified, it is
22653 rewritten as soon as a message's header lines have been received.
22654
22655 .vindex "&$domain$&"
22656 .vindex "&$local_part$&"
22657 Similarly, at the start of an ACL for RCPT, the current recipient's address
22658 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22659 rewrite rules have yet been applied to it. However, the behaviour is different
22660 from the sender address when a recipient is verified. The address is rewritten
22661 for the verification, but the rewriting is not remembered at this stage. The
22662 value of &$local_part$& and &$domain$& after verification are always the same
22663 as they were before (that is, they contain the unrewritten &-- except for
22664 SMTP-time rewriting &-- address).
22665
22666 As soon as a message's header lines have been received, all the envelope
22667 recipient addresses are permanently rewritten, and rewriting is also applied to
22668 the addresses in the header lines (if configured). This happens before adding
22669 any header lines that were specified in MAIL or RCPT ACLs, and
22670 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22671 before the DATA ACL and &[local_scan()]& functions are run.
22672
22673 When an address is being routed, either for delivery or for verification,
22674 rewriting is applied immediately to child addresses that are generated by
22675 redirection, unless &%no_rewrite%& is set on the router.
22676
22677 .cindex "envelope sender" "rewriting at transport time"
22678 .cindex "rewriting" "at transport time"
22679 .cindex "header lines" "rewriting at transport time"
22680 At transport time, additional rewriting of addresses in header lines can be
22681 specified by setting the generic &%headers_rewrite%& option on a transport.
22682 This option contains rules that are identical in form to those in the rewrite
22683 section of the configuration file. They are applied to the original message
22684 header lines and any that were added by ACLs or a system filter. They are not
22685 applied to header lines that are added by routers or the transport.
22686
22687 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22688 transport option. However, it is not possible to rewrite envelope recipients at
22689 transport time.
22690
22691
22692
22693
22694 .section "Testing the rewriting rules that apply on input" "SECID149"
22695 .cindex "rewriting" "testing"
22696 .cindex "testing" "rewriting"
22697 Exim's input rewriting configuration appears in a part of the run time
22698 configuration file headed by &"begin rewrite"&. It can be tested by the
22699 &%-brw%& command line option. This takes an address (which can be a full RFC
22700 2822 address) as its argument. The output is a list of how the address would be
22701 transformed by the rewriting rules for each of the different places it might
22702 appear in an incoming message, that is, for each different header and for the
22703 envelope sender and recipient fields. For example,
22704 .code
22705 exim -brw ph10@exim.workshop.example
22706 .endd
22707 might produce the output
22708 .code
22709 sender: Philip.Hazel@exim.workshop.example
22710 from: Philip.Hazel@exim.workshop.example
22711 to: ph10@exim.workshop.example
22712 cc: ph10@exim.workshop.example
22713 bcc: ph10@exim.workshop.example
22714 reply-to: Philip.Hazel@exim.workshop.example
22715 env-from: Philip.Hazel@exim.workshop.example
22716 env-to: ph10@exim.workshop.example
22717 .endd
22718 which shows that rewriting has been set up for that address when used in any of
22719 the source fields, but not when it appears as a recipient address. At the
22720 present time, there is no equivalent way of testing rewriting rules that are
22721 set for a particular transport.
22722
22723
22724 .section "Rewriting rules" "SECID150"
22725 .cindex "rewriting" "rules"
22726 The rewrite section of the configuration file consists of lines of rewriting
22727 rules in the form
22728 .display
22729 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22730 .endd
22731 Rewriting rules that are specified for the &%headers_rewrite%& generic
22732 transport option are given as a colon-separated list. Each item in the list
22733 takes the same form as a line in the main rewriting configuration (except that
22734 any colons must be doubled, of course).
22735
22736 The formats of source patterns and replacement strings are described below.
22737 Each is terminated by white space, unless enclosed in double quotes, in which
22738 case normal quoting conventions apply inside the quotes. The flags are single
22739 characters which may appear in any order. Spaces and tabs between them are
22740 ignored.
22741
22742 For each address that could potentially be rewritten, the rules are scanned in
22743 order, and replacements for the address from earlier rules can themselves be
22744 replaced by later rules (but see the &"q"& and &"R"& flags).
22745
22746 The order in which addresses are rewritten is undefined, may change between
22747 releases, and must not be relied on, with one exception: when a message is
22748 received, the envelope sender is always rewritten first, before any header
22749 lines are rewritten. For example, the replacement string for a rewrite of an
22750 address in &'To:'& must not assume that the message's address in &'From:'& has
22751 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22752 that the envelope sender has already been rewritten.
22753
22754 .vindex "&$domain$&"
22755 .vindex "&$local_part$&"
22756 The variables &$local_part$& and &$domain$& can be used in the replacement
22757 string to refer to the address that is being rewritten. Note that lookup-driven
22758 rewriting can be done by a rule of the form
22759 .code
22760 *@*   ${lookup ...
22761 .endd
22762 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22763 refer to the address that is being rewritten.
22764
22765
22766 .section "Rewriting patterns" "SECID151"
22767 .cindex "rewriting" "patterns"
22768 .cindex "address list" "in a rewriting pattern"
22769 The source pattern in a rewriting rule is any item which may appear in an
22770 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22771 single-item address list, which means that it is expanded before being tested
22772 against the address. As always, if you use a regular expression as a pattern,
22773 you must take care to escape dollar and backslash characters, or use the &`\N`&
22774 facility to suppress string expansion within the regular expression.
22775
22776 Domains in patterns should be given in lower case. Local parts in patterns are
22777 case-sensitive. If you want to do case-insensitive matching of local parts, you
22778 can use a regular expression that starts with &`^(?i)`&.
22779
22780 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22781 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22782 depending on the type of match which occurred. These can be used in the
22783 replacement string to insert portions of the incoming address. &$0$& always
22784 refers to the complete incoming address. When a regular expression is used, the
22785 numerical variables are set from its capturing subexpressions. For other types
22786 of pattern they are set as follows:
22787
22788 .ilist
22789 If a local part or domain starts with an asterisk, the numerical variables
22790 refer to the character strings matched by asterisks, with &$1$& associated with
22791 the first asterisk, and &$2$& with the second, if present. For example, if the
22792 pattern
22793 .code
22794 *queen@*.fict.example
22795 .endd
22796 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22797 .code
22798 $0 = hearts-queen@wonderland.fict.example
22799 $1 = hearts-
22800 $2 = wonderland
22801 .endd
22802 Note that if the local part does not start with an asterisk, but the domain
22803 does, it is &$1$& that contains the wild part of the domain.
22804
22805 .next
22806 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22807 of the domain are placed in the next available numerical variables. Suppose,
22808 for example, that the address &'foo@bar.baz.example'& is processed by a
22809 rewriting rule of the form
22810 .display
22811 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22812 .endd
22813 and the key in the file that matches the domain is &`*.baz.example`&. Then
22814 .code
22815 $1 = foo
22816 $2 = bar
22817 $3 = baz.example
22818 .endd
22819 If the address &'foo@baz.example'& is looked up, this matches the same
22820 wildcard file entry, and in this case &$2$& is set to the empty string, but
22821 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22822 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22823 whole domain. For non-partial domain lookups, no numerical variables are set.
22824 .endlist
22825
22826
22827 .section "Rewriting replacements" "SECID152"
22828 .cindex "rewriting" "replacements"
22829 If the replacement string for a rule is a single asterisk, addresses that
22830 match the pattern and the flags are &'not'& rewritten, and no subsequent
22831 rewriting rules are scanned. For example,
22832 .code
22833 hatta@lookingglass.fict.example  *  f
22834 .endd
22835 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22836 &'From:'& headers.
22837
22838 .vindex "&$domain$&"
22839 .vindex "&$local_part$&"
22840 If the replacement string is not a single asterisk, it is expanded, and must
22841 yield a fully qualified address. Within the expansion, the variables
22842 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22843 Any letters they contain retain their original case &-- they are not lower
22844 cased. The numerical variables are set up according to the type of pattern that
22845 matched the address, as described above. If the expansion is forced to fail by
22846 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22847 current rule is abandoned, but subsequent rules may take effect. Any other
22848 expansion failure causes the entire rewriting operation to be abandoned, and an
22849 entry written to the panic log.
22850
22851
22852
22853 .section "Rewriting flags" "SECID153"
22854 There are three different kinds of flag that may appear on rewriting rules:
22855
22856 .ilist
22857 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22858 c, f, h, r, s, t.
22859 .next
22860 A flag that specifies rewriting at SMTP time: S.
22861 .next
22862 Flags that control the rewriting process: Q, q, R, w.
22863 .endlist
22864
22865 For rules that are part of the &%headers_rewrite%& generic transport option,
22866 E, F, T, and S are not permitted.
22867
22868
22869
22870 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22871          "SECID154"
22872 .cindex "rewriting" "flags"
22873 If none of the following flag letters, nor the &"S"& flag (see section
22874 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22875 and to both the sender and recipient fields of the envelope, whereas a
22876 transport-time rewriting rule just applies to all headers. Otherwise, the
22877 rewriting rule is skipped unless the relevant addresses are being processed.
22878 .display
22879 &`E`&       rewrite all envelope fields
22880 &`F`&       rewrite the envelope From field
22881 &`T`&       rewrite the envelope To field
22882 &`b`&       rewrite the &'Bcc:'& header
22883 &`c`&       rewrite the &'Cc:'& header
22884 &`f`&       rewrite the &'From:'& header
22885 &`h`&       rewrite all headers
22886 &`r`&       rewrite the &'Reply-To:'& header
22887 &`s`&       rewrite the &'Sender:'& header
22888 &`t`&       rewrite the &'To:'& header
22889 .endd
22890 "All headers" means all of the headers listed above that can be selected
22891 individually, plus their &'Resent-'& versions. It does not include
22892 other headers such as &'Subject:'& etc.
22893
22894 You should be particularly careful about rewriting &'Sender:'& headers, and
22895 restrict this to special known cases in your own domains.
22896
22897
22898 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22899 .cindex "SMTP" "rewriting malformed addresses"
22900 .cindex "RCPT" "rewriting argument of"
22901 .cindex "MAIL" "rewriting argument of"
22902 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22903 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22904 before any other processing; even before syntax checking. The pattern is
22905 required to be a regular expression, and it is matched against the whole of the
22906 data for the command, including any surrounding angle brackets.
22907
22908 .vindex "&$domain$&"
22909 .vindex "&$local_part$&"
22910 This form of rewrite rule allows for the handling of addresses that are not
22911 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22912 input). Because the input is not required to be a syntactically valid address,
22913 the variables &$local_part$& and &$domain$& are not available during the
22914 expansion of the replacement string. The result of rewriting replaces the
22915 original address in the MAIL or RCPT command.
22916
22917
22918 .section "Flags controlling the rewriting process" "SECID155"
22919 There are four flags which control the way the rewriting process works. These
22920 take effect only when a rule is invoked, that is, when the address is of the
22921 correct type (matches the flags) and matches the pattern:
22922
22923 .ilist
22924 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22925 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22926 absence of &"Q"& the rewritten address must always include a domain.
22927 .next
22928 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22929 even if no rewriting actually takes place because of a &"fail"& in the
22930 expansion. The &"q"& flag is not effective if the address is of the wrong type
22931 (does not match the flags) or does not match the pattern.
22932 .next
22933 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22934 address, up to ten times. It can be combined with the &"q"& flag, to stop
22935 rewriting once it fails to match (after at least one successful rewrite).
22936 .next
22937 .cindex "rewriting" "whole addresses"
22938 When an address in a header is rewritten, the rewriting normally applies only
22939 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22940 left unchanged. For example, rewriting might change
22941 .code
22942 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22943 .endd
22944 into
22945 .code
22946 From: Ford Prefect <prefectf@hitch.fict.example>
22947 .endd
22948 .cindex "RFC 2047"
22949 Sometimes there is a need to replace the whole address item, and this can be
22950 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22951 causes an address in a header line to be rewritten, the entire address is
22952 replaced, not just the working part. The replacement must be a complete RFC
22953 2822 address, including the angle brackets if necessary. If text outside angle
22954 brackets contains a character whose value is greater than 126 or less than 32
22955 (except for tab), the text is encoded according to RFC 2047. The character set
22956 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22957
22958 When the &"w"& flag is set on a rule that causes an envelope address to be
22959 rewritten, all but the working part of the replacement address is discarded.
22960 .endlist
22961
22962
22963 .section "Rewriting examples" "SECID156"
22964 Here is an example of the two common rewriting paradigms:
22965 .code
22966 *@*.hitch.fict.example  $1@hitch.fict.example
22967 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22968                      {$value}fail}@hitch.fict.example bctfrF
22969 .endd
22970 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22971 the string expansion to fail if the lookup does not succeed. In this context it
22972 has the effect of leaving the original address unchanged, but Exim goes on to
22973 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22974 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22975 explicitly, which would cause the rewritten address to be the same as before,
22976 at the cost of a small bit of processing. Not supplying either of these is an
22977 error, since the rewritten address would then contain no local part.
22978
22979 The first example above replaces the domain with a superior, more general
22980 domain. This may not be desirable for certain local parts. If the rule
22981 .code
22982 root@*.hitch.fict.example  *
22983 .endd
22984 were inserted before the first rule, rewriting would be suppressed for the
22985 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22986
22987 Rewriting can be made conditional on a number of tests, by making use of
22988 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22989 messages that originate outside the local host:
22990 .code
22991 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22992                          {$1@hitch.fict.example}fail}"
22993 .endd
22994 The replacement string is quoted in this example because it contains white
22995 space.
22996
22997 .cindex "rewriting" "bang paths"
22998 .cindex "bang paths" "rewriting"
22999 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23000 an address it treats it as an unqualified local part which it qualifies with
23001 the local qualification domain (if the source of the message is local or if the
23002 remote host is permitted to send unqualified addresses). Rewriting can
23003 sometimes be used to handle simple bang paths with a fixed number of
23004 components. For example, the rule
23005 .code
23006 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23007 .endd
23008 rewrites a two-component bang path &'host.name!user'& as the domain address
23009 &'user@host.name'&. However, there is a security implication in using this as
23010 a global rewriting rule for envelope addresses. It can provide a backdoor
23011 method for using your system as a relay, because the incoming addresses appear
23012 to be local. If the bang path addresses are received via SMTP, it is safer to
23013 use the &"S"& flag to rewrite them as they are received, so that relay checking
23014 can be done on the rewritten addresses.
23015 .ecindex IIDaddrew
23016
23017
23018
23019
23020
23021 . ////////////////////////////////////////////////////////////////////////////
23022 . ////////////////////////////////////////////////////////////////////////////
23023
23024 .chapter "Retry configuration" "CHAPretry"
23025 .scindex IIDretconf1 "retry" "configuration, description of"
23026 .scindex IIDregconf2 "configuration file" "retry section"
23027 The &"retry"& section of the runtime configuration file contains a list of
23028 retry rules that control how often Exim tries to deliver messages that cannot
23029 be delivered at the first attempt. If there are no retry rules (the section is
23030 empty or not present), there are no retries. In this situation, temporary
23031 errors are treated as permanent. The default configuration contains a single,
23032 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23033 line option can be used to test which retry rule will be used for a given
23034 address, domain and error.
23035
23036 The most common cause of retries is temporary failure to deliver to a remote
23037 host because the host is down, or inaccessible because of a network problem.
23038 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23039 address) basis, not on a per-message basis. Thus, if one message has recently
23040 been delayed, delivery of a new message to the same host is not immediately
23041 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23042 log selector is set, the message
23043 .cindex "retry" "time not reached"
23044 &"retry time not reached"& is written to the main log whenever a delivery is
23045 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23046 the handling of errors during remote deliveries.
23047
23048 Retry processing applies to routing as well as to delivering, except as covered
23049 in the next paragraph. The retry rules do not distinguish between these
23050 actions. It is not possible, for example, to specify different behaviour for
23051 failures to route the domain &'snark.fict.example'& and failures to deliver to
23052 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23053 added complication, so did not implement it. However, although they share the
23054 same retry rule, the actual retry times for routing and transporting a given
23055 domain are maintained independently.
23056
23057 When a delivery is not part of a queue run (typically an immediate delivery on
23058 receipt of a message), the routers are always run, and local deliveries are
23059 always attempted, even if retry times are set for them. This makes for better
23060 behaviour if one particular message is causing problems (for example, causing
23061 quota overflow, or provoking an error in a filter file). If such a delivery
23062 suffers a temporary failure, the retry data is updated as normal, and
23063 subsequent delivery attempts from queue runs occur only when the retry time for
23064 the local address is reached.
23065
23066 .section "Changing retry rules" "SECID157"
23067 If you change the retry rules in your configuration, you should consider
23068 whether or not to delete the retry data that is stored in Exim's spool area in
23069 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23070 always safe; that is why they are called &"hints"&.
23071
23072 The hints retry data contains suggested retry times based on the previous
23073 rules. In the case of a long-running problem with a remote host, it might
23074 record the fact that the host has timed out. If your new rules increase the
23075 timeout time for such a host, you should definitely remove the old retry data
23076 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23077 messages that it should now be retaining.
23078
23079
23080
23081 .section "Format of retry rules" "SECID158"
23082 .cindex "retry" "rules"
23083 Each retry rule occupies one line and consists of three or four parts,
23084 separated by white space: a pattern, an error name, an optional list of sender
23085 addresses, and a list of retry parameters. The pattern and sender lists must be
23086 enclosed in double quotes if they contain white space. The rules are searched
23087 in order until one is found where the pattern, error name, and sender list (if
23088 present) match the failing host or address, the error that occurred, and the
23089 message's sender, respectively.
23090
23091
23092 The pattern is any single item that may appear in an address list (see section
23093 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23094 which means that it is expanded before being tested against the address that
23095 has been delayed. A negated address list item is permitted. Address
23096 list processing treats a plain domain name as if it were preceded by &"*@"&,
23097 which makes it possible for many retry rules to start with just a domain. For
23098 example,
23099 .code
23100 lookingglass.fict.example        *  F,24h,30m;
23101 .endd
23102 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23103 whereas
23104 .code
23105 alice@lookingglass.fict.example  *  F,24h,30m;
23106 .endd
23107 applies only to temporary failures involving the local part &%alice%&.
23108 In practice, almost all rules start with a domain name pattern without a local
23109 part.
23110
23111 .cindex "regular expressions" "in retry rules"
23112 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23113 must match a complete address, not just a domain, because that is how regular
23114 expressions work in address lists.
23115 .display
23116 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23117 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23118 .endd
23119
23120
23121 .section "Choosing which retry rule to use for address errors" "SECID159"
23122 When Exim is looking for a retry rule after a routing attempt has failed (for
23123 example, after a DNS timeout), each line in the retry configuration is tested
23124 against the complete address only if &%retry_use_local_part%& is set for the
23125 router. Otherwise, only the domain is used, except when matching against a
23126 regular expression, when the local part of the address is replaced with &"*"&.
23127 A domain on its own can match a domain pattern, or a pattern that starts with
23128 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23129 &%check_local_user%& is true, and false for other routers.
23130
23131 Similarly, when Exim is looking for a retry rule after a local delivery has
23132 failed (for example, after a mailbox full error), each line in the retry
23133 configuration is tested against the complete address only if
23134 &%retry_use_local_part%& is set for the transport (it defaults true for all
23135 local transports).
23136
23137 .cindex "4&'xx'& responses" "retry rules for"
23138 However, when Exim is looking for a retry rule after a remote delivery attempt
23139 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23140 whole address is always used as the key when searching the retry rules. The
23141 rule that is found is used to create a retry time for the combination of the
23142 failing address and the message's sender. It is the combination of sender and
23143 recipient that is delayed in subsequent queue runs until its retry time is
23144 reached. You can delay the recipient without regard to the sender by setting
23145 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23146 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23147 commands.
23148
23149
23150
23151 .section "Choosing which retry rule to use for host and message errors" &&&
23152          "SECID160"
23153 For a temporary error that is not related to an individual address (for
23154 example, a connection timeout), each line in the retry configuration is checked
23155 twice. First, the name of the remote host is used as a domain name (preceded by
23156 &"*@"& when matching a regular expression). If this does not match the line,
23157 the domain from the email address is tried in a similar fashion. For example,
23158 suppose the MX records for &'a.b.c.example'& are
23159 .code
23160 a.b.c.example  MX  5  x.y.z.example
23161                MX  6  p.q.r.example
23162                MX  7  m.n.o.example
23163 .endd
23164 and the retry rules are
23165 .code
23166 p.q.r.example    *      F,24h,30m;
23167 a.b.c.example    *      F,4d,45m;
23168 .endd
23169 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23170 first rule matches neither the host nor the domain, so Exim looks at the second
23171 rule. This does not match the host, but it does match the domain, so it is used
23172 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23173 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23174 first retry rule is used, because it matches the host.
23175
23176 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23177 first rule to determine retry times, but for all the other hosts for the domain
23178 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23179 routing to &'a.b.c.example'& suffers a temporary failure.
23180
23181 &*Note*&: The host name is used when matching the patterns, not its IP address.
23182 However, if a message is routed directly to an IP address without the use of a
23183 host name, for example, if a &(manualroute)& router contains a setting such as:
23184 .code
23185 route_list = *.a.example  192.168.34.23
23186 .endd
23187 then the &"host name"& that is used when searching for a retry rule is the
23188 textual form of the IP address.
23189
23190 .section "Retry rules for specific errors" "SECID161"
23191 .cindex "retry" "specific errors; specifying"
23192 The second field in a retry rule is the name of a particular error, or an
23193 asterisk, which matches any error. The errors that can be tested for are:
23194
23195 .vlist
23196 .vitem &%auth_failed%&
23197 Authentication failed when trying to send to a host in the
23198 &%hosts_require_auth%& list in an &(smtp)& transport.
23199
23200 .vitem &%data_4xx%&
23201 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23202 after the command, or after sending the message's data.
23203
23204 .vitem &%mail_4xx%&
23205 A 4&'xx'& error was received for an outgoing MAIL command.
23206
23207 .vitem &%rcpt_4xx%&
23208 A 4&'xx'& error was received for an outgoing RCPT command.
23209 .endlist
23210
23211 For the three 4&'xx'& errors, either the first or both of the x's can be given
23212 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23213 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23214 and have retries every ten minutes with a one-hour timeout, you could set up a
23215 retry rule of this form:
23216 .code
23217 the.domain.name  rcpt_452   F,1h,10m
23218 .endd
23219 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23220 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23221
23222 .vlist
23223 .vitem &%lost_connection%&
23224 A server unexpectedly closed the SMTP connection. There may, of course,
23225 legitimate reasons for this (host died, network died), but if it repeats a lot
23226 for the same host, it indicates something odd.
23227
23228 .vitem &%refused_MX%&
23229 A connection to a host obtained from an MX record was refused.
23230
23231 .vitem &%refused_A%&
23232 A connection to a host not obtained from an MX record was refused.
23233
23234 .vitem &%refused%&
23235 A connection was refused.
23236
23237 .vitem &%timeout_connect_MX%&
23238 A connection attempt to a host obtained from an MX record timed out.
23239
23240 .vitem &%timeout_connect_A%&
23241 A connection attempt to a host not obtained from an MX record timed out.
23242
23243 .vitem &%timeout_connect%&
23244 A connection attempt timed out.
23245
23246 .vitem &%timeout_MX%&
23247 There was a timeout while connecting or during an SMTP session with a host
23248 obtained from an MX record.
23249
23250 .vitem &%timeout_A%&
23251 There was a timeout while connecting or during an SMTP session with a host not
23252 obtained from an MX record.
23253
23254 .vitem &%timeout%&
23255 There was a timeout while connecting or during an SMTP session.
23256
23257 .vitem &%tls_required%&
23258 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23259 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23260 to STARTTLS, or there was a problem setting up the TLS connection.
23261
23262 .vitem &%quota%&
23263 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23264 transport.
23265
23266 .vitem &%quota_%&<&'time'&>
23267 .cindex "quota" "error testing in retry rule"
23268 .cindex "retry" "quota error testing"
23269 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23270 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23271 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23272 for four days.
23273 .endlist
23274
23275 .cindex "mailbox" "time of last read"
23276 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23277 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23278 it should be based on the last time that the user accessed the mailbox.
23279 However, it is not always possible to determine this. Exim uses the following
23280 heuristic rules:
23281
23282 .ilist
23283 If the mailbox is a single file, the time of last access (the &"atime"&) is
23284 used. As no new messages are being delivered (because the mailbox is over
23285 quota), Exim does not access the file, so this is the time of last user access.
23286 .next
23287 .cindex "maildir format" "time of last read"
23288 For a maildir delivery, the time of last modification of the &_new_&
23289 subdirectory is used. As the mailbox is over quota, no new files are created in
23290 the &_new_& subdirectory, because no new messages are being delivered. Any
23291 change to the &_new_& subdirectory is therefore assumed to be the result of an
23292 MUA moving a new message to the &_cur_& directory when it is first read. The
23293 time that is used is therefore the last time that the user read a new message.
23294 .next
23295 For other kinds of multi-file mailbox, the time of last access cannot be
23296 obtained, so a retry rule that uses this type of error field is never matched.
23297 .endlist
23298
23299 The quota errors apply both to system-enforced quotas and to Exim's own quota
23300 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23301 when a local delivery is deferred because a partition is full (the ENOSPC
23302 error).
23303
23304
23305
23306 .section "Retry rules for specified senders" "SECID162"
23307 .cindex "retry" "rules; sender-specific"
23308 You can specify retry rules that apply only when the failing message has a
23309 specific sender. In particular, this can be used to define retry rules that
23310 apply only to bounce messages. The third item in a retry rule can be of this
23311 form:
23312 .display
23313 &`senders=`&<&'address list'&>
23314 .endd
23315 The retry timings themselves are then the fourth item. For example:
23316 .code
23317 *   rcpt_4xx   senders=:   F,1h,30m
23318 .endd
23319 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23320 host. If the address list contains white space, it must be enclosed in quotes.
23321 For example:
23322 .code
23323 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23324 .endd
23325 &*Warning*&: This facility can be unhelpful if it is used for host errors
23326 (which do not depend on the recipient). The reason is that the sender is used
23327 only to match the retry rule. Once the rule has been found for a host error,
23328 its contents are used to set a retry time for the host, and this will apply to
23329 all messages, not just those with specific senders.
23330
23331 When testing retry rules using &%-brt%&, you can supply a sender using the
23332 &%-f%& command line option, like this:
23333 .code
23334 exim -f "" -brt user@dom.ain
23335 .endd
23336 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23337 list is never matched.
23338
23339
23340
23341
23342
23343 .section "Retry parameters" "SECID163"
23344 .cindex "retry" "parameters in rules"
23345 The third (or fourth, if a senders list is present) field in a retry rule is a
23346 sequence of retry parameter sets, separated by semicolons. Each set consists of
23347 .display
23348 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23349 .endd
23350 The letter identifies the algorithm for computing a new retry time; the cutoff
23351 time is the time beyond which this algorithm no longer applies, and the
23352 arguments vary the algorithm's action. The cutoff time is measured from the
23353 time that the first failure for the domain (combined with the local part if
23354 relevant) was detected, not from the time the message was received.
23355
23356 .cindex "retry" "algorithms"
23357 .cindex "retry" "fixed intervals"
23358 .cindex "retry" "increasing intervals"
23359 .cindex "retry" "random intervals"
23360 The available algorithms are:
23361
23362 .ilist
23363 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23364 the interval.
23365 .next
23366 &'G'&: retry at geometrically increasing intervals. The first argument
23367 specifies a starting value for the interval, and the second a multiplier, which
23368 is used to increase the size of the interval at each retry.
23369 .next
23370 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23371 retry, the previous interval is multiplied by the factor in order to get a
23372 maximum for the next interval. The minimum interval is the first argument of
23373 the parameter, and an actual interval is chosen randomly between them. Such a
23374 rule has been found to be helpful in cluster configurations when all the
23375 members of the cluster restart at once, and may therefore synchronize their
23376 queue processing times.
23377 .endlist
23378
23379 When computing the next retry time, the algorithm definitions are scanned in
23380 order until one whose cutoff time has not yet passed is reached. This is then
23381 used to compute a new retry time that is later than the current time. In the
23382 case of fixed interval retries, this simply means adding the interval to the
23383 current time. For geometrically increasing intervals, retry intervals are
23384 computed from the rule's parameters until one that is greater than the previous
23385 interval is found. The main configuration variable
23386 .cindex "limit" "retry interval"
23387 .cindex "retry" "interval, maximum"
23388 .oindex "&%retry_interval_max%&"
23389 &%retry_interval_max%& limits the maximum interval between retries. It
23390 cannot be set greater than &`24h`&, which is its default value.
23391
23392 A single remote domain may have a number of hosts associated with it, and each
23393 host may have more than one IP address. Retry algorithms are selected on the
23394 basis of the domain name, but are applied to each IP address independently. If,
23395 for example, a host has two IP addresses and one is unusable, Exim will
23396 generate retry times for it and will not try to use it until its next retry
23397 time comes. Thus the good IP address is likely to be tried first most of the
23398 time.
23399
23400 .cindex "hints database" "use for retrying"
23401 Retry times are hints rather than promises. Exim does not make any attempt to
23402 run deliveries exactly at the computed times. Instead, a queue runner process
23403 starts delivery processes for delayed messages periodically, and these attempt
23404 new deliveries only for those addresses that have passed their next retry time.
23405 If a new message arrives for a deferred address, an immediate delivery attempt
23406 occurs only if the address has passed its retry time. In the absence of new
23407 messages, the minimum time between retries is the interval between queue runner
23408 processes. There is not much point in setting retry times of five minutes if
23409 your queue runners happen only once an hour, unless there are a significant
23410 number of incoming messages (which might be the case on a system that is
23411 sending everything to a smart host, for example).
23412
23413 The data in the retry hints database can be inspected by using the
23414 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23415 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23416 &'exinext'& utility script can be used to find out what the next retry times
23417 are for the hosts associated with a particular mail domain, and also for local
23418 deliveries that have been deferred.
23419
23420
23421 .section "Retry rule examples" "SECID164"
23422 Here are some example retry rules:
23423 .code
23424 alice@wonderland.fict.example quota_5d  F,7d,3h
23425 wonderland.fict.example       quota_5d
23426 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23427 lookingglass.fict.example     *         F,24h,30m;
23428 *                 refused_A   F,2h,20m;
23429 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23430 .endd
23431 The first rule sets up special handling for mail to
23432 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23433 mailbox has not been read for at least 5 days. Retries continue every three
23434 hours for 7 days. The second rule handles over-quota errors for all other local
23435 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23436 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23437 fail are bounced immediately if the mailbox has not been read for at least 5
23438 days.
23439
23440 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23441 happen every 15 minutes for an hour, then with geometrically increasing
23442 intervals until two days have passed since a delivery first failed. After the
23443 first hour there is a delay of one hour, then two hours, then four hours, and
23444 so on (this is a rather extreme example).
23445
23446 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23447 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23448 all other domains, with special action for connection refusal from hosts that
23449 were not obtained from an MX record.
23450
23451 The final rule in a retry configuration should always have asterisks in the
23452 first two fields so as to provide a general catch-all for any addresses that do
23453 not have their own special handling. This example tries every 15 minutes for 2
23454 hours, then with intervals starting at one hour and increasing by a factor of
23455 1.5 up to 16 hours, then every 8 hours up to 5 days.
23456
23457
23458
23459 .section "Timeout of retry data" "SECID165"
23460 .cindex "timeout" "of retry data"
23461 .oindex "&%retry_data_expire%&"
23462 .cindex "hints database" "data expiry"
23463 .cindex "retry" "timeout of data"
23464 Exim timestamps the data that it writes to its retry hints database. When it
23465 consults the data during a delivery it ignores any that is older than the value
23466 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23467 been tried for 7 days, Exim will try to deliver to it immediately a message
23468 arrives, and if that fails, it will calculate a retry time as if it were
23469 failing for the first time.
23470
23471 This improves the behaviour for messages routed to rarely-used hosts such as MX
23472 backups. If such a host was down at one time, and happens to be down again when
23473 Exim tries a month later, using the old retry data would imply that it had been
23474 down all the time, which is not a justified assumption.
23475
23476 If a host really is permanently dead, this behaviour causes a burst of retries
23477 every now and again, but only if messages routed to it are rare. If there is a
23478 message at least once every 7 days the retry data never expires.
23479
23480
23481
23482
23483 .section "Long-term failures" "SECID166"
23484 .cindex "delivery failure, long-term"
23485 .cindex "retry" "after long-term failure"
23486 Special processing happens when an email address has been failing for so long
23487 that the cutoff time for the last algorithm is reached. For example, using the
23488 default retry rule:
23489 .code
23490 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23491 .endd
23492 the cutoff time is four days. Reaching the retry cutoff is independent of how
23493 long any specific message has been failing; it is the length of continuous
23494 failure for the recipient address that counts.
23495
23496 When the cutoff time is reached for a local delivery, or for all the IP
23497 addresses associated with a remote delivery, a subsequent delivery failure
23498 causes Exim to give up on the address, and a bounce message is generated.
23499 In order to cater for new messages that use the failing address, a next retry
23500 time is still computed from the final algorithm, and is used as follows:
23501
23502 For local deliveries, one delivery attempt is always made for any subsequent
23503 messages. If this delivery fails, the address fails immediately. The
23504 post-cutoff retry time is not used.
23505
23506 If the delivery is remote, there are two possibilities, controlled by the
23507 .oindex "&%delay_after_cutoff%&"
23508 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23509 default. Until the post-cutoff retry time for one of the IP addresses is
23510 reached, the failing email address is bounced immediately, without a delivery
23511 attempt taking place. After that time, one new delivery attempt is made to
23512 those IP addresses that are past their retry times, and if that still fails,
23513 the address is bounced and new retry times are computed.
23514
23515 In other words, when all the hosts for a given email address have been failing
23516 for a long time, Exim bounces rather then defers until one of the hosts' retry
23517 times is reached. Then it tries once, and bounces if that attempt fails. This
23518 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23519 to a broken destination, but if the host does recover, Exim will eventually
23520 notice.
23521
23522 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23523 addresses are past their final cutoff time, Exim tries to deliver to those IP
23524 addresses that have not been tried since the message arrived. If there are
23525 no suitable IP addresses, or if they all fail, the address is bounced. In other
23526 words, it does not delay when a new message arrives, but tries the expired
23527 addresses immediately, unless they have been tried since the message arrived.
23528 If there is a continuous stream of messages for the failing domains, setting
23529 &%delay_after_cutoff%& false means that there will be many more attempts to
23530 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23531 true.
23532
23533 .section "Deliveries that work intermittently" "SECID167"
23534 .cindex "retry" "intermittently working deliveries"
23535 Some additional logic is needed to cope with cases where a host is
23536 intermittently available, or when a message has some attribute that prevents
23537 its delivery when others to the same address get through. In this situation,
23538 because some messages are successfully delivered, the &"retry clock"& for the
23539 host or address keeps getting reset by the successful deliveries, and so
23540 failing messages remain on the queue for ever because the cutoff time is never
23541 reached.
23542
23543 Two exceptional actions are applied to prevent this happening. The first
23544 applies to errors that are related to a message rather than a remote host.
23545 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23546 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23547 commands, and quota failures. For this type of error, if a message's arrival
23548 time is earlier than the &"first failed"& time for the error, the earlier time
23549 is used when scanning the retry rules to decide when to try next and when to
23550 time out the address.
23551
23552 The exceptional second action applies in all cases. If a message has been on
23553 the queue for longer than the cutoff time of any applicable retry rule for a
23554 given address, a delivery is attempted for that address, even if it is not yet
23555 time, and if this delivery fails, the address is timed out. A new retry time is
23556 not computed in this case, so that other messages for the same address are
23557 considered immediately.
23558 .ecindex IIDretconf1
23559 .ecindex IIDregconf2
23560
23561
23562
23563
23564
23565
23566 . ////////////////////////////////////////////////////////////////////////////
23567 . ////////////////////////////////////////////////////////////////////////////
23568
23569 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23570 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23571 .scindex IIDauthconf2 "authentication"
23572 The &"authenticators"& section of Exim's run time configuration is concerned
23573 with SMTP authentication. This facility is an extension to the SMTP protocol,
23574 described in RFC 2554, which allows a client SMTP host to authenticate itself
23575 to a server. This is a common way for a server to recognize clients that are
23576 permitted to use it as a relay. SMTP authentication is not of relevance to the
23577 transfer of mail between servers that have no managerial connection with each
23578 other.
23579
23580 .cindex "AUTH" "description of"
23581 Very briefly, the way SMTP authentication works is as follows:
23582
23583 .ilist
23584 The server advertises a number of authentication &'mechanisms'& in response to
23585 the client's EHLO command.
23586 .next
23587 The client issues an AUTH command, naming a specific mechanism. The command
23588 may, optionally, contain some authentication data.
23589 .next
23590 The server may issue one or more &'challenges'&, to which the client must send
23591 appropriate responses. In simple authentication mechanisms, the challenges are
23592 just prompts for user names and passwords. The server does not have to issue
23593 any challenges &-- in some mechanisms the relevant data may all be transmitted
23594 with the AUTH command.
23595 .next
23596 The server either accepts or denies authentication.
23597 .next
23598 If authentication succeeds, the client may optionally make use of the AUTH
23599 option on the MAIL command to pass an authenticated sender in subsequent
23600 mail transactions. Authentication lasts for the remainder of the SMTP
23601 connection.
23602 .next
23603 If authentication fails, the client may give up, or it may try a different
23604 authentication mechanism, or it may try transferring mail over the
23605 unauthenticated connection.
23606 .endlist
23607
23608 If you are setting up a client, and want to know which authentication
23609 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23610 SMTP port) on the server, and issue an EHLO command. The response to this
23611 includes the list of supported mechanisms. For example:
23612 .display
23613 &`$ `&&*&`telnet server.example 25`&*&
23614 &`Trying 192.168.34.25...`&
23615 &`Connected to server.example.`&
23616 &`Escape character is &#x0027;^]&#x0027;.`&
23617 &`220 server.example ESMTP Exim 4.20 ...`&
23618 &*&`ehlo client.example`&*&
23619 &`250-server.example Hello client.example [10.8.4.5]`&
23620 &`250-SIZE 52428800`&
23621 &`250-PIPELINING`&
23622 &`250-AUTH PLAIN`&
23623 &`250 HELP`&
23624 .endd
23625 The second-last line of this example output shows that the server supports
23626 authentication using the PLAIN mechanism. In Exim, the different authentication
23627 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23628 routers and transports, which authenticators are included in the binary is
23629 controlled by build-time definitions. The following are currently available,
23630 included by setting
23631 .code
23632 AUTH_CRAM_MD5=yes
23633 AUTH_CYRUS_SASL=yes
23634 .new
23635 AUTH_DOVECOT=yes
23636 AUTH_GSASL=yes
23637 AUTH_HEIMDAL_GSSAPI=yes
23638 .wen
23639 AUTH_PLAINTEXT=yes
23640 AUTH_SPA=yes
23641 .endd
23642 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23643 authentication mechanism (RFC 2195), and the second provides an interface to
23644 the Cyrus SASL authentication library.
23645 .new
23646 The third is an interface to Dovecot's authentication system, delegating the
23647 work via a socket interface.
23648 The fourth provides an interface to the GNU SASL authentication library, which
23649 provides mechanisms but typically not data sources.
23650 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23651 supporting setting a server keytab.
23652 The sixth can be configured to support
23653 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23654 not formally documented, but used by several MUAs. The seventh authenticator
23655 supports Microsoft's &'Secure Password Authentication'& mechanism.
23656 .wen
23657
23658 The authenticators are configured using the same syntax as other drivers (see
23659 section &<<SECTfordricon>>&). If no authenticators are required, no
23660 authentication section need be present in the configuration file. Each
23661 authenticator can in principle have both server and client functions. When Exim
23662 is receiving SMTP mail, it is acting as a server; when it is sending out
23663 messages over SMTP, it is acting as a client. Authenticator configuration
23664 options are provided for use in both these circumstances.
23665
23666 To make it clear which options apply to which situation, the prefixes
23667 &%server_%& and &%client_%& are used on option names that are specific to
23668 either the server or the client function, respectively. Server and client
23669 functions are disabled if none of their options are set. If an authenticator is
23670 to be used for both server and client functions, a single definition, using
23671 both sets of options, is required. For example:
23672 .code
23673 cram:
23674   driver = cram_md5
23675   public_name = CRAM-MD5
23676   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23677   client_name = ph10
23678   client_secret = secret2
23679 .endd
23680 The &%server_%& option is used when Exim is acting as a server, and the
23681 &%client_%& options when it is acting as a client.
23682
23683 Descriptions of the individual authenticators are given in subsequent chapters.
23684 The remainder of this chapter covers the generic options for the
23685 authenticators, followed by general discussion of the way authentication works
23686 in Exim.
23687
23688 .new
23689 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
23690 per-mechanism basis.  Please read carefully to determine which variables hold
23691 account labels such as usercodes and which hold passwords or other
23692 authenticating data.
23693
23694 Note that some mechanisms support two different identifiers for accounts: the
23695 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
23696 and &'authz'& are commonly encountered.  The American spelling is standard here.
23697 Conceptually, authentication data such as passwords are tied to the identifier
23698 used to authenticate; servers may have rules to permit one user to act as a
23699 second user, so that after login the session is treated as though that second
23700 user had logged in.  That second user is the &'authorization id'&.  A robust
23701 configuration might confirm that the &'authz'& field is empty or matches the
23702 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
23703 as verified data, the &'authz'& as an unverified request which the server might
23704 choose to honour.
23705
23706 A &'realm'& is a text string, typically a domain name, presented by a server
23707 to a client to help it select an account and credentials to use.  In some
23708 mechanisms, the client and server provably agree on the realm, but clients
23709 typically can not treat the realm as secure data to be blindly trusted.
23710 .wen
23711
23712
23713
23714 .section "Generic options for authenticators" "SECID168"
23715 .cindex "authentication" "generic options"
23716 .cindex "options" "generic; for authenticators"
23717
23718 .option client_condition authenticators string&!! unset
23719 When Exim is authenticating as a client, it skips any authenticator whose
23720 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23721 used, for example, to skip plain text authenticators when the connection is not
23722 encrypted by a setting such as:
23723 .code
23724 client_condition = ${if !eq{$tls_cipher}{}}
23725 .endd
23726 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23727 used for incoming messages. In fact, during SMTP delivery, it contains the
23728 cipher used for the delivery.)
23729
23730
23731 .option driver authenticators string unset
23732 This option must always be set. It specifies which of the available
23733 authenticators is to be used.
23734
23735
23736 .option public_name authenticators string unset
23737 This option specifies the name of the authentication mechanism that the driver
23738 implements, and by which it is known to the outside world. These names should
23739 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23740 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23741 defaults to the driver's instance name.
23742
23743
23744 .option server_advertise_condition authenticators string&!! unset
23745 When a server is about to advertise an authentication mechanism, the condition
23746 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23747 mechanism is not advertised.
23748 If the expansion fails, the mechanism is not advertised. If the failure was not
23749 forced, and was not caused by a lookup defer, the incident is logged.
23750 See section &<<SECTauthexiser>>& below for further discussion.
23751
23752
23753 .option server_condition authenticators string&!! unset
23754 This option must be set for a &%plaintext%& server authenticator, where it
23755 is used directly to control authentication. See section &<<SECTplainserver>>&
23756 for details.
23757
23758 .new
23759 For the &(gsasl)& authenticator, this option is required for various
23760 mechanisms; see chapter &<<CHAPgsasl>>& for details.
23761 .wen
23762
23763 For the other authenticators, &%server_condition%& can be used as an additional
23764 authentication or authorization mechanism that is applied after the other
23765 authenticator conditions succeed. If it is set, it is expanded when the
23766 authenticator would otherwise return a success code. If the expansion is forced
23767 to fail, authentication fails. Any other expansion failure causes a temporary
23768 error code to be returned. If the result of a successful expansion is an empty
23769 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23770 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23771 other result, a temporary error code is returned, with the expanded string as
23772 the error text.
23773
23774
23775 .option server_debug_print authenticators string&!! unset
23776 If this option is set and authentication debugging is enabled (see the &%-d%&
23777 command line option), the string is expanded and included in the debugging
23778 output when the authenticator is run as a server. This can help with checking
23779 out the values of variables.
23780 If expansion of the string fails, the error message is written to the debugging
23781 output, and Exim carries on processing.
23782
23783
23784 .option server_set_id authenticators string&!! unset
23785 .vindex "&$authenticated_id$&"
23786 When an Exim server successfully authenticates a client, this string is
23787 expanded using data from the authentication, and preserved for any incoming
23788 messages in the variable &$authenticated_id$&. It is also included in the log
23789 lines for incoming messages. For example, a user/password authenticator
23790 configuration might preserve the user name that was used to authenticate, and
23791 refer to it subsequently during delivery of the message.
23792 If expansion fails, the option is ignored.
23793
23794
23795 .option server_mail_auth_condition authenticators string&!! unset
23796 This option allows a server to discard authenticated sender addresses supplied
23797 as part of MAIL commands in SMTP connections that are authenticated by the
23798 driver on which &%server_mail_auth_condition%& is set. The option is not used
23799 as part of the authentication process; instead its (unexpanded) value is
23800 remembered for later use.
23801 How it is used is described in the following section.
23802
23803
23804
23805
23806
23807 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23808 .cindex "authentication" "sender; authenticated"
23809 .cindex "AUTH" "on MAIL command"
23810 When a client supplied an AUTH= item on a MAIL command, Exim applies
23811 the following checks before accepting it as the authenticated sender of the
23812 message:
23813
23814 .ilist
23815 If the connection is not using extended SMTP (that is, HELO was used rather
23816 than EHLO), the use of AUTH= is a syntax error.
23817 .next
23818 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23819 .next
23820 .vindex "&$authenticated_sender$&"
23821 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23822 running, the value of &$authenticated_sender$& is set to the value obtained
23823 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23824 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23825 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23826 given for the MAIL command.
23827 .next
23828 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23829 is accepted and placed in &$authenticated_sender$& only if the client has
23830 authenticated.
23831 .next
23832 If the AUTH= value was accepted by either of the two previous rules, and
23833 the client has authenticated, and the authenticator has a setting for the
23834 &%server_mail_auth_condition%&, the condition is checked at this point. The
23835 valued that was saved from the authenticator is expanded. If the expansion
23836 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23837 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23838 the value of &$authenticated_sender$& is retained and passed on with the
23839 message.
23840 .endlist
23841
23842
23843 When &$authenticated_sender$& is set for a message, it is passed on to other
23844 hosts to which Exim authenticates as a client. Do not confuse this value with
23845 &$authenticated_id$&, which is a string obtained from the authentication
23846 process, and which is not usually a complete email address.
23847
23848 .vindex "&$sender_address$&"
23849 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23850 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23851 therefore make use of &$authenticated_sender$&. The converse is not true: the
23852 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23853 ACL is run.
23854
23855
23856
23857 .section "Authentication on an Exim server" "SECTauthexiser"
23858 .cindex "authentication" "on an Exim server"
23859 When Exim receives an EHLO command, it advertises the public names of those
23860 authenticators that are configured as servers, subject to the following
23861 conditions:
23862
23863 .ilist
23864 The client host must match &%auth_advertise_hosts%& (default *).
23865 .next
23866 It the &%server_advertise_condition%& option is set, its expansion must not
23867 yield the empty string, &"0"&, &"no"&, or &"false"&.
23868 .endlist
23869
23870 The order in which the authenticators are defined controls the order in which
23871 the mechanisms are advertised.
23872
23873 Some mail clients (for example, some versions of Netscape) require the user to
23874 provide a name and password for authentication whenever AUTH is advertised,
23875 even though authentication may not in fact be needed (for example, Exim may be
23876 set up to allow unconditional relaying from the client by an IP address check).
23877 You can make such clients more friendly by not advertising AUTH to them.
23878 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23879 that runs for RCPT) to relay without authentication, you should set
23880 .code
23881 auth_advertise_hosts = ! 10.9.8.0/24
23882 .endd
23883 so that no authentication mechanisms are advertised to them.
23884
23885 The &%server_advertise_condition%& controls the advertisement of individual
23886 authentication mechanisms. For example, it can be used to restrict the
23887 advertisement of a particular mechanism to encrypted connections, by a setting
23888 such as:
23889 .code
23890 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23891 .endd
23892 .vindex "&$tls_cipher$&"
23893 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23894 yields &"yes"&, which allows the advertisement to happen.
23895
23896 When an Exim server receives an AUTH command from a client, it rejects it
23897 immediately if AUTH was not advertised in response to an earlier EHLO
23898 command. This is the case if
23899
23900 .ilist
23901 The client host does not match &%auth_advertise_hosts%&; or
23902 .next
23903 No authenticators are configured with server options; or
23904 .next
23905 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23906 server authenticators.
23907 .endlist
23908
23909
23910 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23911 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23912 AUTH is accepted from any client host.
23913
23914 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23915 server authentication mechanism that was advertised in response to EHLO and
23916 that matches the one named in the AUTH command. If it finds one, it runs
23917 the appropriate authentication protocol, and authentication either succeeds or
23918 fails. If there is no matching advertised mechanism, the AUTH command is
23919 rejected with a 504 error.
23920
23921 .vindex "&$received_protocol$&"
23922 .vindex "&$sender_host_authenticated$&"
23923 When a message is received from an authenticated host, the value of
23924 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23925 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23926 public name) of the authenticator driver that successfully authenticated the
23927 client from which the message was received. This variable is empty if there was
23928 no successful authentication.
23929
23930
23931
23932
23933 .section "Testing server authentication" "SECID169"
23934 .cindex "authentication" "testing a server"
23935 .cindex "AUTH" "testing a server"
23936 .cindex "base64 encoding" "creating authentication test data"
23937 Exim's &%-bh%& option can be useful for testing server authentication
23938 configurations. The data for the AUTH command has to be sent using base64
23939 encoding. A quick way to produce such data for testing is the following Perl
23940 script:
23941 .code
23942 use MIME::Base64;
23943 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23944 .endd
23945 .cindex "binary zero" "in authentication data"
23946 This interprets its argument as a Perl string, and then encodes it. The
23947 interpretation as a Perl string allows binary zeros, which are required for
23948 some kinds of authentication, to be included in the data. For example, a
23949 command line to run this script on such data might be
23950 .code
23951 encode '\0user\0password'
23952 .endd
23953 Note the use of single quotes to prevent the shell interpreting the
23954 backslashes, so that they can be interpreted by Perl to specify characters
23955 whose code value is zero.
23956
23957 &*Warning 1*&: If either of the user or password strings starts with an octal
23958 digit, you must use three zeros instead of one after the leading backslash. If
23959 you do not, the octal digit that starts your string will be incorrectly
23960 interpreted as part of the code for the first character.
23961
23962 &*Warning 2*&: If there are characters in the strings that Perl interprets
23963 specially, you must use a Perl escape to prevent them being misinterpreted. For
23964 example, a command such as
23965 .code
23966 encode '\0user@domain.com\0pas$$word'
23967 .endd
23968 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23969
23970 If you have the &%mimencode%& command installed, another way to do produce
23971 base64-encoded strings is to run the command
23972 .code
23973 echo -e -n `\0user\0password' | mimencode
23974 .endd
23975 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23976 in the argument, and the &%-n%& option specifies no newline at the end of its
23977 output. However, not all versions of &%echo%& recognize these options, so you
23978 should check your version before relying on this suggestion.
23979
23980
23981
23982 .section "Authentication by an Exim client" "SECID170"
23983 .cindex "authentication" "on an Exim client"
23984 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23985 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23986 announces support for authentication, and the host matches an entry in either
23987 of these options, Exim (as a client) tries to authenticate as follows:
23988
23989 .ilist
23990 For each authenticator that is configured as a client, in the order in which
23991 they are defined in the configuration, it searches the authentication
23992 mechanisms announced by the server for one whose name matches the public name
23993 of the authenticator.
23994 .next
23995 .vindex "&$host$&"
23996 .vindex "&$host_address$&"
23997 When it finds one that matches, it runs the authenticator's client code. The
23998 variables &$host$& and &$host_address$& are available for any string expansions
23999 that the client might do. They are set to the server's name and IP address. If
24000 any expansion is forced to fail, the authentication attempt is abandoned, and
24001 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24002 delivery to be deferred.
24003 .next
24004 If the result of the authentication attempt is a temporary error or a timeout,
24005 Exim abandons trying to send the message to the host for the moment. It will
24006 try again later. If there are any backup hosts available, they are tried in the
24007 usual way.
24008 .next
24009 If the response to authentication is a permanent error (5&'xx'& code), Exim
24010 carries on searching the list of authenticators and tries another one if
24011 possible. If all authentication attempts give permanent errors, or if there are
24012 no attempts because no mechanisms match (or option expansions force failure),
24013 what happens depends on whether the host matches &%hosts_require_auth%& or
24014 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24015 delivery is deferred. The error can be detected in the retry rules, and thereby
24016 turned into a permanent error if you wish. In the second case, Exim tries to
24017 deliver the message unauthenticated.
24018 .endlist
24019
24020 .cindex "AUTH" "on MAIL command"
24021 When Exim has authenticated itself to a remote server, it adds the AUTH
24022 parameter to the MAIL commands it sends, if it has an authenticated sender for
24023 the message. If the message came from a remote host, the authenticated sender
24024 is the one that was receiving on an incoming MAIL command, provided that the
24025 incoming connection was authenticated and the &%server_mail_auth%& condition
24026 allowed the authenticated sender to be retained. If a local process calls Exim
24027 to send a message, the sender address that is built from the login name and
24028 &%qualify_domain%& is treated as authenticated. However, if the
24029 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24030 the authenticated sender that was received with the message.
24031 .ecindex IIDauthconf1
24032 .ecindex IIDauthconf2
24033
24034
24035
24036
24037
24038
24039 . ////////////////////////////////////////////////////////////////////////////
24040 . ////////////////////////////////////////////////////////////////////////////
24041
24042 .chapter "The plaintext authenticator" "CHAPplaintext"
24043 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24044 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24045 The &(plaintext)& authenticator can be configured to support the PLAIN and
24046 LOGIN authentication mechanisms, both of which transfer authentication data as
24047 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24048 security risk; you are strongly advised to insist on the use of SMTP encryption
24049 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24050 use unencrypted plain text, you should not use the same passwords for SMTP
24051 connections as you do for login accounts.
24052
24053 .section "Plaintext options" "SECID171"
24054 .cindex "options" "&(plaintext)& authenticator (server)"
24055 When configured as a server, &(plaintext)& uses the following options:
24056
24057 .option server_condition authenticators string&!! unset
24058 This is actually a global authentication option, but it must be set in order to
24059 configure the &(plaintext)& driver as a server. Its use is described below.
24060
24061 .option server_prompts plaintext string&!! unset
24062 The contents of this option, after expansion, must be a colon-separated list of
24063 prompt strings. If expansion fails, a temporary authentication rejection is
24064 given.
24065
24066 .section "Using plaintext in a server" "SECTplainserver"
24067 .cindex "AUTH" "in &(plaintext)& authenticator"
24068 .cindex "binary zero" "in &(plaintext)& authenticator"
24069 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24070         "in &(plaintext)& authenticator"
24071 .vindex "&$auth1$&, &$auth2$&, etc"
24072 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24073
24074 When running as a server, &(plaintext)& performs the authentication test by
24075 expanding a string. The data sent by the client with the AUTH command, or in
24076 response to subsequent prompts, is base64 encoded, and so may contain any byte
24077 values when decoded. If any data is supplied with the command, it is treated as
24078 a list of strings, separated by NULs (binary zeros), the first three of which
24079 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24080 (neither LOGIN nor PLAIN uses more than three strings).
24081
24082 For compatibility with previous releases of Exim, the values are also placed in
24083 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24084 variables for this purpose is now deprecated, as it can lead to confusion in
24085 string expansions that also use them for other things.
24086
24087 If there are more strings in &%server_prompts%& than the number of strings
24088 supplied with the AUTH command, the remaining prompts are used to obtain more
24089 data. Each response from the client may be a list of NUL-separated strings.
24090
24091 .vindex "&$authenticated_id$&"
24092 Once a sufficient number of data strings have been received,
24093 &%server_condition%& is expanded. If the expansion is forced to fail,
24094 authentication fails. Any other expansion failure causes a temporary error code
24095 to be returned. If the result of a successful expansion is an empty string,
24096 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24097 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24098 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24099 For any other result, a temporary error code is returned, with the expanded
24100 string as the error text.
24101
24102 &*Warning*&: If you use a lookup in the expansion to find the user's
24103 password, be sure to make the authentication fail if the user is unknown.
24104 There are good and bad examples at the end of the next section.
24105
24106
24107
24108 .section "The PLAIN authentication mechanism" "SECID172"
24109 .cindex "PLAIN authentication mechanism"
24110 .cindex "authentication" "PLAIN mechanism"
24111 .cindex "binary zero" "in &(plaintext)& authenticator"
24112 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24113 sent as one item of data (that is, one combined string containing two NUL
24114 separators). The data is sent either as part of the AUTH command, or
24115 subsequently in response to an empty prompt from the server.
24116
24117 The second and third strings are a user name and a corresponding password.
24118 Using a single fixed user name and password as an example, this could be
24119 configured as follows:
24120 .code
24121 fixed_plain:
24122   driver = plaintext
24123   public_name = PLAIN
24124   server_prompts = :
24125   server_condition = \
24126     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24127   server_set_id = $auth2
24128 .endd
24129 Note that the default result strings from &%if%& (&"true"& or an empty string)
24130 are exactly what we want here, so they need not be specified. Obviously, if the
24131 password contains expansion-significant characters such as dollar, backslash,
24132 or closing brace, they have to be escaped.
24133
24134 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24135 the end of a string list are ignored). If all the data comes as part of the
24136 AUTH command, as is commonly the case, the prompt is not used. This
24137 authenticator is advertised in the response to EHLO as
24138 .code
24139 250-AUTH PLAIN
24140 .endd
24141 and a client host can authenticate itself by sending the command
24142 .code
24143 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24144 .endd
24145 As this contains three strings (more than the number of prompts), no further
24146 data is required from the client. Alternatively, the client may just send
24147 .code
24148 AUTH PLAIN
24149 .endd
24150 to initiate authentication, in which case the server replies with an empty
24151 prompt. The client must respond with the combined data string.
24152
24153 The data string is base64 encoded, as required by the RFC. This example,
24154 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24155 represents a zero byte. This is split up into three strings, the first of which
24156 is empty. The &%server_condition%& option in the authenticator checks that the
24157 second two are &`username`& and &`mysecret`& respectively.
24158
24159 Having just one fixed user name and password, as in this example, is not very
24160 realistic, though for a small organization with only a handful of
24161 authenticating clients it could make sense.
24162
24163 A more sophisticated instance of this authenticator could use the user name in
24164 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24165 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24166 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24167 This is an incorrect example:
24168 .code
24169 server_condition = \
24170   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24171 .endd
24172 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24173 which it then compares to the supplied password (&$auth3$&). Why is this example
24174 incorrect? It works fine for existing users, but consider what happens if a
24175 non-existent user name is given. The lookup fails, but as no success/failure
24176 strings are given for the lookup, it yields an empty string. Thus, to defeat
24177 the authentication, all a client has to do is to supply a non-existent user
24178 name and an empty password. The correct way of writing this test is:
24179 .code
24180 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24181   {${if eq{$value}{$auth3}}} {false}}
24182 .endd
24183 In this case, if the lookup succeeds, the result is checked; if the lookup
24184 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24185 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24186 always fails if its second argument is empty. However, the second way of
24187 writing the test makes the logic clearer.
24188
24189
24190 .section "The LOGIN authentication mechanism" "SECID173"
24191 .cindex "LOGIN authentication mechanism"
24192 .cindex "authentication" "LOGIN mechanism"
24193 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24194 in a number of programs. No data is sent with the AUTH command. Instead, a
24195 user name and password are supplied separately, in response to prompts. The
24196 plaintext authenticator can be configured to support this as in this example:
24197 .code
24198 fixed_login:
24199   driver = plaintext
24200   public_name = LOGIN
24201   server_prompts = User Name : Password
24202   server_condition = \
24203     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24204   server_set_id = $auth1
24205 .endd
24206 Because of the way plaintext operates, this authenticator accepts data supplied
24207 with the AUTH command (in contravention of the specification of LOGIN), but
24208 if the client does not supply it (as is the case for LOGIN clients), the prompt
24209 strings are used to obtain two data items.
24210
24211 Some clients are very particular about the precise text of the prompts. For
24212 example, Outlook Express is reported to recognize only &"Username:"& and
24213 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24214 strings. It uses the &%ldapauth%& expansion condition to check the user
24215 name and password by binding to an LDAP server:
24216 .code
24217 login:
24218   driver = plaintext
24219   public_name = LOGIN
24220   server_prompts = Username:: : Password::
24221   server_condition = ${if and{{ \
24222     !eq{}{$auth1} }{ \
24223     ldapauth{\
24224       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24225       pass=${quote:$auth2} \
24226       ldap://ldap.example.org/} }} }
24227   server_set_id = uid=$auth1,ou=people,o=example.org
24228 .endd
24229 We have to check that the username is not empty before using it, because LDAP
24230 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24231 operator to correctly quote the DN for authentication. However, the basic
24232 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24233 correct one to use for the password, because quoting is needed only to make
24234 the password conform to the Exim syntax. At the LDAP level, the password is an
24235 uninterpreted string.
24236
24237
24238 .section "Support for different kinds of authentication" "SECID174"
24239 A number of string expansion features are provided for the purpose of
24240 interfacing to different ways of user authentication. These include checking
24241 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24242 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24243 &<<SECTexpcond>>&.
24244
24245
24246
24247
24248 .section "Using plaintext in a client" "SECID175"
24249 .cindex "options" "&(plaintext)& authenticator (client)"
24250 The &(plaintext)& authenticator has two client options:
24251
24252 .option client_ignore_invalid_base64 plaintext boolean false
24253 If the client receives a server prompt that is not a valid base64 string,
24254 authentication is abandoned by default. However, if this option is set true,
24255 the error in the challenge is ignored and the client sends the response as
24256 usual.
24257
24258 .option client_send plaintext string&!! unset
24259 The string is a colon-separated list of authentication data strings. Each
24260 string is independently expanded before being sent to the server. The first
24261 string is sent with the AUTH command; any more strings are sent in response
24262 to prompts from the server. Before each string is expanded, the value of the
24263 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24264 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24265 way. Thus, the prompt that is received in response to sending the first string
24266 (with the AUTH command) can be used in the expansion of the second string, and
24267 so on. If an invalid base64 string is received when
24268 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24269 &$auth$&<&'n'&> variable.
24270
24271 &*Note*&: You cannot use expansion to create multiple strings, because
24272 splitting takes priority and happens first.
24273
24274 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24275 the data, further processing is applied to each string before it is sent. If
24276 there are any single circumflex characters in the string, they are converted to
24277 NULs. Should an actual circumflex be required as data, it must be doubled in
24278 the string.
24279
24280 This is an example of a client configuration that implements the PLAIN
24281 authentication mechanism with a fixed user name and password:
24282 .code
24283 fixed_plain:
24284   driver = plaintext
24285   public_name = PLAIN
24286   client_send = ^username^mysecret
24287 .endd
24288 The lack of colons means that the entire text is sent with the AUTH
24289 command, with the circumflex characters converted to NULs. A similar example
24290 that uses the LOGIN mechanism is:
24291 .code
24292 fixed_login:
24293   driver = plaintext
24294   public_name = LOGIN
24295   client_send = : username : mysecret
24296 .endd
24297 The initial colon means that the first string is empty, so no data is sent with
24298 the AUTH command itself. The remaining strings are sent in response to
24299 prompts.
24300 .ecindex IIDplaiauth1
24301 .ecindex IIDplaiauth2
24302
24303
24304
24305
24306 . ////////////////////////////////////////////////////////////////////////////
24307 . ////////////////////////////////////////////////////////////////////////////
24308
24309 .chapter "The cram_md5 authenticator" "CHID9"
24310 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24311 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24312 .cindex "CRAM-MD5 authentication mechanism"
24313 .cindex "authentication" "CRAM-MD5 mechanism"
24314 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24315 sends a challenge string to the client, and the response consists of a user
24316 name and the CRAM-MD5 digest of the challenge string combined with a secret
24317 string (password) which is known to both server and client. Thus, the secret
24318 is not sent over the network as plain text, which makes this authenticator more
24319 secure than &(plaintext)&. However, the downside is that the secret has to be
24320 available in plain text at either end.
24321
24322
24323 .section "Using cram_md5 as a server" "SECID176"
24324 .cindex "options" "&(cram_md5)& authenticator (server)"
24325 This authenticator has one server option, which must be set to configure the
24326 authenticator as a server:
24327
24328 .option server_secret cram_md5 string&!! unset
24329 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24330 When the server receives the client's response, the user name is placed in
24331 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24332 obtain the password for that user. The server then computes the CRAM-MD5 digest
24333 that the client should have sent, and checks that it received the correct
24334 string. If the expansion of &%server_secret%& is forced to fail, authentication
24335 fails. If the expansion fails for some other reason, a temporary error code is
24336 returned to the client.
24337
24338 For compatibility with previous releases of Exim, the user name is also placed
24339 in &$1$&. However, the use of this variables for this purpose is now
24340 deprecated, as it can lead to confusion in string expansions that also use
24341 numeric variables for other things.
24342
24343 For example, the following authenticator checks that the user name given by the
24344 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24345 user name, authentication fails.
24346 .code
24347 fixed_cram:
24348   driver = cram_md5
24349   public_name = CRAM-MD5
24350   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24351   server_set_id = $auth1
24352 .endd
24353 .vindex "&$authenticated_id$&"
24354 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24355 name in &$authenticated_id$&. A more typical configuration might look up the
24356 secret string in a file, using the user name as the key. For example:
24357 .code
24358 lookup_cram:
24359   driver = cram_md5
24360   public_name = CRAM-MD5
24361   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24362                   {$value}fail}
24363   server_set_id = $auth1
24364 .endd
24365 Note that this expansion explicitly forces failure if the lookup fails
24366 because &$auth1$& contains an unknown user name.
24367
24368 .new
24369 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24370 using the relevant libraries, you need to know the realm to specify in the
24371 lookup and then ask for the &"userPassword"& attribute for that user in that
24372 realm, with:
24373 .code
24374 cyrusless_crammd5:
24375   driver = cram_md5
24376   public_name = CRAM-MD5
24377   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24378                   dbmjz{/etc/sasldb2}}
24379   server_set_id = $auth1
24380 .endd
24381 .wen
24382
24383 .section "Using cram_md5 as a client" "SECID177"
24384 .cindex "options" "&(cram_md5)& authenticator (client)"
24385 When used as a client, the &(cram_md5)& authenticator has two options:
24386
24387
24388
24389 .option client_name cram_md5 string&!! "the primary host name"
24390 This string is expanded, and the result used as the user name data when
24391 computing the response to the server's challenge.
24392
24393
24394 .option client_secret cram_md5 string&!! unset
24395 This option must be set for the authenticator to work as a client. Its value is
24396 expanded and the result used as the secret string when computing the response.
24397
24398
24399 .vindex "&$host$&"
24400 .vindex "&$host_address$&"
24401 Different user names and secrets can be used for different servers by referring
24402 to &$host$& or &$host_address$& in the options. Forced failure of either
24403 expansion string is treated as an indication that this authenticator is not
24404 prepared to handle this case. Exim moves on to the next configured client
24405 authenticator. Any other expansion failure causes Exim to give up trying to
24406 send the message to the current server.
24407
24408 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24409 strings, is:
24410 .code
24411 fixed_cram:
24412   driver = cram_md5
24413   public_name = CRAM-MD5
24414   client_name = ph10
24415   client_secret = secret
24416 .endd
24417 .ecindex IIDcramauth1
24418 .ecindex IIDcramauth2
24419
24420
24421
24422 . ////////////////////////////////////////////////////////////////////////////
24423 . ////////////////////////////////////////////////////////////////////////////
24424
24425 .chapter "The cyrus_sasl authenticator" "CHID10"
24426 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24427 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24428 .cindex "Cyrus" "SASL library"
24429 .cindex "Kerberos"
24430 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24431 Digital Ltd (&url(http://www.aldigital.co.uk)).
24432
24433 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24434 library implementation of the RFC 2222 (&"Simple Authentication and Security
24435 Layer"&). This library supports a number of authentication mechanisms,
24436 including PLAIN and LOGIN, but also several others that Exim does not support
24437 directly. In particular, there is support for Kerberos authentication.
24438
24439 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24440 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24441 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24442 name of the driver to determine which mechanism to support.
24443
24444 Where access to some kind of secret file is required, for example in GSSAPI
24445 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24446 user, and that the Cyrus SASL library has no way of escalating privileges
24447 by default. You may also find you need to set environment variables,
24448 depending on the driver you are using.
24449
24450 The application name provided by Exim is &"exim"&, so various SASL options may
24451 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24452 Kerberos, note that because of limitations in the GSSAPI interface,
24453 changing the server keytab might need to be communicated down to the Kerberos
24454 layer independently. The mechanism for doing so is dependent upon the Kerberos
24455 implementation.
24456 .new
24457 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24458 may be set to point to an alternative keytab file. Exim will pass this
24459 variable through from its own inherited environment when started as root or the
24460 Exim user. The keytab file needs to be readable by the Exim user.
24461 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24462 environment variable.  In practice, for those releases, the Cyrus authenticator
24463 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24464 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24465 .wen
24466
24467
24468 .section "Using cyrus_sasl as a server" "SECID178"
24469 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24470 (on a successful authentication) into &$auth1$&. For compatibility with
24471 previous releases of Exim, the username is also placed in &$1$&. However, the
24472 use of this variable for this purpose is now deprecated, as it can lead to
24473 confusion in string expansions that also use numeric variables for other
24474 things.
24475
24476
24477 .option server_hostname cyrus_sasl string&!! "see below"
24478 This option selects the hostname that is used when communicating with the
24479 library. The default value is &`$primary_hostname`&. It is up to the underlying
24480 SASL plug-in what it does with this data.
24481
24482
24483 .option server_mech cyrus_sasl string "see below"
24484 This option selects the authentication mechanism this driver should use. The
24485 default is the value of the generic &%public_name%& option. This option allows
24486 you to use a different underlying mechanism from the advertised name. For
24487 example:
24488 .code
24489 sasl:
24490   driver = cyrus_sasl
24491   public_name = X-ANYTHING
24492   server_mech = CRAM-MD5
24493   server_set_id = $auth1
24494 .endd
24495
24496 .new
24497 .option server_realm cyrus_sasl string&!! unset
24498 This specifies the SASL realm that the server claims to be in.
24499 .wen
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 .new
24573 .chapter "The gsasl authenticator" "CHAPgsasl"
24574 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24575 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24576 .cindex "authentication" "GNU SASL"
24577 .cindex "authentication" "SASL"
24578 .cindex "authentication" "EXTERNAL"
24579 .cindex "authentication" "ANONYMOUS"
24580 .cindex "authentication" "PLAIN"
24581 .cindex "authentication" "LOGIN"
24582 .cindex "authentication" "DIGEST-MD5"
24583 .cindex "authentication" "CRAM-MD5"
24584 .cindex "authentication" "SCRAM-SHA-1"
24585 The &(gsasl)& authenticator provides server integration for the GNU SASL
24586 library and the mechanisms it provides.  This is new as of the 4.80 release
24587 and there are a few areas where the library does not let Exim smoothly
24588 scale to handle future authentication mechanisms, so no guarantee can be
24589 made that any particular new authentication mechanism will be supported
24590 without code changes in Exim.
24591
24592
24593 .option server_channelbinding gsasl boolean false
24594 Some authentication mechanisms are able to use external context at both ends
24595 of the session to bind the authentication to that context, and fail the
24596 authentication process if that context differs.  Specifically, some TLS
24597 ciphersuites can provide identifying information about the cryptographic
24598 context.
24599
24600 This means that certificate identity and verification becomes a non-issue,
24601 as a man-in-the-middle attack will cause the correct client and server to
24602 see different identifiers and authentication will fail.
24603
24604 This is currently only supported when using the GnuTLS library.  This is
24605 only usable by mechanisms which support "channel binding"; at time of
24606 writing, that's the SCRAM family.
24607
24608 This defaults off to ensure smooth upgrade across Exim releases, in case
24609 this option causes some clients to start failing.  Some future release
24610 of Exim may switch the default to be true.
24611
24612
24613 .option server_hostname gsasl string&!! "see below"
24614 This option selects the hostname that is used when communicating with the
24615 library. The default value is &`$primary_hostname`&.
24616 Some mechanisms will use this data.
24617
24618
24619 .option server_mech gsasl string "see below"
24620 This option selects the authentication mechanism this driver should use. The
24621 default is the value of the generic &%public_name%& option. This option allows
24622 you to use a different underlying mechanism from the advertised name. For
24623 example:
24624 .code
24625 sasl:
24626   driver = gsasl
24627   public_name = X-ANYTHING
24628   server_mech = CRAM-MD5
24629   server_set_id = $auth1
24630 .endd
24631
24632
24633 .option server_password gsasl string&!! unset
24634 Various mechanisms need access to the cleartext password on the server, so
24635 that proof-of-possession can be demonstrated on the wire, without sending
24636 the password itself.
24637
24638 The data available for lookup varies per mechanism.
24639 In all cases, &$auth1$& is set to the &'authentication id'&.
24640 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24641 if available, else the empty string.
24642 The &$auth3$& variable will always be the &'realm'& if available,
24643 else the empty string.
24644
24645 A forced failure will cause authentication to defer.
24646
24647 If using this option, it may make sense to set the &%server_condition%&
24648 option to be simply "true".
24649
24650
24651 .option server_realm gsasl string&!! unset
24652 This specifies the SASL realm that the server claims to be in.
24653 Some mechanisms will use this data.
24654
24655
24656 .option server_scram_iter gsasl string&!! unset
24657 This option provides data for the SCRAM family of mechanisms.
24658 &$auth1$& is not available at evaluation time.
24659 (This may change, as we receive feedback on use)
24660
24661
24662 .option server_scram_salt gsasl string&!! unset
24663 This option provides data for the SCRAM family of mechanisms.
24664 &$auth1$& is not available at evaluation time.
24665 (This may change, as we receive feedback on use)
24666
24667
24668 .option server_service gsasl string &`smtp`&
24669 This is the SASL service that the server claims to implement.
24670 Some mechanisms will use this data.
24671
24672
24673 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24674 .vindex "&$auth1$&, &$auth2$&, etc"
24675 These may be set when evaluating specific options, as detailed above.
24676 They will also be set when evaluating &%server_condition%&.
24677
24678 Unless otherwise stated below, the &(gsasl)& integration will use the following
24679 meanings for these variables:
24680
24681 .ilist
24682 .vindex "&$auth1$&"
24683 &$auth1$&: the &'authentication id'&
24684 .next
24685 .vindex "&$auth2$&"
24686 &$auth2$&: the &'authorization id'&
24687 .next
24688 .vindex "&$auth3$&"
24689 &$auth3$&: the &'realm'&
24690 .endlist
24691
24692 On a per-mechanism basis:
24693
24694 .ilist
24695 .cindex "authentication" "EXTERNAL"
24696 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
24697 the &%server_condition%& option must be present.
24698 .next
24699 .cindex "authentication" "ANONYMOUS"
24700 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
24701 the &%server_condition%& option must be present.
24702 .next
24703 .cindex "authentication" "GSSAPI"
24704 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
24705 &$auth2$& will be set to the &'authorization id'&,
24706 the &%server_condition%& option must be present.
24707 .endlist
24708
24709 An &'anonymous token'& is something passed along as an unauthenticated
24710 identifier; this is analogous to FTP anonymous authentication passing an
24711 email address, or software-identifier@, as the "password".
24712
24713
24714 An example showing the password having the realm specified in the callback
24715 and demonstrating a Cyrus SASL to GSASL migration approach is:
24716 .code
24717 gsasl_cyrusless_crammd5:
24718   driver = gsasl
24719   public_name = CRAM-MD5
24720   server_realm = imap.example.org
24721   server_password = ${lookup{$auth1:$auth3:userPassword}\
24722                     dbmjz{/etc/sasldb2}{$value}fail}
24723   server_set_id = ${quote:$auth1}
24724   server_condition = yes
24725 .endd
24726
24727 .wen
24728
24729 . ////////////////////////////////////////////////////////////////////////////
24730 . ////////////////////////////////////////////////////////////////////////////
24731
24732 .new
24733 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
24734 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
24735 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
24736 .cindex "authentication" "GSSAPI"
24737 .cindex "authentication" "Kerberos"
24738 The &(heimdal_gssapi)& authenticator provides server integration for the
24739 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
24740 reliably.
24741
24742 .option server_hostname heimdal_gssapi string&!! "see below"
24743 This option selects the hostname that is used, with &%server_service%&,
24744 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
24745 identifier.  The default value is &`$primary_hostname`&.
24746
24747 .option server_keytab heimdal_gssapi string&!! unset
24748 If set, then Heimdal will not use the system default keytab (typically
24749 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
24750 The value should be a pathname, with no &"file:"& prefix.
24751
24752 .option server_service heimdal_gssapi string&!! "smtp"
24753 This option specifies the service identifier used, in conjunction with
24754 &%server_hostname%&, for building the identifer for finding credentials
24755 from the keytab.
24756
24757
24758 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
24759 Beware that these variables will typically include a realm, thus will appear
24760 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
24761 not verified, so a malicious client can set it to anything.
24762
24763 The &$auth1$& field should be safely trustable as a value from the Key
24764 Distribution Center.  Note that these are not quite email addresses.
24765 Each identifier is for a role, and so the left-hand-side may include a
24766 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
24767
24768 .vindex "&$auth1$&, &$auth2$&, etc"
24769 .ilist
24770 .vindex "&$auth1$&"
24771 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
24772 .next
24773 .vindex "&$auth2$&"
24774 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
24775 authentication.  If that was empty, this will also be set to the
24776 GSS Display Name.
24777 .endlist
24778
24779 .wen
24780
24781 . ////////////////////////////////////////////////////////////////////////////
24782 . ////////////////////////////////////////////////////////////////////////////
24783
24784 .chapter "The spa authenticator" "CHAPspa"
24785 .scindex IIDspaauth1 "&(spa)& authenticator"
24786 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24787 .cindex "authentication" "Microsoft Secure Password"
24788 .cindex "authentication" "NTLM"
24789 .cindex "Microsoft Secure Password Authentication"
24790 .cindex "NTLM authentication"
24791 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24792 Password Authentication'& mechanism,
24793 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24794 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24795 taken from the Samba project (&url(http://www.samba.org)). The code for the
24796 server side was subsequently contributed by Tom Kistner. The mechanism works as
24797 follows:
24798
24799 .ilist
24800 After the AUTH command has been accepted, the client sends an SPA
24801 authentication request based on the user name and optional domain.
24802 .next
24803 The server sends back a challenge.
24804 .next
24805 The client builds a challenge response which makes use of the user's password
24806 and sends it to the server, which then accepts or rejects it.
24807 .endlist
24808
24809 Encryption is used to protect the password in transit.
24810
24811
24812
24813 .section "Using spa as a server" "SECID179"
24814 .cindex "options" "&(spa)& authenticator (server)"
24815 The &(spa)& authenticator has just one server option:
24816
24817 .option server_password spa string&!! unset
24818 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24819 This option is expanded, and the result must be the cleartext password for the
24820 authenticating user, whose name is at this point in &$auth1$&. For
24821 compatibility with previous releases of Exim, the user name is also placed in
24822 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24823 it can lead to confusion in string expansions that also use numeric variables
24824 for other things. For example:
24825 .code
24826 spa:
24827   driver = spa
24828   public_name = NTLM
24829   server_password = \
24830     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24831 .endd
24832 If the expansion is forced to fail, authentication fails. Any other expansion
24833 failure causes a temporary error code to be returned.
24834
24835
24836
24837
24838
24839 .section "Using spa as a client" "SECID180"
24840 .cindex "options" "&(spa)& authenticator (client)"
24841 The &(spa)& authenticator has the following client options:
24842
24843
24844
24845 .option client_domain spa string&!! unset
24846 This option specifies an optional domain for the authentication.
24847
24848
24849 .option client_password spa string&!! unset
24850 This option specifies the user's password, and must be set.
24851
24852
24853 .option client_username spa string&!! unset
24854 This option specifies the user name, and must be set. Here is an example of a
24855 configuration of this authenticator for use with the mail servers at
24856 &'msn.com'&:
24857 .code
24858 msn:
24859   driver = spa
24860   public_name = MSN
24861   client_username = msn/msn_username
24862   client_password = msn_plaintext_password
24863   client_domain = DOMAIN_OR_UNSET
24864 .endd
24865 .ecindex IIDspaauth1
24866 .ecindex IIDspaauth2
24867
24868
24869
24870
24871
24872 . ////////////////////////////////////////////////////////////////////////////
24873 . ////////////////////////////////////////////////////////////////////////////
24874
24875 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24876          "Encrypted SMTP connections"
24877 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24878 .scindex IIDencsmtp2 "SMTP" "encryption"
24879 .cindex "TLS" "on SMTP connection"
24880 .cindex "OpenSSL"
24881 .cindex "GnuTLS"
24882 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24883 Sockets Layer), is implemented by making use of the OpenSSL library or the
24884 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24885 cryptographic code in the Exim distribution itself for implementing TLS. In
24886 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24887 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24888 You also need to understand the basic concepts of encryption at a managerial
24889 level, and in particular, the way that public keys, private keys, and
24890 certificates are used.
24891
24892 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24893 connection is established, the client issues a STARTTLS command. If the
24894 server accepts this, the client and the server negotiate an encryption
24895 mechanism. If the negotiation succeeds, the data that subsequently passes
24896 between them is encrypted.
24897
24898 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24899 and if so, what cipher suite is in use, whether the client supplied a
24900 certificate, and whether or not that certificate was verified. This makes it
24901 possible for an Exim server to deny or accept certain commands based on the
24902 encryption state.
24903
24904 &*Warning*&: Certain types of firewall and certain anti-virus products can
24905 disrupt TLS connections. You need to turn off SMTP scanning for these products
24906 in order to get TLS to work.
24907
24908
24909
24910 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24911          "SECID284"
24912 .cindex "ssmtp protocol"
24913 .cindex "smtps protocol"
24914 .cindex "SMTP" "ssmtp protocol"
24915 .cindex "SMTP" "smtps protocol"
24916 Early implementations of encrypted SMTP used a different TCP port from normal
24917 SMTP, and expected an encryption negotiation to start immediately, instead of
24918 waiting for a STARTTLS command from the client using the standard SMTP
24919 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24920 allocated for this purpose.
24921
24922 This approach was abandoned when encrypted SMTP was standardized, but there are
24923 still some legacy clients that use it. Exim supports these clients by means of
24924 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24925 numbers; the most common use is expected to be:
24926 .code
24927 tls_on_connect_ports = 465
24928 .endd
24929 The port numbers specified by this option apply to all SMTP connections, both
24930 via the daemon and via &'inetd'&. You still need to specify all the ports that
24931 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24932 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24933 an extra port &-- rather, it specifies different behaviour on a port that is
24934 defined elsewhere.
24935
24936 There is also a &%-tls-on-connect%& command line option. This overrides
24937 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24938
24939
24940
24941
24942
24943
24944 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24945 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24946 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24947 followed later, when the first versions of GnuTLS were released. To build Exim
24948 to use GnuTLS, you need to set
24949 .code
24950 USE_GNUTLS=yes
24951 .endd
24952 in Local/Makefile, in addition to
24953 .code
24954 SUPPORT_TLS=yes
24955 .endd
24956 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24957 include files and libraries for GnuTLS can be found.
24958
24959 There are some differences in usage when using GnuTLS instead of OpenSSL:
24960
24961 .ilist
24962 The &%tls_verify_certificates%& option must contain the name of a file, not the
24963 name of a directory (for OpenSSL it can be either).
24964 .next
24965 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24966 facility for varying its Diffie-Hellman parameters.
24967 .new
24968 Since then, the GnuTLS support has been updated to generate parameters upon
24969 demand, keeping them in the spool directory.  See &<<SECTgnutlsparam>>& for
24970 details.
24971 .wen
24972 .next
24973 .vindex "&$tls_peerdn$&"
24974 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24975 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24976 affects the value of the &$tls_peerdn$& variable.
24977 .next
24978 OpenSSL identifies cipher suites using hyphens as separators, for example:
24979 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
24980 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
24981 in a cipher list. To make life simpler, Exim changes underscores to hyphens
24982 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
24983 to handle its own older variants) when processing lists of cipher suites in the
24984 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24985 option).
24986 .next
24987 The &%tls_require_ciphers%& options operate differently, as described in the
24988 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24989 .new
24990 .next
24991 Some other recently added features may only be available in one or the other.
24992 This should be documented with the feature.  If the documentation does not
24993 explicitly state that the feature is infeasible in the other TLS
24994 implementation, then patches are welcome.
24995 .wen
24996 .endlist
24997
24998
24999 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25000 .new
25001 GnuTLS uses D-H parameters that may take a substantial amount of time
25002 to compute. It is unreasonable to re-compute them for every TLS session.
25003 Therefore, Exim keeps this data in a file in its spool directory, called
25004 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25005 of bits requested.
25006 The file is owned by the Exim user and is readable only by
25007 its owner. Every Exim process that start up GnuTLS reads the D-H
25008 parameters from this file. If the file does not exist, the first Exim process
25009 that needs it computes the data and writes it to a temporary file which is
25010 renamed once it is complete. It does not matter if several Exim processes do
25011 this simultaneously (apart from wasting a few resources). Once a file is in
25012 place, new Exim processes immediately start using it.
25013
25014 For maximum security, the parameters that are stored in this file should be
25015 recalculated periodically, the frequency depending on your paranoia level.
25016 Arranging this is easy in principle; just delete the file when you want new
25017 values to be computed. However, there may be a problem. The calculation of new
25018 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25019 If the system is not very active, &_/dev/random_& may delay returning data
25020 until enough randomness (entropy) is available. This may cause Exim to hang for
25021 a substantial amount of time, causing timeouts on incoming connections.
25022
25023 The solution is to generate the parameters externally to Exim. They are stored
25024 in &_gnutls-params-N_& in PEM format, which means that they can be
25025 generated externally using the &(certtool)& command that is part of GnuTLS.
25026
25027 To replace the parameters with new ones, instead of deleting the file
25028 and letting Exim re-create it, you can generate new parameters using
25029 &(certtool)& and, when this has been done, replace Exim's cache file by
25030 renaming. The relevant commands are something like this:
25031 .code
25032 # ls
25033 [ look for file; assume gnutls-params-2236 is the most recent ]
25034 # rm -f new-params
25035 # touch new-params
25036 # chown exim:exim new-params
25037 # chmod 0600 new-params
25038 # certtool --generate-dh-params --bits 2236 >>new-params
25039 # chmod 0400 new-params
25040 # mv new-params gnutls-params-2236
25041 .endd
25042 If Exim never has to generate the parameters itself, the possibility of
25043 stalling is removed.
25044
25045 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25046 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25047 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25048 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25049 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25050 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25051 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25052 which applies to all D-H usage, client or server.  If the value returned by
25053 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25054 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25055 limit, which is still much higher than Exim historically used.
25056
25057 The filename and bits used will change as the GnuTLS maintainers change the
25058 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25059 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25060 2432 bits, while NSS is limited to 2236 bits.
25061 .wen
25062
25063
25064 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25065 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25066 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25067 There is a function in the OpenSSL library that can be passed a list of cipher
25068 suites before the cipher negotiation takes place. This specifies which ciphers
25069 are acceptable. The list is colon separated and may contain names like
25070 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25071 directly to this function call. The following quotation from the OpenSSL
25072 documentation specifies what forms of item are allowed in the cipher string:
25073
25074 .ilist
25075 It can consist of a single cipher suite such as RC4-SHA.
25076 .next
25077 It can represent a list of cipher suites containing a certain algorithm,
25078 or cipher suites of a certain type. For example SHA1 represents all
25079 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25080 SSL v3 algorithms.
25081 .next
25082 Lists of cipher suites can be combined in a single cipher string using
25083 the + character. This is used as a logical and operation. For example
25084 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25085 algorithms.
25086 .endlist
25087
25088 Each cipher string can be optionally preceded by one of the characters &`!`&,
25089 &`-`& or &`+`&.
25090 .ilist
25091 If &`!`& is used, the ciphers are permanently deleted from the list. The
25092 ciphers deleted can never reappear in the list even if they are explicitly
25093 stated.
25094 .next
25095 If &`-`& is used, the ciphers are deleted from the list, but some or all
25096 of the ciphers can be added again by later options.
25097 .next
25098 If &`+`& is used, the ciphers are moved to the end of the list. This
25099 option does not add any new ciphers; it just moves matching existing ones.
25100 .endlist
25101
25102 If none of these characters is present, the string is interpreted as
25103 a list of ciphers to be appended to the current preference list. If the list
25104 includes any ciphers already present they will be ignored: that is, they will
25105 not be moved to the end of the list.
25106 .endlist
25107
25108
25109
25110 .new
25111 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25112          "SECTreqciphgnu"
25113 .cindex "GnuTLS" "specifying parameters for"
25114 .cindex "TLS" "specifying ciphers (GnuTLS)"
25115 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25116 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25117 .cindex "TLS" "specifying protocols (GnuTLS)"
25118 .cindex "TLS" "specifying priority string (GnuTLS)"
25119 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25120 The GnuTLS library allows the caller to provide a "priority string", documented
25121 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25122 ciphersuite specification in OpenSSL.
25123
25124 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25125
25126 The &%tls_require_ciphers%& option is available both as an global option,
25127 controlling how Exim behaves as a server, and also as an option of the
25128 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25129 the value is string expanded.  The resulting string is not an Exim list and
25130 the string is given to the GnuTLS library, so that Exim does not need to be
25131 aware of future feature enhancements of GnuTLS.
25132
25133 Documentation of the strings accepted may be found in the GnuTLS manual, under
25134 "Priority strings".  This is online as
25135 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html).
25136
25137 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25138 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25139 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25140 .wen
25141
25142
25143 .section "Configuring an Exim server to use TLS" "SECID182"
25144 .cindex "TLS" "configuring an Exim server"
25145 When Exim has been built with TLS support, it advertises the availability of
25146 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25147 but not to any others. The default value of this option is unset, which means
25148 that STARTTLS is not advertised at all. This default is chosen because you
25149 need to set some other options in order to make TLS available, and also it is
25150 sensible for systems that want to use TLS only as a client.
25151
25152 If a client issues a STARTTLS command and there is some configuration
25153 problem in the server, the command is rejected with a 454 error. If the client
25154 persists in trying to issue SMTP commands, all except QUIT are rejected
25155 with the error
25156 .code
25157 554 Security failure
25158 .endd
25159 If a STARTTLS command is issued within an existing TLS session, it is
25160 rejected with a 554 error code.
25161
25162 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25163 match some hosts. You can, of course, set it to * to match all hosts.
25164 However, this is not all you need to do. TLS sessions to a server won't work
25165 without some further configuration at the server end.
25166
25167 It is rumoured that all existing clients that support TLS/SSL use RSA
25168 encryption. To make this work you need to set, in the server,
25169 .code
25170 tls_certificate = /some/file/name
25171 tls_privatekey = /some/file/name
25172 .endd
25173 These options are, in fact, expanded strings, so you can make them depend on
25174 the identity of the client that is connected if you wish. The first file
25175 contains the server's X509 certificate, and the second contains the private key
25176 that goes with it. These files need to be readable by the Exim user, and must
25177 always be given as full path names. They can be the same file if both the
25178 certificate and the key are contained within it. If &%tls_privatekey%& is not
25179 set, or if its expansion is forced to fail or results in an empty string, this
25180 is assumed to be the case. The certificate file may also contain intermediate
25181 certificates that need to be sent to the client to enable it to authenticate
25182 the server's certificate.
25183
25184 If you do not understand about certificates and keys, please try to find a
25185 source of this background information, which is not Exim-specific. (There are a
25186 few comments below in section &<<SECTcerandall>>&.)
25187
25188 &*Note*&: These options do not apply when Exim is operating as a client &--
25189 they apply only in the case of a server. If you need to use a certificate in an
25190 Exim client, you must set the options of the same names in an &(smtp)&
25191 transport.
25192
25193 With just these options, an Exim server will be able to use TLS. It does not
25194 require the client to have a certificate (but see below for how to insist on
25195 this). There is one other option that may be needed in other situations. If
25196 .code
25197 tls_dhparam = /some/file/name
25198 .endd
25199 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25200 with the parameters contained in the file. This increases the set of cipher
25201 suites that the server supports. See the command
25202 .code
25203 openssl dhparam
25204 .endd
25205 for a way of generating this data. At present, &%tls_dhparam%& is used only
25206 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
25207
25208 The strings supplied for these three options are expanded every time a client
25209 host connects. It is therefore possible to use different certificates and keys
25210 for different hosts, if you so wish, by making use of the client's IP address
25211 in &$sender_host_address$& to control the expansion. If a string expansion is
25212 forced to fail, Exim behaves as if the option is not set.
25213
25214 .cindex "cipher" "logging"
25215 .cindex "log" "TLS cipher"
25216 .vindex "&$tls_cipher$&"
25217 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
25218 an incoming TLS connection. It is included in the &'Received:'& header of an
25219 incoming message (by default &-- you can, of course, change this), and it is
25220 also included in the log line that records a message's arrival, keyed by
25221 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25222 condition can be used to test for specific cipher suites in ACLs.
25223 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
25224 &<<SECID185>>&.)
25225
25226 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25227 can check the name of the cipher suite and vary their actions accordingly. The
25228 cipher suite names vary, depending on which TLS library is being used. For
25229 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25230 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25231 documentation for more details.
25232
25233
25234 .section "Requesting and verifying client certificates" "SECID183"
25235 .cindex "certificate" "verification of client"
25236 .cindex "TLS" "client certificate verification"
25237 If you want an Exim server to request a certificate when negotiating a TLS
25238 session with a client, you must set either &%tls_verify_hosts%& or
25239 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25240 apply to all TLS connections. For any host that matches one of these options,
25241 Exim requests a certificate as part of the setup of the TLS session. The
25242 contents of the certificate are verified by comparing it with a list of
25243 expected certificates. These must be available in a file or,
25244 for OpenSSL only (not GnuTLS), a directory, identified by
25245 &%tls_verify_certificates%&.
25246
25247 A file can contain multiple certificates, concatenated end to end. If a
25248 directory is used
25249 (OpenSSL only),
25250 each certificate must be in a separate file, with a name (or a symbolic link)
25251 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25252 certificate. You can compute the relevant hash by running the command
25253 .code
25254 openssl x509 -hash -noout -in /cert/file
25255 .endd
25256 where &_/cert/file_& contains a single certificate.
25257
25258 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25259 what happens if the client does not supply a certificate, or if the certificate
25260 does not match any of the certificates in the collection named by
25261 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25262 attempt to set up a TLS session is aborted, and the incoming connection is
25263 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25264 session continues. ACLs that run for subsequent SMTP commands can detect the
25265 fact that no certificate was verified, and vary their actions accordingly. For
25266 example, you can insist on a certificate before accepting a message for
25267 relaying, but not when the message is destined for local delivery.
25268
25269 .vindex "&$tls_peerdn$&"
25270 When a client supplies a certificate (whether it verifies or not), the value of
25271 the Distinguished Name of the certificate is made available in the variable
25272 &$tls_peerdn$& during subsequent processing of the message.
25273
25274 .cindex "log" "distinguished name"
25275 Because it is often a long text string, it is not included in the log line or
25276 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25277 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25278 &%received_header_text%& to change the &'Received:'& header. When no
25279 certificate is supplied, &$tls_peerdn$& is empty.
25280
25281
25282 .section "Revoked certificates" "SECID184"
25283 .cindex "TLS" "revoked certificates"
25284 .cindex "revocation list"
25285 .cindex "certificate" "revocation list"
25286 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25287 certificates are revoked. If you have such a list, you can pass it to an Exim
25288 server using the global option called &%tls_crl%& and to an Exim client using
25289 an identically named option for the &(smtp)& transport. In each case, the value
25290 of the option is expanded and must then be the name of a file that contains a
25291 CRL in PEM format.
25292
25293
25294 .section "Configuring an Exim client to use TLS" "SECID185"
25295 .cindex "cipher" "logging"
25296 .cindex "log" "TLS cipher"
25297 .cindex "log" "distinguished name"
25298 .cindex "TLS" "configuring an Exim client"
25299 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25300 deliveries as well as to incoming, the latter one causing logging of the
25301 server certificate's DN. The remaining client configuration for TLS is all
25302 within the &(smtp)& transport.
25303
25304 It is not necessary to set any options to have TLS work in the &(smtp)&
25305 transport. If Exim is built with TLS support, and TLS is advertised by a
25306 server, the &(smtp)& transport always tries to start a TLS session. However,
25307 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25308 transport) to a list of server hosts for which TLS should not be used.
25309
25310 If you do not want Exim to attempt to send messages unencrypted when an attempt
25311 to set up an encrypted connection fails in any way, you can set
25312 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25313 those hosts, delivery is always deferred if an encrypted connection cannot be
25314 set up. If there are any other hosts for the address, they are tried in the
25315 usual way.
25316
25317 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25318 the message unencrypted. It always does this if the response to STARTTLS is
25319 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25320 session after a success response code, what happens is controlled by the
25321 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25322 delivery to this host is deferred, and other hosts (if available) are tried. If
25323 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25324 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25325 negotiation fails, Exim closes the current connection (because it is in an
25326 unknown state), opens a new one to the same host, and then tries the delivery
25327 unencrypted.
25328
25329 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25330 transport provide the client with a certificate, which is passed to the server
25331 if it requests it. If the server is Exim, it will request a certificate only if
25332 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25333
25334 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25335 must name a file or,
25336 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25337 expected server certificates. The client verifies the server's certificate
25338 against this collection, taking into account any revoked certificates that are
25339 in the list defined by &%tls_crl%&.
25340
25341 If
25342 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25343 list of permitted cipher suites. If either of these checks fails, delivery to
25344 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25345 alternative hosts, if any.
25346
25347  &*Note*&:
25348 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25349 is operating as a client. Exim does not assume that a server certificate (set
25350 by the global options of the same name) should also be used when operating as a
25351 client.
25352
25353 .vindex "&$host$&"
25354 .vindex "&$host_address$&"
25355 All the TLS options in the &(smtp)& transport are expanded before use, with
25356 &$host$& and &$host_address$& containing the name and address of the server to
25357 which the client is connected. Forced failure of an expansion causes Exim to
25358 behave as if the relevant option were unset.
25359
25360 .vindex &$tls_bits$&
25361 .vindex &$tls_cipher$&
25362 .vindex &$tls_peerdn$&
25363 .vindex &$tls_sni$&
25364 Before an SMTP connection is established, the
25365 &$tls_bits$&, &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25366 variables are emptied. (Until the first connection, they contain the values
25367 that were set when the message was received.) If STARTTLS is subsequently
25368 successfully obeyed, these variables are set to the relevant values for the
25369 outgoing connection.
25370
25371
25372
25373 .new
25374 .section "Use of TLS Server Name Indication" "SECTtlssni"
25375 .cindex "TLS" "Server Name Indication"
25376 .vindex "&$tls_sni$&"
25377 .oindex "&%tls_sni%&"
25378 With TLS1.0 or above, there is an extension mechanism by which extra
25379 information can be included at various points in the protocol.  One of these
25380 extensions, documented in RFC 6066 (and before that RFC 4366) is
25381 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25382 client in the initial handshake, so that the server can examine the servername
25383 within and possibly choose to use different certificates and keys (and more)
25384 for this session.
25385
25386 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25387 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25388 address.
25389
25390 With SMTP to MX, there are the same problems here as in choosing the identity
25391 against which to validate a certificate: you can't rely on insecure DNS to
25392 provide the identity which you then cryptographically verify.  So this will
25393 be of limited use in that environment.
25394
25395 With SMTP to Submission, there is a well-defined hostname which clients are
25396 connecting to and can validate certificates against.  Thus clients &*can*&
25397 choose to include this information in the TLS negotiation.  If this becomes
25398 wide-spread, then hosters can choose to present different certificates to
25399 different clients.  Or even negotiate different cipher suites.
25400
25401 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25402 if not empty, will be sent on a TLS session as part of the handshake.  There's
25403 nothing more to it.  Choosing a sensible value not derived insecurely is the
25404 only point of caution.  The &$tls_sni$& variable will be set to this string
25405 for the lifetime of the client connection (including during authentication).
25406
25407 Except during SMTP client sessions, if &$tls_sni$& is set then it is a string
25408 received from a client.
25409 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25410
25411 If the string &`tls_sni`& appears in the main section's &%tls_certificate%&
25412 option (prior to expansion) then the following options will be re-expanded
25413 during TLS session handshake, to permit alternative values to be chosen:
25414
25415 .ilist
25416 .vindex "&%tls_certificate%&"
25417 &%tls_certificate%&
25418 .next
25419 .vindex "&%tls_crl%&"
25420 &%tls_crl%&
25421 .next
25422 .vindex "&%tls_privatekey%&"
25423 &%tls_privatekey%&
25424 .next
25425 .vindex "&%tls_verify_certificates%&"
25426 &%tls_verify_certificates%&
25427 .endlist
25428
25429 Great care should be taken to deal with matters of case, various injection
25430 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25431 can always be referenced; it is important to remember that &$tls_sni$& is
25432 arbitrary unverified data provided prior to authentication.
25433
25434 The Exim developers are proceeding cautiously and so far no other TLS options
25435 are re-expanded.
25436
25437 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25438 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25439 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25440 see &`-servername`& in the output, then OpenSSL has support.
25441
25442 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25443 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25444 built, then you have SNI support).
25445 .wen
25446
25447
25448
25449 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25450          "SECTmulmessam"
25451 .cindex "multiple SMTP deliveries with TLS"
25452 .cindex "TLS" "multiple message deliveries"
25453 Exim sends multiple messages down the same TCP/IP connection by starting up
25454 an entirely new delivery process for each message, passing the socket from
25455 one process to the next. This implementation does not fit well with the use
25456 of TLS, because there is quite a lot of state information associated with a TLS
25457 connection, not just a socket identification. Passing all the state information
25458 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25459 session before passing the socket to a new process. The new process may then
25460 try to start a new TLS session, and if successful, may try to re-authenticate
25461 if AUTH is in use, before sending the next message.
25462
25463 The RFC is not clear as to whether or not an SMTP session continues in clear
25464 after TLS has been shut down, or whether TLS may be restarted again later, as
25465 just described. However, if the server is Exim, this shutdown and
25466 reinitialization works. It is not known which (if any) other servers operate
25467 successfully if the client closes a TLS session and continues with unencrypted
25468 SMTP, but there are certainly some that do not work. For such servers, Exim
25469 should not pass the socket to another process, because the failure of the
25470 subsequent attempt to use it would cause Exim to record a temporary host error,
25471 and delay other deliveries to that host.
25472
25473 To test for this case, Exim sends an EHLO command to the server after
25474 closing down the TLS session. If this fails in any way, the connection is
25475 closed instead of being passed to a new delivery process, but no retry
25476 information is recorded.
25477
25478 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25479 &(smtp)& transport to match those hosts for which Exim should not pass
25480 connections to new processes if TLS has been used.
25481
25482
25483
25484
25485 .section "Certificates and all that" "SECTcerandall"
25486 .cindex "certificate" "references to discussion"
25487 In order to understand fully how TLS works, you need to know about
25488 certificates, certificate signing, and certificate authorities. This is not the
25489 place to give a tutorial, especially as I do not know very much about it
25490 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25491 to Apache, currently at
25492 .display
25493 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25494 .endd
25495 Other parts of the &'modssl'& documentation are also helpful, and have
25496 links to further files.
25497 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25498 0-201-61598-3), contains both introductory and more in-depth descriptions.
25499 Some sample programs taken from the book are available from
25500 .display
25501 &url(http://www.rtfm.com/openssl-examples/)
25502 .endd
25503
25504
25505 .section "Certificate chains" "SECID186"
25506 The file named by &%tls_certificate%& may contain more than one
25507 certificate. This is useful in the case where the certificate that is being
25508 sent is validated by an intermediate certificate which the other end does
25509 not have. Multiple certificates must be in the correct order in the file.
25510 First the host's certificate itself, then the first intermediate
25511 certificate to validate the issuer of the host certificate, then the next
25512 intermediate certificate to validate the issuer of the first intermediate
25513 certificate, and so on, until finally (optionally) the root certificate.
25514 The root certificate must already be trusted by the recipient for
25515 validation to succeed, of course, but if it's not preinstalled, sending the
25516 root certificate along with the rest makes it available for the user to
25517 install if the receiving end is a client MUA that can interact with a user.
25518
25519
25520 .section "Self-signed certificates" "SECID187"
25521 .cindex "certificate" "self-signed"
25522 You can create a self-signed certificate using the &'req'& command provided
25523 with OpenSSL, like this:
25524 .code
25525 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25526             -days 9999 -nodes
25527 .endd
25528 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25529 delimited and so can be identified independently. The &%-days%& option
25530 specifies a period for which the certificate is valid. The &%-nodes%& option is
25531 important: if you do not set it, the key is encrypted with a passphrase
25532 that you are prompted for, and any use that is made of the key causes more
25533 prompting for the passphrase. This is not helpful if you are going to use
25534 this certificate and key in an MTA, where prompting is not possible.
25535
25536 A self-signed certificate made in this way is sufficient for testing, and
25537 may be adequate for all your requirements if you are mainly interested in
25538 encrypting transfers, and not in secure identification.
25539
25540 However, many clients require that the certificate presented by the server be a
25541 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25542 certificate. In this situation, the self-signed certificate described above
25543 must be installed on the client host as a trusted root &'certification
25544 authority'& (CA), and the certificate used by Exim must be a user certificate
25545 signed with that self-signed certificate.
25546
25547 For information on creating self-signed CA certificates and using them to sign
25548 user certificates, see the &'General implementation overview'& chapter of the
25549 Open-source PKI book, available online at
25550 &url(http://ospkibook.sourceforge.net/).
25551 .ecindex IIDencsmtp1
25552 .ecindex IIDencsmtp2
25553
25554
25555
25556 . ////////////////////////////////////////////////////////////////////////////
25557 . ////////////////////////////////////////////////////////////////////////////
25558
25559 .chapter "Access control lists" "CHAPACL"
25560 .scindex IIDacl "&ACL;" "description"
25561 .cindex "control of incoming mail"
25562 .cindex "message" "controlling incoming"
25563 .cindex "policy control" "access control lists"
25564 Access Control Lists (ACLs) are defined in a separate section of the run time
25565 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25566 name, terminated by a colon. Here is a complete ACL section that contains just
25567 one very small ACL:
25568 .code
25569 begin acl
25570 small_acl:
25571   accept   hosts = one.host.only
25572 .endd
25573 You can have as many lists as you like in the ACL section, and the order in
25574 which they appear does not matter. The lists are self-terminating.
25575
25576 The majority of ACLs are used to control Exim's behaviour when it receives
25577 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25578 when a local process submits a message using SMTP by specifying the &%-bs%&
25579 option. The most common use is for controlling which recipients are accepted
25580 in incoming messages. In addition, you can define an ACL that is used to check
25581 local non-SMTP messages. The default configuration file contains an example of
25582 a realistic ACL for checking RCPT commands. This is discussed in chapter
25583 &<<CHAPdefconfil>>&.
25584
25585
25586 .section "Testing ACLs" "SECID188"
25587 The &%-bh%& command line option provides a way of testing your ACL
25588 configuration locally by running a fake SMTP session with which you interact.
25589 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25590 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25591
25592
25593
25594 .section "Specifying when ACLs are used" "SECID189"
25595 .cindex "&ACL;" "options for specifying"
25596 In order to cause an ACL to be used, you have to name it in one of the relevant
25597 options in the main part of the configuration. These options are:
25598 .cindex "AUTH" "ACL for"
25599 .cindex "DATA" "ACLs for"
25600 .cindex "ETRN" "ACL for"
25601 .cindex "EXPN" "ACL for"
25602 .cindex "HELO" "ACL for"
25603 .cindex "EHLO" "ACL for"
25604 .cindex "MAIL" "ACL for"
25605 .cindex "QUIT, ACL for"
25606 .cindex "RCPT" "ACL for"
25607 .cindex "STARTTLS, ACL for"
25608 .cindex "VRFY" "ACL for"
25609 .cindex "SMTP" "connection, ACL for"
25610 .cindex "non-SMTP messages" "ACLs for"
25611 .cindex "MIME content scanning" "ACL for"
25612
25613 .table2 140pt
25614 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25615 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25616 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25617 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25618 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25619 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25620 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25621 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25622 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25623 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25624 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25625 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25626 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25627 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25628 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25629 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25630 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25631 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25632 .endtable
25633
25634 For example, if you set
25635 .code
25636 acl_smtp_rcpt = small_acl
25637 .endd
25638 the little ACL defined above is used whenever Exim receives a RCPT command
25639 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25640 done when RCPT commands arrive. A rejection of RCPT should cause the
25641 sending MTA to give up on the recipient address contained in the RCPT
25642 command, whereas rejection at other times may cause the client MTA to keep on
25643 trying to deliver the message. It is therefore recommended that you do as much
25644 testing as possible at RCPT time.
25645
25646
25647 .section "The non-SMTP ACLs" "SECID190"
25648 .cindex "non-SMTP messages" "ACLs for"
25649 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25650 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25651 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25652 the state of the SMTP connection such as encryption and authentication) are not
25653 relevant and are forbidden in these ACLs. However, the sender and recipients
25654 are known, so the &%senders%& and &%sender_domains%& conditions and the
25655 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25656 &$authenticated_sender$& are also available. You can specify added header lines
25657 in any of these ACLs.
25658
25659 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25660 non-SMTP message, before any of the message has been read. (This is the
25661 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25662 batched SMTP input, it runs after the DATA command has been reached. The
25663 result of this ACL is ignored; it cannot be used to reject a message. If you
25664 really need to, you could set a value in an ACL variable here and reject based
25665 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25666 controls, and in particular, it can be used to set
25667 .code
25668 control = suppress_local_fixups
25669 .endd
25670 This cannot be used in the other non-SMTP ACLs because by the time they are
25671 run, it is too late.
25672
25673 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25674 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25675
25676 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25677 kind of rejection is treated as permanent, because there is no way of sending a
25678 temporary error for these kinds of message.
25679
25680
25681 .section "The SMTP connect ACL" "SECID191"
25682 .cindex "SMTP" "connection, ACL for"
25683 .oindex &%smtp_banner%&
25684 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25685 session, after the test specified by &%host_reject_connection%& (which is now
25686 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25687 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25688 the message override the banner message that is otherwise specified by the
25689 &%smtp_banner%& option.
25690
25691
25692 .section "The EHLO/HELO ACL" "SECID192"
25693 .cindex "EHLO" "ACL for"
25694 .cindex "HELO" "ACL for"
25695 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25696 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25697 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25698 Note that a client may issue more than one EHLO or HELO command in an SMTP
25699 session, and indeed is required to issue a new EHLO or HELO after successfully
25700 setting up encryption following a STARTTLS command.
25701
25702 If the command is accepted by an &%accept%& verb that has a &%message%&
25703 modifier, the message may not contain more than one line (it will be truncated
25704 at the first newline and a panic logged if it does). Such a message cannot
25705 affect the EHLO options that are listed on the second and subsequent lines of
25706 an EHLO response.
25707
25708
25709 .section "The DATA ACLs" "SECID193"
25710 .cindex "DATA" "ACLs for"
25711 Two ACLs are associated with the DATA command, because it is two-stage
25712 command, with two responses being sent to the client.
25713 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25714 is obeyed. This gives you control after all the RCPT commands, but before
25715 the message itself is received. It offers the opportunity to give a negative
25716 response to the DATA command before the data is transmitted. Header lines
25717 added by MAIL or RCPT ACLs are not visible at this time, but any that
25718 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25719
25720 You cannot test the contents of the message, for example, to verify addresses
25721 in the headers, at RCPT time or when the DATA command is received. Such
25722 tests have to appear in the ACL that is run after the message itself has been
25723 received, before the final response to the DATA command is sent. This is
25724 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25725 associated with the DATA command.
25726
25727 For both of these ACLs, it is not possible to reject individual recipients. An
25728 error response rejects the entire message. Unfortunately, it is known that some
25729 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25730 before or after the data) correctly &-- they keep the message on their queues
25731 and try again later, but that is their problem, though it does waste some of
25732 your resources.
25733
25734
25735 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25736 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25737 enabled (which is the default).
25738
25739 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25740 received, and is executed for each DKIM signature found in a message.  If not
25741 otherwise specified, the default action is to accept.
25742
25743 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25744
25745
25746 .section "The SMTP MIME ACL" "SECID194"
25747 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25748 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25749
25750
25751 .section "The QUIT ACL" "SECTQUITACL"
25752 .cindex "QUIT, ACL for"
25753 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25754 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25755 does not in fact control any access. For this reason, the only verbs that are
25756 permitted are &%accept%& and &%warn%&.
25757
25758 This ACL can be used for tasks such as custom logging at the end of an SMTP
25759 session. For example, you can use ACL variables in other ACLs to count
25760 messages, recipients, etc., and log the totals at QUIT time using one or
25761 more &%logwrite%& modifiers on a &%warn%& verb.
25762
25763 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25764 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25765
25766 You do not need to have a final &%accept%&, but if you do, you can use a
25767 &%message%& modifier to specify custom text that is sent as part of the 221
25768 response to QUIT.
25769
25770 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25771 failure (for example, failure to open a log file, or when Exim is bombing out
25772 because it has detected an unrecoverable error), all SMTP commands from the
25773 client are given temporary error responses until QUIT is received or the
25774 connection is closed. In these special cases, the QUIT ACL does not run.
25775
25776
25777 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25778 .vindex &$acl_smtp_notquit$&
25779 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25780 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25781 trouble, such as being unable to write to its log files, this ACL is not run,
25782 because it might try to do things (such as write to log files) that make the
25783 situation even worse.
25784
25785 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25786 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25787 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25788 and &%warn%&.
25789
25790 .vindex &$smtp_notquit_reason$&
25791 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25792 to a string that indicates the reason for the termination of the SMTP
25793 connection. The possible values are:
25794 .table2
25795 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25796 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25797 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25798 .irow &`connection-lost`&          "The SMTP connection has been lost"
25799 .irow &`data-timeout`&             "Timeout while reading message data"
25800 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25801 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25802 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25803 .irow &`synchronization-error`&    "SMTP synchronization error"
25804 .irow &`tls-failed`&               "TLS failed to start"
25805 .endtable
25806 In most cases when an SMTP connection is closed without having received QUIT,
25807 Exim sends an SMTP response message before actually closing the connection.
25808 With the exception of the &`acl-drop`& case, the default message can be
25809 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25810 &%drop%& verb in another ACL, it is the message from the other ACL that is
25811 used.
25812
25813
25814 .section "Finding an ACL to use" "SECID195"
25815 .cindex "&ACL;" "finding which to use"
25816 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25817 you can use different ACLs in different circumstances. For example,
25818 .code
25819 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25820                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25821 .endd
25822 In the default configuration file there are some example settings for
25823 providing an RFC 4409 message submission service on port 587 and a
25824 non-standard &"smtps"& service on port 465. You can use a string
25825 expansion like this to choose an ACL for MUAs on these ports which is
25826 more appropriate for this purpose than the default ACL on port 25.
25827
25828 The expanded string does not have to be the name of an ACL in the
25829 configuration file; there are other possibilities. Having expanded the
25830 string, Exim searches for an ACL as follows:
25831
25832 .ilist
25833 If the string begins with a slash, Exim uses it as a file name, and reads its
25834 contents as an ACL. The lines are processed in the same way as lines in the
25835 Exim configuration file. In particular, continuation lines are supported, blank
25836 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25837 If the file does not exist or cannot be read, an error occurs (typically
25838 causing a temporary failure of whatever caused the ACL to be run). For example:
25839 .code
25840 acl_smtp_data = /etc/acls/\
25841   ${lookup{$sender_host_address}lsearch\
25842   {/etc/acllist}{$value}{default}}
25843 .endd
25844 This looks up an ACL file to use on the basis of the host's IP address, falling
25845 back to a default if the lookup fails. If an ACL is successfully read from a
25846 file, it is retained in memory for the duration of the Exim process, so that it
25847 can be re-used without having to re-read the file.
25848 .next
25849 If the string does not start with a slash, and does not contain any spaces,
25850 Exim searches the ACL section of the configuration for an ACL whose name
25851 matches the string.
25852 .next
25853 If no named ACL is found, or if the string contains spaces, Exim parses
25854 the string as an inline ACL. This can save typing in cases where you just
25855 want to have something like
25856 .code
25857 acl_smtp_vrfy = accept
25858 .endd
25859 in order to allow free use of the VRFY command. Such a string may contain
25860 newlines; it is processed in the same way as an ACL that is read from a file.
25861 .endlist
25862
25863
25864
25865
25866 .section "ACL return codes" "SECID196"
25867 .cindex "&ACL;" "return codes"
25868 Except for the QUIT ACL, which does not affect the SMTP return code (see
25869 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25870 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25871 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25872 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25873 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25874 This also causes a 4&'xx'& return code.
25875
25876 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25877 &"deny"&, because there is no mechanism for passing temporary errors to the
25878 submitters of non-SMTP messages.
25879
25880
25881 ACLs that are relevant to message reception may also return &"discard"&. This
25882 has the effect of &"accept"&, but causes either the entire message or an
25883 individual recipient address to be discarded. In other words, it is a
25884 blackholing facility. Use it with care.
25885
25886 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25887 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25888 RCPT ACL is to discard just the one recipient address. If there are no
25889 recipients left when the message's data is received, the DATA ACL is not
25890 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25891 remaining recipients. The &"discard"& return is not permitted for the
25892 &%acl_smtp_predata%& ACL.
25893
25894
25895 .cindex "&[local_scan()]& function" "when all recipients discarded"
25896 The &[local_scan()]& function is always run, even if there are no remaining
25897 recipients; it may create new recipients.
25898
25899
25900
25901 .section "Unset ACL options" "SECID197"
25902 .cindex "&ACL;" "unset options"
25903 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25904 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25905 not defined at all. For any defined ACL, the default action when control
25906 reaches the end of the ACL statements is &"deny"&.
25907
25908 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25909 these two are ACLs that are used only for their side effects. They cannot be
25910 used to accept or reject anything.
25911
25912 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25913 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25914 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25915 when the ACL is not defined is &"accept"&.
25916
25917 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25918 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25919 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25920 messages over an SMTP connection. For an example, see the ACL in the default
25921 configuration file.
25922
25923
25924
25925
25926 .section "Data for message ACLs" "SECID198"
25927 .cindex "&ACL;" "data for message ACL"
25928 .vindex &$domain$&
25929 .vindex &$local_part$&
25930 .vindex &$sender_address$&
25931 .vindex &$sender_host_address$&
25932 .vindex &$smtp_command$&
25933 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25934 that contain information about the host and the message's sender (for example,
25935 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25936 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25937 &$local_part$& are set from the argument address. The entire SMTP command
25938 is available in &$smtp_command$&.
25939
25940 When an ACL for the AUTH parameter of MAIL is running, the variables that
25941 contain information about the host are set, but &$sender_address$& is not yet
25942 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25943 how it is used.
25944
25945 .vindex "&$message_size$&"
25946 The &$message_size$& variable is set to the value of the SIZE parameter on
25947 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25948 that parameter is not given. The value is updated to the true message size by
25949 the time the final DATA ACL is run (after the message data has been
25950 received).
25951
25952 .vindex "&$rcpt_count$&"
25953 .vindex "&$recipients_count$&"
25954 The &$rcpt_count$& variable increases by one for each RCPT command received.
25955 The &$recipients_count$& variable increases by one each time a RCPT command is
25956 accepted, so while an ACL for RCPT is being processed, it contains the number
25957 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25958 &$rcpt_count$& contains the total number of RCPT commands, and
25959 &$recipients_count$& contains the total number of accepted recipients.
25960
25961
25962
25963
25964
25965 .section "Data for non-message ACLs" "SECTdatfornon"
25966 .cindex "&ACL;" "data for non-message ACL"
25967 .vindex &$smtp_command_argument$&
25968 .vindex &$smtp_command$&
25969 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25970 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25971 and the entire SMTP command is available in &$smtp_command$&.
25972 These variables can be tested using a &%condition%& condition. For example,
25973 here is an ACL for use with AUTH, which insists that either the session is
25974 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25975 does not permit authentication methods that use cleartext passwords on
25976 unencrypted connections.
25977 .code
25978 acl_check_auth:
25979   accept encrypted = *
25980   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25981                      {CRAM-MD5}}
25982   deny   message   = TLS encryption or CRAM-MD5 required
25983 .endd
25984 (Another way of applying this restriction is to arrange for the authenticators
25985 that use cleartext passwords not to be advertised when the connection is not
25986 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25987 option to do this.)
25988
25989
25990
25991 .section "Format of an ACL" "SECID199"
25992 .cindex "&ACL;" "format of"
25993 .cindex "&ACL;" "verbs, definition of"
25994 An individual ACL consists of a number of statements. Each statement starts
25995 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25996 Modifiers can change the way the verb operates, define error and log messages,
25997 set variables, insert delays, and vary the processing of accepted messages.
25998
25999 If all the conditions are met, the verb is obeyed. The same condition may be
26000 used (with different arguments) more than once in the same statement. This
26001 provides a means of specifying an &"and"& conjunction between conditions. For
26002 example:
26003 .code
26004 deny  dnslists = list1.example
26005 dnslists = list2.example
26006 .endd
26007 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26008 the conditions and modifiers when it reaches a condition that fails. What
26009 happens then depends on the verb (and in one case, on a special modifier). Not
26010 all the conditions make sense at every testing point. For example, you cannot
26011 test a sender address in the ACL that is run for a VRFY command.
26012
26013
26014 .section "ACL verbs" "SECID200"
26015 The ACL verbs are as follows:
26016
26017 .ilist
26018 .cindex "&%accept%& ACL verb"
26019 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26020 of the conditions are not met, what happens depends on whether &%endpass%&
26021 appears among the conditions (for syntax see below). If the failing condition
26022 is before &%endpass%&, control is passed to the next ACL statement; if it is
26023 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26024 check a RCPT command:
26025 .code
26026 accept domains = +local_domains
26027 endpass
26028 verify = recipient
26029 .endd
26030 If the recipient domain does not match the &%domains%& condition, control
26031 passes to the next statement. If it does match, the recipient is verified, and
26032 the command is accepted if verification succeeds. However, if verification
26033 fails, the ACL yields &"deny"&, because the failing condition is after
26034 &%endpass%&.
26035
26036 The &%endpass%& feature has turned out to be confusing to many people, so its
26037 use is not recommended nowadays. It is always possible to rewrite an ACL so
26038 that &%endpass%& is not needed, and it is no longer used in the default
26039 configuration.
26040
26041 .cindex "&%message%& ACL modifier" "with &%accept%&"
26042 If a &%message%& modifier appears on an &%accept%& statement, its action
26043 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26044 (when an &%accept%& verb either accepts or passes control to the next
26045 statement), &%message%& can be used to vary the message that is sent when an
26046 SMTP command is accepted. For example, in a RCPT ACL you could have:
26047 .display
26048 &`accept  `&<&'some conditions'&>
26049 &`        message = OK, I will allow you through today`&
26050 .endd
26051 You can specify an SMTP response code, optionally followed by an &"extended
26052 response code"& at the start of the message, but the first digit must be the
26053 same as would be sent by default, which is 2 for an &%accept%& verb.
26054
26055 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26056 an error message that is used when access is denied. This behaviour is retained
26057 for backward compatibility, but current &"best practice"& is to avoid the use
26058 of &%endpass%&.
26059
26060
26061 .next
26062 .cindex "&%defer%& ACL verb"
26063 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26064 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26065 &%defer%& is the same as &%deny%&, because there is no way of sending a
26066 temporary error. For a RCPT command, &%defer%& is much the same as using a
26067 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26068 be used in any ACL, and even for a recipient it might be a simpler approach.
26069
26070
26071 .next
26072 .cindex "&%deny%& ACL verb"
26073 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26074 the conditions are not met, control is passed to the next ACL statement. For
26075 example,
26076 .code
26077 deny dnslists = blackholes.mail-abuse.org
26078 .endd
26079 rejects commands from hosts that are on a DNS black list.
26080
26081
26082 .next
26083 .cindex "&%discard%& ACL verb"
26084 &%discard%&: This verb behaves like &%accept%&, except that it returns
26085 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26086 that are concerned with receiving messages. When all the conditions are true,
26087 the sending entity receives a &"success"& response. However, &%discard%& causes
26088 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26089 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26090 message's recipients are discarded. Recipients that are discarded before DATA
26091 do not appear in the log line when the &%received_recipients%& log selector is set.
26092
26093 If the &%log_message%& modifier is set when &%discard%& operates,
26094 its contents are added to the line that is automatically written to the log.
26095 The &%message%& modifier operates exactly as it does for &%accept%&.
26096
26097
26098 .next
26099 .cindex "&%drop%& ACL verb"
26100 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26101 forcibly closed after the 5&'xx'& error message has been sent. For example:
26102 .code
26103 drop   message   = I don't take more than 20 RCPTs
26104        condition = ${if > {$rcpt_count}{20}}
26105 .endd
26106 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26107 The connection is always dropped after sending a 550 response.
26108
26109 .next
26110 .cindex "&%require%& ACL verb"
26111 &%require%&: If all the conditions are met, control is passed to the next ACL
26112 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26113 example, when checking a RCPT command,
26114 .code
26115 require message = Sender did not verify
26116         verify  = sender
26117 .endd
26118 passes control to subsequent statements only if the message's sender can be
26119 verified. Otherwise, it rejects the command. Note the positioning of the
26120 &%message%& modifier, before the &%verify%& condition. The reason for this is
26121 discussed in section &<<SECTcondmodproc>>&.
26122
26123 .next
26124 .cindex "&%warn%& ACL verb"
26125 &%warn%&: If all the conditions are true, a line specified by the
26126 &%log_message%& modifier is written to Exim's main log. Control always passes
26127 to the next ACL statement. If any condition is false, the log line is not
26128 written. If an identical log line is requested several times in the same
26129 message, only one copy is actually written to the log. If you want to force
26130 duplicates to be written, use the &%logwrite%& modifier instead.
26131
26132 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26133 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26134 &%logwrite%&, and &%add_header%&) that appear before the first failing
26135 condition. There is more about adding header lines in section
26136 &<<SECTaddheadacl>>&.
26137
26138 If any condition on a &%warn%& statement cannot be completed (that is, there is
26139 some sort of defer), the log line specified by &%log_message%& is not written.
26140 This does not include the case of a forced failure from a lookup, which
26141 is considered to be a successful completion. After a defer, no further
26142 conditions or modifiers in the &%warn%& statement are processed. The incident
26143 is logged, and the ACL continues to be processed, from the next statement
26144 onwards.
26145
26146
26147 .vindex "&$acl_verify_message$&"
26148 When one of the &%warn%& conditions is an address verification that fails, the
26149 text of the verification failure message is in &$acl_verify_message$&. If you
26150 want this logged, you must set it up explicitly. For example:
26151 .code
26152 warn   !verify = sender
26153        log_message = sender verify failed: $acl_verify_message
26154 .endd
26155 .endlist
26156
26157 At the end of each ACL there is an implicit unconditional &%deny%&.
26158
26159 As you can see from the examples above, the conditions and modifiers are
26160 written one to a line, with the first one on the same line as the verb, and
26161 subsequent ones on following lines. If you have a very long condition, you can
26162 continue it onto several physical lines by the usual backslash continuation
26163 mechanism. It is conventional to align the conditions vertically.
26164
26165
26166
26167 .section "ACL variables" "SECTaclvariables"
26168 .cindex "&ACL;" "variables"
26169 There are some special variables that can be set during ACL processing. They
26170 can be used to pass information between different ACLs, different invocations
26171 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26172 transports, and filters that are used to deliver a message. The names of these
26173 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26174 an underscore, but the remainder of the name can be any sequence of
26175 alphanumeric characters and underscores that you choose. There is no limit on
26176 the number of ACL variables. The two sets act as follows:
26177 .ilist
26178 The values of those variables whose names begin with &$acl_c$& persist
26179 throughout an SMTP connection. They are never reset. Thus, a value that is set
26180 while receiving one message is still available when receiving the next message
26181 on the same SMTP connection.
26182 .next
26183 The values of those variables whose names begin with &$acl_m$& persist only
26184 while a message is being received. They are reset afterwards. They are also
26185 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26186 .endlist
26187
26188 When a message is accepted, the current values of all the ACL variables are
26189 preserved with the message and are subsequently made available at delivery
26190 time. The ACL variables are set by a modifier called &%set%&. For example:
26191 .code
26192 accept hosts = whatever
26193        set acl_m4 = some value
26194 accept authenticated = *
26195        set acl_c_auth = yes
26196 .endd
26197 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26198 be set. If you want to set a variable without taking any action, you can use a
26199 &%warn%& verb without any other modifiers or conditions.
26200
26201 .oindex &%strict_acl_vars%&
26202 What happens if a syntactically valid but undefined ACL variable is
26203 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26204 false (the default), an empty string is substituted; if it is true, an
26205 error is generated.
26206
26207 Versions of Exim before 4.64 have a limited set of numbered variables, but
26208 their names are compatible, so there is no problem with upgrading.
26209
26210
26211 .section "Condition and modifier processing" "SECTcondmodproc"
26212 .cindex "&ACL;" "conditions; processing"
26213 .cindex "&ACL;" "modifiers; processing"
26214 An exclamation mark preceding a condition negates its result. For example:
26215 .code
26216 deny   domains = *.dom.example
26217       !verify  = recipient
26218 .endd
26219 causes the ACL to return &"deny"& if the recipient domain ends in
26220 &'dom.example'& and the recipient address cannot be verified. Sometimes
26221 negation can be used on the right-hand side of a condition. For example, these
26222 two statements are equivalent:
26223 .code
26224 deny  hosts = !192.168.3.4
26225 deny !hosts =  192.168.3.4
26226 .endd
26227 However, for many conditions (&%verify%& being a good example), only left-hand
26228 side negation of the whole condition is possible.
26229
26230 The arguments of conditions and modifiers are expanded. A forced failure
26231 of an expansion causes a condition to be ignored, that is, it behaves as if the
26232 condition is true. Consider these two statements:
26233 .code
26234 accept  senders = ${lookup{$host_name}lsearch\
26235                   {/some/file}{$value}fail}
26236 accept  senders = ${lookup{$host_name}lsearch\
26237                   {/some/file}{$value}{}}
26238 .endd
26239 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26240 the returned list is searched, but if the lookup fails the behaviour is
26241 different in the two cases. The &%fail%& in the first statement causes the
26242 condition to be ignored, leaving no further conditions. The &%accept%& verb
26243 therefore succeeds. The second statement, however, generates an empty list when
26244 the lookup fails. No sender can match an empty list, so the condition fails,
26245 and therefore the &%accept%& also fails.
26246
26247 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26248 specify actions that are taken as the conditions for a statement are checked;
26249 others specify text for messages that are used when access is denied or a
26250 warning is generated. The &%control%& modifier affects the way an incoming
26251 message is handled.
26252
26253 The positioning of the modifiers in an ACL statement important, because the
26254 processing of a verb ceases as soon as its outcome is known. Only those
26255 modifiers that have already been encountered will take effect. For example,
26256 consider this use of the &%message%& modifier:
26257 .code
26258 require message = Can't verify sender
26259         verify  = sender
26260         message = Can't verify recipient
26261         verify  = recipient
26262         message = This message cannot be used
26263 .endd
26264 If sender verification fails, Exim knows that the result of the statement is
26265 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26266 so its text is used as the error message. If sender verification succeeds, but
26267 recipient verification fails, the second message is used. If recipient
26268 verification succeeds, the third message becomes &"current"&, but is never used
26269 because there are no more conditions to cause failure.
26270
26271 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26272 modifier that is used, because all the conditions must be true for rejection to
26273 happen. Specifying more than one &%message%& modifier does not make sense, and
26274 the message can even be specified after all the conditions. For example:
26275 .code
26276 deny   hosts = ...
26277       !senders = *@my.domain.example
26278        message = Invalid sender from client host
26279 .endd
26280 The &"deny"& result does not happen until the end of the statement is reached,
26281 by which time Exim has set up the message.
26282
26283
26284
26285 .section "ACL modifiers" "SECTACLmodi"
26286 .cindex "&ACL;" "modifiers; list of"
26287 The ACL modifiers are as follows:
26288
26289 .vlist
26290 .vitem &*add_header*&&~=&~<&'text'&>
26291 This modifier specifies one or more header lines that are to be added to an
26292 incoming message, assuming, of course, that the message is ultimately
26293 accepted. For details, see section &<<SECTaddheadacl>>&.
26294
26295 .vitem &*continue*&&~=&~<&'text'&>
26296 .cindex "&%continue%& ACL modifier"
26297 .cindex "database" "updating in ACL"
26298 This modifier does nothing of itself, and processing of the ACL always
26299 continues with the next condition or modifier. The value of &%continue%& is in
26300 the side effects of expanding its argument. Typically this could be used to
26301 update a database. It is really just a syntactic tidiness, to avoid having to
26302 write rather ugly lines like this:
26303 .display
26304 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26305 .endd
26306 Instead, all you need is
26307 .display
26308 &`continue = `&<&'some expansion'&>
26309 .endd
26310
26311 .vitem &*control*&&~=&~<&'text'&>
26312 .cindex "&%control%& ACL modifier"
26313 This modifier affects the subsequent processing of the SMTP connection or of an
26314 incoming message that is accepted. The effect of the first type of control
26315 lasts for the duration of the connection, whereas the effect of the second type
26316 lasts only until the current message has been received. The message-specific
26317 controls always apply to the whole message, not to individual recipients,
26318 even if the &%control%& modifier appears in a RCPT ACL.
26319
26320 As there are now quite a few controls that can be applied, they are described
26321 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26322 in several different ways. For example:
26323
26324 . ==== As this is a nested list, any displays it contains must be indented
26325 . ==== as otherwise they are too far to the left. That comment applies only
26326 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26327 . ==== way.
26328
26329 .ilist
26330 It can be at the end of an &%accept%& statement:
26331 .code
26332     accept  ...some conditions
26333             control = queue_only
26334 .endd
26335 In this case, the control is applied when this statement yields &"accept"&, in
26336 other words, when the conditions are all true.
26337
26338 .next
26339 It can be in the middle of an &%accept%& statement:
26340 .code
26341     accept  ...some conditions...
26342             control = queue_only
26343             ...some more conditions...
26344 .endd
26345 If the first set of conditions are true, the control is applied, even if the
26346 statement does not accept because one of the second set of conditions is false.
26347 In this case, some subsequent statement must yield &"accept"& for the control
26348 to be relevant.
26349
26350 .next
26351 It can be used with &%warn%& to apply the control, leaving the
26352 decision about accepting or denying to a subsequent verb. For
26353 example:
26354 .code
26355     warn    ...some conditions...
26356             control = freeze
26357     accept  ...
26358 .endd
26359 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26360 &%logwrite%&, so it does not add anything to the message and does not write a
26361 log entry.
26362
26363 .next
26364 If you want to apply a control unconditionally, you can use it with a
26365 &%require%& verb. For example:
26366 .code
26367     require  control = no_multiline_responses
26368 .endd
26369 .endlist
26370
26371 .vitem &*delay*&&~=&~<&'time'&>
26372 .cindex "&%delay%& ACL modifier"
26373 .oindex "&%-bh%&"
26374 This modifier may appear in any ACL. It causes Exim to wait for the time
26375 interval before proceeding. However, when testing Exim using the &%-bh%&
26376 option, the delay is not actually imposed (an appropriate message is output
26377 instead). The time is given in the usual Exim notation, and the delay happens
26378 as soon as the modifier is processed. In an SMTP session, pending output is
26379 flushed before the delay is imposed.
26380
26381 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26382 example:
26383 .code
26384 deny    ...some conditions...
26385         delay = 30s
26386 .endd
26387 The delay happens if all the conditions are true, before the statement returns
26388 &"deny"&. Compare this with:
26389 .code
26390 deny    delay = 30s
26391         ...some conditions...
26392 .endd
26393 which waits for 30s before processing the conditions. The &%delay%& modifier
26394 can also be used with &%warn%& and together with &%control%&:
26395 .code
26396 warn    ...some conditions...
26397         delay = 2m
26398         control = freeze
26399 accept  ...
26400 .endd
26401
26402 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26403 responses to several commands are no longer buffered and sent in one packet (as
26404 they would normally be) because all output is flushed before imposing the
26405 delay. This optimization is disabled so that a number of small delays do not
26406 appear to the client as one large aggregated delay that might provoke an
26407 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26408 using a &%control%& modifier to set &%no_delay_flush%&.
26409
26410
26411 .vitem &*endpass*&
26412 .cindex "&%endpass%& ACL modifier"
26413 This modifier, which has no argument, is recognized only in &%accept%& and
26414 &%discard%& statements. It marks the boundary between the conditions whose
26415 failure causes control to pass to the next statement, and the conditions whose
26416 failure causes the ACL to return &"deny"&. This concept has proved to be
26417 confusing to some people, so the use of &%endpass%& is no longer recommended as
26418 &"best practice"&. See the description of &%accept%& above for more details.
26419
26420
26421 .vitem &*log_message*&&~=&~<&'text'&>
26422 .cindex "&%log_message%& ACL modifier"
26423 This modifier sets up a message that is used as part of the log message if the
26424 ACL denies access or a &%warn%& statement's conditions are true. For example:
26425 .code
26426 require log_message = wrong cipher suite $tls_cipher
26427         encrypted   = DES-CBC3-SHA
26428 .endd
26429 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26430 example:
26431 .display
26432 &`discard `&<&'some conditions'&>
26433 &`        log_message = Discarded $local_part@$domain because...`&
26434 .endd
26435 When access is denied, &%log_message%& adds to any underlying error message
26436 that may exist because of a condition failure. For example, while verifying a
26437 recipient address, a &':fail:'& redirection might have already set up a
26438 message.
26439
26440 The message may be defined before the conditions to which it applies, because
26441 the string expansion does not happen until Exim decides that access is to be
26442 denied. This means that any variables that are set by the condition are
26443 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26444 variables are set after a DNS black list lookup succeeds. If the expansion of
26445 &%log_message%& fails, or if the result is an empty string, the modifier is
26446 ignored.
26447
26448 .vindex "&$acl_verify_message$&"
26449 If you want to use a &%warn%& statement to log the result of an address
26450 verification, you can use &$acl_verify_message$& to include the verification
26451 error message.
26452
26453 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26454 the start of the logged message. If the same warning log message is requested
26455 more than once while receiving  a single email message, only one copy is
26456 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26457 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26458 is logged for a successful &%warn%& statement.
26459
26460 If &%log_message%& is not present and there is no underlying error message (for
26461 example, from the failure of address verification), but &%message%& is present,
26462 the &%message%& text is used for logging rejections. However, if any text for
26463 logging contains newlines, only the first line is logged. In the absence of
26464 both &%log_message%& and &%message%&, a default built-in message is used for
26465 logging rejections.
26466
26467
26468 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26469 .cindex "&%log_reject_target%& ACL modifier"
26470 .cindex "logging in ACL" "specifying which log"
26471 This modifier makes it possible to specify which logs are used for messages
26472 about ACL rejections. Its argument is a colon-separated list of words that can
26473 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26474 may be empty, in which case a rejection is not logged at all. For example, this
26475 ACL fragment writes no logging information when access is denied:
26476 .display
26477 &`deny `&<&'some conditions'&>
26478 &`     log_reject_target =`&
26479 .endd
26480 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26481 permanent and temporary rejections. Its effect lasts for the rest of the
26482 current ACL.
26483
26484
26485 .vitem &*logwrite*&&~=&~<&'text'&>
26486 .cindex "&%logwrite%& ACL modifier"
26487 .cindex "logging in ACL" "immediate"
26488 This modifier writes a message to a log file as soon as it is encountered when
26489 processing an ACL. (Compare &%log_message%&, which, except in the case of
26490 &%warn%& and &%discard%&, is used only if the ACL statement denies
26491 access.) The &%logwrite%& modifier can be used to log special incidents in
26492 ACLs. For example:
26493 .display
26494 &`accept `&<&'some special conditions'&>
26495 &`       control  = freeze`&
26496 &`       logwrite = froze message because ...`&
26497 .endd
26498 By default, the message is written to the main log. However, it may begin
26499 with a colon, followed by a comma-separated list of log names, and then
26500 another colon, to specify exactly which logs are to be written. For
26501 example:
26502 .code
26503 logwrite = :main,reject: text for main and reject logs
26504 logwrite = :panic: text for panic log only
26505 .endd
26506
26507
26508 .vitem &*message*&&~=&~<&'text'&>
26509 .cindex "&%message%& ACL modifier"
26510 This modifier sets up a text string that is expanded and used as a response
26511 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26512 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26513 there is some complication if &%endpass%& is involved; see the description of
26514 &%accept%& for details.)
26515
26516 The expansion of the message happens at the time Exim decides that the ACL is
26517 to end, not at the time it processes &%message%&. If the expansion fails, or
26518 generates an empty string, the modifier is ignored. Here is an example where
26519 &%message%& must be specified first, because the ACL ends with a rejection if
26520 the &%hosts%& condition fails:
26521 .code
26522 require  message = Host not recognized
26523          hosts = 10.0.0.0/8
26524 .endd
26525 (Once a condition has failed, no further conditions or modifiers are
26526 processed.)
26527
26528 .cindex "SMTP" "error codes"
26529 .oindex "&%smtp_banner%&
26530 For ACLs that are triggered by SMTP commands, the message is returned as part
26531 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26532 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26533 is accepted. In the case of the connect ACL, accepting with a message modifier
26534 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26535 accept message may not contain more than one line (otherwise it will be
26536 truncated at the first newline and a panic logged), and it cannot affect the
26537 EHLO options.
26538
26539 When SMTP is involved, the message may begin with an overriding response code,
26540 consisting of three digits optionally followed by an &"extended response code"&
26541 of the form &'n.n.n'&, each code being followed by a space. For example:
26542 .code
26543 deny  message = 599 1.2.3 Host not welcome
26544       hosts = 192.168.34.0/24
26545 .endd
26546 The first digit of the supplied response code must be the same as would be sent
26547 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26548 access, but for the predata ACL, note that the default success code is 354, not
26549 2&'xx'&.
26550
26551 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26552 the message modifier cannot override the 221 response code.
26553
26554 The text in a &%message%& modifier is literal; any quotes are taken as
26555 literals, but because the string is expanded, backslash escapes are processed
26556 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26557 response.
26558
26559 .vindex "&$acl_verify_message$&"
26560 If &%message%& is used on a statement that verifies an address, the message
26561 specified overrides any message that is generated by the verification process.
26562 However, the original message is available in the variable
26563 &$acl_verify_message$&, so you can incorporate it into your message if you
26564 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26565 routers to be passed back as part of the SMTP response, you should either not
26566 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26567
26568 For compatibility with previous releases of Exim, a &%message%& modifier that
26569 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26570 modifier, but this usage is now deprecated. However, &%message%& acts only when
26571 all the conditions are true, wherever it appears in an ACL command, whereas
26572 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26573 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26574 effect.
26575
26576
26577 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26578 .cindex "&%set%& ACL modifier"
26579 This modifier puts a value into one of the ACL variables (see section
26580 &<<SECTaclvariables>>&).
26581 .endlist
26582
26583
26584
26585
26586
26587 .section "Use of the control modifier" "SECTcontrols"
26588 .cindex "&%control%& ACL modifier"
26589 The &%control%& modifier supports the following settings:
26590
26591 .vlist
26592 .vitem &*control&~=&~allow_auth_unadvertised*&
26593 This modifier allows a client host to use the SMTP AUTH command even when it
26594 has not been advertised in response to EHLO. Furthermore, because there are
26595 apparently some really broken clients that do this, Exim will accept AUTH after
26596 HELO (rather than EHLO) when this control is set. It should be used only if you
26597 really need it, and you should limit its use to those broken clients that do
26598 not work without it. For example:
26599 .code
26600 warn hosts   = 192.168.34.25
26601      control = allow_auth_unadvertised
26602 .endd
26603 Normally, when an Exim server receives an AUTH command, it checks the name of
26604 the authentication mechanism that is given in the command to ensure that it
26605 matches an advertised mechanism. When this control is set, the check that a
26606 mechanism has been advertised is bypassed. Any configured mechanism can be used
26607 by the client. This control is permitted only in the connection and HELO ACLs.
26608
26609
26610 .vitem &*control&~=&~caseful_local_part*& &&&
26611        &*control&~=&~caselower_local_part*&
26612 .cindex "&ACL;" "case of local part in"
26613 .cindex "case of local parts"
26614 .vindex "&$local_part$&"
26615 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26616 (that is, during RCPT processing). By default, the contents of &$local_part$&
26617 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26618 any uppercase letters in the original local part are restored in &$local_part$&
26619 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26620 is encountered.
26621
26622 These controls affect only the current recipient. Moreover, they apply only to
26623 local part handling that takes place directly in the ACL (for example, as a key
26624 in lookups). If a test to verify the recipient is obeyed, the case-related
26625 handling of the local part during the verification is controlled by the router
26626 configuration (see the &%caseful_local_part%& generic router option).
26627
26628 This facility could be used, for example, to add a spam score to local parts
26629 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26630 spam score:
26631 .code
26632 warn  control = caseful_local_part
26633       set acl_m4 = ${eval:\
26634                      $acl_m4 + \
26635                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26636                     }
26637       control = caselower_local_part
26638 .endd
26639 Notice that we put back the lower cased version afterwards, assuming that
26640 is what is wanted for subsequent tests.
26641
26642
26643 .vitem &*control&~=&~debug/*&<&'options'&>
26644 .cindex "&ACL;" "enabling debug logging"
26645 .cindex "debugging" "enabling from an ACL"
26646 This control turns on debug logging, almost as though Exim had been invoked
26647 with &`-d`&, with the output going to a new logfile, by default called
26648 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26649 may access any variables already defined.  The logging may be adjusted with
26650 the &'opts'& option, which takes the same values as the &`-d`& command-line
26651 option.  Some examples (which depend on variables that don't exist in all
26652 contexts):
26653 .code
26654       control = debug
26655       control = debug/tag=.$sender_host_address
26656       control = debug/opts=+expand+acl
26657       control = debug/tag=.$message_exim_id/opts=+expand
26658 .endd
26659
26660
26661 .vitem &*control&~=&~enforce_sync*& &&&
26662        &*control&~=&~no_enforce_sync*&
26663 .cindex "SMTP" "synchronization checking"
26664 .cindex "synchronization checking in SMTP"
26665 These controls make it possible to be selective about when SMTP synchronization
26666 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26667 state of the switch (it is true by default). See the description of this option
26668 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26669
26670 The effect of these two controls lasts for the remainder of the SMTP
26671 connection. They can appear in any ACL except the one for the non-SMTP
26672 messages. The most straightforward place to put them is in the ACL defined by
26673 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26674 before the first synchronization check. The expected use is to turn off the
26675 synchronization checks for badly-behaved hosts that you nevertheless need to
26676 work with.
26677
26678
26679 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26680 .cindex "fake defer"
26681 .cindex "defer, fake"
26682 This control works in exactly the same way as &%fakereject%& (described below)
26683 except that it causes an SMTP 450 response after the message data instead of a
26684 550 response. You must take care when using &%fakedefer%& because it causes the
26685 messages to be duplicated when the sender retries. Therefore, you should not
26686 use &%fakedefer%& if the message is to be delivered normally.
26687
26688 .vitem &*control&~=&~fakereject/*&<&'message'&>
26689 .cindex "fake rejection"
26690 .cindex "rejection, fake"
26691 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26692 words, only when an SMTP message is being received. If Exim accepts the
26693 message, instead the final 250 response, a 550 rejection message is sent.
26694 However, Exim proceeds to deliver the message as normal. The control applies
26695 only to the current message, not to any subsequent ones that may be received in
26696 the same SMTP connection.
26697
26698 The text for the 550 response is taken from the &%control%& modifier. If no
26699 message is supplied, the following is used:
26700 .code
26701 550-Your message has been rejected but is being
26702 550-kept for evaluation.
26703 550-If it was a legitimate message, it may still be
26704 550 delivered to the target recipient(s).
26705 .endd
26706 This facility should be used with extreme caution.
26707
26708 .vitem &*control&~=&~freeze*&
26709 .cindex "frozen messages" "forcing in ACL"
26710 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26711 other words, only when a message is being received. If the message is accepted,
26712 it is placed on Exim's queue and frozen. The control applies only to the
26713 current message, not to any subsequent ones that may be received in the same
26714 SMTP connection.
26715
26716 This modifier can optionally be followed by &`/no_tell`&. If the global option
26717 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26718 is told about the freezing), provided all the &*control=freeze*& modifiers that
26719 are obeyed for the current message have the &`/no_tell`& option.
26720
26721 .vitem &*control&~=&~no_delay_flush*&
26722 .cindex "SMTP" "output flushing, disabling for delay"
26723 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26724 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26725 use. This control, as long as it is encountered before the &%delay%& modifier,
26726 disables such output flushing.
26727
26728 .vitem &*control&~=&~no_callout_flush*&
26729 .cindex "SMTP" "output flushing, disabling for callout"
26730 Exim normally flushes SMTP output before performing a callout in an ACL, to
26731 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26732 use. This control, as long as it is encountered before the &%verify%& condition
26733 that causes the callout, disables such output flushing.
26734
26735 .vitem &*control&~=&~no_mbox_unspool*&
26736 This control is available when Exim is compiled with the content scanning
26737 extension. Content scanning may require a copy of the current message, or parts
26738 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26739 or spam scanner. Normally, such copies are deleted when they are no longer
26740 needed. If this control is set, the copies are not deleted. The control applies
26741 only to the current message, not to any subsequent ones that may be received in
26742 the same SMTP connection. It is provided for debugging purposes and is unlikely
26743 to be useful in production.
26744
26745 .vitem &*control&~=&~no_multiline_responses*&
26746 .cindex "multiline responses, suppressing"
26747 This control is permitted for any ACL except the one for non-SMTP messages.
26748 It seems that there are broken clients in use that cannot handle multiline
26749 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26750
26751 If this control is set, multiline SMTP responses from ACL rejections are
26752 suppressed. One way of doing this would have been to put out these responses as
26753 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26754 (&"use multiline responses for more"& it says &-- ha!), and some of the
26755 responses might get close to that. So this facility, which is after all only a
26756 sop to broken clients, is implemented by doing two very easy things:
26757
26758 .ilist
26759 Extra information that is normally output as part of a rejection caused by
26760 sender verification failure is omitted. Only the final line (typically &"sender
26761 verification failed"&) is sent.
26762 .next
26763 If a &%message%& modifier supplies a multiline response, only the first
26764 line is output.
26765 .endlist
26766
26767 The setting of the switch can, of course, be made conditional on the
26768 calling host. Its effect lasts until the end of the SMTP connection.
26769
26770 .vitem &*control&~=&~no_pipelining*&
26771 .cindex "PIPELINING" "suppressing advertising"
26772 This control turns off the advertising of the PIPELINING extension to SMTP in
26773 the current session. To be useful, it must be obeyed before Exim sends its
26774 response to an EHLO command. Therefore, it should normally appear in an ACL
26775 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26776 &%pipelining_advertise_hosts%&.
26777
26778 .vitem &*control&~=&~queue_only*&
26779 .oindex "&%queue_only%&"
26780 .cindex "queueing incoming messages"
26781 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26782 other words, only when a message is being received. If the message is accepted,
26783 it is placed on Exim's queue and left there for delivery by a subsequent queue
26784 runner. No immediate delivery process is started. In other words, it has the
26785 effect as the &%queue_only%& global option. However, the control applies only
26786 to the current message, not to any subsequent ones that may be received in the
26787 same SMTP connection.
26788
26789 .vitem &*control&~=&~submission/*&<&'options'&>
26790 .cindex "message" "submission"
26791 .cindex "submission mode"
26792 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26793 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26794 the current message is a submission from a local MUA. In this case, Exim
26795 operates in &"submission mode"&, and applies certain fixups to the message if
26796 necessary. For example, it adds a &'Date:'& header line if one is not present.
26797 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26798 late (the message has already been created).
26799
26800 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26801 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26802 submission mode; the available options for this control are described there.
26803 The control applies only to the current message, not to any subsequent ones
26804 that may be received in the same SMTP connection.
26805
26806 .vitem &*control&~=&~suppress_local_fixups*&
26807 .cindex "submission fixups, suppressing"
26808 This control applies to locally submitted (non TCP/IP) messages, and is the
26809 complement of &`control = submission`&. It disables the fixups that are
26810 normally applied to locally-submitted messages. Specifically:
26811
26812 .ilist
26813 Any &'Sender:'& header line is left alone (in this respect, it is a
26814 dynamic version of &%local_sender_retain%&).
26815 .next
26816 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26817 .next
26818 There is no check that &'From:'& corresponds to the actual sender.
26819 .endlist ilist
26820
26821 This control may be useful when a remotely-originated message is accepted,
26822 passed to some scanning program, and then re-submitted for delivery. It can be
26823 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26824 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26825 data is read.
26826
26827 &*Note:*& This control applies only to the current message, not to any others
26828 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26829 .endlist vlist
26830
26831
26832 .section "Summary of message fixup control" "SECTsummesfix"
26833 All four possibilities for message fixups can be specified:
26834
26835 .ilist
26836 Locally submitted, fixups applied: the default.
26837 .next
26838 Locally submitted, no fixups applied: use
26839 &`control = suppress_local_fixups`&.
26840 .next
26841 Remotely submitted, no fixups applied: the default.
26842 .next
26843 Remotely submitted, fixups applied: use &`control = submission`&.
26844 .endlist
26845
26846
26847
26848 .section "Adding header lines in ACLs" "SECTaddheadacl"
26849 .cindex "header lines" "adding in an ACL"
26850 .cindex "header lines" "position of added lines"
26851 .cindex "&%message%& ACL modifier"
26852 The &%add_header%& modifier can be used to add one or more extra header lines
26853 to an incoming message, as in this example:
26854 .code
26855 warn dnslists = sbl.spamhaus.org : \
26856                 dialup.mail-abuse.org
26857      add_header = X-blacklisted-at: $dnslist_domain
26858 .endd
26859 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26860 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26861 receiving a message). The message must ultimately be accepted for
26862 &%add_header%& to have any significant effect. You can use &%add_header%& with
26863 any ACL verb, including &%deny%& (though this is potentially useful only in a
26864 RCPT ACL).
26865
26866 If the data for the &%add_header%& modifier contains one or more newlines that
26867 are not followed by a space or a tab, it is assumed to contain multiple header
26868 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26869 front of any line that is not a valid header line.
26870
26871 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26872 They are added to the message before processing the DATA and MIME ACLs.
26873 However, if an identical header line is requested more than once, only one copy
26874 is actually added to the message. Further header lines may be accumulated
26875 during the DATA and MIME ACLs, after which they are added to the message, again
26876 with duplicates suppressed. Thus, it is possible to add two identical header
26877 lines to an SMTP message, but only if one is added before DATA and one after.
26878 In the case of non-SMTP messages, new headers are accumulated during the
26879 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26880 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26881 are included in the entry that is written to the reject log.
26882
26883 .cindex "header lines" "added; visibility of"
26884 Header lines are not visible in string expansions until they are added to the
26885 message. It follows that header lines defined in the MAIL, RCPT, and predata
26886 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26887 header lines that are added by the DATA or MIME ACLs are not visible in those
26888 ACLs. Because of this restriction, you cannot use header lines as a way of
26889 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26890 this, you can use ACL variables, as described in section
26891 &<<SECTaclvariables>>&.
26892
26893 The &%add_header%& modifier acts immediately it is encountered during the
26894 processing of an ACL. Notice the difference between these two cases:
26895 .display
26896 &`accept add_header = ADDED: some text`&
26897 &`       `&<&'some condition'&>
26898
26899 &`accept `&<&'some condition'&>
26900 &`       add_header = ADDED: some text`&
26901 .endd
26902 In the first case, the header line is always added, whether or not the
26903 condition is true. In the second case, the header line is added only if the
26904 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26905 ACL statement. All those that are encountered before a condition fails are
26906 honoured.
26907
26908 .cindex "&%warn%& ACL verb"
26909 For compatibility with previous versions of Exim, a &%message%& modifier for a
26910 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26911 effect only if all the conditions are true, even if it appears before some of
26912 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26913 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26914 are present on a &%warn%& verb, both are processed according to their
26915 specifications.
26916
26917 By default, new header lines are added to a message at the end of the existing
26918 header lines. However, you can specify that any particular header line should
26919 be added right at the start (before all the &'Received:'& lines), immediately
26920 after the first block of &'Received:'& lines, or immediately before any line
26921 that is not a &'Received:'& or &'Resent-something:'& header.
26922
26923 This is done by specifying &":at_start:"&, &":after_received:"&, or
26924 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26925 header line, respectively. (Header text cannot start with a colon, as there has
26926 to be a header name first.) For example:
26927 .code
26928 warn add_header = \
26929        :after_received:X-My-Header: something or other...
26930 .endd
26931 If more than one header line is supplied in a single &%add_header%& modifier,
26932 each one is treated independently and can therefore be placed differently. If
26933 you add more than one line at the start, or after the Received: block, they end
26934 up in reverse order.
26935
26936 &*Warning*&: This facility currently applies only to header lines that are
26937 added in an ACL. It does NOT work for header lines that are added in a
26938 system filter or in a router or transport.
26939
26940
26941
26942
26943 .section "ACL conditions" "SECTaclconditions"
26944 .cindex "&ACL;" "conditions; list of"
26945 Some of conditions listed in this section are available only when Exim is
26946 compiled with the content-scanning extension. They are included here briefly
26947 for completeness. More detailed descriptions can be found in the discussion on
26948 content scanning in chapter &<<CHAPexiscan>>&.
26949
26950 Not all conditions are relevant in all circumstances. For example, testing
26951 senders and recipients does not make sense in an ACL that is being run as the
26952 result of the arrival of an ETRN command, and checks on message headers can be
26953 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26954 can use the same condition (with different parameters) more than once in the
26955 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26956 The conditions are as follows:
26957
26958
26959 .vlist
26960 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26961 .cindex "&ACL;" "nested"
26962 .cindex "&ACL;" "indirect"
26963 .cindex "&%acl%& ACL condition"
26964 The possible values of the argument are the same as for the
26965 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26966 &"accept"& the condition is true; if it returns &"deny"& the condition is
26967 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26968 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26969 condition false. This means that further processing of the &%warn%& verb
26970 ceases, but processing of the ACL continues.
26971
26972 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26973 the connection is dropped. If it returns &"discard"&, the verb must be
26974 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26975 conditions are tested.
26976
26977 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26978 loops. This condition allows you to use different ACLs in different
26979 circumstances. For example, different ACLs can be used to handle RCPT commands
26980 for different local users or different local domains.
26981
26982 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26983 .cindex "&%authenticated%& ACL condition"
26984 .cindex "authentication" "ACL checking"
26985 .cindex "&ACL;" "testing for authentication"
26986 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26987 the name of the authenticator is tested against the list. To test for
26988 authentication by any authenticator, you can set
26989 .code
26990 authenticated = *
26991 .endd
26992
26993 .vitem &*condition&~=&~*&<&'string'&>
26994 .cindex "&%condition%& ACL condition"
26995 .cindex "customizing" "ACL condition"
26996 .cindex "&ACL;" "customized test"
26997 .cindex "&ACL;" "testing, customized"
26998 This feature allows you to make up custom conditions. If the result of
26999 expanding the string is an empty string, the number zero, or one of the strings
27000 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27001 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27002 any other value, some error is assumed to have occurred, and the ACL returns
27003 &"defer"&. However, if the expansion is forced to fail, the condition is
27004 ignored. The effect is to treat it as true, whether it is positive or
27005 negative.
27006
27007 .vitem &*decode&~=&~*&<&'location'&>
27008 .cindex "&%decode%& ACL condition"
27009 This condition is available only when Exim is compiled with the
27010 content-scanning extension, and it is allowed only in the ACL defined by
27011 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27012 If all goes well, the condition is true. It is false only if there are
27013 problems such as a syntax error or a memory shortage. For more details, see
27014 chapter &<<CHAPexiscan>>&.
27015
27016 .vitem &*demime&~=&~*&<&'extension&~list'&>
27017 .cindex "&%demime%& ACL condition"
27018 This condition is available only when Exim is compiled with the
27019 content-scanning extension. Its use is described in section
27020 &<<SECTdemimecond>>&.
27021
27022 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27023 .cindex "&%dnslists%& ACL condition"
27024 .cindex "DNS list" "in ACL"
27025 .cindex "black list (DNS)"
27026 .cindex "&ACL;" "testing a DNS list"
27027 This condition checks for entries in DNS black lists. These are also known as
27028 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27029 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27030 different variants of this condition to describe briefly here. See sections
27031 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27032
27033 .vitem &*domains&~=&~*&<&'domain&~list'&>
27034 .cindex "&%domains%& ACL condition"
27035 .cindex "domain" "ACL checking"
27036 .cindex "&ACL;" "testing a recipient domain"
27037 .vindex "&$domain_data$&"
27038 This condition is relevant only after a RCPT command. It checks that the domain
27039 of the recipient address is in the domain list. If percent-hack processing is
27040 enabled, it is done before this test is done. If the check succeeds with a
27041 lookup, the result of the lookup is placed in &$domain_data$& until the next
27042 &%domains%& test.
27043
27044 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27045 use &%domains%& in a DATA ACL.
27046
27047
27048 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27049 .cindex "&%encrypted%& ACL condition"
27050 .cindex "encryption" "checking in an ACL"
27051 .cindex "&ACL;" "testing for encryption"
27052 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27053 name of the cipher suite in use is tested against the list. To test for
27054 encryption without testing for any specific cipher suite(s), set
27055 .code
27056 encrypted = *
27057 .endd
27058
27059
27060 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
27061 .cindex "&%hosts%& ACL condition"
27062 .cindex "host" "ACL checking"
27063 .cindex "&ACL;" "testing the client host"
27064 This condition tests that the calling host matches the host list. If you have
27065 name lookups or wildcarded host names and IP addresses in the same host list,
27066 you should normally put the IP addresses first. For example, you could have:
27067 .code
27068 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27069 .endd
27070 The lookup in this example uses the host name for its key. This is implied by
27071 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27072 and it wouldn't matter which way round you had these two items.)
27073
27074 The reason for the problem with host names lies in the left-to-right way that
27075 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27076 but when it reaches an item that requires a host name, it fails if it cannot
27077 find a host name to compare with the pattern. If the above list is given in the
27078 opposite order, the &%accept%& statement fails for a host whose name cannot be
27079 found, even if its IP address is 10.9.8.7.
27080
27081 If you really do want to do the name check first, and still recognize the IP
27082 address even if the name lookup fails, you can rewrite the ACL like this:
27083 .code
27084 accept hosts = dbm;/etc/friendly/hosts
27085 accept hosts = 10.9.8.7
27086 .endd
27087 The default action on failing to find the host name is to assume that the host
27088 is not in the list, so the first &%accept%& statement fails. The second
27089 statement can then check the IP address.
27090
27091 .vindex "&$host_data$&"
27092 If a &%hosts%& condition is satisfied by means of a lookup, the result
27093 of the lookup is made available in the &$host_data$& variable. This
27094 allows you, for example, to set up a statement like this:
27095 .code
27096 deny  hosts = net-lsearch;/some/file
27097 message = $host_data
27098 .endd
27099 which gives a custom error message for each denied host.
27100
27101 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27102 .cindex "&%local_parts%& ACL condition"
27103 .cindex "local part" "ACL checking"
27104 .cindex "&ACL;" "testing a local part"
27105 .vindex "&$local_part_data$&"
27106 This condition is relevant only after a RCPT command. It checks that the local
27107 part of the recipient address is in the list. If percent-hack processing is
27108 enabled, it is done before this test. If the check succeeds with a lookup, the
27109 result of the lookup is placed in &$local_part_data$&, which remains set until
27110 the next &%local_parts%& test.
27111
27112 .vitem &*malware&~=&~*&<&'option'&>
27113 .cindex "&%malware%& ACL condition"
27114 .cindex "&ACL;" "virus scanning"
27115 .cindex "&ACL;" "scanning for viruses"
27116 This condition is available only when Exim is compiled with the
27117 content-scanning extension. It causes the incoming message to be scanned for
27118 viruses. For details, see chapter &<<CHAPexiscan>>&.
27119
27120 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27121 .cindex "&%mime_regex%& ACL condition"
27122 .cindex "&ACL;" "testing by regex matching"
27123 This condition is available only when Exim is compiled with the
27124 content-scanning extension, and it is allowed only in the ACL defined by
27125 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27126 with any of the regular expressions. For details, see chapter
27127 &<<CHAPexiscan>>&.
27128
27129 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27130 .cindex "rate limiting"
27131 This condition can be used to limit the rate at which a user or host submits
27132 messages. Details are given in section &<<SECTratelimiting>>&.
27133
27134 .vitem &*recipients&~=&~*&<&'address&~list'&>
27135 .cindex "&%recipients%& ACL condition"
27136 .cindex "recipient" "ACL checking"
27137 .cindex "&ACL;" "testing a recipient"
27138 This condition is relevant only after a RCPT command. It checks the entire
27139 recipient address against a list of recipients.
27140
27141 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27142 .cindex "&%regex%& ACL condition"
27143 .cindex "&ACL;" "testing by regex matching"
27144 This condition is available only when Exim is compiled with the
27145 content-scanning extension, and is available only in the DATA, MIME, and
27146 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27147 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27148
27149 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27150 .cindex "&%sender_domains%& ACL condition"
27151 .cindex "sender" "ACL checking"
27152 .cindex "&ACL;" "testing a sender domain"
27153 .vindex "&$domain$&"
27154 .vindex "&$sender_address_domain$&"
27155 This condition tests the domain of the sender of the message against the given
27156 domain list. &*Note*&: The domain of the sender address is in
27157 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27158 of this condition. This is an exception to the general rule for testing domain
27159 lists. It is done this way so that, if this condition is used in an ACL for a
27160 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27161 influence the sender checking.
27162
27163 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27164 relaying, because sender addresses are easily, and commonly, forged.
27165
27166 .vitem &*senders&~=&~*&<&'address&~list'&>
27167 .cindex "&%senders%& ACL condition"
27168 .cindex "sender" "ACL checking"
27169 .cindex "&ACL;" "testing a sender"
27170 This condition tests the sender of the message against the given list. To test
27171 for a bounce message, which has an empty sender, set
27172 .code
27173 senders = :
27174 .endd
27175 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27176 relaying, because sender addresses are easily, and commonly, forged.
27177
27178 .vitem &*spam&~=&~*&<&'username'&>
27179 .cindex "&%spam%& ACL condition"
27180 .cindex "&ACL;" "scanning for spam"
27181 This condition is available only when Exim is compiled with the
27182 content-scanning extension. It causes the incoming message to be scanned by
27183 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27184
27185 .vitem &*verify&~=&~certificate*&
27186 .cindex "&%verify%& ACL condition"
27187 .cindex "TLS" "client certificate verification"
27188 .cindex "certificate" "verification of client"
27189 .cindex "&ACL;" "certificate verification"
27190 .cindex "&ACL;" "testing a TLS certificate"
27191 This condition is true in an SMTP session if the session is encrypted, and a
27192 certificate was received from the client, and the certificate was verified. The
27193 server requests a certificate only if the client matches &%tls_verify_hosts%&
27194 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27195
27196 .vitem &*verify&~=&~csa*&
27197 .cindex "CSA verification"
27198 This condition checks whether the sending host (the client) is authorized to
27199 send email. Details of how this works are given in section
27200 &<<SECTverifyCSA>>&.
27201
27202 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27203 .cindex "&%verify%& ACL condition"
27204 .cindex "&ACL;" "verifying sender in the header"
27205 .cindex "header lines" "verifying the sender in"
27206 .cindex "sender" "verifying in header"
27207 .cindex "verifying" "sender in header"
27208 This condition is relevant only in an ACL that is run after a message has been
27209 received, that is, in an ACL specified by &%acl_smtp_data%& or
27210 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27211 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27212 is loosely thought of as a &"sender"& address (hence the name of the test).
27213 However, an address that appears in one of these headers need not be an address
27214 that accepts bounce messages; only sender addresses in envelopes are required
27215 to accept bounces. Therefore, if you use the callout option on this check, you
27216 might want to arrange for a non-empty address in the MAIL command.
27217
27218 Details of address verification and the options are given later, starting at
27219 section &<<SECTaddressverification>>& (callouts are described in section
27220 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27221 condition to restrict it to bounce messages only:
27222 .code
27223 deny    senders = :
27224         message = A valid sender header is required for bounces
27225        !verify  = header_sender
27226 .endd
27227
27228 .vitem &*verify&~=&~header_syntax*&
27229 .cindex "&%verify%& ACL condition"
27230 .cindex "&ACL;" "verifying header syntax"
27231 .cindex "header lines" "verifying syntax"
27232 .cindex "verifying" "header syntax"
27233 This condition is relevant only in an ACL that is run after a message has been
27234 received, that is, in an ACL specified by &%acl_smtp_data%& or
27235 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27236 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27237 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27238 permitted only in locally generated messages and from hosts that match
27239 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27240 appropriate.
27241
27242 Note that this condition is a syntax check only. However, a common spamming
27243 ploy used to be to send syntactically invalid headers such as
27244 .code
27245 To: @
27246 .endd
27247 and this condition can be used to reject such messages, though they are not as
27248 common as they used to be.
27249
27250 .vitem &*verify&~=&~helo*&
27251 .cindex "&%verify%& ACL condition"
27252 .cindex "&ACL;" "verifying HELO/EHLO"
27253 .cindex "HELO" "verifying"
27254 .cindex "EHLO" "verifying"
27255 .cindex "verifying" "EHLO"
27256 .cindex "verifying" "HELO"
27257 This condition is true if a HELO or EHLO command has been received from the
27258 client host, and its contents have been verified. If there has been no previous
27259 attempt to verify the HELO/EHLO contents, it is carried out when this
27260 condition is encountered. See the description of the &%helo_verify_hosts%& and
27261 &%helo_try_verify_hosts%& options for details of how to request verification
27262 independently of this condition.
27263
27264 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27265 option), this condition is always true.
27266
27267
27268 .vitem &*verify&~=&~not_blind*&
27269 .cindex "verifying" "not blind"
27270 .cindex "bcc recipients, verifying none"
27271 This condition checks that there are no blind (bcc) recipients in the message.
27272 Every envelope recipient must appear either in a &'To:'& header line or in a
27273 &'Cc:'& header line for this condition to be true. Local parts are checked
27274 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27275 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27276 used only in a DATA or non-SMTP ACL.
27277
27278 There are, of course, many legitimate messages that make use of blind (bcc)
27279 recipients. This check should not be used on its own for blocking messages.
27280
27281
27282 .vitem &*verify&~=&~recipient/*&<&'options'&>
27283 .cindex "&%verify%& ACL condition"
27284 .cindex "&ACL;" "verifying recipient"
27285 .cindex "recipient" "verifying"
27286 .cindex "verifying" "recipient"
27287 .vindex "&$address_data$&"
27288 This condition is relevant only after a RCPT command. It verifies the current
27289 recipient. Details of address verification are given later, starting at section
27290 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27291 of &$address_data$& is the last value that was set while routing the address.
27292 This applies even if the verification fails. When an address that is being
27293 verified is redirected to a single address, verification continues with the new
27294 address, and in that case, the subsequent value of &$address_data$& is the
27295 value for the child address.
27296
27297 .vitem &*verify&~=&~reverse_host_lookup*&
27298 .cindex "&%verify%& ACL condition"
27299 .cindex "&ACL;" "verifying host reverse lookup"
27300 .cindex "host" "verifying reverse lookup"
27301 This condition ensures that a verified host name has been looked up from the IP
27302 address of the client host. (This may have happened already if the host name
27303 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27304 Verification ensures that the host name obtained from a reverse DNS lookup, or
27305 one of its aliases, does, when it is itself looked up in the DNS, yield the
27306 original IP address.
27307
27308 If this condition is used for a locally generated message (that is, when there
27309 is no client host involved), it always succeeds.
27310
27311 .vitem &*verify&~=&~sender/*&<&'options'&>
27312 .cindex "&%verify%& ACL condition"
27313 .cindex "&ACL;" "verifying sender"
27314 .cindex "sender" "verifying"
27315 .cindex "verifying" "sender"
27316 This condition is relevant only after a MAIL or RCPT command, or after a
27317 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27318 the message's sender is empty (that is, this is a bounce message), the
27319 condition is true. Otherwise, the sender address is verified.
27320
27321 .vindex "&$address_data$&"
27322 .vindex "&$sender_address_data$&"
27323 If there is data in the &$address_data$& variable at the end of routing, its
27324 value is placed in &$sender_address_data$& at the end of verification. This
27325 value can be used in subsequent conditions and modifiers in the same ACL
27326 statement. It does not persist after the end of the current statement. If you
27327 want to preserve the value for longer, you can save it in an ACL variable.
27328
27329 Details of verification are given later, starting at section
27330 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27331 to avoid doing it more than once per message.
27332
27333 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27334 .cindex "&%verify%& ACL condition"
27335 This is a variation of the previous option, in which a modified address is
27336 verified as a sender.
27337 .endlist
27338
27339
27340
27341 .section "Using DNS lists" "SECTmorednslists"
27342 .cindex "DNS list" "in ACL"
27343 .cindex "black list (DNS)"
27344 .cindex "&ACL;" "testing a DNS list"
27345 In its simplest form, the &%dnslists%& condition tests whether the calling host
27346 is on at least one of a number of DNS lists by looking up the inverted IP
27347 address in one or more DNS domains. (Note that DNS list domains are not mail
27348 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27349 special options instead.) For example, if the calling host's IP
27350 address is 192.168.62.43, and the ACL statement is
27351 .code
27352 deny dnslists = blackholes.mail-abuse.org : \
27353                 dialups.mail-abuse.org
27354 .endd
27355 the following records are looked up:
27356 .code
27357 43.62.168.192.blackholes.mail-abuse.org
27358 43.62.168.192.dialups.mail-abuse.org
27359 .endd
27360 As soon as Exim finds an existing DNS record, processing of the list stops.
27361 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27362 to test that a host is on more than one list (an &"and"& conjunction), you can
27363 use two separate conditions:
27364 .code
27365 deny dnslists = blackholes.mail-abuse.org
27366      dnslists = dialups.mail-abuse.org
27367 .endd
27368 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27369 behaves as if the host does not match the list item, that is, as if the DNS
27370 record does not exist. If there are further items in the DNS list, they are
27371 processed.
27372
27373 This is usually the required action when &%dnslists%& is used with &%deny%&
27374 (which is the most common usage), because it prevents a DNS failure from
27375 blocking mail. However, you can change this behaviour by putting one of the
27376 following special items in the list:
27377 .display
27378 &`+include_unknown `&   behave as if the item is on the list
27379 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27380 &`+defer_unknown   `&   give a temporary error
27381 .endd
27382 .cindex "&`+include_unknown`&"
27383 .cindex "&`+exclude_unknown`&"
27384 .cindex "&`+defer_unknown`&"
27385 Each of these applies to any subsequent items on the list. For example:
27386 .code
27387 deny dnslists = +defer_unknown : foo.bar.example
27388 .endd
27389 Testing the list of domains stops as soon as a match is found. If you want to
27390 warn for one list and block for another, you can use two different statements:
27391 .code
27392 deny  dnslists = blackholes.mail-abuse.org
27393 warn  message  = X-Warn: sending host is on dialups list
27394       dnslists = dialups.mail-abuse.org
27395 .endd
27396 DNS list lookups are cached by Exim for the duration of the SMTP session,
27397 so a lookup based on the IP address is done at most once for any incoming
27398 connection. Exim does not share information between multiple incoming
27399 connections (but your local name server cache should be active).
27400
27401
27402
27403 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27404 .cindex "DNS list" "keyed by explicit IP address"
27405 By default, the IP address that is used in a DNS list lookup is the IP address
27406 of the calling host. However, you can specify another IP address by listing it
27407 after the domain name, introduced by a slash. For example:
27408 .code
27409 deny dnslists = black.list.tld/192.168.1.2
27410 .endd
27411 This feature is not very helpful with explicit IP addresses; it is intended for
27412 use with IP addresses that are looked up, for example, the IP addresses of the
27413 MX hosts or nameservers of an email sender address. For an example, see section
27414 &<<SECTmulkeyfor>>& below.
27415
27416
27417
27418
27419 .section "DNS lists keyed on domain names" "SECID202"
27420 .cindex "DNS list" "keyed by domain name"
27421 There are some lists that are keyed on domain names rather than inverted IP
27422 addresses (see for example the &'domain based zones'& link at
27423 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27424 with these lists. You can change the name that is looked up in a DNS list by
27425 listing it after the domain name, introduced by a slash. For example,
27426 .code
27427 deny  message  = Sender's domain is listed at $dnslist_domain
27428       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27429 .endd
27430 This particular example is useful only in ACLs that are obeyed after the
27431 RCPT or DATA commands, when a sender address is available. If (for
27432 example) the message's sender is &'user@tld.example'& the name that is looked
27433 up by this example is
27434 .code
27435 tld.example.dsn.rfc-ignorant.org
27436 .endd
27437 A single &%dnslists%& condition can contain entries for both names and IP
27438 addresses. For example:
27439 .code
27440 deny dnslists = sbl.spamhaus.org : \
27441                 dsn.rfc-ignorant.org/$sender_address_domain
27442 .endd
27443 The first item checks the sending host's IP address; the second checks a domain
27444 name. The whole condition is true if either of the DNS lookups succeeds.
27445
27446
27447
27448
27449 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27450 .cindex "DNS list" "multiple keys for"
27451 The syntax described above for looking up explicitly-defined values (either
27452 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27453 name for the DNS list, what follows the slash can in fact be a list of items.
27454 As with all lists in Exim, the default separator is a colon. However, because
27455 this is a sublist within the list of DNS blacklist domains, it is necessary
27456 either to double the separators like this:
27457 .code
27458 dnslists = black.list.tld/name.1::name.2
27459 .endd
27460 or to change the separator character, like this:
27461 .code
27462 dnslists = black.list.tld/<;name.1;name.2
27463 .endd
27464 If an item in the list is an IP address, it is inverted before the DNS
27465 blacklist domain is appended. If it is not an IP address, no inversion
27466 occurs. Consider this condition:
27467 .code
27468 dnslists = black.list.tld/<;192.168.1.2;a.domain
27469 .endd
27470 The DNS lookups that occur are:
27471 .code
27472 2.1.168.192.black.list.tld
27473 a.domain.black.list.tld
27474 .endd
27475 Once a DNS record has been found (that matches a specific IP return
27476 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27477 are done. If there is a temporary DNS error, the rest of the sublist of domains
27478 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27479 only if no other DNS lookup in this sublist succeeds. In other words, a
27480 successful lookup for any of the items in the sublist overrides a temporary
27481 error for a previous item.
27482
27483 The ability to supply a list of items after the slash is in some sense just a
27484 syntactic convenience. These two examples have the same effect:
27485 .code
27486 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
27487 dnslists = black.list.tld/a.domain::b.domain
27488 .endd
27489 However, when the data for the list is obtained from a lookup, the second form
27490 is usually much more convenient. Consider this example:
27491 .code
27492 deny message  = The mail servers for the domain \
27493                 $sender_address_domain \
27494                 are listed at $dnslist_domain ($dnslist_value); \
27495                 see $dnslist_text.
27496      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
27497                                    ${lookup dnsdb {>|mxh=\
27498                                    $sender_address_domain} }} }
27499 .endd
27500 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
27501 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
27502 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
27503 of expanding the condition might be something like this:
27504 .code
27505 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
27506 .endd
27507 Thus, this example checks whether or not the IP addresses of the sender
27508 domain's mail servers are on the Spamhaus black list.
27509
27510 The key that was used for a successful DNS list lookup is put into the variable
27511 &$dnslist_matched$& (see section &<<SECID204>>&).
27512
27513
27514
27515
27516 .section "Data returned by DNS lists" "SECID203"
27517 .cindex "DNS list" "data returned from"
27518 DNS lists are constructed using address records in the DNS. The original RBL
27519 just used the address 127.0.0.1 on the right hand side of each record, but the
27520 RBL+ list and some other lists use a number of values with different meanings.
27521 The values used on the RBL+ list are:
27522 .display
27523 127.1.0.1  RBL
27524 127.1.0.2  DUL
27525 127.1.0.3  DUL and RBL
27526 127.1.0.4  RSS
27527 127.1.0.5  RSS and RBL
27528 127.1.0.6  RSS and DUL
27529 127.1.0.7  RSS and DUL and RBL
27530 .endd
27531 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
27532 different values. Some DNS lists may return more than one address record;
27533 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
27534
27535
27536 .section "Variables set from DNS lists" "SECID204"
27537 .cindex "expansion" "variables, set from DNS list"
27538 .cindex "DNS list" "variables set from"
27539 .vindex "&$dnslist_domain$&"
27540 .vindex "&$dnslist_matched$&"
27541 .vindex "&$dnslist_text$&"
27542 .vindex "&$dnslist_value$&"
27543 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
27544 the name of the overall domain that matched (for example,
27545 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
27546 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
27547 the DNS record. When the key is an IP address, it is not reversed in
27548 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
27549 cases, for example:
27550 .code
27551 deny dnslists = spamhaus.example
27552 .endd
27553 the key is also available in another variable (in this case,
27554 &$sender_host_address$&). In more complicated cases, however, this is not true.
27555 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
27556 might generate a dnslists lookup like this:
27557 .code
27558 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
27559 .endd
27560 If this condition succeeds, the value in &$dnslist_matched$& might be
27561 &`192.168.6.7`& (for example).
27562
27563 If more than one address record is returned by the DNS lookup, all the IP
27564 addresses are included in &$dnslist_value$&, separated by commas and spaces.
27565 The variable &$dnslist_text$& contains the contents of any associated TXT
27566 record. For lists such as RBL+ the TXT record for a merged entry is often not
27567 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
27568 information.
27569
27570 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
27571 &-- although these appear before the condition in the ACL, they are not
27572 expanded until after it has failed. For example:
27573 .code
27574 deny    hosts = !+local_networks
27575         message = $sender_host_address is listed \
27576                   at $dnslist_domain
27577         dnslists = rbl-plus.mail-abuse.example
27578 .endd
27579
27580
27581
27582 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
27583 .cindex "DNS list" "matching specific returned data"
27584 You can add an equals sign and an IP address after a &%dnslists%& domain name
27585 in order to restrict its action to DNS records with a matching right hand side.
27586 For example,
27587 .code
27588 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
27589 .endd
27590 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27591 any address record is considered to be a match. For the moment, we assume
27592 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27593 describes how multiple records are handled.
27594
27595 More than one IP address may be given for checking, using a comma as a
27596 separator. These are alternatives &-- if any one of them matches, the
27597 &%dnslists%& condition is true. For example:
27598 .code
27599 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27600 .endd
27601 If you want to specify a constraining address list and also specify names or IP
27602 addresses to be looked up, the constraining address list must be specified
27603 first. For example:
27604 .code
27605 deny dnslists = dsn.rfc-ignorant.org\
27606                 =127.0.0.2/$sender_address_domain
27607 .endd
27608
27609 If the character &`&&`& is used instead of &`=`&, the comparison for each
27610 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27611 In other words, the listed addresses are used as bit masks. The comparison is
27612 true if all the bits in the mask are present in the address that is being
27613 tested. For example:
27614 .code
27615 dnslists = a.b.c&0.0.0.3
27616 .endd
27617 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27618 want to test whether one bit or another bit is present (as opposed to both
27619 being present), you must use multiple values. For example:
27620 .code
27621 dnslists = a.b.c&0.0.0.1,0.0.0.2
27622 .endd
27623 matches if the final component of the address is an odd number or two times
27624 an odd number.
27625
27626
27627
27628 .section "Negated DNS matching conditions" "SECID205"
27629 You can supply a negative list of IP addresses as part of a &%dnslists%&
27630 condition. Whereas
27631 .code
27632 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27633 .endd
27634 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27635 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27636 .code
27637 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27638 .endd
27639 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27640 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27641 words, the result of the test is inverted if an exclamation mark appears before
27642 the &`=`& (or the &`&&`&) sign.
27643
27644 &*Note*&: This kind of negation is not the same as negation in a domain,
27645 host, or address list (which is why the syntax is different).
27646
27647 If you are using just one list, the negation syntax does not gain you much. The
27648 previous example is precisely equivalent to
27649 .code
27650 deny  dnslists = a.b.c
27651      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27652 .endd
27653 However, if you are using multiple lists, the negation syntax is clearer.
27654 Consider this example:
27655 .code
27656 deny  dnslists = sbl.spamhaus.org : \
27657                  list.dsbl.org : \
27658                  dnsbl.njabl.org!=127.0.0.3 : \
27659                  relays.ordb.org
27660 .endd
27661 Using only positive lists, this would have to be:
27662 .code
27663 deny  dnslists = sbl.spamhaus.org : \
27664                  list.dsbl.org
27665 deny  dnslists = dnsbl.njabl.org
27666      !dnslists = dnsbl.njabl.org=127.0.0.3
27667 deny  dnslists = relays.ordb.org
27668 .endd
27669 which is less clear, and harder to maintain.
27670
27671
27672
27673
27674 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27675 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27676 thereby providing more than one IP address. When an item in a &%dnslists%& list
27677 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27678 the match to specific results from the DNS lookup, there are two ways in which
27679 the checking can be handled. For example, consider the condition:
27680 .code
27681 dnslists = a.b.c=127.0.0.1
27682 .endd
27683 What happens if the DNS lookup for the incoming IP address yields both
27684 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27685 condition true because at least one given value was found, or is it false
27686 because at least one of the found values was not listed? And how does this
27687 affect negated conditions? Both possibilities are provided for with the help of
27688 additional separators &`==`& and &`=&&`&.
27689
27690 .ilist
27691 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27692 IP addresses matches one of the listed addresses. For the example above, the
27693 condition is true because 127.0.0.1 matches.
27694 .next
27695 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27696 looked up IP addresses matches one of the listed addresses. If the condition is
27697 changed to:
27698 .code
27699 dnslists = a.b.c==127.0.0.1
27700 .endd
27701 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27702 false because 127.0.0.2 is not listed. You would need to have:
27703 .code
27704 dnslists = a.b.c==127.0.0.1,127.0.0.2
27705 .endd
27706 for the condition to be true.
27707 .endlist
27708
27709 When &`!`& is used to negate IP address matching, it inverts the result, giving
27710 the precise opposite of the behaviour above. Thus:
27711 .ilist
27712 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27713 addresses matches one of the listed addresses. Consider:
27714 .code
27715 dnslists = a.b.c!&0.0.0.1
27716 .endd
27717 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27718 false because 127.0.0.1 matches.
27719 .next
27720 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27721 looked up IP address that does not match. Consider:
27722 .code
27723 dnslists = a.b.c!=&0.0.0.1
27724 .endd
27725 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27726 true, because 127.0.0.2 does not match. You would need to have:
27727 .code
27728 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27729 .endd
27730 for the condition to be false.
27731 .endlist
27732 When the DNS lookup yields only a single IP address, there is no difference
27733 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27734
27735
27736
27737
27738 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27739 .cindex "DNS list" "information from merged"
27740 When the facility for restricting the matching IP values in a DNS list is used,
27741 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27742 the true reason for rejection. This happens when lists are merged and the IP
27743 address in the A record is used to distinguish them; unfortunately there is
27744 only one TXT record. One way round this is not to use merged lists, but that
27745 can be inefficient because it requires multiple DNS lookups where one would do
27746 in the vast majority of cases when the host of interest is not on any of the
27747 lists.
27748
27749 A less inefficient way of solving this problem is available. If
27750 two domain names, comma-separated, are given, the second is used first to
27751 do an initial check, making use of any IP value restrictions that are set.
27752 If there is a match, the first domain is used, without any IP value
27753 restrictions, to get the TXT record. As a byproduct of this, there is also
27754 a check that the IP being tested is indeed on the first list. The first
27755 domain is the one that is put in &$dnslist_domain$&. For example:
27756 .code
27757 reject message  = \
27758          rejected because $sender_host_address is blacklisted \
27759          at $dnslist_domain\n$dnslist_text
27760        dnslists = \
27761          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27762          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27763 .endd
27764 For the first blacklist item, this starts by doing a lookup in
27765 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27766 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27767 value, and as long as something is found, it looks for the corresponding TXT
27768 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27769 The second blacklist item is processed similarly.
27770
27771 If you are interested in more than one merged list, the same list must be
27772 given several times, but because the results of the DNS lookups are cached,
27773 the DNS calls themselves are not repeated. For example:
27774 .code
27775 reject dnslists = \
27776          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27777          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27778          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27779          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27780 .endd
27781 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27782 values matches (or if no record is found), this is the only lookup that is
27783 done. Only if there is a match is one of the more specific lists consulted.
27784
27785
27786
27787 .section "DNS lists and IPv6" "SECTmorednslistslast"
27788 .cindex "IPv6" "DNS black lists"
27789 .cindex "DNS list" "IPv6 usage"
27790 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27791 nibble by nibble. For example, if the calling host's IP address is
27792 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27793 .code
27794 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27795   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27796 .endd
27797 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27798 lists contain wildcard records, intended for IPv4, that interact badly with
27799 IPv6. For example, the DNS entry
27800 .code
27801 *.3.some.list.example.    A    127.0.0.1
27802 .endd
27803 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27804 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27805
27806 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27807 &%condition%& condition, as in this example:
27808 .code
27809 deny   condition = ${if isip4{$sender_host_address}}
27810        dnslists  = some.list.example
27811 .endd
27812
27813 .section "Rate limiting incoming messages" "SECTratelimiting"
27814 .cindex "rate limiting" "client sending"
27815 .cindex "limiting client sending rates"
27816 .oindex "&%smtp_ratelimit_*%&"
27817 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27818 which clients can send email. This is more powerful than the
27819 &%smtp_ratelimit_*%& options, because those options control the rate of
27820 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27821 works across all connections (concurrent and sequential) from the same client
27822 host. The syntax of the &%ratelimit%& condition is:
27823 .display
27824 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27825 .endd
27826 If the average client sending rate is less than &'m'& messages per time
27827 period &'p'& then the condition is false; otherwise it is true.
27828
27829 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27830 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27831 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27832 of &'p'&.
27833
27834 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27835 time interval, for example, &`8h`& for eight hours. A larger time constant
27836 means that it takes Exim longer to forget a client's past behaviour. The
27837 parameter &'m'& is the maximum number of messages that a client is permitted to
27838 send in each time interval. It also specifies the number of messages permitted
27839 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27840 constant, you can allow a client to send more messages in a burst without
27841 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27842 both small, messages must be sent at an even rate.
27843
27844 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27845 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27846 when deploying the &%ratelimit%& ACL condition. The script prints usage
27847 instructions when it is run with no arguments.
27848
27849 The key is used to look up the data for calculating the client's average
27850 sending rate. This data is stored in Exim's spool directory, alongside the
27851 retry and other hints databases. The default key is &$sender_host_address$&,
27852 which means Exim computes the sending rate of each client host IP address.
27853 By changing the key you can change how Exim identifies clients for the purpose
27854 of ratelimiting. For example, to limit the sending rate of each authenticated
27855 user, independent of the computer they are sending from, set the key to
27856 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27857 example, &$authenticated_id$& is only meaningful if the client has
27858 authenticated (which you can check with the &%authenticated%& ACL condition).
27859
27860 The lookup key does not have to identify clients: If you want to limit the
27861 rate at which a recipient receives messages, you can use the key
27862 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27863 ACL.
27864
27865 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
27866 specifies what Exim measures the rate of, for example messages or recipients
27867 or bytes. You can adjust the measurement using the &%unique=%& and/or
27868 &%count=%& options. You can also control when Exim updates the recorded rate
27869 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
27870 separated by a slash, like the other parameters. They may appear in any order.
27871
27872 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
27873 any options that alter the meaning of the stored data. The limit &'m'& is not
27874 stored, so you can alter the configured maximum rate and Exim will still
27875 remember clients' past behaviour. If you change the &%per_*%& mode or add or
27876 remove the &%unique=%& option, the lookup key changes so Exim will forget past
27877 behaviour. The lookup key is not affected by changes to the update mode and
27878 the &%count=%& option.
27879
27880
27881 .section "Ratelimit options for what is being measured" "ratoptmea"
27882 .cindex "rate limiting" "per_* options"
27883 The &%per_conn%& option limits the client's connection rate. It is not
27884 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
27885 &%acl_not_smtp_start%& ACLs.
27886
27887 The &%per_mail%& option limits the client's rate of sending messages. This is
27888 the default if none of the &%per_*%& options is specified. It can be used in
27889 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
27890 &%acl_smtp_data%&, or &%acl_not_smtp%&.
27891
27892 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
27893 the same ACLs as the &%per_mail%& option, though it is best to use this option
27894 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
27895 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
27896 in its MAIL command, which may be inaccurate or completely missing. You can
27897 follow the limit &'m'& in the configuration with K, M, or G to specify limits
27898 in kilobytes, megabytes, or gigabytes, respectively.
27899
27900 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
27901 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27902 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
27903 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
27904 ACLs the rate is updated with the total recipient count in one go. Note that
27905 in either case the rate limiting engine will see a message with many
27906 recipients as a large high-speed burst.
27907
27908 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
27909 number of different recipients that the client has sent messages to in the
27910 last time period. That is, if the client repeatedly sends messages to the same
27911 recipient, its measured rate is not increased. This option can only be used in
27912 &%acl_smtp_rcpt%&.
27913
27914 The &%per_cmd%& option causes Exim to recompute the rate every time the
27915 condition is processed. This can be used to limit the rate of any SMTP
27916 command. If it is used in multiple ACLs it can limit the aggregate rate of
27917 multiple different commands.
27918
27919 The &%count=%& option can be used to alter how much Exim adds to the client's
27920 measured rate. For example, the &%per_byte%& option is equivalent to
27921 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
27922 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
27923 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
27924
27925 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
27926
27927
27928 .section "Ratelimit update modes" "ratoptupd"
27929 .cindex "rate limiting" "reading data without updating"
27930 You can specify one of three options with the &%ratelimit%& condition to
27931 control when its database is updated. This section describes the &%readonly%&
27932 mode, and the next section describes the &%strict%& and &%leaky%& modes.
27933
27934 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
27935 previously-computed rate to check against the limit.
27936
27937 For example, you can test the client's sending rate and deny it access (when
27938 it is too fast) in the connect ACL. If the client passes this check then it
27939 can go on to send a message, in which case its recorded rate will be updated
27940 in the MAIL ACL. Subsequent connections from the same client will check this
27941 new rate.
27942 .code
27943 acl_check_connect:
27944  deny ratelimit = 100 / 5m / readonly
27945     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
27946                   (max $sender_rate_limit)
27947 # ...
27948 acl_check_mail:
27949  warn ratelimit = 100 / 5m / strict
27950     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
27951                   (max $sender_rate_limit)
27952 .endd
27953
27954 If Exim encounters multiple &%ratelimit%& conditions with the same key when
27955 processing a message then it may increase the client's measured rate more than
27956 it should. For example, this will happen if you check the &%per_rcpt%& option
27957 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
27958 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
27959 multiple update problems by using the &%readonly%& option on later ratelimit
27960 checks.
27961
27962 The &%per_*%& options described above do not make sense in some ACLs. If you
27963 use a &%per_*%& option in an ACL where it is not normally permitted then the
27964 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
27965 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
27966 next section) so you must specify the &%readonly%& option explicitly.
27967
27968
27969 .section "Ratelimit options for handling fast clients" "ratoptfast"
27970 .cindex "rate limiting" "strict and leaky modes"
27971 If a client's average rate is greater than the maximum, the rate limiting
27972 engine can react in two possible ways, depending on the presence of the
27973 &%strict%& or &%leaky%& update modes. This is independent of the other
27974 counter-measures (such as rejecting the message) that may be specified by the
27975 rest of the ACL.
27976
27977 The &%leaky%& (default) option means that the client's recorded rate is not
27978 updated if it is above the limit. The effect of this is that Exim measures the
27979 client's average rate of successfully sent email, which cannot be greater than
27980 the maximum allowed. If the client is over the limit it may suffer some
27981 counter-measures (as specified in the ACL), but it will still be able to send
27982 email at the configured maximum rate, whatever the rate of its attempts. This
27983 is generally the better choice if you have clients that retry automatically.
27984 For example, it does not prevent a sender with an over-aggressive retry rate
27985 from getting any email through.
27986
27987 The &%strict%& option means that the client's recorded rate is always
27988 updated. The effect of this is that Exim measures the client's average rate
27989 of attempts to send email, which can be much higher than the maximum it is
27990 actually allowed. If the client is over the limit it may be subjected to
27991 counter-measures by the ACL. It must slow down and allow sufficient time to
27992 pass that its computed rate falls below the maximum before it can send email
27993 again. The time (the number of smoothing periods) it must wait and not
27994 attempt to send mail can be calculated with this formula:
27995 .code
27996         ln(peakrate/maxrate)
27997 .endd
27998
27999
28000 .section "Limiting the rate of different events" "ratoptuniq"
28001 .cindex "rate limiting" "counting unique events"
28002 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28003 rate of different events. For example, the &%per_addr%& option uses this
28004 mechanism to count the number of different recipients that the client has
28005 sent messages to in the last time period; it is equivalent to
28006 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28007 measure the rate that a client uses different sender addresses with the
28008 options &`per_mail/unique=$sender_address`&.
28009
28010 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28011 has seen for that key. The whole set is thrown away when it is older than the
28012 rate smoothing period &'p'&, so each different event is counted at most once
28013 per period. In the &%leaky%& update mode, an event that causes the client to
28014 go over the limit is not added to the set, in the same way that the client's
28015 recorded rate is not updated in the same situation.
28016
28017 When you combine the &%unique=%& and &%readonly%& options, the specific
28018 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28019 rate.
28020
28021 The &%unique=%& mechanism needs more space in the ratelimit database than the
28022 other &%ratelimit%& options in order to store the event set. The number of
28023 unique values is potentially as large as the rate limit, so the extra space
28024 required increases with larger limits.
28025
28026 The uniqueification is not perfect: there is a small probability that Exim
28027 will think a new event has happened before. If the sender's rate is less than
28028 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28029 the measured rate can go above the limit, in which case Exim may under-count
28030 events by a significant margin. Fortunately, if the rate is high enough (2.7
28031 times the limit) that the false positive rate goes above 9%, then Exim will
28032 throw away the over-full event set before the measured rate falls below the
28033 limit. Therefore the only harm should be that exceptionally high sending rates
28034 are logged incorrectly; any countermeasures you configure will be as effective
28035 as intended.
28036
28037
28038 .section "Using rate limiting" "useratlim"
28039 Exim's other ACL facilities are used to define what counter-measures are taken
28040 when the rate limit is exceeded. This might be anything from logging a warning
28041 (for example, while measuring existing sending rates in order to define
28042 policy), through time delays to slow down fast senders, up to rejecting the
28043 message. For example:
28044 .code
28045 # Log all senders' rates
28046 warn ratelimit = 0 / 1h / strict
28047      log_message = Sender rate $sender_rate / $sender_rate_period
28048
28049 # Slow down fast senders; note the need to truncate $sender_rate
28050 # at the decimal point.
28051 warn ratelimit = 100 / 1h / per_rcpt / strict
28052      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28053                    $sender_rate_limit }s
28054
28055 # Keep authenticated users under control
28056 deny authenticated = *
28057      ratelimit = 100 / 1d / strict / $authenticated_id
28058
28059 # System-wide rate limit
28060 defer message = Sorry, too busy. Try again later.
28061      ratelimit = 10 / 1s / $primary_hostname
28062
28063 # Restrict incoming rate from each host, with a default
28064 # set using a macro and special cases looked up in a table.
28065 defer message = Sender rate exceeds $sender_rate_limit \
28066                messages per $sender_rate_period
28067      ratelimit = ${lookup {$sender_host_address} \
28068                    cdb {DB/ratelimits.cdb} \
28069                    {$value} {RATELIMIT} }
28070 .endd
28071 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28072 especially with the &%per_rcpt%& option, you may suffer from a performance
28073 bottleneck caused by locking on the ratelimit hints database. Apart from
28074 making your ACLs less complicated, you can reduce the problem by using a
28075 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28076 this means that Exim will lose its hints data after a reboot (including retry
28077 hints, the callout cache, and ratelimit data).
28078
28079
28080
28081 .section "Address verification" "SECTaddressverification"
28082 .cindex "verifying address" "options for"
28083 .cindex "policy control" "address verification"
28084 Several of the &%verify%& conditions described in section
28085 &<<SECTaclconditions>>& cause addresses to be verified. Section
28086 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28087 The verification conditions can be followed by options that modify the
28088 verification process. The options are separated from the keyword and from each
28089 other by slashes, and some of them contain parameters. For example:
28090 .code
28091 verify = sender/callout
28092 verify = recipient/defer_ok/callout=10s,defer_ok
28093 .endd
28094 The first stage of address verification, which always happens, is to run the
28095 address through the routers, in &"verify mode"&. Routers can detect the
28096 difference between verification and routing for delivery, and their actions can
28097 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28098 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28099 The available options are as follows:
28100
28101 .ilist
28102 If the &%callout%& option is specified, successful routing to one or more
28103 remote hosts is followed by a &"callout"& to those hosts as an additional
28104 check. Callouts and their sub-options are discussed in the next section.
28105 .next
28106 If there is a defer error while doing verification routing, the ACL
28107 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28108 options, the condition is forced to be true instead. Note that this is a main
28109 verification option as well as a suboption for callouts.
28110 .next
28111 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28112 discusses the reporting of sender address verification failures.
28113 .next
28114 The &%success_on_redirect%& option causes verification always to succeed
28115 immediately after a successful redirection. By default, if a redirection
28116 generates just one address, that address is also verified. See further
28117 discussion in section &<<SECTredirwhilveri>>&.
28118 .endlist
28119
28120 .cindex "verifying address" "differentiating failures"
28121 .vindex "&$recipient_verify_failure$&"
28122 .vindex "&$sender_verify_failure$&"
28123 .vindex "&$acl_verify_message$&"
28124 After an address verification failure, &$acl_verify_message$& contains the
28125 error message that is associated with the failure. It can be preserved by
28126 coding like this:
28127 .code
28128 warn  !verify = sender
28129        set acl_m0 = $acl_verify_message
28130 .endd
28131 If you are writing your own custom rejection message or log message when
28132 denying access, you can use this variable to include information about the
28133 verification failure.
28134
28135 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28136 appropriate) contains one of the following words:
28137
28138 .ilist
28139 &%qualify%&: The address was unqualified (no domain), and the message
28140 was neither local nor came from an exempted host.
28141 .next
28142 &%route%&: Routing failed.
28143 .next
28144 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28145 occurred at or before the MAIL command (that is, on initial
28146 connection, HELO, or MAIL).
28147 .next
28148 &%recipient%&: The RCPT command in a callout was rejected.
28149 .next
28150 &%postmaster%&: The postmaster check in a callout was rejected.
28151 .endlist
28152
28153 The main use of these variables is expected to be to distinguish between
28154 rejections of MAIL and rejections of RCPT in callouts.
28155
28156
28157
28158
28159 .section "Callout verification" "SECTcallver"
28160 .cindex "verifying address" "by callout"
28161 .cindex "callout" "verification"
28162 .cindex "SMTP" "callout verification"
28163 For non-local addresses, routing verifies the domain, but is unable to do any
28164 checking of the local part. There are situations where some means of verifying
28165 the local part is desirable. One way this can be done is to make an SMTP
28166 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28167 a subsequent host for a recipient address, to see if the host accepts the
28168 address. We use the term &'callout'& to cover both cases. Note that for a
28169 sender address, the callback is not to the client host that is trying to
28170 deliver the message, but to one of the hosts that accepts incoming mail for the
28171 sender's domain.
28172
28173 Exim does not do callouts by default. If you want them to happen, you must
28174 request them by setting appropriate options on the &%verify%& condition, as
28175 described below. This facility should be used with care, because it can add a
28176 lot of resource usage to the cost of verifying an address. However, Exim does
28177 cache the results of callouts, which helps to reduce the cost. Details of
28178 caching are in section &<<SECTcallvercache>>&.
28179
28180 Recipient callouts are usually used only between hosts that are controlled by
28181 the same administration. For example, a corporate gateway host could use
28182 callouts to check for valid recipients on an internal mailserver. A successful
28183 callout does not guarantee that a real delivery to the address would succeed;
28184 on the other hand, a failing callout does guarantee that a delivery would fail.
28185
28186 If the &%callout%& option is present on a condition that verifies an address, a
28187 second stage of verification occurs if the address is successfully routed to
28188 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28189 &(manualroute)& router, where the router specifies the hosts. However, if a
28190 router that does not set up hosts routes to an &(smtp)& transport with a
28191 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28192 &%hosts_override%& set, its hosts are always used, whether or not the router
28193 supplies a host list.
28194
28195 The port that is used is taken from the transport, if it is specified and is a
28196 remote transport. (For routers that do verification only, no transport need be
28197 specified.) Otherwise, the default SMTP port is used. If a remote transport
28198 specifies an outgoing interface, this is used; otherwise the interface is not
28199 specified. Likewise, the text that is used for the HELO command is taken from
28200 the transport's &%helo_data%& option; if there is no transport, the value of
28201 &$smtp_active_hostname$& is used.
28202
28203 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28204 test whether a bounce message could be delivered to the sender address. The
28205 following SMTP commands are sent:
28206 .display
28207 &`HELO `&<&'local host name'&>
28208 &`MAIL FROM:<>`&
28209 &`RCPT TO:`&<&'the address to be tested'&>
28210 &`QUIT`&
28211 .endd
28212 LHLO is used instead of HELO if the transport's &%protocol%& option is
28213 set to &"lmtp"&.
28214
28215 A recipient callout check is similar. By default, it also uses an empty address
28216 for the sender. This default is chosen because most hosts do not make use of
28217 the sender address when verifying a recipient. Using the same address means
28218 that a single cache entry can be used for each recipient. Some sites, however,
28219 do make use of the sender address when verifying. These are catered for by the
28220 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28221
28222 If the response to the RCPT command is a 2&'xx'& code, the verification
28223 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28224 Exim tries the next host, if any. If there is a problem with all the remote
28225 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28226 &%callout%& option is given, in which case the condition is forced to succeed.
28227
28228 .cindex "SMTP" "output flushing, disabling for callout"
28229 A callout may take a little time. For this reason, Exim normally flushes SMTP
28230 output before performing a callout in an ACL, to avoid unexpected timeouts in
28231 clients when the SMTP PIPELINING extension is in use. The flushing can be
28232 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28233
28234
28235
28236
28237 .section "Additional parameters for callouts" "CALLaddparcall"
28238 .cindex "callout" "additional parameters for"
28239 The &%callout%& option can be followed by an equals sign and a number of
28240 optional parameters, separated by commas. For example:
28241 .code
28242 verify = recipient/callout=10s,defer_ok
28243 .endd
28244 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28245 separate verify options, is retained for backwards compatibility, but is now
28246 deprecated. The additional parameters for &%callout%& are as follows:
28247
28248
28249 .vlist
28250 .vitem <&'a&~time&~interval'&>
28251 .cindex "callout" "timeout, specifying"
28252 This specifies the timeout that applies for the callout attempt to each host.
28253 For example:
28254 .code
28255 verify = sender/callout=5s
28256 .endd
28257 The default is 30 seconds. The timeout is used for each response from the
28258 remote host. It is also used for the initial connection, unless overridden by
28259 the &%connect%& parameter.
28260
28261
28262 .vitem &*connect&~=&~*&<&'time&~interval'&>
28263 .cindex "callout" "connection timeout, specifying"
28264 This parameter makes it possible to set a different (usually smaller) timeout
28265 for making the SMTP connection. For example:
28266 .code
28267 verify = sender/callout=5s,connect=1s
28268 .endd
28269 If not specified, this timeout defaults to the general timeout value.
28270
28271 .vitem &*defer_ok*&
28272 .cindex "callout" "defer, action on"
28273 When this parameter is present, failure to contact any host, or any other kind
28274 of temporary error, is treated as success by the ACL. However, the cache is not
28275 updated in this circumstance.
28276
28277 .vitem &*fullpostmaster*&
28278 .cindex "callout" "full postmaster check"
28279 This operates like the &%postmaster%& option (see below), but if the check for
28280 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28281 accordance with the specification in RFC 2821. The RFC states that the
28282 unqualified address &'postmaster'& should be accepted.
28283
28284
28285 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28286 .cindex "callout" "sender when verifying header"
28287 When verifying addresses in header lines using the &%header_sender%&
28288 verification option, Exim behaves by default as if the addresses are envelope
28289 sender addresses from a message. Callout verification therefore tests to see
28290 whether a bounce message could be delivered, by using an empty address in the
28291 MAIL command. However, it is arguable that these addresses might never be used
28292 as envelope senders, and could therefore justifiably reject bounce messages
28293 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28294 address to use in the MAIL command. For example:
28295 .code
28296 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28297 .endd
28298 This parameter is available only for the &%header_sender%& verification option.
28299
28300
28301 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28302 .cindex "callout" "overall timeout, specifying"
28303 This parameter sets an overall timeout for performing a callout verification.
28304 For example:
28305 .code
28306 verify = sender/callout=5s,maxwait=30s
28307 .endd
28308 This timeout defaults to four times the callout timeout for individual SMTP
28309 commands. The overall timeout applies when there is more than one host that can
28310 be tried. The timeout is checked before trying the next host. This prevents
28311 very long delays if there are a large number of hosts and all are timing out
28312 (for example, when network connections are timing out).
28313
28314
28315 .vitem &*no_cache*&
28316 .cindex "callout" "cache, suppressing"
28317 .cindex "caching callout, suppressing"
28318 When this parameter is given, the callout cache is neither read nor updated.
28319
28320 .vitem &*postmaster*&
28321 .cindex "callout" "postmaster; checking"
28322 When this parameter is set, a successful callout check is followed by a similar
28323 check for the local part &'postmaster'& at the same domain. If this address is
28324 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28325 the postmaster check is recorded in a cache record; if it is a failure, this is
28326 used to fail subsequent callouts for the domain without a connection being
28327 made, until the cache record expires.
28328
28329 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28330 The postmaster check uses an empty sender in the MAIL command by default.
28331 You can use this parameter to do a postmaster check using a different address.
28332 For example:
28333 .code
28334 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28335 .endd
28336 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28337 one overrides. The &%postmaster%& parameter is equivalent to this example:
28338 .code
28339 require  verify = sender/callout=postmaster_mailfrom=
28340 .endd
28341 &*Warning*&: The caching arrangements for postmaster checking do not take
28342 account of the sender address. It is assumed that either the empty address or
28343 a fixed non-empty address will be used. All that Exim remembers is that the
28344 postmaster check for the domain succeeded or failed.
28345
28346
28347 .vitem &*random*&
28348 .cindex "callout" "&""random""& check"
28349 When this parameter is set, before doing the normal callout check, Exim does a
28350 check for a &"random"& local part at the same domain. The local part is not
28351 really random &-- it is defined by the expansion of the option
28352 &%callout_random_local_part%&, which defaults to
28353 .code
28354 $primary_hostname-$tod_epoch-testing
28355 .endd
28356 The idea here is to try to determine whether the remote host accepts all local
28357 parts without checking. If it does, there is no point in doing callouts for
28358 specific local parts. If the &"random"& check succeeds, the result is saved in
28359 a cache record, and used to force the current and subsequent callout checks to
28360 succeed without a connection being made, until the cache record expires.
28361
28362 .vitem &*use_postmaster*&
28363 .cindex "callout" "sender for recipient check"
28364 This parameter applies to recipient callouts only. For example:
28365 .code
28366 deny  !verify = recipient/callout=use_postmaster
28367 .endd
28368 .vindex "&$qualify_domain$&"
28369 It causes a non-empty postmaster address to be used in the MAIL command when
28370 performing the callout for the recipient, and also for a &"random"& check if
28371 that is configured. The local part of the address is &`postmaster`& and the
28372 domain is the contents of &$qualify_domain$&.
28373
28374 .vitem &*use_sender*&
28375 This option applies to recipient callouts only. For example:
28376 .code
28377 require  verify = recipient/callout=use_sender
28378 .endd
28379 It causes the message's actual sender address to be used in the MAIL
28380 command when performing the callout, instead of an empty address. There is no
28381 need to use this option unless you know that the called hosts make use of the
28382 sender when checking recipients. If used indiscriminately, it reduces the
28383 usefulness of callout caching.
28384 .endlist
28385
28386 If you use any of the parameters that set a non-empty sender for the MAIL
28387 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28388 &%use_sender%&), you should think about possible loops. Recipient checking is
28389 usually done between two hosts that are under the same management, and the host
28390 that receives the callouts is not normally configured to do callouts itself.
28391 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28392 these circumstances.
28393
28394 However, if you use a non-empty sender address for a callout to an arbitrary
28395 host, there is the likelihood that the remote host will itself initiate a
28396 callout check back to your host. As it is checking what appears to be a message
28397 sender, it is likely to use an empty address in MAIL, thus avoiding a
28398 callout loop. However, to be on the safe side it would be best to set up your
28399 own ACLs so that they do not do sender verification checks when the recipient
28400 is the address you use for header sender or postmaster callout checking.
28401
28402 Another issue to think about when using non-empty senders for callouts is
28403 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28404 by the sender/recipient combination; thus, for any given recipient, many more
28405 actual callouts are performed than when an empty sender or postmaster is used.
28406
28407
28408
28409
28410 .section "Callout caching" "SECTcallvercache"
28411 .cindex "hints database" "callout cache"
28412 .cindex "callout" "cache, description of"
28413 .cindex "caching" "callout"
28414 Exim caches the results of callouts in order to reduce the amount of resources
28415 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28416 option. A hints database called &"callout"& is used for the cache. Two
28417 different record types are used: one records the result of a callout check for
28418 a specific address, and the other records information that applies to the
28419 entire domain (for example, that it accepts the local part &'postmaster'&).
28420
28421 When an original callout fails, a detailed SMTP error message is given about
28422 the failure. However, for subsequent failures use the cache data, this message
28423 is not available.
28424
28425 The expiry times for negative and positive address cache records are
28426 independent, and can be set by the global options &%callout_negative_expire%&
28427 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28428
28429 If a host gives a negative response to an SMTP connection, or rejects any
28430 commands up to and including
28431 .code
28432 MAIL FROM:<>
28433 .endd
28434 (but not including the MAIL command with a non-empty address),
28435 any callout attempt is bound to fail. Exim remembers such failures in a
28436 domain cache record, which it uses to fail callouts for the domain without
28437 making new connections, until the domain record times out. There are two
28438 separate expiry times for domain cache records:
28439 &%callout_domain_negative_expire%& (default 3h) and
28440 &%callout_domain_positive_expire%& (default 7d).
28441
28442 Domain records expire when the negative expiry time is reached if callouts
28443 cannot be made for the domain, or if the postmaster check failed.
28444 Otherwise, they expire when the positive expiry time is reached. This
28445 ensures that, for example, a host that stops accepting &"random"& local parts
28446 will eventually be noticed.
28447
28448 The callout caching mechanism is based on the domain of the address that is
28449 being tested. If the domain routes to several hosts, it is assumed that their
28450 behaviour will be the same.
28451
28452
28453
28454 .section "Sender address verification reporting" "SECTsenaddver"
28455 .cindex "verifying" "suppressing error details"
28456 See section &<<SECTaddressverification>>& for a general discussion of
28457 verification. When sender verification fails in an ACL, the details of the
28458 failure are given as additional output lines before the 550 response to the
28459 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28460 you might see:
28461 .code
28462 MAIL FROM:<xyz@abc.example>
28463 250 OK
28464 RCPT TO:<pqr@def.example>
28465 550-Verification failed for <xyz@abc.example>
28466 550-Called:   192.168.34.43
28467 550-Sent:     RCPT TO:<xyz@abc.example>
28468 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28469 550 Sender verification failed
28470 .endd
28471 If more than one RCPT command fails in the same way, the details are given
28472 only for the first of them. However, some administrators do not want to send
28473 out this much information. You can suppress the details by adding
28474 &`/no_details`& to the ACL statement that requests sender verification. For
28475 example:
28476 .code
28477 verify = sender/no_details
28478 .endd
28479
28480 .section "Redirection while verifying" "SECTredirwhilveri"
28481 .cindex "verifying" "redirection while"
28482 .cindex "address redirection" "while verifying"
28483 A dilemma arises when a local address is redirected by aliasing or forwarding
28484 during verification: should the generated addresses themselves be verified,
28485 or should the successful expansion of the original address be enough to verify
28486 it? By default, Exim takes the following pragmatic approach:
28487
28488 .ilist
28489 When an incoming address is redirected to just one child address, verification
28490 continues with the child address, and if that fails to verify, the original
28491 verification also fails.
28492 .next
28493 When an incoming address is redirected to more than one child address,
28494 verification does not continue. A success result is returned.
28495 .endlist
28496
28497 This seems the most reasonable behaviour for the common use of aliasing as a
28498 way of redirecting different local parts to the same mailbox. It means, for
28499 example, that a pair of alias entries of the form
28500 .code
28501 A.Wol:   aw123
28502 aw123:   :fail: Gone away, no forwarding address
28503 .endd
28504 work as expected, with both local parts causing verification failure. When a
28505 redirection generates more than one address, the behaviour is more like a
28506 mailing list, where the existence of the alias itself is sufficient for
28507 verification to succeed.
28508
28509 It is possible, however, to change the default behaviour so that all successful
28510 redirections count as successful verifications, however many new addresses are
28511 generated. This is specified by the &%success_on_redirect%& verification
28512 option. For example:
28513 .code
28514 require verify = recipient/success_on_redirect/callout=10s
28515 .endd
28516 In this example, verification succeeds if a router generates a new address, and
28517 the callout does not occur, because no address was routed to a remote host.
28518
28519 When verification is being tested via the &%-bv%& option, the treatment of
28520 redirections is as just described, unless the &%-v%& or any debugging option is
28521 also specified. In that case, full verification is done for every generated
28522 address and a report is output for each of them.
28523
28524
28525
28526 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
28527 .cindex "CSA" "verifying"
28528 Client SMTP Authorization is a system that allows a site to advertise
28529 which machines are and are not permitted to send email. This is done by placing
28530 special SRV records in the DNS; these are looked up using the client's HELO
28531 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
28532 Authorization checks in Exim are performed by the ACL condition:
28533 .code
28534 verify = csa
28535 .endd
28536 This fails if the client is not authorized. If there is a DNS problem, or if no
28537 valid CSA SRV record is found, or if the client is authorized, the condition
28538 succeeds. These three cases can be distinguished using the expansion variable
28539 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
28540 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
28541 be likely to cause problems for legitimate email.
28542
28543 The error messages produced by the CSA code include slightly more
28544 detail. If &$csa_status$& is &"defer"&, this may be because of problems
28545 looking up the CSA SRV record, or problems looking up the CSA target
28546 address record. There are four reasons for &$csa_status$& being &"fail"&:
28547
28548 .ilist
28549 The client's host name is explicitly not authorized.
28550 .next
28551 The client's IP address does not match any of the CSA target IP addresses.
28552 .next
28553 The client's host name is authorized but it has no valid target IP addresses
28554 (for example, the target's addresses are IPv6 and the client is using IPv4).
28555 .next
28556 The client's host name has no CSA SRV record but a parent domain has asserted
28557 that all subdomains must be explicitly authorized.
28558 .endlist
28559
28560 The &%csa%& verification condition can take an argument which is the domain to
28561 use for the DNS query. The default is:
28562 .code
28563 verify = csa/$sender_helo_name
28564 .endd
28565 This implementation includes an extension to CSA. If the query domain
28566 is an address literal such as [192.0.2.95], or if it is a bare IP
28567 address, Exim searches for CSA SRV records in the reverse DNS as if
28568 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
28569 meaningful to say:
28570 .code
28571 verify = csa/$sender_host_address
28572 .endd
28573 In fact, this is the check that Exim performs if the client does not say HELO.
28574 This extension can be turned off by setting the main configuration option
28575 &%dns_csa_use_reverse%& to be false.
28576
28577 If a CSA SRV record is not found for the domain itself, a search
28578 is performed through its parent domains for a record which might be
28579 making assertions about subdomains. The maximum depth of this search is limited
28580 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
28581 default. Exim does not look for CSA SRV records in a top level domain, so the
28582 default settings handle HELO domains as long as seven
28583 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
28584 of legitimate HELO domains.
28585
28586 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
28587 direct SRV lookups, this is not sufficient because of the extra parent domain
28588 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
28589 addresses into lookups in the reverse DNS space. The result of a successful
28590 lookup such as:
28591 .code
28592 ${lookup dnsdb {csa=$sender_helo_name}}
28593 .endd
28594 has two space-separated fields: an authorization code and a target host name.
28595 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
28596 authorization required but absent, or &"?"& for unknown.
28597
28598
28599
28600
28601 .section "Bounce address tag validation" "SECTverifyPRVS"
28602 .cindex "BATV, verifying"
28603 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
28604 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
28605 Genuine incoming bounce messages should therefore always be addressed to
28606 recipients that have a valid tag. This scheme is a way of detecting unwanted
28607 bounce messages caused by sender address forgeries (often called &"collateral
28608 spam"&), because the recipients of such messages do not include valid tags.
28609
28610 There are two expansion items to help with the implementation of the BATV
28611 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
28612 the original envelope sender address by using a simple key to add a hash of the
28613 address and some time-based randomizing information. The &%prvs%& expansion
28614 item creates a signed address, and the &%prvscheck%& expansion item checks one.
28615 The syntax of these expansion items is described in section
28616 &<<SECTexpansionitems>>&.
28617
28618 As an example, suppose the secret per-address keys are stored in an MySQL
28619 database. A query to look up the key for an address could be defined as a macro
28620 like this:
28621 .code
28622 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
28623                 WHERE sender='${quote_mysql:$prvscheck_address}'\
28624                 }{$value}}
28625 .endd
28626 Suppose also that the senders who make use of BATV are defined by an address
28627 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
28628 use this:
28629 .code
28630 # Bounces: drop unsigned addresses for BATV senders
28631 deny message = This address does not send an unsigned reverse path
28632      senders = :
28633      recipients = +batv_senders
28634
28635 # Bounces: In case of prvs-signed address, check signature.
28636 deny message = Invalid reverse path signature.
28637      senders = :
28638      condition  = ${prvscheck {$local_part@$domain}\
28639                   {PRVSCHECK_SQL}{1}}
28640      !condition = $prvscheck_result
28641 .endd
28642 The first statement rejects recipients for bounce messages that are addressed
28643 to plain BATV sender addresses, because it is known that BATV senders do not
28644 send out messages with plain sender addresses. The second statement rejects
28645 recipients that are prvs-signed, but with invalid signatures (either because
28646 the key is wrong, or the signature has timed out).
28647
28648 A non-prvs-signed address is not rejected by the second statement, because the
28649 &%prvscheck%& expansion yields an empty string if its first argument is not a
28650 prvs-signed address, thus causing the &%condition%& condition to be false. If
28651 the first argument is a syntactically valid prvs-signed address, the yield is
28652 the third string (in this case &"1"&), whether or not the cryptographic and
28653 timeout checks succeed. The &$prvscheck_result$& variable contains the result
28654 of the checks (empty for failure, &"1"& for success).
28655
28656 There is one more issue you must consider when implementing prvs-signing:
28657 you have to ensure that the routers accept prvs-signed addresses and
28658 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
28659 router to remove the signature with a configuration along these lines:
28660 .code
28661 batv_redirect:
28662   driver = redirect
28663   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
28664 .endd
28665 This works because, if the third argument of &%prvscheck%& is empty, the result
28666 of the expansion of a prvs-signed address is the decoded value of the original
28667 address. This router should probably be the first of your routers that handles
28668 local addresses.
28669
28670 To create BATV-signed addresses in the first place, a transport of this form
28671 can be used:
28672 .code
28673 external_smtp_batv:
28674   driver = smtp
28675   return_path = ${prvs {$return_path} \
28676                        {${lookup mysql{SELECT \
28677                        secret FROM batv_prvs WHERE \
28678                        sender='${quote_mysql:$sender_address}'} \
28679                        {$value}fail}}}
28680 .endd
28681 If no key can be found for the existing return path, no signing takes place.
28682
28683
28684
28685 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28686 .cindex "&ACL;" "relay control"
28687 .cindex "relaying" "control by ACL"
28688 .cindex "policy control" "relay control"
28689 An MTA is said to &'relay'& a message if it receives it from some host and
28690 delivers it directly to another host as a result of a remote address contained
28691 within it. Redirecting a local address via an alias or forward file and then
28692 passing the message on to another host is not relaying,
28693 .cindex "&""percent hack""&"
28694 but a redirection as a result of the &"percent hack"& is.
28695
28696 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28697 A host which is acting as a gateway or an MX backup is concerned with incoming
28698 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28699 a host which is acting as a smart host for a number of clients is concerned
28700 with outgoing relaying from those clients to the Internet at large. Often the
28701 same host is fulfilling both functions,
28702 . ///
28703 . as illustrated in the diagram below,
28704 . ///
28705 but in principle these two kinds of relaying are entirely independent. What is
28706 not wanted is the transmission of mail from arbitrary remote hosts through your
28707 system to arbitrary domains.
28708
28709
28710 You can implement relay control by means of suitable statements in the ACL that
28711 runs for each RCPT command. For convenience, it is often easiest to use
28712 Exim's named list facility to define the domains and hosts involved. For
28713 example, suppose you want to do the following:
28714
28715 .ilist
28716 Deliver a number of domains to mailboxes on the local host (or process them
28717 locally in some other way). Let's say these are &'my.dom1.example'& and
28718 &'my.dom2.example'&.
28719 .next
28720 Relay mail for a number of other domains for which you are the secondary MX.
28721 These might be &'friend1.example'& and &'friend2.example'&.
28722 .next
28723 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28724 Suppose your LAN is 192.168.45.0/24.
28725 .endlist
28726
28727
28728 In the main part of the configuration, you put the following definitions:
28729 .code
28730 domainlist local_domains = my.dom1.example : my.dom2.example
28731 domainlist relay_domains = friend1.example : friend2.example
28732 hostlist   relay_hosts   = 192.168.45.0/24
28733 .endd
28734 Now you can use these definitions in the ACL that is run for every RCPT
28735 command:
28736 .code
28737 acl_check_rcpt:
28738   accept domains = +local_domains : +relay_domains
28739   accept hosts   = +relay_hosts
28740 .endd
28741 The first statement accepts any RCPT command that contains an address in
28742 the local or relay domains. For any other domain, control passes to the second
28743 statement, which accepts the command only if it comes from one of the relay
28744 hosts. In practice, you will probably want to make your ACL more sophisticated
28745 than this, for example, by including sender and recipient verification. The
28746 default configuration includes a more comprehensive example, which is described
28747 in chapter &<<CHAPdefconfil>>&.
28748
28749
28750
28751 .section "Checking a relay configuration" "SECTcheralcon"
28752 .cindex "relaying" "checking control of"
28753 You can check the relay characteristics of your configuration in the same way
28754 that you can test any ACL behaviour for an incoming SMTP connection, by using
28755 the &%-bh%& option to run a fake SMTP session with which you interact.
28756
28757 For specifically testing for unwanted relaying, the host
28758 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28759 host from the host on which Exim is running, using the normal telnet port, you
28760 will see a normal telnet connection message and then quite a long delay. Be
28761 patient. The remote host is making an SMTP connection back to your host, and
28762 trying a number of common probes to test for open relay vulnerability. The
28763 results of the tests will eventually appear on your terminal.
28764 .ecindex IIDacl
28765
28766
28767
28768 . ////////////////////////////////////////////////////////////////////////////
28769 . ////////////////////////////////////////////////////////////////////////////
28770
28771 .chapter "Content scanning at ACL time" "CHAPexiscan"
28772 .scindex IIDcosca "content scanning" "at ACL time"
28773 The extension of Exim to include content scanning at ACL time, formerly known
28774 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28775 was integrated into the main source for Exim release 4.50, and Tom continues to
28776 maintain it. Most of the wording of this chapter is taken from Tom's
28777 specification.
28778
28779 It is also possible to scan the content of messages at other times. The
28780 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28781 scanning after all the ACLs have run. A transport filter can be used to scan
28782 messages at delivery time (see the &%transport_filter%& option, described in
28783 chapter &<<CHAPtransportgeneric>>&).
28784
28785 If you want to include the ACL-time content-scanning features when you compile
28786 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28787 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28788
28789 .ilist
28790 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28791 for all MIME parts for SMTP and non-SMTP messages, respectively.
28792 .next
28793 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28794 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28795 run at the end of message reception (the &%acl_smtp_data%& ACL).
28796 .next
28797 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28798 of messages, or parts of messages, for debugging purposes.
28799 .next
28800 Additional expansion variables that are set in the new ACL and by the new
28801 conditions.
28802 .next
28803 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28804 .endlist
28805
28806 There is another content-scanning configuration option for &_Local/Makefile_&,
28807 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28808 condition is compiled, in addition to all the other content-scanning features.
28809
28810 Content-scanning is continually evolving, and new features are still being
28811 added. While such features are still unstable and liable to incompatible
28812 changes, they are made available in Exim by setting options whose names begin
28813 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28814 this manual. You can find out about them by reading the file called
28815 &_doc/experimental.txt_&.
28816
28817 All the content-scanning facilities work on a MBOX copy of the message that is
28818 temporarily created in a file called:
28819 .display
28820 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28821 .endd
28822 The &_.eml_& extension is a friendly hint to virus scanners that they can
28823 expect an MBOX-like structure inside that file. The file is created when the
28824 first content scanning facility is called. Subsequent calls to content
28825 scanning conditions open the same file again. The directory is recursively
28826 removed when the &%acl_smtp_data%& ACL has finished running, unless
28827 .code
28828 control = no_mbox_unspool
28829 .endd
28830 has been encountered. When the MIME ACL decodes files, they are put into the
28831 same directory by default.
28832
28833
28834
28835 .section "Scanning for viruses" "SECTscanvirus"
28836 .cindex "virus scanning"
28837 .cindex "content scanning" "for viruses"
28838 .cindex "content scanning" "the &%malware%& condition"
28839 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28840 It supports a &"generic"& interface to scanners called via the shell, and
28841 specialized interfaces for &"daemon"& type virus scanners, which are resident
28842 in memory and thus are much faster.
28843
28844
28845 .oindex "&%av_scanner%&"
28846 You can set the &%av_scanner%& option in first part of the Exim configuration
28847 file to specify which scanner to use, together with any additional options that
28848 are needed. The basic syntax is as follows:
28849 .display
28850 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28851 .endd
28852 If you do not set &%av_scanner%&, it defaults to
28853 .code
28854 av_scanner = sophie:/var/run/sophie
28855 .endd
28856 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28857 before use. The following scanner types are supported in this release:
28858
28859 .vlist
28860 .vitem &%aveserver%&
28861 .cindex "virus scanners" "Kaspersky"
28862 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28863 at &url(http://www.kaspersky.com). This scanner type takes one option,
28864 which is the path to the daemon's UNIX socket. The default is shown in this
28865 example:
28866 .code
28867 av_scanner = aveserver:/var/run/aveserver
28868 .endd
28869
28870
28871 .vitem &%clamd%&
28872 .cindex "virus scanners" "clamd"
28873 This daemon-type scanner is GPL and free. You can get it at
28874 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28875 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28876 in the MIME ACL. This no longer believed to be necessary. One option is
28877 required: either the path and name of a UNIX socket file, or a hostname or IP
28878 number, and a port, separated by space, as in the second of these examples:
28879 .code
28880 av_scanner = clamd:/opt/clamd/socket
28881 av_scanner = clamd:192.0.2.3 1234
28882 av_scanner = clamd:192.0.2.3 1234:local
28883 .endd
28884 If the value of av_scanner points to a UNIX socket file or contains the local
28885 keyword, then the ClamAV interface will pass a filename containing the data
28886 to be scanned, which will should normally result in less I/O happening and be
28887 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28888 Exim does not assume that there is a common filesystem with the remote host.
28889 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28890 you be running a version of ClamAV prior to 0.95.
28891 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28892 contributing the code for this scanner.
28893
28894 .vitem &%cmdline%&
28895 .cindex "virus scanners" "command line interface"
28896 This is the keyword for the generic command line scanner interface. It can be
28897 used to attach virus scanners that are invoked from the shell. This scanner
28898 type takes 3 mandatory options:
28899
28900 .olist
28901 The full path and name of the scanner binary, with all command line options,
28902 and a placeholder (&`%s`&) for the directory to scan.
28903
28904 .next
28905 A regular expression to match against the STDOUT and STDERR output of the
28906 virus scanner. If the expression matches, a virus was found. You must make
28907 absolutely sure that this expression matches on &"virus found"&. This is called
28908 the &"trigger"& expression.
28909
28910 .next
28911 Another regular expression, containing exactly one pair of parentheses, to
28912 match the name of the virus found in the scanners output. This is called the
28913 &"name"& expression.
28914 .endlist olist
28915
28916 For example, Sophos Sweep reports a virus on a line like this:
28917 .code
28918 Virus 'W32/Magistr-B' found in file ./those.bat
28919 .endd
28920 For the trigger expression, we can match the phrase &"found in file"&. For the
28921 name expression, we want to extract the W32/Magistr-B string, so we can match
28922 for the single quotes left and right of it. Altogether, this makes the
28923 configuration setting:
28924 .code
28925 av_scanner = cmdline:\
28926              /path/to/sweep -ss -all -rec -archive %s:\
28927              found in file:'(.+)'
28928 .endd
28929 .vitem &%drweb%&
28930 .cindex "virus scanners" "DrWeb"
28931 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28932 argument, either a full path to a UNIX socket, or an IP address and port
28933 separated by white space, as in these examples:
28934 .code
28935 av_scanner = drweb:/var/run/drwebd.sock
28936 av_scanner = drweb:192.168.2.20 31337
28937 .endd
28938 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28939 is used. Thanks to Alex Miller for contributing the code for this scanner.
28940
28941 .vitem &%fsecure%&
28942 .cindex "virus scanners" "F-Secure"
28943 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28944 argument which is the path to a UNIX socket. For example:
28945 .code
28946 av_scanner = fsecure:/path/to/.fsav
28947 .endd
28948 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28949 Thelmen for contributing the code for this scanner.
28950
28951 .vitem &%kavdaemon%&
28952 .cindex "virus scanners" "Kaspersky"
28953 This is the scanner daemon of Kaspersky Version 4. This version of the
28954 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28955 scanner type takes one option, which is the path to the daemon's UNIX socket.
28956 For example:
28957 .code
28958 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28959 .endd
28960 The default path is &_/var/run/AvpCtl_&.
28961
28962 .vitem &%mksd%&
28963 .cindex "virus scanners" "mksd"
28964 This is a daemon type scanner that is aimed mainly at Polish users, though some
28965 parts of documentation are now available in English. You can get it at
28966 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28967 the maximum number of processes used simultaneously to scan the attachments,
28968 provided that the demime facility is employed and also provided that mksd has
28969 been run with at least the same number of child processes. For example:
28970 .code
28971 av_scanner = mksd:2
28972 .endd
28973 You can safely omit this option (the default value is 1).
28974
28975 .vitem &%sophie%&
28976 .cindex "virus scanners" "Sophos and Sophie"
28977 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28978 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28979 for this scanner type is the path to the UNIX socket that Sophie uses for
28980 client communication. For example:
28981 .code
28982 av_scanner = sophie:/tmp/sophie
28983 .endd
28984 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28985 the option.
28986 .endlist
28987
28988 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28989 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28990 ACL.
28991
28992 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28993 makes it possible to use different scanners. See further below for an example.
28994 The &%malware%& condition caches its results, so when you use it multiple times
28995 for the same message, the actual scanning process is only carried out once.
28996 However, using expandable items in &%av_scanner%& disables this caching, in
28997 which case each use of the &%malware%& condition causes a new scan of the
28998 message.
28999
29000 The &%malware%& condition takes a right-hand argument that is expanded before
29001 use. It can then be one of
29002
29003 .ilist
29004 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29005 The condition succeeds if a virus was found, and fail otherwise. This is the
29006 recommended usage.
29007 .next
29008 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29009 the condition fails immediately.
29010 .next
29011 A regular expression, in which case the message is scanned for viruses. The
29012 condition succeeds if a virus is found and its name matches the regular
29013 expression. This allows you to take special actions on certain types of virus.
29014 .endlist
29015
29016 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29017 even if there is a problem with the virus scanner. Otherwise, such a problem
29018 causes the ACL to defer.
29019
29020 .vindex "&$malware_name$&"
29021 When a virus is found, the condition sets up an expansion variable called
29022 &$malware_name$& that contains the name of the virus. You can use it in a
29023 &%message%& modifier that specifies the error returned to the sender, and/or in
29024 logging data.
29025
29026 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29027 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29028 &%malware%& condition.
29029
29030 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29031 imposed by your anti-virus scanner.
29032
29033 Here is a very simple scanning example:
29034 .code
29035 deny message = This message contains malware ($malware_name)
29036      demime = *
29037      malware = *
29038 .endd
29039 The next example accepts messages when there is a problem with the scanner:
29040 .code
29041 deny message = This message contains malware ($malware_name)
29042      demime = *
29043      malware = */defer_ok
29044 .endd
29045 The next example shows how to use an ACL variable to scan with both sophie and
29046 aveserver. It assumes you have set:
29047 .code
29048 av_scanner = $acl_m0
29049 .endd
29050 in the main Exim configuration.
29051 .code
29052 deny message = This message contains malware ($malware_name)
29053      set acl_m0 = sophie
29054      malware = *
29055
29056 deny message = This message contains malware ($malware_name)
29057      set acl_m0 = aveserver
29058      malware = *
29059 .endd
29060
29061
29062 .section "Scanning with SpamAssassin" "SECTscanspamass"
29063 .cindex "content scanning" "for spam"
29064 .cindex "spam scanning"
29065 .cindex "SpamAssassin"
29066 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29067 score and a report for the message. You can get SpamAssassin at
29068 &url(http://www.spamassassin.org), or, if you have a working Perl
29069 installation, you can use CPAN by running:
29070 .code
29071 perl -MCPAN -e 'install Mail::SpamAssassin'
29072 .endd
29073 SpamAssassin has its own set of configuration files. Please review its
29074 documentation to see how you can tweak it. The default installation should work
29075 nicely, however.
29076
29077 .oindex "&%spamd_address%&"
29078 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29079 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29080 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29081 part of the Exim configuration as follows (example):
29082 .code
29083 spamd_address = 192.168.99.45 387
29084 .endd
29085 You do not need to set this option if you use the default. As of version 2.60,
29086 &%spamd%& also supports communication over UNIX sockets. If you want to use
29087 these, supply &%spamd_address%& with an absolute file name instead of a
29088 address/port pair:
29089 .code
29090 spamd_address = /var/run/spamd_socket
29091 .endd
29092 You can have multiple &%spamd%& servers to improve scalability. These can
29093 reside on other hardware reachable over the network. To specify multiple
29094 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29095 option, separated with colons:
29096 .code
29097 spamd_address = 192.168.2.10 783 : \
29098                 192.168.2.11 783 : \
29099                 192.168.2.12 783
29100 .endd
29101 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29102 fashion. When a server fails to respond to the connection attempt, all other
29103 servers are tried until one succeeds. If no server responds, the &%spam%&
29104 condition defers.
29105
29106 &*Warning*&: It is not possible to use the UNIX socket connection method with
29107 multiple &%spamd%& servers.
29108
29109 The &%spamd_address%& variable is expanded before use if it starts with
29110 a dollar sign. In this case, the expansion may return a string that is
29111 used as the list so that multiple spamd servers can be the result of an
29112 expansion.
29113
29114 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29115 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29116 .code
29117 deny message = This message was classified as SPAM
29118      spam = joe
29119 .endd
29120 The right-hand side of the &%spam%& condition specifies a name. This is
29121 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29122 to scan using a specific profile, but rather use the SpamAssassin system-wide
29123 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29124 However, you must put something on the right-hand side.
29125
29126 The name allows you to use per-domain or per-user antispam profiles in
29127 principle, but this is not straightforward in practice, because a message may
29128 have multiple recipients, not necessarily all in the same domain. Because the
29129 &%spam%& condition has to be called from a DATA ACL in order to be able to
29130 read the contents of the message, the variables &$local_part$& and &$domain$&
29131 are not set.
29132
29133 The right-hand side of the &%spam%& condition is expanded before being used, so
29134 you can put lookups or conditions there. When the right-hand side evaluates to
29135 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29136
29137
29138 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29139 large ones may cause significant performance degradation. As most spam messages
29140 are quite small, it is recommended that you do not scan the big ones. For
29141 example:
29142 .code
29143 deny message = This message was classified as SPAM
29144      condition = ${if < {$message_size}{10K}}
29145      spam = nobody
29146 .endd
29147
29148 The &%spam%& condition returns true if the threshold specified in the user's
29149 SpamAssassin profile has been matched or exceeded. If you want to use the
29150 &%spam%& condition for its side effects (see the variables below), you can make
29151 it always return &"true"& by appending &`:true`& to the username.
29152
29153 .cindex "spam scanning" "returned variables"
29154 When the &%spam%& condition is run, it sets up a number of expansion
29155 variables. These variables are saved with the received message, thus they are
29156 available for use at delivery time.
29157
29158 .vlist
29159 .vitem &$spam_score$&
29160 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29161 for inclusion in log or reject messages.
29162
29163 .vitem &$spam_score_int$&
29164 The spam score of the message, multiplied by ten, as an integer value. For
29165 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29166 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29167 The integer value is useful for numeric comparisons in conditions.
29168
29169 .vitem &$spam_bar$&
29170 A string consisting of a number of &"+"& or &"-"& characters, representing the
29171 integer part of the spam score value. A spam score of 4.4 would have a
29172 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29173 headers, since MUAs can match on such strings.
29174
29175 .vitem &$spam_report$&
29176 A multiline text table, containing the full SpamAssassin report for the
29177 message. Useful for inclusion in headers or reject messages.
29178 .endlist
29179
29180 The &%spam%& condition caches its results unless expansion in
29181 spamd_address was used. If you call it again with the same user name, it
29182 does not scan again, but rather returns the same values as before.
29183
29184 The &%spam%& condition returns DEFER if there is any error while running
29185 the message through SpamAssassin or if the expansion of spamd_address
29186 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29187 statement block), append &`/defer_ok`& to the right-hand side of the
29188 spam condition, like this:
29189 .code
29190 deny message = This message was classified as SPAM
29191      spam    = joe/defer_ok
29192 .endd
29193 This causes messages to be accepted even if there is a problem with &%spamd%&.
29194
29195 Here is a longer, commented example of the use of the &%spam%&
29196 condition:
29197 .code
29198 # put headers in all messages (no matter if spam or not)
29199 warn  spam = nobody:true
29200       add_header = X-Spam-Score: $spam_score ($spam_bar)
29201       add_header = X-Spam-Report: $spam_report
29202
29203 # add second subject line with *SPAM* marker when message
29204 # is over threshold
29205 warn  spam = nobody
29206       add_header = Subject: *SPAM* $h_Subject:
29207
29208 # reject spam at high scores (> 12)
29209 deny  message = This message scored $spam_score spam points.
29210       spam = nobody:true
29211       condition = ${if >{$spam_score_int}{120}{1}{0}}
29212 .endd
29213
29214
29215
29216 .section "Scanning MIME parts" "SECTscanmimepart"
29217 .cindex "content scanning" "MIME parts"
29218 .cindex "MIME content scanning"
29219 .oindex "&%acl_smtp_mime%&"
29220 .oindex "&%acl_not_smtp_mime%&"
29221 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29222 each MIME part of an SMTP message, including multipart types, in the sequence
29223 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29224 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29225 options may both refer to the same ACL if you want the same processing in both
29226 cases.
29227
29228 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29229 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29230 the case of a non-SMTP message. However, a MIME ACL is called only if the
29231 message contains a &'Content-Type:'& header line. When a call to a MIME
29232 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29233 result code is sent to the client. In the case of an SMTP message, the
29234 &%acl_smtp_data%& ACL is not called when this happens.
29235
29236 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29237 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29238 condition to match against the raw MIME part. You can also use the
29239 &%mime_regex%& condition to match against the decoded MIME part (see section
29240 &<<SECTscanregex>>&).
29241
29242 At the start of a MIME ACL, a number of variables are set from the header
29243 information for the relevant MIME part. These are described below. The contents
29244 of the MIME part are not by default decoded into a disk file except for MIME
29245 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29246 part into a disk file, you can use the &%decode%& condition. The general
29247 syntax is:
29248 .display
29249 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29250 .endd
29251 The right hand side is expanded before use. After expansion,
29252 the value can be:
29253
29254 .olist
29255 &"0"& or &"false"&, in which case no decoding is done.
29256 .next
29257 The string &"default"&. In that case, the file is put in the temporary
29258 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29259 a sequential file name consisting of the message id and a sequence number. The
29260 full path and name is available in &$mime_decoded_filename$& after decoding.
29261 .next
29262 A full path name starting with a slash. If the full name is an existing
29263 directory, it is used as a replacement for the default directory. The filename
29264 is then sequentially assigned. If the path does not exist, it is used as
29265 the full path and file name.
29266 .next
29267 If the string does not start with a slash, it is used as the
29268 filename, and the default path is then used.
29269 .endlist
29270 The &%decode%& condition normally succeeds. It is only false for syntax
29271 errors or unusual circumstances such as memory shortages. You can easily decode
29272 a file with its original, proposed filename using
29273 .code
29274 decode = $mime_filename
29275 .endd
29276 However, you should keep in mind that &$mime_filename$& might contain
29277 anything. If you place files outside of the default path, they are not
29278 automatically unlinked.
29279
29280 For RFC822 attachments (these are messages attached to messages, with a
29281 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29282 as for the primary message, only that the &$mime_is_rfc822$& expansion
29283 variable is set (see below). Attached messages are always decoded to disk
29284 before being checked, and the files are unlinked once the check is done.
29285
29286 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29287 used to match regular expressions against raw and decoded MIME parts,
29288 respectively. They are described in section &<<SECTscanregex>>&.
29289
29290 .cindex "MIME content scanning" "returned variables"
29291 The following list describes all expansion variables that are
29292 available in the MIME ACL:
29293
29294 .vlist
29295 .vitem &$mime_boundary$&
29296 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29297 have a boundary string, which is stored in this variable. If the current part
29298 has no boundary parameter in the &'Content-Type:'& header, this variable
29299 contains the empty string.
29300
29301 .vitem &$mime_charset$&
29302 This variable contains the character set identifier, if one was found in the
29303 &'Content-Type:'& header. Examples for charset identifiers are:
29304 .code
29305 us-ascii
29306 gb2312 (Chinese)
29307 iso-8859-1
29308 .endd
29309 Please note that this value is not normalized, so you should do matches
29310 case-insensitively.
29311
29312 .vitem &$mime_content_description$&
29313 This variable contains the normalized content of the &'Content-Description:'&
29314 header. It can contain a human-readable description of the parts content. Some
29315 implementations repeat the filename for attachments here, but they are usually
29316 only used for display purposes.
29317
29318 .vitem &$mime_content_disposition$&
29319 This variable contains the normalized content of the &'Content-Disposition:'&
29320 header. You can expect strings like &"attachment"& or &"inline"& here.
29321
29322 .vitem &$mime_content_id$&
29323 This variable contains the normalized content of the &'Content-ID:'& header.
29324 This is a unique ID that can be used to reference a part from another part.
29325
29326 .vitem &$mime_content_size$&
29327 This variable is set only after the &%decode%& modifier (see above) has been
29328 successfully run. It contains the size of the decoded part in kilobytes. The
29329 size is always rounded up to full kilobytes, so only a completely empty part
29330 has a &$mime_content_size$& of zero.
29331
29332 .vitem &$mime_content_transfer_encoding$&
29333 This variable contains the normalized content of the
29334 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29335 type. Typical values are &"base64"& and &"quoted-printable"&.
29336
29337 .vitem &$mime_content_type$&
29338 If the MIME part has a &'Content-Type:'& header, this variable contains its
29339 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29340 are some examples of popular MIME types, as they may appear in this variable:
29341 .code
29342 text/plain
29343 text/html
29344 application/octet-stream
29345 image/jpeg
29346 audio/midi
29347 .endd
29348 If the MIME part has no &'Content-Type:'& header, this variable contains the
29349 empty string.
29350
29351 .vitem &$mime_decoded_filename$&
29352 This variable is set only after the &%decode%& modifier (see above) has been
29353 successfully run. It contains the full path and file name of the file
29354 containing the decoded data.
29355 .endlist
29356
29357 .cindex "RFC 2047"
29358 .vlist
29359 .vitem &$mime_filename$&
29360 This is perhaps the most important of the MIME variables. It contains a
29361 proposed filename for an attachment, if one was found in either the
29362 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29363 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29364 found, this variable contains the empty string.
29365
29366 .vitem &$mime_is_coverletter$&
29367 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29368 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29369 content in the cover letter, while not restricting attachments at all.
29370
29371 The variable contains 1 (true) for a MIME part believed to be part of the
29372 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29373 follows:
29374
29375 .olist
29376 The outermost MIME part of a message is always a cover letter.
29377
29378 .next
29379 If a multipart/alternative or multipart/related MIME part is a cover letter,
29380 so are all MIME subparts within that multipart.
29381
29382 .next
29383 If any other multipart is a cover letter, the first subpart is a cover letter,
29384 and the rest are attachments.
29385
29386 .next
29387 All parts contained within an attachment multipart are attachments.
29388 .endlist olist
29389
29390 As an example, the following will ban &"HTML mail"& (including that sent with
29391 alternative plain text), while allowing HTML files to be attached. HTML
29392 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29393 .code
29394 deny message = HTML mail is not accepted here
29395 !condition = $mime_is_rfc822
29396 condition = $mime_is_coverletter
29397 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29398 .endd
29399 .vitem &$mime_is_multipart$&
29400 This variable has the value 1 (true) when the current part has the main type
29401 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29402 Since multipart entities only serve as containers for other parts, you may not
29403 want to carry out specific actions on them.
29404
29405 .vitem &$mime_is_rfc822$&
29406 This variable has the value 1 (true) if the current part is not a part of the
29407 checked message itself, but part of an attached message. Attached message
29408 decoding is fully recursive.
29409
29410 .vitem &$mime_part_count$&
29411 This variable is a counter that is raised for each processed MIME part. It
29412 starts at zero for the very first part (which is usually a multipart). The
29413 counter is per-message, so it is reset when processing RFC822 attachments (see
29414 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29415 complete, so you can use it in the DATA ACL to determine the number of MIME
29416 parts of a message. For non-MIME messages, this variable contains the value -1.
29417 .endlist
29418
29419
29420
29421 .section "Scanning with regular expressions" "SECTscanregex"
29422 .cindex "content scanning" "with regular expressions"
29423 .cindex "regular expressions" "content scanning with"
29424 You can specify your own custom regular expression matches on the full body of
29425 the message, or on individual MIME parts.
29426
29427 The &%regex%& condition takes one or more regular expressions as arguments and
29428 matches them against the full message (when called in the DATA ACL) or a raw
29429 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29430 linewise, with a maximum line length of 32K characters. That means you cannot
29431 have multiline matches with the &%regex%& condition.
29432
29433 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29434 to 32K of decoded content (the whole content at once, not linewise). If the
29435 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29436 is decoded automatically when &%mime_regex%& is executed (using default path
29437 and filename values). If the decoded data is larger than  32K, only the first
29438 32K characters are checked.
29439
29440 The regular expressions are passed as a colon-separated list. To include a
29441 literal colon, you must double it. Since the whole right-hand side string is
29442 expanded before being used, you must also escape dollar signs and backslashes
29443 with more backslashes, or use the &`\N`& facility to disable expansion.
29444 Here is a simple example that contains two regular expressions:
29445 .code
29446 deny message = contains blacklisted regex ($regex_match_string)
29447      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29448 .endd
29449 The conditions returns true if any one of the regular expressions matches. The
29450 &$regex_match_string$& expansion variable is then set up and contains the
29451 matching regular expression.
29452
29453 &*Warning*&: With large messages, these conditions can be fairly
29454 CPU-intensive.
29455
29456
29457
29458
29459 .section "The demime condition" "SECTdemimecond"
29460 .cindex "content scanning" "MIME checking"
29461 .cindex "MIME content scanning"
29462 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29463 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29464 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29465 ACL functionality, but provides no additional facilities. Please note that this
29466 condition is deprecated and kept only for backward compatibility. You must set
29467 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29468 use the &%demime%& condition.
29469
29470 The &%demime%& condition unpacks MIME containers in the message. It detects
29471 errors in MIME containers and can match file extensions found in the message
29472 against a list. Using this facility produces files containing the unpacked MIME
29473 parts of the message in the temporary scan directory. If you do antivirus
29474 scanning, it is recommended that you use the &%demime%& condition before the
29475 antivirus (&%malware%&) condition.
29476
29477 On the right-hand side of the &%demime%& condition you can pass a
29478 colon-separated list of file extensions that it should match against. For
29479 example:
29480 .code
29481 deny message = Found blacklisted file attachment
29482      demime  = vbs:com:bat:pif:prf:lnk
29483 .endd
29484 If one of the file extensions is found, the condition is true, otherwise it is
29485 false. If there is a temporary error while demimeing (for example, &"disk
29486 full"&), the condition defers, and the message is temporarily rejected (unless
29487 the condition is on a &%warn%& verb).
29488
29489 The right-hand side is expanded before being treated as a list, so you can have
29490 conditions and lookups there. If it expands to an empty string, &"false"&, or
29491 zero (&"0"&), no demimeing is done and the condition is false.
29492
29493 The &%demime%& condition set the following variables:
29494
29495 .vlist
29496 .vitem &$demime_errorlevel$&
29497 .vindex "&$demime_errorlevel$&"
29498 When an error is detected in a MIME container, this variable contains the
29499 severity of the error, as an integer number. The higher the value, the more
29500 severe the error (the current maximum value is 3). If this variable is unset or
29501 zero, no error occurred.
29502
29503 .vitem &$demime_reason$&
29504 .vindex "&$demime_reason$&"
29505 When &$demime_errorlevel$& is greater than zero, this variable contains a
29506 human-readable text string describing the MIME error that occurred.
29507 .endlist
29508
29509 .vlist
29510 .vitem &$found_extension$&
29511 .vindex "&$found_extension$&"
29512 When the &%demime%& condition is true, this variable contains the file
29513 extension it found.
29514 .endlist
29515
29516 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
29517 the &%demime%& condition, and are not changed on subsequent calls.
29518
29519 If you do not want to check for file extensions, but rather use the &%demime%&
29520 condition for unpacking or error checking purposes, pass &"*"& as the
29521 right-hand side value. Here is a more elaborate example of how to use this
29522 facility:
29523 .code
29524 # Reject messages with serious MIME container errors
29525 deny  message = Found MIME error ($demime_reason).
29526       demime = *
29527       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
29528
29529 # Reject known virus spreading file extensions.
29530 # Accepting these is pretty much braindead.
29531 deny  message = contains $found_extension file (blacklisted).
29532       demime  = com:vbs:bat:pif:scr
29533
29534 # Freeze .exe and .doc files. Postmaster can
29535 # examine them and eventually thaw them.
29536 deny  log_message = Another $found_extension file.
29537       demime = exe:doc
29538       control = freeze
29539 .endd
29540 .ecindex IIDcosca
29541
29542
29543
29544
29545 . ////////////////////////////////////////////////////////////////////////////
29546 . ////////////////////////////////////////////////////////////////////////////
29547
29548 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
29549          "Local scan function"
29550 .scindex IIDlosca "&[local_scan()]& function" "description of"
29551 .cindex "customizing" "input scan using C function"
29552 .cindex "policy control" "by local scan function"
29553 In these days of email worms, viruses, and ever-increasing spam, some sites
29554 want to apply a lot of checking to messages before accepting them.
29555
29556 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
29557 passing messages to external virus and spam scanning software. You can also do
29558 a certain amount in Exim itself through string expansions and the &%condition%&
29559 condition in the ACL that runs after the SMTP DATA command or the ACL for
29560 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
29561
29562 To allow for further customization to a site's own requirements, there is the
29563 possibility of linking Exim with a private message scanning function, written
29564 in C. If you want to run code that is written in something other than C, you
29565 can of course use a little C stub to call it.
29566
29567 The local scan function is run once for every incoming message, at the point
29568 when Exim is just about to accept the message.
29569 It can therefore be used to control non-SMTP messages from local processes as
29570 well as messages arriving via SMTP.
29571
29572 Exim applies a timeout to calls of the local scan function, and there is an
29573 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
29574 Zero means &"no timeout"&.
29575 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
29576 before calling the local scan function, so that the most common types of crash
29577 are caught. If the timeout is exceeded or one of those signals is caught, the
29578 incoming message is rejected with a temporary error if it is an SMTP message.
29579 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
29580 code. The incident is logged on the main and reject logs.
29581
29582
29583
29584 .section "Building Exim to use a local scan function" "SECID207"
29585 .cindex "&[local_scan()]& function" "building Exim to use"
29586 To make use of the local scan function feature, you must tell Exim where your
29587 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
29588 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
29589 directory, so you might set
29590 .code
29591 LOCAL_SCAN_SOURCE=Local/local_scan.c
29592 .endd
29593 for example. The function must be called &[local_scan()]&. It is called by
29594 Exim after it has received a message, when the success return code is about to
29595 be sent. This is after all the ACLs have been run. The return code from your
29596 function controls whether the message is actually accepted or not. There is a
29597 commented template function (that just accepts the message) in the file
29598 _src/local_scan.c_.
29599
29600 If you want to make use of Exim's run time configuration file to set options
29601 for your &[local_scan()]& function, you must also set
29602 .code
29603 LOCAL_SCAN_HAS_OPTIONS=yes
29604 .endd
29605 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
29606
29607
29608
29609
29610 .section "API for local_scan()" "SECTapiforloc"
29611 .cindex "&[local_scan()]& function" "API description"
29612 You must include this line near the start of your code:
29613 .code
29614 #include "local_scan.h"
29615 .endd
29616 This header file defines a number of variables and other values, and the
29617 prototype for the function itself. Exim is coded to use unsigned char values
29618 almost exclusively, and one of the things this header defines is a shorthand
29619 for &`unsigned char`& called &`uschar`&.
29620 It also contains the following macro definitions, to simplify casting character
29621 strings and pointers to character strings:
29622 .code
29623 #define CS   (char *)
29624 #define CCS  (const char *)
29625 #define CSS  (char **)
29626 #define US   (unsigned char *)
29627 #define CUS  (const unsigned char *)
29628 #define USS  (unsigned char **)
29629 .endd
29630 The function prototype for &[local_scan()]& is:
29631 .code
29632 extern int local_scan(int fd, uschar **return_text);
29633 .endd
29634 The arguments are as follows:
29635
29636 .ilist
29637 &%fd%& is a file descriptor for the file that contains the body of the message
29638 (the -D file). The file is open for reading and writing, but updating it is not
29639 recommended. &*Warning*&: You must &'not'& close this file descriptor.
29640
29641 The descriptor is positioned at character 19 of the file, which is the first
29642 character of the body itself, because the first 19 characters are the message
29643 id followed by &`-D`& and a newline. If you rewind the file, you should use the
29644 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
29645 case this changes in some future version.
29646 .next
29647 &%return_text%& is an address which you can use to return a pointer to a text
29648 string at the end of the function. The value it points to on entry is NULL.
29649 .endlist
29650
29651 The function must return an &%int%& value which is one of the following macros:
29652
29653 .vlist
29654 .vitem &`LOCAL_SCAN_ACCEPT`&
29655 .vindex "&$local_scan_data$&"
29656 The message is accepted. If you pass back a string of text, it is saved with
29657 the message, and made available in the variable &$local_scan_data$&. No
29658 newlines are permitted (if there are any, they are turned into spaces) and the
29659 maximum length of text is 1000 characters.
29660
29661 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
29662 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29663 queued without immediate delivery, and is frozen.
29664
29665 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
29666 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29667 queued without immediate delivery.
29668
29669 .vitem &`LOCAL_SCAN_REJECT`&
29670 The message is rejected; the returned text is used as an error message which is
29671 passed back to the sender and which is also logged. Newlines are permitted &--
29672 they cause a multiline response for SMTP rejections, but are converted to
29673 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
29674 used.
29675
29676 .vitem &`LOCAL_SCAN_TEMPREJECT`&
29677 The message is temporarily rejected; the returned text is used as an error
29678 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
29679 problem"& is used.
29680
29681 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29682 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29683 message is not written to the reject log. It has the effect of unsetting the
29684 &%rejected_header%& log selector for just this rejection. If
29685 &%rejected_header%& is already unset (see the discussion of the
29686 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29687 same as LOCAL_SCAN_REJECT.
29688
29689 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29690 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29691 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29692 .endlist
29693
29694 If the message is not being received by interactive SMTP, rejections are
29695 reported by writing to &%stderr%& or by sending an email, as configured by the
29696 &%-oe%& command line options.
29697
29698
29699
29700 .section "Configuration options for local_scan()" "SECTconoptloc"
29701 .cindex "&[local_scan()]& function" "configuration options"
29702 It is possible to have option settings in the main configuration file
29703 that set values in static variables in the &[local_scan()]& module. If you
29704 want to do this, you must have the line
29705 .code
29706 LOCAL_SCAN_HAS_OPTIONS=yes
29707 .endd
29708 in your &_Local/Makefile_& when you build Exim. (This line is in
29709 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29710 file, you must define static variables to hold the option values, and a table
29711 to define them.
29712
29713 The table must be a vector called &%local_scan_options%&, of type
29714 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29715 and a pointer to the variable that holds the value. The entries must appear in
29716 alphabetical order. Following &%local_scan_options%& you must also define a
29717 variable called &%local_scan_options_count%& that contains the number of
29718 entries in the table. Here is a short example, showing two kinds of option:
29719 .code
29720 static int my_integer_option = 42;
29721 static uschar *my_string_option = US"a default string";
29722
29723 optionlist local_scan_options[] = {
29724   { "my_integer", opt_int,       &my_integer_option },
29725   { "my_string",  opt_stringptr, &my_string_option }
29726 };
29727
29728 int local_scan_options_count =
29729   sizeof(local_scan_options)/sizeof(optionlist);
29730 .endd
29731 The values of the variables can now be changed from Exim's runtime
29732 configuration file by including a local scan section as in this example:
29733 .code
29734 begin local_scan
29735 my_integer = 99
29736 my_string = some string of text...
29737 .endd
29738 The available types of option data are as follows:
29739
29740 .vlist
29741 .vitem &*opt_bool*&
29742 This specifies a boolean (true/false) option. The address should point to a
29743 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29744 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29745 whether such a variable has been set at all, you can initialize it to
29746 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29747 values.)
29748
29749 .vitem &*opt_fixed*&
29750 This specifies a fixed point number, such as is used for load averages.
29751 The address should point to a variable of type &`int`&. The value is stored
29752 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29753
29754 .vitem &*opt_int*&
29755 This specifies an integer; the address should point to a variable of type
29756 &`int`&. The value may be specified in any of the integer formats accepted by
29757 Exim.
29758
29759 .vitem &*opt_mkint*&
29760 This is the same as &%opt_int%&, except that when such a value is output in a
29761 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29762 printed with the suffix K or M.
29763
29764 .vitem &*opt_octint*&
29765 This also specifies an integer, but the value is always interpreted as an
29766 octal integer, whether or not it starts with the digit zero, and it is
29767 always output in octal.
29768
29769 .vitem &*opt_stringptr*&
29770 This specifies a string value; the address must be a pointer to a
29771 variable that points to a string (for example, of type &`uschar *`&).
29772
29773 .vitem &*opt_time*&
29774 This specifies a time interval value. The address must point to a variable of
29775 type &`int`&. The value that is placed there is a number of seconds.
29776 .endlist
29777
29778 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29779 out the values of all the &[local_scan()]& options.
29780
29781
29782
29783 .section "Available Exim variables" "SECID208"
29784 .cindex "&[local_scan()]& function" "available Exim variables"
29785 The header &_local_scan.h_& gives you access to a number of C variables. These
29786 are the only ones that are guaranteed to be maintained from release to release.
29787 Note, however, that you can obtain the value of any Exim expansion variable,
29788 including &$recipients$&, by calling &'expand_string()'&. The exported
29789 C variables are as follows:
29790
29791 .vlist
29792 .vitem &*int&~body_linecount*&
29793 This variable contains the number of lines in the message's body.
29794
29795 .vitem &*int&~body_zerocount*&
29796 This variable contains the number of binary zero bytes in the message's body.
29797
29798 .vitem &*unsigned&~int&~debug_selector*&
29799 This variable is set to zero when no debugging is taking place. Otherwise, it
29800 is a bitmap of debugging selectors. Two bits are identified for use in
29801 &[local_scan()]&; they are defined as macros:
29802
29803 .ilist
29804 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29805 testing option that is not privileged &-- any caller may set it. All the
29806 other selector bits can be set only by admin users.
29807
29808 .next
29809 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29810 by the &`+local_scan`& debug selector. It is not included in the default set
29811 of debugging bits.
29812 .endlist ilist
29813
29814 Thus, to write to the debugging output only when &`+local_scan`& has been
29815 selected, you should use code like this:
29816 .code
29817 if ((debug_selector & D_local_scan) != 0)
29818   debug_printf("xxx", ...);
29819 .endd
29820 .vitem &*uschar&~*expand_string_message*&
29821 After a failing call to &'expand_string()'& (returned value NULL), the
29822 variable &%expand_string_message%& contains the error message, zero-terminated.
29823
29824 .vitem &*header_line&~*header_list*&
29825 A pointer to a chain of header lines. The &%header_line%& structure is
29826 discussed below.
29827
29828 .vitem &*header_line&~*header_last*&
29829 A pointer to the last of the header lines.
29830
29831 .vitem &*uschar&~*headers_charset*&
29832 The value of the &%headers_charset%& configuration option.
29833
29834 .vitem &*BOOL&~host_checking*&
29835 This variable is TRUE during a host checking session that is initiated by the
29836 &%-bh%& command line option.
29837
29838 .vitem &*uschar&~*interface_address*&
29839 The IP address of the interface that received the message, as a string. This
29840 is NULL for locally submitted messages.
29841
29842 .vitem &*int&~interface_port*&
29843 The port on which this message was received. When testing with the &%-bh%&
29844 command line option, the value of this variable is -1 unless a port has been
29845 specified via the &%-oMi%& option.
29846
29847 .vitem &*uschar&~*message_id*&
29848 This variable contains Exim's message id for the incoming message (the value of
29849 &$message_exim_id$&) as a zero-terminated string.
29850
29851 .vitem &*uschar&~*received_protocol*&
29852 The name of the protocol by which the message was received.
29853
29854 .vitem &*int&~recipients_count*&
29855 The number of accepted recipients.
29856
29857 .vitem &*recipient_item&~*recipients_list*&
29858 .cindex "recipient" "adding in local scan"
29859 .cindex "recipient" "removing in local scan"
29860 The list of accepted recipients, held in a vector of length
29861 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29862 can add additional recipients by calling &'receive_add_recipient()'& (see
29863 below). You can delete recipients by removing them from the vector and
29864 adjusting the value in &%recipients_count%&. In particular, by setting
29865 &%recipients_count%& to zero you remove all recipients. If you then return the
29866 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29867 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29868 and then call &'receive_add_recipient()'& as often as needed.
29869
29870 .vitem &*uschar&~*sender_address*&
29871 The envelope sender address. For bounce messages this is the empty string.
29872
29873 .vitem &*uschar&~*sender_host_address*&
29874 The IP address of the sending host, as a string. This is NULL for
29875 locally-submitted messages.
29876
29877 .vitem &*uschar&~*sender_host_authenticated*&
29878 The name of the authentication mechanism that was used, or NULL if the message
29879 was not received over an authenticated SMTP connection.
29880
29881 .vitem &*uschar&~*sender_host_name*&
29882 The name of the sending host, if known.
29883
29884 .vitem &*int&~sender_host_port*&
29885 The port on the sending host.
29886
29887 .vitem &*BOOL&~smtp_input*&
29888 This variable is TRUE for all SMTP input, including BSMTP.
29889
29890 .vitem &*BOOL&~smtp_batched_input*&
29891 This variable is TRUE for BSMTP input.
29892
29893 .vitem &*int&~store_pool*&
29894 The contents of this variable control which pool of memory is used for new
29895 requests. See section &<<SECTmemhanloc>>& for details.
29896 .endlist
29897
29898
29899 .section "Structure of header lines" "SECID209"
29900 The &%header_line%& structure contains the members listed below.
29901 You can add additional header lines by calling the &'header_add()'& function
29902 (see below). You can cause header lines to be ignored (deleted) by setting
29903 their type to *.
29904
29905
29906 .vlist
29907 .vitem &*struct&~header_line&~*next*&
29908 A pointer to the next header line, or NULL for the last line.
29909
29910 .vitem &*int&~type*&
29911 A code identifying certain headers that Exim recognizes. The codes are printing
29912 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29913 Notice in particular that any header line whose type is * is not transmitted
29914 with the message. This flagging is used for header lines that have been
29915 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29916 lines.) Effectively, * means &"deleted"&.
29917
29918 .vitem &*int&~slen*&
29919 The number of characters in the header line, including the terminating and any
29920 internal newlines.
29921
29922 .vitem &*uschar&~*text*&
29923 A pointer to the text of the header. It always ends with a newline, followed by
29924 a zero byte. Internal newlines are preserved.
29925 .endlist
29926
29927
29928
29929 .section "Structure of recipient items" "SECID210"
29930 The &%recipient_item%& structure contains these members:
29931
29932 .vlist
29933 .vitem &*uschar&~*address*&
29934 This is a pointer to the recipient address as it was received.
29935
29936 .vitem &*int&~pno*&
29937 This is used in later Exim processing when top level addresses are created by
29938 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29939 and must always contain -1 at this stage.
29940
29941 .vitem &*uschar&~*errors_to*&
29942 If this value is not NULL, bounce messages caused by failing to deliver to the
29943 recipient are sent to the address it contains. In other words, it overrides the
29944 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29945 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29946 an unqualified address, Exim qualifies it using the domain from
29947 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29948 is NULL for all recipients.
29949 .endlist
29950
29951
29952
29953 .section "Available Exim functions" "SECID211"
29954 .cindex "&[local_scan()]& function" "available Exim functions"
29955 The header &_local_scan.h_& gives you access to a number of Exim functions.
29956 These are the only ones that are guaranteed to be maintained from release to
29957 release:
29958
29959 .vlist
29960 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29961        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29962
29963 This function creates a child process that runs the command specified by
29964 &%argv%&. The environment for the process is specified by &%envp%&, which can
29965 be NULL if no environment variables are to be passed. A new umask is supplied
29966 for the process in &%newumask%&.
29967
29968 Pipes to the standard input and output of the new process are set up
29969 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29970 standard error is cloned to the standard output. If there are any file
29971 descriptors &"in the way"& in the new process, they are closed. If the final
29972 argument is TRUE, the new process is made into a process group leader.
29973
29974 The function returns the pid of the new process, or -1 if things go wrong.
29975
29976 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29977 This function waits for a child process to terminate, or for a timeout (in
29978 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29979 return value is as follows:
29980
29981 .ilist
29982 >= 0
29983
29984 The process terminated by a normal exit and the value is the process
29985 ending status.
29986
29987 .next
29988 < 0 and > &--256
29989
29990 The process was terminated by a signal and the value is the negation of the
29991 signal number.
29992
29993 .next
29994 &--256
29995
29996 The process timed out.
29997 .next
29998 &--257
29999
30000 The was some other error in wait(); &%errno%& is still set.
30001 .endlist
30002
30003 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30004 This function provide you with a means of submitting a new message to
30005 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30006 want, but this packages it all up for you.) The function creates a pipe,
30007 forks a subprocess that is running
30008 .code
30009 exim -t -oem -oi -f <>
30010 .endd
30011 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30012 that is connected to the standard input. The yield of the function is the PID
30013 of the subprocess. You can then write a message to the file descriptor, with
30014 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30015
30016 When you have finished, call &'child_close()'& to wait for the process to
30017 finish and to collect its ending status. A timeout value of zero is usually
30018 fine in this circumstance. Unless you have made a mistake with the recipient
30019 addresses, you should get a return code of zero.
30020
30021
30022 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30023        *sender_authentication)*&
30024 This function is a more sophisticated version of &'child_open()'&. The command
30025 that it runs is:
30026 .display
30027 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30028 .endd
30029 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30030
30031
30032 .vitem &*void&~debug_printf(char&~*,&~...)*&
30033 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30034 output is written to the standard error stream. If no debugging is selected,
30035 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30036 conditional on the &`local_scan`& debug selector by coding like this:
30037 .code
30038 if ((debug_selector & D_local_scan) != 0)
30039   debug_printf("xxx", ...);
30040 .endd
30041
30042 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30043 This is an interface to Exim's string expansion code. The return value is the
30044 expanded string, or NULL if there was an expansion failure.
30045 The C variable &%expand_string_message%& contains an error message after an
30046 expansion failure. If expansion does not change the string, the return value is
30047 the pointer to the input string. Otherwise, the return value points to a new
30048 block of memory that was obtained by a call to &'store_get()'&. See section
30049 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30050
30051 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30052 This function allows you to an add additional header line at the end of the
30053 existing ones. The first argument is the type, and should normally be a space
30054 character. The second argument is a format string and any number of
30055 substitution arguments as for &[sprintf()]&. You may include internal newlines
30056 if you want, and you must ensure that the string ends with a newline.
30057
30058 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30059         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30060 This function adds a new header line at a specified point in the header
30061 chain. The header itself is specified as for &'header_add()'&.
30062
30063 If &%name%& is NULL, the new header is added at the end of the chain if
30064 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30065 NULL, the header lines are searched for the first non-deleted header that
30066 matches the name. If one is found, the new header is added before it if
30067 &%after%& is false. If &%after%& is true, the new header is added after the
30068 found header and any adjacent subsequent ones with the same name (even if
30069 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30070 option controls where the header is added. If it is true, addition is at the
30071 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30072 headers, or at the top if there are no &'Received:'& headers, you could use
30073 .code
30074 header_add_at_position(TRUE, US"Received", TRUE,
30075   ' ', "X-xxx: ...");
30076 .endd
30077 Normally, there is always at least one non-deleted &'Received:'& header, but
30078 there may not be if &%received_header_text%& expands to an empty string.
30079
30080
30081 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30082 This function removes header lines. If &%occurrence%& is zero or negative, all
30083 occurrences of the header are removed. If occurrence is greater than zero, that
30084 particular instance of the header is removed. If no header(s) can be found that
30085 match the specification, the function does nothing.
30086
30087
30088 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30089         int&~length,&~BOOL&~notdel)*&"
30090 This function tests whether the given header has the given name. It is not just
30091 a string comparison, because white space is permitted between the name and the
30092 colon. If the &%notdel%& argument is true, a false return is forced for all
30093 &"deleted"& headers; otherwise they are not treated specially. For example:
30094 .code
30095 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30096 .endd
30097 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30098 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30099 This function base64-encodes a string, which is passed by address and length.
30100 The text may contain bytes of any value, including zero. The result is passed
30101 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30102 zero-terminated.
30103
30104 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30105 This function decodes a base64-encoded string. Its arguments are a
30106 zero-terminated base64-encoded string and the address of a variable that is set
30107 to point to the result, which is in dynamic memory. The length of the decoded
30108 string is the yield of the function. If the input is invalid base64 data, the
30109 yield is -1. A zero byte is added to the end of the output string to make it
30110 easy to interpret as a C string (assuming it contains no zeros of its own). The
30111 added zero byte is not included in the returned count.
30112
30113 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30114 This function checks for a match in a domain list. Domains are always
30115 matched caselessly. The return value is one of the following:
30116 .display
30117 &`OK     `& match succeeded
30118 &`FAIL   `& match failed
30119 &`DEFER  `& match deferred
30120 .endd
30121 DEFER is usually caused by some kind of lookup defer, such as the
30122 inability to contact a database.
30123
30124 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30125         BOOL&~caseless)*&"
30126 This function checks for a match in a local part list. The third argument
30127 controls case-sensitivity. The return values are as for
30128 &'lss_match_domain()'&.
30129
30130 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30131         BOOL&~caseless)*&"
30132 This function checks for a match in an address list. The third argument
30133 controls the case-sensitivity of the local part match. The domain is always
30134 matched caselessly. The return values are as for &'lss_match_domain()'&.
30135
30136 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30137         uschar&~*list)*&"
30138 This function checks for a match in a host list. The most common usage is
30139 expected to be
30140 .code
30141 lss_match_host(sender_host_name, sender_host_address, ...)
30142 .endd
30143 .vindex "&$sender_host_address$&"
30144 An empty address field matches an empty item in the host list. If the host name
30145 is NULL, the name corresponding to &$sender_host_address$& is automatically
30146 looked up if a host name is required to match an item in the list. The return
30147 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30148 returns ERROR in the case when it had to look up a host name, but the lookup
30149 failed.
30150
30151 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30152         *format,&~...)*&"
30153 This function writes to Exim's log files. The first argument should be zero (it
30154 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30155 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30156 them. It specifies to which log or logs the message is written. The remaining
30157 arguments are a format and relevant insertion arguments. The string should not
30158 contain any newlines, not even at the end.
30159
30160
30161 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30162 This function adds an additional recipient to the message. The first argument
30163 is the recipient address. If it is unqualified (has no domain), it is qualified
30164 with the &%qualify_recipient%& domain. The second argument must always be -1.
30165
30166 This function does not allow you to specify a private &%errors_to%& address (as
30167 described with the structure of &%recipient_item%& above), because it pre-dates
30168 the addition of that field to the structure. However, it is easy to add such a
30169 value afterwards. For example:
30170 .code
30171  receive_add_recipient(US"monitor@mydom.example", -1);
30172  recipients_list[recipients_count-1].errors_to =
30173    US"postmaster@mydom.example";
30174 .endd
30175
30176 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30177 This is a convenience function to remove a named recipient from the list of
30178 recipients. It returns true if a recipient was removed, and false if no
30179 matching recipient could be found. The argument must be a complete email
30180 address.
30181 .endlist
30182
30183
30184 .cindex "RFC 2047"
30185 .vlist
30186 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30187   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30188 This function decodes strings that are encoded according to RFC 2047. Typically
30189 these are the contents of header lines. First, each &"encoded word"& is decoded
30190 from the Q or B encoding into a byte-string. Then, if provided with the name of
30191 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30192 made  to translate the result to the named character set. If this fails, the
30193 binary string is returned with an error message.
30194
30195 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30196 maximum MIME word length is enforced. The third argument is the target
30197 encoding, or NULL if no translation is wanted.
30198
30199 .cindex "binary zero" "in RFC 2047 decoding"
30200 .cindex "RFC 2047" "binary zero in"
30201 If a binary zero is encountered in the decoded string, it is replaced by the
30202 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30203 not be 0 because header lines are handled as zero-terminated strings.
30204
30205 The function returns the result of processing the string, zero-terminated; if
30206 &%lenptr%& is not NULL, the length of the result is set in the variable to
30207 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30208
30209 If an error is encountered, the function returns NULL and uses the &%error%&
30210 argument to return an error message. The variable pointed to by &%error%& is
30211 set to NULL if there is no error; it may be set non-NULL even when the function
30212 returns a non-NULL value if decoding was successful, but there was a problem
30213 with translation.
30214
30215
30216 .vitem &*int&~smtp_fflush(void)*&
30217 This function is used in conjunction with &'smtp_printf()'&, as described
30218 below.
30219
30220 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30221 The arguments of this function are like &[printf()]&; it writes to the SMTP
30222 output stream. You should use this function only when there is an SMTP output
30223 stream, that is, when the incoming message is being received via interactive
30224 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30225 is FALSE. If you want to test for an incoming message from another host (as
30226 opposed to a local process that used the &%-bs%& command line option), you can
30227 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30228 is involved.
30229
30230 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30231 output function, so it can be used for all forms of SMTP connection.
30232
30233 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30234 must start with an appropriate response code: 550 if you are going to return
30235 LOCAL_SCAN_REJECT, 451 if you are going to return
30236 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30237 initial lines of a multi-line response, the code must be followed by a hyphen
30238 to indicate that the line is not the final response line. You must also ensure
30239 that the lines you write terminate with CRLF. For example:
30240 .code
30241 smtp_printf("550-this is some extra info\r\n");
30242 return LOCAL_SCAN_REJECT;
30243 .endd
30244 Note that you can also create multi-line responses by including newlines in
30245 the data returned via the &%return_text%& argument. The added value of using
30246 &'smtp_printf()'& is that, for instance, you could introduce delays between
30247 multiple output lines.
30248
30249 The &'smtp_printf()'& function does not return any error indication, because it
30250 does not automatically flush pending output, and therefore does not test
30251 the state of the stream. (In the main code of Exim, flushing and error
30252 detection is done when Exim is ready for the next SMTP input command.) If
30253 you want to flush the output and check for an error (for example, the
30254 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30255 arguments. It flushes the output stream, and returns a non-zero value if there
30256 is an error.
30257
30258 .vitem &*void&~*store_get(int)*&
30259 This function accesses Exim's internal store (memory) manager. It gets a new
30260 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30261 runs out of memory. See the next section for a discussion of memory handling.
30262
30263 .vitem &*void&~*store_get_perm(int)*&
30264 This function is like &'store_get()'&, but it always gets memory from the
30265 permanent pool. See the next section for a discussion of memory handling.
30266
30267 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30268 See below.
30269
30270 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30271 See below.
30272
30273 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30274 These three functions create strings using Exim's dynamic memory facilities.
30275 The first makes a copy of an entire string. The second copies up to a maximum
30276 number of characters, indicated by the second argument. The third uses a format
30277 and insertion arguments to create a new string. In each case, the result is a
30278 pointer to a new string in the current memory pool. See the next section for
30279 more discussion.
30280 .endlist
30281
30282
30283
30284 .section "More about Exim's memory handling" "SECTmemhanloc"
30285 .cindex "&[local_scan()]& function" "memory handling"
30286 No function is provided for freeing memory, because that is never needed.
30287 The dynamic memory that Exim uses when receiving a message is automatically
30288 recycled if another message is received by the same process (this applies only
30289 to incoming SMTP connections &-- other input methods can supply only one
30290 message at a time). After receiving the last message, a reception process
30291 terminates.
30292
30293 Because it is recycled, the normal dynamic memory cannot be used for holding
30294 data that must be preserved over a number of incoming messages on the same SMTP
30295 connection. However, Exim in fact uses two pools of dynamic memory; the second
30296 one is not recycled, and can be used for this purpose.
30297
30298 If you want to allocate memory that remains available for subsequent messages
30299 in the same SMTP connection, you should set
30300 .code
30301 store_pool = POOL_PERM
30302 .endd
30303 before calling the function that does the allocation. There is no need to
30304 restore the value if you do not need to; however, if you do want to revert to
30305 the normal pool, you can either restore the previous value of &%store_pool%& or
30306 set it explicitly to POOL_MAIN.
30307
30308 The pool setting applies to all functions that get dynamic memory, including
30309 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30310 There is also a convenience function called &'store_get_perm()'& that gets a
30311 block of memory from the permanent pool while preserving the value of
30312 &%store_pool%&.
30313 .ecindex IIDlosca
30314
30315
30316
30317
30318 . ////////////////////////////////////////////////////////////////////////////
30319 . ////////////////////////////////////////////////////////////////////////////
30320
30321 .chapter "System-wide message filtering" "CHAPsystemfilter"
30322 .scindex IIDsysfil1 "filter" "system filter"
30323 .scindex IIDsysfil2 "filtering all mail"
30324 .scindex IIDsysfil3 "system filter"
30325 The previous chapters (on ACLs and the local scan function) describe checks
30326 that can be applied to messages before they are accepted by a host. There is
30327 also a mechanism for checking messages once they have been received, but before
30328 they are delivered. This is called the &'system filter'&.
30329
30330 The system filter operates in a similar manner to users' filter files, but it
30331 is run just once per message (however many recipients the message has).
30332 It should not normally be used as a substitute for routing, because &%deliver%&
30333 commands in a system router provide new envelope recipient addresses.
30334 The system filter must be an Exim filter. It cannot be a Sieve filter.
30335
30336 The system filter is run at the start of a delivery attempt, before any routing
30337 is done. If a message fails to be completely delivered at the first attempt,
30338 the system filter is run again at the start of every retry.
30339 If you want your filter to do something only once per message, you can make use
30340 of the &%first_delivery%& condition in an &%if%& command in the filter to
30341 prevent it happening on retries.
30342
30343 .vindex "&$domain$&"
30344 .vindex "&$local_part$&"
30345 &*Warning*&: Because the system filter runs just once, variables that are
30346 specific to individual recipient addresses, such as &$local_part$& and
30347 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30348 you want to run a centrally-specified filter for each recipient address
30349 independently, you can do so by setting up a suitable &(redirect)& router, as
30350 described in section &<<SECTperaddfil>>& below.
30351
30352
30353 .section "Specifying a system filter" "SECID212"
30354 .cindex "uid (user id)" "system filter"
30355 .cindex "gid (group id)" "system filter"
30356 The name of the file that contains the system filter must be specified by
30357 setting &%system_filter%&. If you want the filter to run under a uid and gid
30358 other than root, you must also set &%system_filter_user%& and
30359 &%system_filter_group%& as appropriate. For example:
30360 .code
30361 system_filter = /etc/mail/exim.filter
30362 system_filter_user = exim
30363 .endd
30364 If a system filter generates any deliveries directly to files or pipes (via the
30365 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30366 specified by setting &%system_filter_file_transport%& and
30367 &%system_filter_pipe_transport%&, respectively. Similarly,
30368 &%system_filter_reply_transport%& must be set to handle any messages generated
30369 by the &%reply%& command.
30370
30371
30372 .section "Testing a system filter" "SECID213"
30373 You can run simple tests of a system filter in the same way as for a user
30374 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30375 are permitted only in system filters are recognized.
30376
30377 If you want to test the combined effect of a system filter and a user filter,
30378 you can use both &%-bF%& and &%-bf%& on the same command line.
30379
30380
30381
30382 .section "Contents of a system filter" "SECID214"
30383 The language used to specify system filters is the same as for users' filter
30384 files. It is described in the separate end-user document &'Exim's interface to
30385 mail filtering'&. However, there are some additional features that are
30386 available only in system filters; these are described in subsequent sections.
30387 If they are encountered in a user's filter file or when testing with &%-bf%&,
30388 they cause errors.
30389
30390 .cindex "frozen messages" "manual thaw; testing in filter"
30391 There are two special conditions which, though available in users' filter
30392 files, are designed for use in system filters. The condition &%first_delivery%&
30393 is true only for the first attempt at delivering a message, and
30394 &%manually_thawed%& is true only if the message has been frozen, and
30395 subsequently thawed by an admin user. An explicit forced delivery counts as a
30396 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30397
30398 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30399 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30400 succeed, it will not be tried again.
30401 If you want Exim to retry an unseen delivery until it succeeds, you should
30402 arrange to set it up every time the filter runs.
30403
30404 When a system filter finishes running, the values of the variables &$n0$& &--
30405 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30406 users' filter files. Thus a system filter can, for example, set up &"scores"&
30407 to which users' filter files can refer.
30408
30409
30410
30411 .section "Additional variable for system filters" "SECID215"
30412 .vindex "&$recipients$&"
30413 The expansion variable &$recipients$&, containing a list of all the recipients
30414 of the message (separated by commas and white space), is available in system
30415 filters. It is not available in users' filters for privacy reasons.
30416
30417
30418
30419 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30420 .cindex "freezing messages"
30421 .cindex "message" "freezing"
30422 .cindex "message" "forced failure"
30423 .cindex "&%fail%&" "in system filter"
30424 .cindex "&%freeze%& in system filter"
30425 .cindex "&%defer%& in system filter"
30426 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30427 always available in system filters, but are not normally enabled in users'
30428 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30429 for the &(redirect)& router.) These commands can optionally be followed by the
30430 word &%text%& and a string containing an error message, for example:
30431 .code
30432 fail text "this message looks like spam to me"
30433 .endd
30434 The keyword &%text%& is optional if the next character is a double quote.
30435
30436 The &%defer%& command defers delivery of the original recipients of the
30437 message. The &%fail%& command causes all the original recipients to be failed,
30438 and a bounce message to be created. The &%freeze%& command suspends all
30439 delivery attempts for the original recipients. In all cases, any new deliveries
30440 that are specified by the filter are attempted as normal after the filter has
30441 run.
30442
30443 The &%freeze%& command is ignored if the message has been manually unfrozen and
30444 not manually frozen since. This means that automatic freezing by a system
30445 filter can be used as a way of checking out suspicious messages. If a message
30446 is found to be all right, manually unfreezing it allows it to be delivered.
30447
30448 .cindex "log" "&%fail%& command log line"
30449 .cindex "&%fail%&" "log line; reducing"
30450 The text given with a fail command is used as part of the bounce message as
30451 well as being written to the log. If the message is quite long, this can fill
30452 up a lot of log space when such failures are common. To reduce the size of the
30453 log message, Exim interprets the text in a special way if it starts with the
30454 two characters &`<<`& and contains &`>>`& later. The text between these two
30455 strings is written to the log, and the rest of the text is used in the bounce
30456 message. For example:
30457 .code
30458 fail "<<filter test 1>>Your message is rejected \
30459      because it contains attachments that we are \
30460      not prepared to receive."
30461 .endd
30462
30463 .cindex "loop" "caused by &%fail%&"
30464 Take great care with the &%fail%& command when basing the decision to fail on
30465 the contents of the message, because the bounce message will of course include
30466 the contents of the original message and will therefore trigger the &%fail%&
30467 command again (causing a mail loop) unless steps are taken to prevent this.
30468 Testing the &%error_message%& condition is one way to prevent this. You could
30469 use, for example
30470 .code
30471 if $message_body contains "this is spam" and not error_message
30472 then fail text "spam is not wanted here" endif
30473 .endd
30474 though of course that might let through unwanted bounce messages. The
30475 alternative is clever checking of the body and/or headers to detect bounces
30476 generated by the filter.
30477
30478 The interpretation of a system filter file ceases after a
30479 &%defer%&,
30480 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30481 set up earlier in the filter file are honoured, so you can use a sequence such
30482 as
30483 .code
30484 mail ...
30485 freeze
30486 .endd
30487 to send a specified message when the system filter is freezing (or deferring or
30488 failing) a message. The normal deliveries for the message do not, of course,
30489 take place.
30490
30491
30492
30493 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
30494 .cindex "header lines" "adding; in system filter"
30495 .cindex "header lines" "removing; in system filter"
30496 .cindex "filter" "header lines; adding/removing"
30497 Two filter commands that are available only in system filters are:
30498 .code
30499 headers add <string>
30500 headers remove <string>
30501 .endd
30502 The argument for the &%headers add%& is a string that is expanded and then
30503 added to the end of the message's headers. It is the responsibility of the
30504 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
30505 space is ignored, and if the string is otherwise empty, or if the expansion is
30506 forced to fail, the command has no effect.
30507
30508 You can use &"\n"& within the string, followed by white space, to specify
30509 continued header lines. More than one header may be added in one command by
30510 including &"\n"& within the string without any following white space. For
30511 example:
30512 .code
30513 headers add "X-header-1: ....\n  \
30514              continuation of X-header-1 ...\n\
30515              X-header-2: ...."
30516 .endd
30517 Note that the header line continuation white space after the first newline must
30518 be placed before the backslash that continues the input string, because white
30519 space after input continuations is ignored.
30520
30521 The argument for &%headers remove%& is a colon-separated list of header names.
30522 This command applies only to those headers that are stored with the message;
30523 those that are added at delivery time (such as &'Envelope-To:'& and
30524 &'Return-Path:'&) cannot be removed by this means. If there is more than one
30525 header with the same name, they are all removed.
30526
30527 The &%headers%& command in a system filter makes an immediate change to the set
30528 of header lines that was received with the message (with possible additions
30529 from ACL processing). Subsequent commands in the system filter operate on the
30530 modified set, which also forms the basis for subsequent message delivery.
30531 Unless further modified during routing or transporting, this set of headers is
30532 used for all recipients of the message.
30533
30534 During routing and transporting, the variables that refer to the contents of
30535 header lines refer only to those lines that are in this set. Thus, header lines
30536 that are added by a system filter are visible to users' filter files and to all
30537 routers and transports. This contrasts with the manipulation of header lines by
30538 routers and transports, which is not immediate, but which instead is saved up
30539 until the message is actually being written (see section
30540 &<<SECTheadersaddrem>>&).
30541
30542 If the message is not delivered at the first attempt, header lines that were
30543 added by the system filter are stored with the message, and so are still
30544 present at the next delivery attempt. Header lines that were removed are still
30545 present, but marked &"deleted"& so that they are not transported with the
30546 message. For this reason, it is usual to make the &%headers%& command
30547 conditional on &%first_delivery%& so that the set of header lines is not
30548 modified more than once.
30549
30550 Because header modification in a system filter acts immediately, you have to
30551 use an indirect approach if you want to modify the contents of a header line.
30552 For example:
30553 .code
30554 headers add "Old-Subject: $h_subject:"
30555 headers remove "Subject"
30556 headers add "Subject: new subject (was: $h_old-subject:)"
30557 headers remove "Old-Subject"
30558 .endd
30559
30560
30561
30562 .section "Setting an errors address in a system filter" "SECID217"
30563 .cindex "envelope sender"
30564 In a system filter, if a &%deliver%& command is followed by
30565 .code
30566 errors_to <some address>
30567 .endd
30568 in order to change the envelope sender (and hence the error reporting) for that
30569 delivery, any address may be specified. (In a user filter, only the current
30570 user's address can be set.) For example, if some mail is being monitored, you
30571 might use
30572 .code
30573 unseen deliver monitor@spying.example errors_to root@local.example
30574 .endd
30575 to take a copy which would not be sent back to the normal error reporting
30576 address if its delivery failed.
30577
30578
30579
30580 .section "Per-address filtering" "SECTperaddfil"
30581 .vindex "&$domain$&"
30582 .vindex "&$local_part$&"
30583 In contrast to the system filter, which is run just once per message for each
30584 delivery attempt, it is also possible to set up a system-wide filtering
30585 operation that runs once for each recipient address. In this case, variables
30586 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
30587 filter file could be made dependent on them. This is an example of a router
30588 which implements such a filter:
30589 .code
30590 central_filter:
30591   check_local_user
30592   driver = redirect
30593   domains = +local_domains
30594   file = /central/filters/$local_part
30595   no_verify
30596   allow_filter
30597   allow_freeze
30598 .endd
30599 The filter is run in a separate process under its own uid. Therefore, either
30600 &%check_local_user%& must be set (as above), in which case the filter is run as
30601 the local user, or the &%user%& option must be used to specify which user to
30602 use. If both are set, &%user%& overrides.
30603
30604 Care should be taken to ensure that none of the commands in the filter file
30605 specify a significant delivery if the message is to go on to be delivered to
30606 its intended recipient. The router will not then claim to have dealt with the
30607 address, so it will be passed on to subsequent routers to be delivered in the
30608 normal way.
30609 .ecindex IIDsysfil1
30610 .ecindex IIDsysfil2
30611 .ecindex IIDsysfil3
30612
30613
30614
30615
30616
30617
30618 . ////////////////////////////////////////////////////////////////////////////
30619 . ////////////////////////////////////////////////////////////////////////////
30620
30621 .chapter "Message processing" "CHAPmsgproc"
30622 .scindex IIDmesproc "message" "general processing"
30623 Exim performs various transformations on the sender and recipient addresses of
30624 all messages that it handles, and also on the messages' header lines. Some of
30625 these are optional and configurable, while others always take place. All of
30626 this processing, except rewriting as a result of routing, and the addition or
30627 removal of header lines while delivering, happens when a message is received,
30628 before it is placed on Exim's queue.
30629
30630 Some of the automatic processing takes place by default only for
30631 &"locally-originated"& messages. This adjective is used to describe messages
30632 that are not received over TCP/IP, but instead are passed to an Exim process on
30633 its standard input. This includes the interactive &"local SMTP"& case that is
30634 set up by the &%-bs%& command line option.
30635
30636 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
30637 or ::1) are not considered to be locally-originated. Exim does not treat the
30638 loopback interface specially in any way.
30639
30640 If you want the loopback interface to be treated specially, you must ensure
30641 that there are appropriate entries in your ACLs.
30642
30643
30644
30645
30646 .section "Submission mode for non-local messages" "SECTsubmodnon"
30647 .cindex "message" "submission"
30648 .cindex "submission mode"
30649 Processing that happens automatically for locally-originated messages (unless
30650 &%suppress_local_fixups%& is set) can also be requested for messages that are
30651 received over TCP/IP. The term &"submission mode"& is used to describe this
30652 state. Submission mode is set by the modifier
30653 .code
30654 control = submission
30655 .endd
30656 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
30657 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
30658 a local submission, and is normally used when the source of the message is
30659 known to be an MUA running on a client host (as opposed to an MTA). For
30660 example, to set submission mode for messages originating on the IPv4 loopback
30661 interface, you could include the following in the MAIL ACL:
30662 .code
30663 warn  hosts = 127.0.0.1
30664       control = submission
30665 .endd
30666 .cindex "&%sender_retain%& submission option"
30667 There are some options that can be used when setting submission mode. A slash
30668 is used to separate options. For example:
30669 .code
30670 control = submission/sender_retain
30671 .endd
30672 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
30673 true and &%local_from_check%& false for the current incoming message. The first
30674 of these allows an existing &'Sender:'& header in the message to remain, and
30675 the second suppresses the check to ensure that &'From:'& matches the
30676 authenticated sender. With this setting, Exim still fixes up messages by adding
30677 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
30678 attempt to check sender authenticity in header lines.
30679
30680 When &%sender_retain%& is not set, a submission mode setting may specify a
30681 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30682 example:
30683 .code
30684 control = submission/domain=some.domain
30685 .endd
30686 The domain may be empty. How this value is used is described in sections
30687 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30688 that allows you to specify the user's full name for inclusion in a created
30689 &'Sender:'& or &'From:'& header line. For example:
30690 .code
30691 accept authenticated = *
30692        control = submission/domain=wonderland.example/\
30693                             name=${lookup {$authenticated_id} \
30694                                    lsearch {/etc/exim/namelist}}
30695 .endd
30696 Because the name may contain any characters, including slashes, the &%name%&
30697 option must be given last. The remainder of the string is used as the name. For
30698 the example above, if &_/etc/exim/namelist_& contains:
30699 .code
30700 bigegg:  Humpty Dumpty
30701 .endd
30702 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30703 line would be:
30704 .code
30705 Sender: Humpty Dumpty <bigegg@wonderland.example>
30706 .endd
30707 .cindex "return path" "in submission mode"
30708 By default, submission mode forces the return path to the same address as is
30709 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30710 specified, the return path is also left unchanged.
30711
30712 &*Note*&: The changes caused by submission mode take effect after the predata
30713 ACL. This means that any sender checks performed before the fix-ups use the
30714 untrusted sender address specified by the user, not the trusted sender address
30715 specified by submission mode. Although this might be slightly unexpected, it
30716 does mean that you can configure ACL checks to spot that a user is trying to
30717 spoof another's address.
30718
30719 .section "Line endings" "SECTlineendings"
30720 .cindex "line endings"
30721 .cindex "carriage return"
30722 .cindex "linefeed"
30723 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30724 linefeed) is the line ending for messages transmitted over the Internet using
30725 SMTP over TCP/IP. However, within individual operating systems, different
30726 conventions are used. For example, Unix-like systems use just LF, but others
30727 use CRLF or just CR.
30728
30729 Exim was designed for Unix-like systems, and internally, it stores messages
30730 using the system's convention of a single LF as a line terminator. When
30731 receiving a message, all line endings are translated to this standard format.
30732 Originally, it was thought that programs that passed messages directly to an
30733 MTA within an operating system would use that system's convention. Experience
30734 has shown that this is not the case; for example, there are Unix applications
30735 that use CRLF in this circumstance. For this reason, and for compatibility with
30736 other MTAs, the way Exim handles line endings for all messages is now as
30737 follows:
30738
30739 .ilist
30740 LF not preceded by CR is treated as a line ending.
30741 .next
30742 CR is treated as a line ending; if it is immediately followed by LF, the LF
30743 is ignored.
30744 .next
30745 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30746 nor a local message in the state where a line containing only a dot is a
30747 terminator.
30748 .next
30749 If a bare CR is encountered within a header line, an extra space is added after
30750 the line terminator so as not to end the header line. The reasoning behind this
30751 is that bare CRs in header lines are most likely either to be mistakes, or
30752 people trying to play silly games.
30753 .next
30754 If the first header line received in a message ends with CRLF, a subsequent
30755 bare LF in a header line is treated in the same way as a bare CR in a header
30756 line.
30757 .endlist
30758
30759
30760
30761
30762
30763 .section "Unqualified addresses" "SECID218"
30764 .cindex "unqualified addresses"
30765 .cindex "address" "qualification"
30766 By default, Exim expects every envelope address it receives from an external
30767 host to be fully qualified. Unqualified addresses cause negative responses to
30768 SMTP commands. However, because SMTP is used as a means of transporting
30769 messages from MUAs running on personal workstations, there is sometimes a
30770 requirement to accept unqualified addresses from specific hosts or IP networks.
30771
30772 Exim has two options that separately control which hosts may send unqualified
30773 sender or recipient addresses in SMTP commands, namely
30774 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30775 cases, if an unqualified address is accepted, it is qualified by adding the
30776 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30777
30778 .oindex "&%qualify_domain%&"
30779 .oindex "&%qualify_recipient%&"
30780 Unqualified addresses in header lines are automatically qualified for messages
30781 that are locally originated, unless the &%-bnq%& option is given on the command
30782 line. For messages received over SMTP, unqualified addresses in header lines
30783 are qualified only if unqualified addresses are permitted in SMTP commands. In
30784 other words, such qualification is also controlled by
30785 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30786
30787
30788
30789
30790 .section "The UUCP From line" "SECID219"
30791 .cindex "&""From""& line"
30792 .cindex "UUCP" "&""From""& line"
30793 .cindex "sender" "address"
30794 .oindex "&%uucp_from_pattern%&"
30795 .oindex "&%uucp_from_sender%&"
30796 .cindex "envelope sender"
30797 .cindex "Sendmail compatibility" "&""From""& line"
30798 Messages that have come from UUCP (and some other applications) often begin
30799 with a line containing the envelope sender and a timestamp, following the word
30800 &"From"&. Examples of two common formats are:
30801 .code
30802 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30803 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30804 .endd
30805 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30806 Exim recognizes such lines at the start of messages that are submitted to it
30807 via the command line (that is, on the standard input). It does not recognize
30808 such lines in incoming SMTP messages, unless the sending host matches
30809 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30810 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30811 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30812 default value matches the two common cases shown above and puts the address
30813 that follows &"From"& into &$1$&.
30814
30815 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30816 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30817 a trusted user, the message's sender address is constructed by expanding the
30818 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30819 then parsed as an RFC 2822 address. If there is no domain, the local part is
30820 qualified with &%qualify_domain%& unless it is the empty string. However, if
30821 the command line &%-f%& option is used, it overrides the &"From"& line.
30822
30823 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30824 sender address is not changed. This is also the case for incoming SMTP messages
30825 that are permitted to contain &"From"& lines.
30826
30827 Only one &"From"& line is recognized. If there is more than one, the second is
30828 treated as a data line that starts the body of the message, as it is not valid
30829 as a header line. This also happens if a &"From"& line is present in an
30830 incoming SMTP message from a source that is not permitted to send them.
30831
30832
30833
30834 .section "Resent- header lines" "SECID220"
30835 .cindex "&%Resent-%& header lines"
30836 RFC 2822 makes provision for sets of header lines starting with the string
30837 &`Resent-`& to be added to a message when it is resent by the original
30838 recipient to somebody else. These headers are &'Resent-Date:'&,
30839 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30840 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30841
30842 .blockquote
30843 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30844 processing of replies or other such automatic actions on messages.'&
30845 .endblockquote
30846
30847 This leaves things a bit vague as far as other processing actions such as
30848 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30849 follows:
30850
30851 .ilist
30852 A &'Resent-From:'& line that just contains the login id of the submitting user
30853 is automatically rewritten in the same way as &'From:'& (see below).
30854 .next
30855 If there's a rewriting rule for a particular header line, it is also applied to
30856 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30857 &'From:'& also rewrites &'Resent-From:'&.
30858 .next
30859 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30860 also removed.
30861 .next
30862 For a locally-submitted message,
30863 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30864 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30865 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30866 included in log lines in this case.
30867 .next
30868 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30869 &%Resent-%& header lines are present.
30870 .endlist
30871
30872
30873
30874
30875 .section "The Auto-Submitted: header line" "SECID221"
30876 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30877 includes the header line:
30878 .code
30879 Auto-Submitted: auto-replied
30880 .endd
30881
30882 .section "The Bcc: header line" "SECID222"
30883 .cindex "&'Bcc:'& header line"
30884 If Exim is called with the &%-t%& option, to take recipient addresses from a
30885 message's header, it removes any &'Bcc:'& header line that may exist (after
30886 extracting its addresses). If &%-t%& is not present on the command line, any
30887 existing &'Bcc:'& is not removed.
30888
30889
30890 .section "The Date: header line" "SECID223"
30891 .cindex "&'Date:'& header line"
30892 If a locally-generated or submission-mode message has no &'Date:'& header line,
30893 Exim adds one, using the current date and time, unless the
30894 &%suppress_local_fixups%& control has been specified.
30895
30896 .section "The Delivery-date: header line" "SECID224"
30897 .cindex "&'Delivery-date:'& header line"
30898 .oindex "&%delivery_date_remove%&"
30899 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30900 set. Exim can be configured to add them to the final delivery of messages. (See
30901 the generic &%delivery_date_add%& transport option.) They should not be present
30902 in messages in transit. If the &%delivery_date_remove%& configuration option is
30903 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30904 messages.
30905
30906
30907 .section "The Envelope-to: header line" "SECID225"
30908 .cindex "&'Envelope-to:'& header line"
30909 .oindex "&%envelope_to_remove%&"
30910 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30911 Exim can be configured to add them to the final delivery of messages. (See the
30912 generic &%envelope_to_add%& transport option.) They should not be present in
30913 messages in transit. If the &%envelope_to_remove%& configuration option is set
30914 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30915 messages.
30916
30917
30918 .section "The From: header line" "SECTthefrohea"
30919 .cindex "&'From:'& header line"
30920 .cindex "Sendmail compatibility" "&""From""& line"
30921 .cindex "message" "submission"
30922 .cindex "submission mode"
30923 If a submission-mode message does not contain a &'From:'& header line, Exim
30924 adds one if either of the following conditions is true:
30925
30926 .ilist
30927 The envelope sender address is not empty (that is, this is not a bounce
30928 message). The added header line copies the envelope sender address.
30929 .next
30930 .vindex "&$authenticated_id$&"
30931 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30932 .olist
30933 .vindex "&$qualify_domain$&"
30934 If no domain is specified by the submission control, the local part is
30935 &$authenticated_id$& and the domain is &$qualify_domain$&.
30936 .next
30937 If a non-empty domain is specified by the submission control, the local
30938 part is &$authenticated_id$&, and the domain is the specified domain.
30939 .next
30940 If an empty domain is specified by the submission control,
30941 &$authenticated_id$& is assumed to be the complete address.
30942 .endlist
30943 .endlist
30944
30945 A non-empty envelope sender takes precedence.
30946
30947 If a locally-generated incoming message does not contain a &'From:'& header
30948 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30949 containing the sender's address. The calling user's login name and full name
30950 are used to construct the address, as described in section &<<SECTconstr>>&.
30951 They are obtained from the password data by calling &[getpwuid()]& (but see the
30952 &%unknown_login%& configuration option). The address is qualified with
30953 &%qualify_domain%&.
30954
30955 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30956 &'From:'& header line containing just the unqualified login name of the calling
30957 user, this is replaced by an address containing the user's login name and full
30958 name as described in section &<<SECTconstr>>&.
30959
30960
30961 .section "The Message-ID: header line" "SECID226"
30962 .cindex "&'Message-ID:'& header line"
30963 .cindex "message" "submission"
30964 .oindex "&%message_id_header_text%&"
30965 If a locally-generated or submission-mode incoming message does not contain a
30966 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30967 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30968 to the message. If there are any &'Resent-:'& headers in the message, it
30969 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30970 message id, preceded by the letter E to ensure it starts with a letter, and
30971 followed by @ and the primary host name. Additional information can be included
30972 in this header line by setting the &%message_id_header_text%& and/or
30973 &%message_id_header_domain%& options.
30974
30975
30976 .section "The Received: header line" "SECID227"
30977 .cindex "&'Received:'& header line"
30978 A &'Received:'& header line is added at the start of every message. The
30979 contents are defined by the &%received_header_text%& configuration option, and
30980 Exim automatically adds a semicolon and a timestamp to the configured string.
30981
30982 The &'Received:'& header is generated as soon as the message's header lines
30983 have been received. At this stage, the timestamp in the &'Received:'& header
30984 line is the time that the message started to be received. This is the value
30985 that is seen by the DATA ACL and by the &[local_scan()]& function.
30986
30987 Once a message is accepted, the timestamp in the &'Received:'& header line is
30988 changed to the time of acceptance, which is (apart from a small delay while the
30989 -H spool file is written) the earliest time at which delivery could start.
30990
30991
30992 .section "The References: header line" "SECID228"
30993 .cindex "&'References:'& header line"
30994 Messages created by the &(autoreply)& transport include a &'References:'&
30995 header line. This is constructed according to the rules that are described in
30996 section 3.64 of RFC 2822 (which states that replies should contain such a
30997 header line), and section 3.14 of RFC 3834 (which states that automatic
30998 responses are not different in this respect). However, because some mail
30999 processing software does not cope well with very long header lines, no more
31000 than 12 message IDs are copied from the &'References:'& header line in the
31001 incoming message. If there are more than 12, the first one and then the final
31002 11 are copied, before adding the message ID of the incoming message.
31003
31004
31005
31006 .section "The Return-path: header line" "SECID229"
31007 .cindex "&'Return-path:'& header line"
31008 .oindex "&%return_path_remove%&"
31009 &'Return-path:'& header lines are defined as something an MTA may insert when
31010 it does the final delivery of messages. (See the generic &%return_path_add%&
31011 transport option.) Therefore, they should not be present in messages in
31012 transit. If the &%return_path_remove%& configuration option is set (the
31013 default), Exim removes &'Return-path:'& header lines from incoming messages.
31014
31015
31016
31017 .section "The Sender: header line" "SECTthesenhea"
31018 .cindex "&'Sender:'& header line"
31019 .cindex "message" "submission"
31020 For a locally-originated message from an untrusted user, Exim may remove an
31021 existing &'Sender:'& header line, and it may add a new one. You can modify
31022 these actions by setting the &%local_sender_retain%& option true, the
31023 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31024 control setting.
31025
31026 When a local message is received from an untrusted user and
31027 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31028 control has not been set, a check is made to see if the address given in the
31029 &'From:'& header line is the correct (local) sender of the message. The address
31030 that is expected has the login name as the local part and the value of
31031 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31032 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31033 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31034 line is added to the message.
31035
31036 If you set &%local_from_check%& false, this checking does not occur. However,
31037 the removal of an existing &'Sender:'& line still happens, unless you also set
31038 &%local_sender_retain%& to be true. It is not possible to set both of these
31039 options true at the same time.
31040
31041 .cindex "submission mode"
31042 By default, no processing of &'Sender:'& header lines is done for messages
31043 received over TCP/IP or for messages submitted by trusted users. However, when
31044 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31045 not specified on the submission control, the following processing takes place:
31046
31047 .vindex "&$authenticated_id$&"
31048 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31049 authenticated, and &$authenticated_id$& is not empty, a sender address is
31050 created as follows:
31051
31052 .ilist
31053 .vindex "&$qualify_domain$&"
31054 If no domain is specified by the submission control, the local part is
31055 &$authenticated_id$& and the domain is &$qualify_domain$&.
31056 .next
31057 If a non-empty domain is specified by the submission control, the local part
31058 is &$authenticated_id$&, and the domain is the specified domain.
31059 .next
31060 If an empty domain is specified by the submission control,
31061 &$authenticated_id$& is assumed to be the complete address.
31062 .endlist
31063
31064 This address is compared with the address in the &'From:'& header line. If they
31065 are different, a &'Sender:'& header line containing the created address is
31066 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31067 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31068
31069 .cindex "return path" "created from &'Sender:'&"
31070 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31071 the message (the envelope sender address) is changed to be the same address,
31072 except in the case of submission mode when &%sender_retain%& is specified.
31073
31074
31075
31076 .section "Adding and removing header lines in routers and transports" &&&
31077          "SECTheadersaddrem"
31078 .cindex "header lines" "adding; in router or transport"
31079 .cindex "header lines" "removing; in router or transport"
31080 When a message is delivered, the addition and removal of header lines can be
31081 specified in a system filter, or on any of the routers and transports that
31082 process the message. Section &<<SECTaddremheasys>>& contains details about
31083 modifying headers in a system filter. Header lines can also be added in an ACL
31084 as a message is received (see section &<<SECTaddheadacl>>&).
31085
31086 In contrast to what happens in a system filter, header modifications that are
31087 specified on routers and transports apply only to the particular recipient
31088 addresses that are being processed by those routers and transports. These
31089 changes do not actually take place until a copy of the message is being
31090 transported. Therefore, they do not affect the basic set of header lines, and
31091 they do not affect the values of the variables that refer to header lines.
31092
31093 &*Note*&: In particular, this means that any expansions in the configuration of
31094 the transport cannot refer to the modified header lines, because such
31095 expansions all occur before the message is actually transported.
31096
31097 For both routers and transports, the result of expanding a &%headers_add%&
31098 option must be in the form of one or more RFC 2822 header lines, separated by
31099 newlines (coded as &"\n"&). For example:
31100 .code
31101 headers_add = X-added-header: added by $primary_hostname\n\
31102               X-added-second: another added header line
31103 .endd
31104 Exim does not check the syntax of these added header lines.
31105
31106 The result of expanding &%headers_remove%& must consist of a colon-separated
31107 list of header names. This is confusing, because header names themselves are
31108 often terminated by colons. In this case, the colons are the list separators,
31109 not part of the names. For example:
31110 .code
31111 headers_remove = return-receipt-to:acknowledge-to
31112 .endd
31113 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31114 is expanded at routing time, and then associated with all addresses that are
31115 accepted by that router, and also with any new addresses that it generates. If
31116 an address passes through several routers as a result of aliasing or
31117 forwarding, the changes are cumulative.
31118
31119 .oindex "&%unseen%&"
31120 However, this does not apply to multiple routers that result from the use of
31121 the &%unseen%& option. Any header modifications that were specified by the
31122 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31123
31124 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31125 settings cannot be delivered together in a batch, so a transport is always
31126 dealing with a set of addresses that have the same header-processing
31127 requirements.
31128
31129 The transport starts by writing the original set of header lines that arrived
31130 with the message, possibly modified by the system filter. As it writes out
31131 these lines, it consults the list of header names that were attached to the
31132 recipient address(es) by &%headers_remove%& options in routers, and it also
31133 consults the transport's own &%headers_remove%& option. Header lines whose
31134 names are on either of these lists are not written out. If there are multiple
31135 instances of any listed header, they are all skipped.
31136
31137 After the remaining original header lines have been written, new header
31138 lines that were specified by routers' &%headers_add%& options are written, in
31139 the order in which they were attached to the address. These are followed by any
31140 header lines specified by the transport's &%headers_add%& option.
31141
31142 This way of handling header line modifications in routers and transports has
31143 the following consequences:
31144
31145 .ilist
31146 The original set of header lines, possibly modified by the system filter,
31147 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31148 to it, at all times.
31149 .next
31150 Header lines that are added by a router's
31151 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31152 expansion syntax in subsequent routers or the transport.
31153 .next
31154 Conversely, header lines that are specified for removal by &%headers_remove%&
31155 in a router remain visible to subsequent routers and the transport.
31156 .next
31157 Headers added to an address by &%headers_add%& in a router cannot be removed by
31158 a later router or by a transport.
31159 .next
31160 An added header can refer to the contents of an original header that is to be
31161 removed, even it has the same name as the added header. For example:
31162 .code
31163 headers_remove = subject
31164 headers_add = Subject: new subject (was: $h_subject:)
31165 .endd
31166 .endlist
31167
31168 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31169 for a &(redirect)& router that has the &%one_time%& option set.
31170
31171
31172
31173
31174
31175 .section "Constructed addresses" "SECTconstr"
31176 .cindex "address" "constructed"
31177 .cindex "constructed address"
31178 When Exim constructs a sender address for a locally-generated message, it uses
31179 the form
31180 .display
31181 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31182 .endd
31183 For example:
31184 .code
31185 Zaphod Beeblebrox <zaphod@end.univ.example>
31186 .endd
31187 The user name is obtained from the &%-F%& command line option if set, or
31188 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31189 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31190 ampersand character, this is replaced by the login name with the first letter
31191 upper cased, as is conventional in a number of operating systems. See the
31192 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31193 The &%unknown_username%& option can be used to specify user names in cases when
31194 there is no password file entry.
31195
31196 .cindex "RFC 2047"
31197 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31198 parts of it if necessary. In addition, if it contains any non-printing
31199 characters, it is encoded as described in RFC 2047, which defines a way of
31200 including non-ASCII characters in header lines. The value of the
31201 &%headers_charset%& option specifies the name of the encoding that is used (the
31202 characters are assumed to be in this encoding). The setting of
31203 &%print_topbitchars%& controls whether characters with the top bit set (that
31204 is, with codes greater than 127) count as printing characters or not.
31205
31206
31207
31208 .section "Case of local parts" "SECID230"
31209 .cindex "case of local parts"
31210 .cindex "local part" "case of"
31211 RFC 2822 states that the case of letters in the local parts of addresses cannot
31212 be assumed to be non-significant. Exim preserves the case of local parts of
31213 addresses, but by default it uses a lower-cased form when it is routing,
31214 because on most Unix systems, usernames are in lower case and case-insensitive
31215 routing is required. However, any particular router can be made to use the
31216 original case for local parts by setting the &%caseful_local_part%& generic
31217 router option.
31218
31219 .cindex "mixed-case login names"
31220 If you must have mixed-case user names on your system, the best way to proceed,
31221 assuming you want case-independent handling of incoming email, is to set up
31222 your first router to convert incoming local parts in your domains to the
31223 correct case by means of a file lookup. For example:
31224 .code
31225 correct_case:
31226   driver = redirect
31227   domains = +local_domains
31228   data = ${lookup{$local_part}cdb\
31229               {/etc/usercased.cdb}{$value}fail}\
31230               @$domain
31231 .endd
31232 For this router, the local part is forced to lower case by the default action
31233 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31234 up a new local part in the correct case. If you then set &%caseful_local_part%&
31235 on any subsequent routers which process your domains, they will operate on
31236 local parts with the correct case in a case-sensitive manner.
31237
31238
31239
31240 .section "Dots in local parts" "SECID231"
31241 .cindex "dot" "in local part"
31242 .cindex "local part" "dots in"
31243 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31244 part may not begin or end with a dot, nor have two consecutive dots in the
31245 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31246 empty components for compatibility.
31247
31248
31249
31250 .section "Rewriting addresses" "SECID232"
31251 .cindex "rewriting" "addresses"
31252 Rewriting of sender and recipient addresses, and addresses in headers, can
31253 happen automatically, or as the result of configuration options, as described
31254 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31255 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31256
31257 Automatic rewriting includes qualification, as mentioned above. The other case
31258 in which it can happen is when an incomplete non-local domain is given. The
31259 routing process may cause this to be expanded into the full domain name. For
31260 example, a header such as
31261 .code
31262 To: hare@teaparty
31263 .endd
31264 might get rewritten as
31265 .code
31266 To: hare@teaparty.wonderland.fict.example
31267 .endd
31268 Rewriting as a result of routing is the one kind of message processing that
31269 does not happen at input time, as it cannot be done until the address has
31270 been routed.
31271
31272 Strictly, one should not do &'any'& deliveries of a message until all its
31273 addresses have been routed, in case any of the headers get changed as a
31274 result of routing. However, doing this in practice would hold up many
31275 deliveries for unreasonable amounts of time, just because one address could not
31276 immediately be routed. Exim therefore does not delay other deliveries when
31277 routing of one or more addresses is deferred.
31278 .ecindex IIDmesproc
31279
31280
31281
31282 . ////////////////////////////////////////////////////////////////////////////
31283 . ////////////////////////////////////////////////////////////////////////////
31284
31285 .chapter "SMTP processing" "CHAPSMTP"
31286 .scindex IIDsmtpproc1 "SMTP" "processing details"
31287 .scindex IIDsmtpproc2 "LMTP" "processing details"
31288 Exim supports a number of different ways of using the SMTP protocol, and its
31289 LMTP variant, which is an interactive protocol for transferring messages into a
31290 closed mail store application. This chapter contains details of how SMTP is
31291 processed. For incoming mail, the following are available:
31292
31293 .ilist
31294 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31295 .next
31296 SMTP over the standard input and output (the &%-bs%& option);
31297 .next
31298 Batched SMTP on the standard input (the &%-bS%& option).
31299 .endlist
31300
31301 For mail delivery, the following are available:
31302
31303 .ilist
31304 SMTP over TCP/IP (the &(smtp)& transport);
31305 .next
31306 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31307 &"lmtp"&);
31308 .next
31309 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31310 transport);
31311 .next
31312 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31313 the &%use_bsmtp%& option set).
31314 .endlist
31315
31316 &'Batched SMTP'& is the name for a process in which batches of messages are
31317 stored in or read from files (or pipes), in a format in which SMTP commands are
31318 used to contain the envelope information.
31319
31320
31321
31322 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31323 .cindex "SMTP" "outgoing over TCP/IP"
31324 .cindex "outgoing SMTP over TCP/IP"
31325 .cindex "LMTP" "over TCP/IP"
31326 .cindex "outgoing LMTP over TCP/IP"
31327 .cindex "EHLO"
31328 .cindex "HELO"
31329 .cindex "SIZE option on MAIL command"
31330 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31331 The &%protocol%& option selects which protocol is to be used, but the actual
31332 processing is the same in both cases.
31333
31334 If, in response to its EHLO command, Exim is told that the SIZE
31335 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31336 command. The value of <&'n'&> is the message size plus the value of the
31337 &%size_addition%& option (default 1024) to allow for additions to the message
31338 such as per-transport header lines, or changes made in a
31339 .cindex "transport" "filter"
31340 .cindex "filter" "transport filter"
31341 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31342 suppressed.
31343
31344 If the remote server advertises support for PIPELINING, Exim uses the
31345 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31346 required for the transaction.
31347
31348 If the remote server advertises support for the STARTTLS command, and Exim
31349 was built to support TLS encryption, it tries to start a TLS session unless the
31350 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31351
31352 If the remote server advertises support for the AUTH command, Exim scans
31353 the authenticators configuration for any suitable client settings, as described
31354 in chapter &<<CHAPSMTPAUTH>>&.
31355
31356 .cindex "carriage return"
31357 .cindex "linefeed"
31358 Responses from the remote host are supposed to be terminated by CR followed by
31359 LF. However, there are known to be hosts that do not send CR characters, so in
31360 order to be able to interwork with such hosts, Exim treats LF on its own as a
31361 line terminator.
31362
31363 If a message contains a number of different addresses, all those with the same
31364 characteristics (for example, the same envelope sender) that resolve to the
31365 same set of hosts, in the same order, are sent in a single SMTP transaction,
31366 even if they are for different domains, unless there are more than the setting
31367 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31368 they are split into groups containing no more than &%max_rcpt%&s addresses
31369 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31370 in parallel sessions. The order of hosts with identical MX values is not
31371 significant when checking whether addresses can be batched in this way.
31372
31373 When the &(smtp)& transport suffers a temporary failure that is not
31374 message-related, Exim updates its transport-specific database, which contains
31375 records indexed by host name that remember which messages are waiting for each
31376 particular host. It also updates the retry database with new retry times.
31377
31378 .cindex "hints database" "retry keys"
31379 Exim's retry hints are based on host name plus IP address, so if one address of
31380 a multi-homed host is broken, it will soon be skipped most of the time.
31381 See the next section for more detail about error handling.
31382
31383 .cindex "SMTP" "passed connection"
31384 .cindex "SMTP" "batching over TCP/IP"
31385 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31386 looks in the hints database for the transport to see if there are any queued
31387 messages waiting for the host to which it is connected. If it finds one, it
31388 creates a new Exim process using the &%-MC%& option (which can only be used by
31389 a process running as root or the Exim user) and passes the TCP/IP socket to it
31390 so that it can deliver another message using the same socket. The new process
31391 does only those deliveries that are routed to the connected host, and may in
31392 turn pass the socket on to a third process, and so on.
31393
31394 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31395 limit the number of messages sent down a single TCP/IP connection.
31396
31397 .cindex "asterisk" "after IP address"
31398 The second and subsequent messages delivered down an existing connection are
31399 identified in the main log by the addition of an asterisk after the closing
31400 square bracket of the IP address.
31401
31402
31403
31404
31405 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31406 .cindex "error" "in outgoing SMTP"
31407 .cindex "SMTP" "errors in outgoing"
31408 .cindex "host" "error"
31409 Three different kinds of error are recognized for outgoing SMTP: host errors,
31410 message errors, and recipient errors.
31411
31412 .vlist
31413 .vitem "&*Host errors*&"
31414 A host error is not associated with a particular message or with a
31415 particular recipient of a message. The host errors are:
31416
31417 .ilist
31418 Connection refused or timed out,
31419 .next
31420 Any error response code on connection,
31421 .next
31422 Any error response code to EHLO or HELO,
31423 .next
31424 Loss of connection at any time, except after &"."&,
31425 .next
31426 I/O errors at any time,
31427 .next
31428 Timeouts during the session, other than in response to MAIL, RCPT or
31429 the &"."& at the end of the data.
31430 .endlist ilist
31431
31432 For a host error, a permanent error response on connection, or in response to
31433 EHLO, causes all addresses routed to the host to be failed. Any other host
31434 error causes all addresses to be deferred, and retry data to be created for the
31435 host. It is not tried again, for any message, until its retry time arrives. If
31436 the current set of addresses are not all delivered in this run (to some
31437 alternative host), the message is added to the list of those waiting for this
31438 host, so if it is still undelivered when a subsequent successful delivery is
31439 made to the host, it will be sent down the same SMTP connection.
31440
31441 .vitem "&*Message errors*&"
31442 .cindex "message" "error"
31443 A message error is associated with a particular message when sent to a
31444 particular host, but not with a particular recipient of the message. The
31445 message errors are:
31446
31447 .ilist
31448 Any error response code to MAIL, DATA, or the &"."& that terminates
31449 the data,
31450 .next
31451 Timeout after MAIL,
31452 .next
31453 Timeout or loss of connection after the &"."& that terminates the data. A
31454 timeout after the DATA command itself is treated as a host error, as is loss of
31455 connection at any other time.
31456 .endlist ilist
31457
31458 For a message error, a permanent error response (5&'xx'&) causes all addresses
31459 to be failed, and a delivery error report to be returned to the sender. A
31460 temporary error response (4&'xx'&), or one of the timeouts, causes all
31461 addresses to be deferred. Retry data is not created for the host, but instead,
31462 a retry record for the combination of host plus message id is created. The
31463 message is not added to the list of those waiting for this host. This ensures
31464 that the failing message will not be sent to this host again until the retry
31465 time arrives. However, other messages that are routed to the host are not
31466 affected, so if it is some property of the message that is causing the error,
31467 it will not stop the delivery of other mail.
31468
31469 If the remote host specified support for the SIZE parameter in its response
31470 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31471 over-large message will cause a message error because the error arrives as a
31472 response to MAIL.
31473
31474 .vitem "&*Recipient errors*&"
31475 .cindex "recipient" "error"
31476 A recipient error is associated with a particular recipient of a message. The
31477 recipient errors are:
31478
31479 .ilist
31480 Any error response to RCPT,
31481 .next
31482 Timeout after RCPT.
31483 .endlist
31484
31485 For a recipient error, a permanent error response (5&'xx'&) causes the
31486 recipient address to be failed, and a bounce message to be returned to the
31487 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
31488 address to be deferred, and routing retry data to be created for it. This is
31489 used to delay processing of the address in subsequent queue runs, until its
31490 routing retry time arrives. This applies to all messages, but because it
31491 operates only in queue runs, one attempt will be made to deliver a new message
31492 to the failing address before the delay starts to operate. This ensures that,
31493 if the failure is really related to the message rather than the recipient
31494 (&"message too big for this recipient"& is a possible example), other messages
31495 have a chance of getting delivered. If a delivery to the address does succeed,
31496 the retry information gets cleared, so all stuck messages get tried again, and
31497 the retry clock is reset.
31498
31499 The message is not added to the list of those waiting for this host. Use of the
31500 host for other messages is unaffected, and except in the case of a timeout,
31501 other recipients are processed independently, and may be successfully delivered
31502 in the current SMTP session. After a timeout it is of course impossible to
31503 proceed with the session, so all addresses get deferred. However, those other
31504 than the one that failed do not suffer any subsequent retry delays. Therefore,
31505 if one recipient is causing trouble, the others have a chance of getting
31506 through when a subsequent delivery attempt occurs before the failing
31507 recipient's retry time.
31508 .endlist
31509
31510 In all cases, if there are other hosts (or IP addresses) available for the
31511 current set of addresses (for example, from multiple MX records), they are
31512 tried in this run for any undelivered addresses, subject of course to their
31513 own retry data. In other words, recipient error retry data does not take effect
31514 until the next delivery attempt.
31515
31516 Some hosts have been observed to give temporary error responses to every
31517 MAIL command at certain times (&"insufficient space"& has been seen). It
31518 would be nice if such circumstances could be recognized, and defer data for the
31519 host itself created, but this is not possible within the current Exim design.
31520 What actually happens is that retry data for every (host, message) combination
31521 is created.
31522
31523 The reason that timeouts after MAIL and RCPT are treated specially is that
31524 these can sometimes arise as a result of the remote host's verification
31525 procedures. Exim makes this assumption, and treats them as if a temporary error
31526 response had been received. A timeout after &"."& is treated specially because
31527 it is known that some broken implementations fail to recognize the end of the
31528 message if the last character of the last line is a binary zero. Thus, it is
31529 helpful to treat this case as a message error.
31530
31531 Timeouts at other times are treated as host errors, assuming a problem with the
31532 host, or the connection to it. If a timeout after MAIL, RCPT,
31533 or &"."& is really a connection problem, the assumption is that at the next try
31534 the timeout is likely to occur at some other point in the dialogue, causing it
31535 then to be treated as a host error.
31536
31537 There is experimental evidence that some MTAs drop the connection after the
31538 terminating &"."& if they do not like the contents of the message for some
31539 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
31540 should be given. That is why Exim treats this case as a message rather than a
31541 host error, in order not to delay other messages to the same host.
31542
31543
31544
31545
31546 .section "Incoming SMTP messages over TCP/IP" "SECID233"
31547 .cindex "SMTP" "incoming over TCP/IP"
31548 .cindex "incoming SMTP over TCP/IP"
31549 .cindex "inetd"
31550 .cindex "daemon"
31551 Incoming SMTP messages can be accepted in one of two ways: by running a
31552 listening daemon, or by using &'inetd'&. In the latter case, the entry in
31553 &_/etc/inetd.conf_& should be like this:
31554 .code
31555 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
31556 .endd
31557 Exim distinguishes between this case and the case of a locally running user
31558 agent using the &%-bs%& option by checking whether or not the standard input is
31559 a socket. When it is, either the port must be privileged (less than 1024), or
31560 the caller must be root or the Exim user. If any other user passes a socket
31561 with an unprivileged port number, Exim prints a message on the standard error
31562 stream and exits with an error code.
31563
31564 By default, Exim does not make a log entry when a remote host connects or
31565 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
31566 unexpected. It can be made to write such log entries by setting the
31567 &%smtp_connection%& log selector.
31568
31569 .cindex "carriage return"
31570 .cindex "linefeed"
31571 Commands from the remote host are supposed to be terminated by CR followed by
31572 LF. However, there are known to be hosts that do not send CR characters. In
31573 order to be able to interwork with such hosts, Exim treats LF on its own as a
31574 line terminator.
31575 Furthermore, because common code is used for receiving messages from all
31576 sources, a CR on its own is also interpreted as a line terminator. However, the
31577 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
31578
31579 .cindex "EHLO" "invalid data"
31580 .cindex "HELO" "invalid data"
31581 One area that sometimes gives rise to problems concerns the EHLO or
31582 HELO commands. Some clients send syntactically invalid versions of these
31583 commands, which Exim rejects by default. (This is nothing to do with verifying
31584 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
31585 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
31586 match the broken hosts that send invalid commands.
31587
31588 .cindex "SIZE option on MAIL command"
31589 .cindex "MAIL" "SIZE option"
31590 The amount of disk space available is checked whenever SIZE is received on
31591 a MAIL command, independently of whether &%message_size_limit%& or
31592 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
31593 false. A temporary error is given if there is not enough space. If
31594 &%check_spool_space%& is set, the check is for that amount of space plus the
31595 value given with SIZE, that is, it checks that the addition of the incoming
31596 message will not reduce the space below the threshold.
31597
31598 When a message is successfully received, Exim includes the local message id in
31599 its response to the final &"."& that terminates the data. If the remote host
31600 logs this text it can help with tracing what has happened to a message.
31601
31602 The Exim daemon can limit the number of simultaneous incoming connections it is
31603 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
31604 number of simultaneous incoming connections from a single remote host (see the
31605 &%smtp_accept_max_per_host%& option). Additional connection attempts are
31606 rejected using the SMTP temporary error code 421.
31607
31608 The Exim daemon does not rely on the SIGCHLD signal to detect when a
31609 subprocess has finished, as this can get lost at busy times. Instead, it looks
31610 for completed subprocesses every time it wakes up. Provided there are other
31611 things happening (new incoming calls, starts of queue runs), completed
31612 processes will be noticed and tidied away. On very quiet systems you may
31613 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
31614 it will be noticed when the daemon next wakes up.
31615
31616 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
31617 and can also be set up to reject SMTP calls from non-reserved hosts at times of
31618 high system load &-- for details see the &%smtp_accept_reserve%&,
31619 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
31620 applies in both the daemon and &'inetd'& cases.
31621
31622 Exim normally starts a delivery process for each message received, though this
31623 can be varied by means of the &%-odq%& command line option and the
31624 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
31625 number of simultaneously running delivery processes started in this way from
31626 SMTP input can be limited by the &%smtp_accept_queue%& and
31627 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
31628 subsequently received messages are just put on the input queue without starting
31629 a delivery process.
31630
31631 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
31632 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
31633 started up from the &'inetd'& daemon, because in that case each connection is
31634 handled by an entirely independent Exim process. Control by load average is,
31635 however, available with &'inetd'&.
31636
31637 Exim can be configured to verify addresses in incoming SMTP commands as they
31638 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
31639 to rewrite addresses at this time &-- before any syntax checking is done. See
31640 section &<<SECTrewriteS>>&.
31641
31642 Exim can also be configured to limit the rate at which a client host submits
31643 MAIL and RCPT commands in a single SMTP session. See the
31644 &%smtp_ratelimit_hosts%& option.
31645
31646
31647
31648 .section "Unrecognized SMTP commands" "SECID234"
31649 .cindex "SMTP" "unrecognized commands"
31650 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
31651 commands during a single SMTP connection, it drops the connection after sending
31652 the error response to the last command. The default value for
31653 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
31654 abuse that subvert web servers into making connections to SMTP ports; in these
31655 circumstances, a number of non-SMTP lines are sent first.
31656
31657
31658 .section "Syntax and protocol errors in SMTP commands" "SECID235"
31659 .cindex "SMTP" "syntax errors"
31660 .cindex "SMTP" "protocol errors"
31661 A syntax error is detected if an SMTP command is recognized, but there is
31662 something syntactically wrong with its data, for example, a malformed email
31663 address in a RCPT command. Protocol errors include invalid command
31664 sequencing such as RCPT before MAIL. If Exim receives more than
31665 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
31666 drops the connection after sending the error response to the last command. The
31667 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
31668 broken clients that loop sending bad commands (yes, it has been seen).
31669
31670
31671
31672 .section "Use of non-mail SMTP commands" "SECID236"
31673 .cindex "SMTP" "non-mail commands"
31674 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
31675 DATA. Exim counts such commands, and drops the connection if there are too
31676 many of them in a single SMTP session. This action catches some
31677 denial-of-service attempts and things like repeated failing AUTHs, or a mad
31678 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
31679 defines what &"too many"& means. Its default value is 10.
31680
31681 When a new message is expected, one occurrence of RSET is not counted. This
31682 allows a client to send one RSET between messages (this is not necessary,
31683 but some clients do it). Exim also allows one uncounted occurrence of HELO
31684 or EHLO, and one occurrence of STARTTLS between messages. After
31685 starting up a TLS session, another EHLO is expected, and so it too is not
31686 counted.
31687
31688 The first occurrence of AUTH in a connection, or immediately following
31689 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31690 RCPT, DATA, and QUIT are counted.
31691
31692 You can control which hosts are subject to the limit set by
31693 &%smtp_accept_max_nonmail%& by setting
31694 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31695 the limit apply to all hosts. This option means that you can exclude any
31696 specific badly-behaved hosts that you have to live with.
31697
31698
31699
31700
31701 .section "The VRFY and EXPN commands" "SECID237"
31702 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31703 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31704 appropriate) in order to decide whether the command should be accepted or not.
31705 If no ACL is defined, the command is rejected.
31706
31707 .cindex "VRFY" "processing"
31708 When VRFY is accepted, it runs exactly the same code as when Exim is
31709 called with the &%-bv%& option.
31710
31711 .cindex "EXPN" "processing"
31712 When EXPN is accepted, a single-level expansion of the address is done.
31713 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31714 than a verification (the &%-bv%& option). If an unqualified local part is given
31715 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31716 of VRFY and EXPN commands are logged on the main and reject logs, and
31717 VRFY verification failures are logged on the main log for consistency with
31718 RCPT failures.
31719
31720
31721
31722 .section "The ETRN command" "SECTETRN"
31723 .cindex "ETRN" "processing"
31724 RFC 1985 describes an SMTP command called ETRN that is designed to
31725 overcome the security problems of the TURN command (which has fallen into
31726 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31727 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31728 should be accepted or not. If no ACL is defined, the command is rejected.
31729
31730 The ETRN command is concerned with &"releasing"& messages that are awaiting
31731 delivery to certain hosts. As Exim does not organize its message queue by host,
31732 the only form of ETRN that is supported by default is the one where the
31733 text starts with the &"#"& prefix, in which case the remainder of the text is
31734 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31735 the &%-R%& option to happen, with the remainder of the ETRN text as its
31736 argument. For example,
31737 .code
31738 ETRN #brigadoon
31739 .endd
31740 runs the command
31741 .code
31742 exim -R brigadoon
31743 .endd
31744 which causes a delivery attempt on all messages with undelivered addresses
31745 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31746 default), Exim prevents the simultaneous execution of more than one queue run
31747 for the same argument string as a result of an ETRN command. This stops
31748 a misbehaving client from starting more than one queue runner at once.
31749
31750 .cindex "hints database" "ETRN serialization"
31751 Exim implements the serialization by means of a hints database in which a
31752 record is written whenever a process is started by ETRN, and deleted when
31753 the process completes. However, Exim does not keep the SMTP session waiting for
31754 the ETRN process to complete. Once ETRN is accepted, the client is sent
31755 a &"success"& return code. Obviously there is scope for hints records to get
31756 left lying around if there is a system or program crash. To guard against this,
31757 Exim ignores any records that are more than six hours old.
31758
31759 .oindex "&%smtp_etrn_command%&"
31760 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31761 used. This specifies a command that is run whenever ETRN is received,
31762 whatever the form of its argument. For
31763 example:
31764 .code
31765 smtp_etrn_command = /etc/etrn_command $domain \
31766                     $sender_host_address
31767 .endd
31768 .vindex "&$domain$&"
31769 The string is split up into arguments which are independently expanded. The
31770 expansion variable &$domain$& is set to the argument of the ETRN command,
31771 and no syntax checking is done on the contents of this argument. Exim does not
31772 wait for the command to complete, so its status code is not checked. Exim runs
31773 under its own uid and gid when receiving incoming SMTP, so it is not possible
31774 for it to change them before running the command.
31775
31776
31777
31778 .section "Incoming local SMTP" "SECID238"
31779 .cindex "SMTP" "local incoming"
31780 Some user agents use SMTP to pass messages to their local MTA using the
31781 standard input and output, as opposed to passing the envelope on the command
31782 line and writing the message to the standard input. This is supported by the
31783 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31784 messages over TCP/IP (including the use of ACLs), except that the envelope
31785 sender given in a MAIL command is ignored unless the caller is trusted. In
31786 an ACL you can detect this form of SMTP input by testing for an empty host
31787 identification. It is common to have this as the first line in the ACL that
31788 runs for RCPT commands:
31789 .code
31790 accept hosts = :
31791 .endd
31792 This accepts SMTP messages from local processes without doing any other tests.
31793
31794
31795
31796 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31797 .cindex "SMTP" "batched outgoing"
31798 .cindex "batched SMTP output"
31799 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31800 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31801 be output in BSMTP format. No SMTP responses are possible for this form of
31802 delivery. All it is doing is using SMTP commands as a way of transmitting the
31803 envelope along with the message.
31804
31805 The message is written to the file or pipe preceded by the SMTP commands
31806 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31807 the message that start with a dot have an extra dot added. The SMTP command
31808 HELO is not normally used. If it is required, the &%message_prefix%& option
31809 can be used to specify it.
31810
31811 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31812 one recipient address at a time by default. However, you can arrange for them
31813 to handle several addresses at once by setting the &%batch_max%& option. When
31814 this is done for BSMTP, messages may contain multiple RCPT commands. See
31815 chapter &<<CHAPbatching>>& for more details.
31816
31817 .vindex "&$host$&"
31818 When one or more addresses are routed to a BSMTP transport by a router that
31819 sets up a host list, the name of the first host on the list is available to the
31820 transport in the variable &$host$&. Here is an example of such a transport and
31821 router:
31822 .code
31823 begin routers
31824 route_append:
31825   driver = manualroute
31826   transport = smtp_appendfile
31827   route_list = domain.example  batch.host.example
31828
31829 begin transports
31830 smtp_appendfile:
31831   driver = appendfile
31832   directory = /var/bsmtp/$host
31833   batch_max = 1000
31834   use_bsmtp
31835   user = exim
31836 .endd
31837 This causes messages addressed to &'domain.example'& to be written in BSMTP
31838 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31839 message (unless there are more than 1000 recipients).
31840
31841
31842
31843 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31844 .cindex "SMTP" "batched incoming"
31845 .cindex "batched SMTP input"
31846 The &%-bS%& command line option causes Exim to accept one or more messages by
31847 reading SMTP on the standard input, but to generate no responses. If the caller
31848 is trusted, the senders in the MAIL commands are believed; otherwise the
31849 sender is always the caller of Exim. Unqualified senders and receivers are not
31850 rejected (there seems little point) but instead just get qualified. HELO
31851 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31852 as NOOP; QUIT quits.
31853
31854 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31855 ACL is run in the same way as for non-SMTP local input.
31856
31857 If an error is detected while reading a message, including a missing &"."& at
31858 the end, Exim gives up immediately. It writes details of the error to the
31859 standard output in a stylized way that the calling program should be able to
31860 make some use of automatically, for example:
31861 .code
31862 554 Unexpected end of file
31863 Transaction started in line 10
31864 Error detected in line 14
31865 .endd
31866 It writes a more verbose version, for human consumption, to the standard error
31867 file, for example:
31868 .code
31869 An error was detected while processing a file of BSMTP input.
31870 The error message was:
31871
31872 501 '>' missing at end of address
31873
31874 The SMTP transaction started in line 10.
31875 The error was detected in line 12.
31876 The SMTP command at fault was:
31877
31878 rcpt to:<malformed@in.com.plete
31879
31880 1 previous message was successfully processed.
31881 The rest of the batch was abandoned.
31882 .endd
31883 The return code from Exim is zero only if there were no errors. It is 1 if some
31884 messages were accepted before an error was detected, and 2 if no messages were
31885 accepted.
31886 .ecindex IIDsmtpproc1
31887 .ecindex IIDsmtpproc2
31888
31889
31890
31891 . ////////////////////////////////////////////////////////////////////////////
31892 . ////////////////////////////////////////////////////////////////////////////
31893
31894 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31895          "Customizing messages"
31896 When a message fails to be delivered, or remains on the queue for more than a
31897 configured amount of time, Exim sends a message to the original sender, or
31898 to an alternative configured address. The text of these messages is built into
31899 the code of Exim, but it is possible to change it, either by adding a single
31900 string, or by replacing each of the paragraphs by text supplied in a file.
31901
31902 The &'From:'& and &'To:'& header lines are automatically generated; you can
31903 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31904 option. Exim also adds the line
31905 .code
31906 Auto-Submitted: auto-generated
31907 .endd
31908 to all warning and bounce messages,
31909
31910
31911 .section "Customizing bounce messages" "SECID239"
31912 .cindex "customizing" "bounce message"
31913 .cindex "bounce message" "customizing"
31914 If &%bounce_message_text%& is set, its contents are included in the default
31915 message immediately after &"This message was created automatically by mail
31916 delivery software."& The string is not expanded. It is not used if
31917 &%bounce_message_file%& is set.
31918
31919 When &%bounce_message_file%& is set, it must point to a template file for
31920 constructing error messages. The file consists of a series of text items,
31921 separated by lines consisting of exactly four asterisks. If the file cannot be
31922 opened, default text is used and a message is written to the main and panic
31923 logs. If any text item in the file is empty, default text is used for that
31924 item.
31925
31926 .vindex "&$bounce_recipient$&"
31927 .vindex "&$bounce_return_size_limit$&"
31928 Each item of text that is read from the file is expanded, and there are two
31929 expansion variables which can be of use here: &$bounce_recipient$& is set to
31930 the recipient of an error message while it is being created, and
31931 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31932 option, rounded to a whole number.
31933
31934 The items must appear in the file in the following order:
31935
31936 .ilist
31937 The first item is included in the headers, and should include at least a
31938 &'Subject:'& header. Exim does not check the syntax of these headers.
31939 .next
31940 The second item forms the start of the error message. After it, Exim lists the
31941 failing addresses with their error messages.
31942 .next
31943 The third item is used to introduce any text from pipe transports that is to be
31944 returned to the sender. It is omitted if there is no such text.
31945 .next
31946 The fourth item is used to introduce the copy of the message that is returned
31947 as part of the error report.
31948 .next
31949 The fifth item is added after the fourth one if the returned message is
31950 truncated because it is bigger than &%return_size_limit%&.
31951 .next
31952 The sixth item is added after the copy of the original message.
31953 .endlist
31954
31955 The default state (&%bounce_message_file%& unset) is equivalent to the
31956 following file, in which the sixth item is empty. The &'Subject:'& and some
31957 other lines have been split in order to fit them on the page:
31958 .code
31959 Subject: Mail delivery failed
31960   ${if eq{$sender_address}{$bounce_recipient}
31961   {: returning message to sender}}
31962 ****
31963 This message was created automatically by mail delivery software.
31964
31965 A message ${if eq{$sender_address}{$bounce_recipient}
31966   {that you sent }{sent by
31967
31968 <$sender_address>
31969
31970 }}could not be delivered to all of its recipients.
31971 This is a permanent error. The following address(es) failed:
31972 ****
31973 The following text was generated during the delivery attempt(s):
31974 ****
31975 ------ This is a copy of the message, including all the headers.
31976   ------
31977 ****
31978 ------ The body of the message is $message_size characters long;
31979   only the first
31980 ------ $bounce_return_size_limit or so are included here.
31981 ****
31982 .endd
31983 .section "Customizing warning messages" "SECTcustwarn"
31984 .cindex "customizing" "warning message"
31985 .cindex "warning of delay" "customizing the message"
31986 The option &%warn_message_file%& can be pointed at a template file for use when
31987 warnings about message delays are created. In this case there are only three
31988 text sections:
31989
31990 .ilist
31991 The first item is included in the headers, and should include at least a
31992 &'Subject:'& header. Exim does not check the syntax of these headers.
31993 .next
31994 The second item forms the start of the warning message. After it, Exim lists
31995 the delayed addresses.
31996 .next
31997 The third item then ends the message.
31998 .endlist
31999
32000 The default state is equivalent to the following file, except that some lines
32001 have been split here, in order to fit them on the page:
32002 .code
32003 Subject: Warning: message $message_exim_id delayed
32004   $warn_message_delay
32005 ****
32006 This message was created automatically by mail delivery software.
32007
32008 A message ${if eq{$sender_address}{$warn_message_recipients}
32009 {that you sent }{sent by
32010
32011 <$sender_address>
32012
32013 }}has not been delivered to all of its recipients after
32014 more than $warn_message_delay on the queue on $primary_hostname.
32015
32016 The message identifier is:     $message_exim_id
32017 The subject of the message is: $h_subject
32018 The date of the message is:    $h_date
32019
32020 The following address(es) have not yet been delivered:
32021 ****
32022 No action is required on your part. Delivery attempts will
32023 continue for some time, and this warning may be repeated at
32024 intervals if the message remains undelivered. Eventually the
32025 mail delivery software will give up, and when that happens,
32026 the message will be returned to you.
32027 .endd
32028 .vindex "&$warn_message_delay$&"
32029 .vindex "&$warn_message_recipients$&"
32030 However, in the default state the subject and date lines are omitted if no
32031 appropriate headers exist. During the expansion of this file,
32032 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32033 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32034 of recipients for the warning message. There may be more than one if there are
32035 multiple addresses with different &%errors_to%& settings on the routers that
32036 handled them.
32037
32038
32039
32040
32041 . ////////////////////////////////////////////////////////////////////////////
32042 . ////////////////////////////////////////////////////////////////////////////
32043
32044 .chapter "Some common configuration settings" "CHAPcomconreq"
32045 This chapter discusses some configuration settings that seem to be fairly
32046 common. More examples and discussion can be found in the Exim book.
32047
32048
32049
32050 .section "Sending mail to a smart host" "SECID240"
32051 .cindex "smart host" "example router"
32052 If you want to send all mail for non-local domains to a &"smart host"&, you
32053 should replace the default &(dnslookup)& router with a router which does the
32054 routing explicitly:
32055 .code
32056 send_to_smart_host:
32057   driver = manualroute
32058   route_list = !+local_domains smart.host.name
32059   transport = remote_smtp
32060 .endd
32061 You can use the smart host's IP address instead of the name if you wish.
32062 If you are using Exim only to submit messages to a smart host, and not for
32063 receiving incoming messages, you can arrange for it to do the submission
32064 synchronously by setting the &%mua_wrapper%& option (see chapter
32065 &<<CHAPnonqueueing>>&).
32066
32067
32068
32069
32070 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32071 .cindex "mailing lists"
32072 Exim can be used to run simple mailing lists, but for large and/or complicated
32073 requirements, the use of additional specialized mailing list software such as
32074 Majordomo or Mailman is recommended.
32075
32076 The &(redirect)& router can be used to handle mailing lists where each list
32077 is maintained in a separate file, which can therefore be managed by an
32078 independent manager. The &%domains%& router option can be used to run these
32079 lists in a separate domain from normal mail. For example:
32080 .code
32081 lists:
32082   driver = redirect
32083   domains = lists.example
32084   file = /usr/lists/$local_part
32085   forbid_pipe
32086   forbid_file
32087   errors_to = $local_part-request@lists.example
32088   no_more
32089 .endd
32090 This router is skipped for domains other than &'lists.example'&. For addresses
32091 in that domain, it looks for a file that matches the local part. If there is no
32092 such file, the router declines, but because &%no_more%& is set, no subsequent
32093 routers are tried, and so the whole delivery fails.
32094
32095 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32096 expanded into a file name or a pipe delivery, which is usually inappropriate in
32097 a mailing list.
32098
32099 .oindex "&%errors_to%&"
32100 The &%errors_to%& option specifies that any delivery errors caused by addresses
32101 taken from a mailing list are to be sent to the given address rather than the
32102 original sender of the message. However, before acting on this, Exim verifies
32103 the error address, and ignores it if verification fails.
32104
32105 For example, using the configuration above, mail sent to
32106 &'dicts@lists.example'& is passed on to those addresses contained in
32107 &_/usr/lists/dicts_&, with error reports directed to
32108 &'dicts-request@lists.example'&, provided that this address can be verified.
32109 There could be a file called &_/usr/lists/dicts-request_& containing
32110 the address(es) of this particular list's manager(s), but other approaches,
32111 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32112 or &%local_part_suffix%& options) to handle addresses of the form
32113 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32114
32115
32116
32117 .section "Syntax errors in mailing lists" "SECID241"
32118 .cindex "mailing lists" "syntax errors in"
32119 If an entry in redirection data contains a syntax error, Exim normally defers
32120 delivery of the original address. That means that a syntax error in a mailing
32121 list holds up all deliveries to the list. This may not be appropriate when a
32122 list is being maintained automatically from data supplied by users, and the
32123 addresses are not rigorously checked.
32124
32125 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32126 entries that fail to parse, noting the incident in the log. If in addition
32127 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32128 whenever a broken address is skipped. It is usually appropriate to set
32129 &%syntax_errors_to%& to the same address as &%errors_to%&.
32130
32131
32132
32133 .section "Re-expansion of mailing lists" "SECID242"
32134 .cindex "mailing lists" "re-expansion of"
32135 Exim remembers every individual address to which a message has been delivered,
32136 in order to avoid duplication, but it normally stores only the original
32137 recipient addresses with a message. If all the deliveries to a mailing list
32138 cannot be done at the first attempt, the mailing list is re-expanded when the
32139 delivery is next tried. This means that alterations to the list are taken into
32140 account at each delivery attempt, so addresses that have been added to
32141 the list since the message arrived will therefore receive a copy of the
32142 message, even though it pre-dates their subscription.
32143
32144 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32145 on the &(redirect)& router. If this is done, any addresses generated by the
32146 router that fail to deliver at the first attempt are added to the message as
32147 &"top level"& addresses, and the parent address that generated them is marked
32148 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32149 subsequent delivery attempts. The disadvantage of this is that if any of the
32150 failing addresses are incorrect, correcting them in the file has no effect on
32151 pre-existing messages.
32152
32153 The original top-level address is remembered with each of the generated
32154 addresses, and is output in any log messages. However, any intermediate parent
32155 addresses are not recorded. This makes a difference to the log only if the
32156 &%all_parents%& selector is set, but for mailing lists there is normally only
32157 one level of expansion anyway.
32158
32159
32160
32161 .section "Closed mailing lists" "SECID243"
32162 .cindex "mailing lists" "closed"
32163 The examples so far have assumed open mailing lists, to which anybody may
32164 send mail. It is also possible to set up closed lists, where mail is accepted
32165 from specified senders only. This is done by making use of the generic
32166 &%senders%& option to restrict the router that handles the list.
32167
32168 The following example uses the same file as a list of recipients and as a list
32169 of permitted senders. It requires three routers:
32170 .code
32171 lists_request:
32172   driver = redirect
32173   domains = lists.example
32174   local_part_suffix = -request
32175   file = /usr/lists/$local_part$local_part_suffix
32176   no_more
32177
32178 lists_post:
32179   driver = redirect
32180   domains = lists.example
32181   senders = ${if exists {/usr/lists/$local_part}\
32182              {lsearch;/usr/lists/$local_part}{*}}
32183   file = /usr/lists/$local_part
32184   forbid_pipe
32185   forbid_file
32186   errors_to = $local_part-request@lists.example
32187   no_more
32188
32189 lists_closed:
32190   driver = redirect
32191   domains = lists.example
32192   allow_fail
32193   data = :fail: $local_part@lists.example is a closed mailing list
32194 .endd
32195 All three routers have the same &%domains%& setting, so for any other domains,
32196 they are all skipped. The first router runs only if the local part ends in
32197 &%-request%&. It handles messages to the list manager(s) by means of an open
32198 mailing list.
32199
32200 The second router runs only if the &%senders%& precondition is satisfied. It
32201 checks for the existence of a list that corresponds to the local part, and then
32202 checks that the sender is on the list by means of a linear search. It is
32203 necessary to check for the existence of the file before trying to search it,
32204 because otherwise Exim thinks there is a configuration error. If the file does
32205 not exist, the expansion of &%senders%& is *, which matches all senders. This
32206 means that the router runs, but because there is no list, declines, and
32207 &%no_more%& ensures that no further routers are run. The address fails with an
32208 &"unrouteable address"& error.
32209
32210 The third router runs only if the second router is skipped, which happens when
32211 a mailing list exists, but the sender is not on it. This router forcibly fails
32212 the address, giving a suitable error message.
32213
32214
32215
32216
32217 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32218 .cindex "VERP"
32219 .cindex "Variable Envelope Return Paths"
32220 .cindex "envelope sender"
32221 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32222 are a way of helping mailing list administrators discover which subscription
32223 address is the cause of a particular delivery failure. The idea is to encode
32224 the original recipient address in the outgoing envelope sender address, so that
32225 if the message is forwarded by another host and then subsequently bounces, the
32226 original recipient can be extracted from the recipient address of the bounce.
32227
32228 .oindex &%errors_to%&
32229 .oindex &%return_path%&
32230 Envelope sender addresses can be modified by Exim using two different
32231 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32232 list examples), or the &%return_path%& option on a transport. The second of
32233 these is effective only if the message is successfully delivered to another
32234 host; it is not used for errors detected on the local host (see the description
32235 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32236 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32237 .code
32238 verp_smtp:
32239   driver = smtp
32240   max_rcpt = 1
32241   return_path = \
32242     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32243       {$1-request+$local_part=$domain@your.dom.example}fail}
32244 .endd
32245 This has the effect of rewriting the return path (envelope sender) on outgoing
32246 SMTP messages, if the local part of the original return path ends in
32247 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32248 local part and domain of the recipient into the return path. Suppose, for
32249 example, that a message whose return path has been set to
32250 &'somelist-request@your.dom.example'& is sent to
32251 &'subscriber@other.dom.example'&. In the transport, the return path is
32252 rewritten as
32253 .code
32254 somelist-request+subscriber=other.dom.example@your.dom.example
32255 .endd
32256 .vindex "&$local_part$&"
32257 For this to work, you must tell Exim to send multiple copies of messages that
32258 have more than one recipient, so that each copy has just one recipient. This is
32259 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32260 might be sent to several different recipients in the same domain, in which case
32261 &$local_part$& is not available in the transport, because it is not unique.
32262
32263 Unless your host is doing nothing but mailing list deliveries, you should
32264 probably use a separate transport for the VERP deliveries, so as not to use
32265 extra resources in making one-per-recipient copies for other deliveries. This
32266 can easily be done by expanding the &%transport%& option in the router:
32267 .code
32268 dnslookup:
32269   driver = dnslookup
32270   domains = ! +local_domains
32271   transport = \
32272     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32273       {verp_smtp}{remote_smtp}}
32274   no_more
32275 .endd
32276 If you want to change the return path using &%errors_to%& in a router instead
32277 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32278 routers that handle mailing list addresses. This will ensure that all delivery
32279 errors, including those detected on the local host, are sent to the VERP
32280 address.
32281
32282 On a host that does no local deliveries and has no manual routing, only the
32283 &(dnslookup)& router needs to be changed. A special transport is not needed for
32284 SMTP deliveries. Every mailing list recipient has its own return path value,
32285 and so Exim must hand them to the transport one at a time. Here is an example
32286 of a &(dnslookup)& router that implements VERP:
32287 .code
32288 verp_dnslookup:
32289   driver = dnslookup
32290   domains = ! +local_domains
32291   transport = remote_smtp
32292   errors_to = \
32293     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32294      {$1-request+$local_part=$domain@your.dom.example}fail}
32295   no_more
32296 .endd
32297 Before you start sending out messages with VERPed return paths, you must also
32298 configure Exim to accept the bounce messages that come back to those paths.
32299 Typically this is done by setting a &%local_part_suffix%& option for a
32300 router, and using this to route the messages to wherever you want to handle
32301 them.
32302
32303 The overhead incurred in using VERP depends very much on the size of the
32304 message, the number of recipient addresses that resolve to the same remote
32305 host, and the speed of the connection over which the message is being sent. If
32306 a lot of addresses resolve to the same host and the connection is slow, sending
32307 a separate copy of the message for each address may take substantially longer
32308 than sending a single copy with many recipients (for which VERP cannot be
32309 used).
32310
32311
32312
32313
32314
32315
32316 .section "Virtual domains" "SECTvirtualdomains"
32317 .cindex "virtual domains"
32318 .cindex "domain" "virtual"
32319 The phrase &'virtual domain'& is unfortunately used with two rather different
32320 meanings:
32321
32322 .ilist
32323 A domain for which there are no real mailboxes; all valid local parts are
32324 aliases for other email addresses. Common examples are organizational
32325 top-level domains and &"vanity"& domains.
32326 .next
32327 One of a number of independent domains that are all handled by the same host,
32328 with mailboxes on that host, but where the mailbox owners do not necessarily
32329 have login accounts on that host.
32330 .endlist
32331
32332 The first usage is probably more common, and does seem more &"virtual"& than
32333 the second. This kind of domain can be handled in Exim with a straightforward
32334 aliasing router. One approach is to create a separate alias file for each
32335 virtual domain. Exim can test for the existence of the alias file to determine
32336 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32337 to a router of this form:
32338 .code
32339 virtual:
32340   driver = redirect
32341   domains = dsearch;/etc/mail/virtual
32342   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32343   no_more
32344 .endd
32345 The &%domains%& option specifies that the router is to be skipped, unless there
32346 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32347 domain that is being processed. When the router runs, it looks up the local
32348 part in the file to find a new address (or list of addresses). The &%no_more%&
32349 setting ensures that if the lookup fails (leading to &%data%& being an empty
32350 string), Exim gives up on the address without trying any subsequent routers.
32351
32352 This one router can handle all the virtual domains because the alias file names
32353 follow a fixed pattern. Permissions can be arranged so that appropriate people
32354 can edit the different alias files. A successful aliasing operation results in
32355 a new envelope recipient address, which is then routed from scratch.
32356
32357 The other kind of &"virtual"& domain can also be handled in a straightforward
32358 way. One approach is to create a file for each domain containing a list of
32359 valid local parts, and use it in a router like this:
32360 .code
32361 my_domains:
32362   driver = accept
32363   domains = dsearch;/etc/mail/domains
32364   local_parts = lsearch;/etc/mail/domains/$domain
32365   transport = my_mailboxes
32366 .endd
32367 The address is accepted if there is a file for the domain, and the local part
32368 can be found in the file. The &%domains%& option is used to check for the
32369 file's existence because &%domains%& is tested before the &%local_parts%&
32370 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32371 because that option is tested after &%local_parts%&. The transport is as
32372 follows:
32373 .code
32374 my_mailboxes:
32375   driver = appendfile
32376   file = /var/mail/$domain/$local_part
32377   user = mail
32378 .endd
32379 This uses a directory of mailboxes for each domain. The &%user%& setting is
32380 required, to specify which uid is to be used for writing to the mailboxes.
32381
32382 The configuration shown here is just one example of how you might support this
32383 requirement. There are many other ways this kind of configuration can be set
32384 up, for example, by using a database instead of separate files to hold all the
32385 information about the domains.
32386
32387
32388
32389 .section "Multiple user mailboxes" "SECTmulbox"
32390 .cindex "multiple mailboxes"
32391 .cindex "mailbox" "multiple"
32392 .cindex "local part" "prefix"
32393 .cindex "local part" "suffix"
32394 Heavy email users often want to operate with multiple mailboxes, into which
32395 incoming mail is automatically sorted. A popular way of handling this is to
32396 allow users to use multiple sender addresses, so that replies can easily be
32397 identified. Users are permitted to add prefixes or suffixes to their local
32398 parts for this purpose. The wildcard facility of the generic router options
32399 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32400 example, consider this router:
32401 .code
32402 userforward:
32403   driver = redirect
32404   check_local_user
32405   file = $home/.forward
32406   local_part_suffix = -*
32407   local_part_suffix_optional
32408   allow_filter
32409 .endd
32410 .vindex "&$local_part_suffix$&"
32411 It runs a user's &_.forward_& file for all local parts of the form
32412 &'username-*'&. Within the filter file the user can distinguish different
32413 cases by testing the variable &$local_part_suffix$&. For example:
32414 .code
32415 if $local_part_suffix contains -special then
32416 save /home/$local_part/Mail/special
32417 endif
32418 .endd
32419 If the filter file does not exist, or does not deal with such addresses, they
32420 fall through to subsequent routers, and, assuming no subsequent use of the
32421 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32422 control over which suffixes are valid.
32423
32424 Alternatively, a suffix can be used to trigger the use of a different
32425 &_.forward_& file &-- which is the way a similar facility is implemented in
32426 another MTA:
32427 .code
32428 userforward:
32429   driver = redirect
32430   check_local_user
32431   file = $home/.forward$local_part_suffix
32432   local_part_suffix = -*
32433   local_part_suffix_optional
32434   allow_filter
32435 .endd
32436 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32437 example, &_.forward-special_& is used. Once again, if the appropriate file
32438 does not exist, or does not deal with the address, it is passed on to
32439 subsequent routers, which could, if required, look for an unqualified
32440 &_.forward_& file to use as a default.
32441
32442
32443
32444 .section "Simplified vacation processing" "SECID244"
32445 .cindex "vacation processing"
32446 The traditional way of running the &'vacation'& program is for a user to set up
32447 a pipe command in a &_.forward_& file
32448 (see section &<<SECTspecitredli>>& for syntax details).
32449 This is prone to error by inexperienced users. There are two features of Exim
32450 that can be used to make this process simpler for users:
32451
32452 .ilist
32453 A local part prefix such as &"vacation-"& can be specified on a router which
32454 can cause the message to be delivered directly to the &'vacation'& program, or
32455 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32456 &_.forward_& file are then much simpler. For example:
32457 .code
32458 spqr, vacation-spqr
32459 .endd
32460 .next
32461 The &%require_files%& generic router option can be used to trigger a
32462 vacation delivery by checking for the existence of a certain file in the
32463 user's home directory. The &%unseen%& generic option should also be used, to
32464 ensure that the original delivery also proceeds. In this case, all the user has
32465 to do is to create a file called, say, &_.vacation_&, containing a vacation
32466 message.
32467 .endlist
32468
32469 Another advantage of both these methods is that they both work even when the
32470 use of arbitrary pipes by users is locked out.
32471
32472
32473
32474 .section "Taking copies of mail" "SECID245"
32475 .cindex "message" "copying every"
32476 Some installations have policies that require archive copies of all messages to
32477 be made. A single copy of each message can easily be taken by an appropriate
32478 command in a system filter, which could, for example, use a different file for
32479 each day's messages.
32480
32481 There is also a shadow transport mechanism that can be used to take copies of
32482 messages that are successfully delivered by local transports, one copy per
32483 delivery. This could be used, &'inter alia'&, to implement automatic
32484 notification of delivery by sites that insist on doing such things.
32485
32486
32487
32488 .section "Intermittently connected hosts" "SECID246"
32489 .cindex "intermittently connected hosts"
32490 It has become quite common (because it is cheaper) for hosts to connect to the
32491 Internet periodically rather than remain connected all the time. The normal
32492 arrangement is that mail for such hosts accumulates on a system that is
32493 permanently connected.
32494
32495 Exim was designed for use on permanently connected hosts, and so it is not
32496 particularly well-suited to use in an intermittently connected environment.
32497 Nevertheless there are some features that can be used.
32498
32499
32500 .section "Exim on the upstream server host" "SECID247"
32501 It is tempting to arrange for incoming mail for the intermittently connected
32502 host to remain on Exim's queue until the client connects. However, this
32503 approach does not scale very well. Two different kinds of waiting message are
32504 being mixed up in the same queue &-- those that cannot be delivered because of
32505 some temporary problem, and those that are waiting for their destination host
32506 to connect. This makes it hard to manage the queue, as well as wasting
32507 resources, because each queue runner scans the entire queue.
32508
32509 A better approach is to separate off those messages that are waiting for an
32510 intermittently connected host. This can be done by delivering these messages
32511 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
32512 format, from where they are transmitted by other software when their
32513 destination connects. This makes it easy to collect all the mail for one host
32514 in a single directory, and to apply local timeout rules on a per-message basis
32515 if required.
32516
32517 On a very small scale, leaving the mail on Exim's queue can be made to work. If
32518 you are doing this, you should configure Exim with a long retry period for the
32519 intermittent host. For example:
32520 .code
32521 cheshire.wonderland.fict.example    *   F,5d,24h
32522 .endd
32523 This stops a lot of failed delivery attempts from occurring, but Exim remembers
32524 which messages it has queued up for that host. Once the intermittent host comes
32525 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
32526 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
32527 causes all the queued up messages to be delivered, often down a single SMTP
32528 connection. While the host remains connected, any new messages get delivered
32529 immediately.
32530
32531 If the connecting hosts do not have fixed IP addresses, that is, if a host is
32532 issued with a different IP address each time it connects, Exim's retry
32533 mechanisms on the holding host get confused, because the IP address is normally
32534 used as part of the key string for holding retry information. This can be
32535 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
32536 Since this has disadvantages for permanently connected hosts, it is best to
32537 arrange a separate transport for the intermittently connected ones.
32538
32539
32540
32541 .section "Exim on the intermittently connected client host" "SECID248"
32542 The value of &%smtp_accept_queue_per_connection%& should probably be
32543 increased, or even set to zero (that is, disabled) on the intermittently
32544 connected host, so that all incoming messages down a single connection get
32545 delivered immediately.
32546
32547 .cindex "SMTP" "passed connection"
32548 .cindex "SMTP" "multiple deliveries"
32549 .cindex "multiple SMTP deliveries"
32550 Mail waiting to be sent from an intermittently connected host will probably
32551 not have been routed, because without a connection DNS lookups are not
32552 possible. This means that if a normal queue run is done at connection time,
32553 each message is likely to be sent in a separate SMTP session. This can be
32554 avoided by starting the queue run with a command line option beginning with
32555 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
32556 first pass, routing is done but no deliveries take place. The second pass is a
32557 normal queue run; since all the messages have been previously routed, those
32558 destined for the same host are likely to get sent as multiple deliveries in a
32559 single SMTP connection.
32560
32561
32562
32563 . ////////////////////////////////////////////////////////////////////////////
32564 . ////////////////////////////////////////////////////////////////////////////
32565
32566 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
32567          "Exim as a non-queueing client"
32568 .cindex "client, non-queueing"
32569 .cindex "smart host" "suppressing queueing"
32570 On a personal computer, it is a common requirement for all
32571 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
32572 configured to operate that way, for all the popular operating systems.
32573 However, there are some MUAs for Unix-like systems that cannot be so
32574 configured: they submit messages using the command line interface of
32575 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
32576 messages this way.
32577
32578 If the personal computer runs continuously, there is no problem, because it can
32579 run a conventional MTA that handles delivery to the smart host, and deal with
32580 any delays via its queueing mechanism. However, if the computer does not run
32581 continuously or runs different operating systems at different times, queueing
32582 email is not desirable.
32583
32584 There is therefore a requirement for something that can provide the
32585 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
32586 any queueing or retrying facilities. Furthermore, the delivery to the smart
32587 host should be synchronous, so that if it fails, the sending MUA is immediately
32588 informed. In other words, we want something that extends an MUA that submits
32589 to a local MTA via the command line so that it behaves like one that submits
32590 to a remote smart host using TCP/SMTP.
32591
32592 There are a number of applications (for example, there is one called &'ssmtp'&)
32593 that do this job. However, people have found them to be lacking in various
32594 ways. For instance, you might want to allow aliasing and forwarding to be done
32595 before sending a message to the smart host.
32596
32597 Exim already had the necessary infrastructure for doing this job. Just a few
32598 tweaks were needed to make it behave as required, though it is somewhat of an
32599 overkill to use a fully-featured MTA for this purpose.
32600
32601 .oindex "&%mua_wrapper%&"
32602 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
32603 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
32604 assumes that it is being used to &"wrap"& a command-line MUA in the manner
32605 just described. As well as setting &%mua_wrapper%&, you also need to provide a
32606 compatible router and transport configuration. Typically there will be just one
32607 router and one transport, sending everything to a smart host.
32608
32609 When run in MUA wrapping mode, the behaviour of Exim changes in the
32610 following ways:
32611
32612 .ilist
32613 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
32614 In other words, the only way to submit messages is via the command line.
32615 .next
32616 Each message is synchronously delivered as soon as it is received (&%-odi%& is
32617 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
32618 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
32619 does not finish until the delivery attempt is complete. If the delivery is
32620 successful, a zero return code is given.
32621 .next
32622 Address redirection is permitted, but the final routing for all addresses must
32623 be to the same remote transport, and to the same list of hosts. Furthermore,
32624 the return address (envelope sender) must be the same for all recipients, as
32625 must any added or deleted header lines. In other words, it must be possible to
32626 deliver the message in a single SMTP transaction, however many recipients there
32627 are.
32628 .next
32629 If these conditions are not met, or if routing any address results in a
32630 failure or defer status, or if Exim is unable to deliver all the recipients
32631 successfully to one of the smart hosts, delivery of the entire message fails.
32632 .next
32633 Because no queueing is allowed, all failures are treated as permanent; there
32634 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
32635 smart host. Furthermore, because only a single yes/no response can be given to
32636 the caller, it is not possible to deliver to some recipients and not others. If
32637 there is an error (temporary or permanent) for any recipient, all are failed.
32638 .next
32639 If more than one smart host is listed, Exim will try another host after a
32640 connection failure or a timeout, in the normal way. However, if this kind of
32641 failure happens for all the hosts, the delivery fails.
32642 .next
32643 When delivery fails, an error message is written to the standard error stream
32644 (as well as to Exim's log), and Exim exits to the caller with a return code
32645 value 1. The message is expunged from Exim's spool files. No bounce messages
32646 are ever generated.
32647 .next
32648 No retry data is maintained, and any retry rules are ignored.
32649 .next
32650 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
32651 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
32652 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
32653 .endlist
32654
32655 The overall effect is that Exim makes a single synchronous attempt to deliver
32656 the message, failing if there is any kind of problem. Because no local
32657 deliveries are done and no daemon can be run, Exim does not need root
32658 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
32659 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
32660 the advantages and disadvantages of running without root privilege.
32661
32662
32663
32664
32665 . ////////////////////////////////////////////////////////////////////////////
32666 . ////////////////////////////////////////////////////////////////////////////
32667
32668 .chapter "Log files" "CHAPlog"
32669 .scindex IIDloggen "log" "general description"
32670 .cindex "log" "types of"
32671 Exim writes three different logs, referred to as the main log, the reject log,
32672 and the panic log:
32673
32674 .ilist
32675 .cindex "main log"
32676 The main log records the arrival of each message and each delivery in a single
32677 line in each case. The format is as compact as possible, in an attempt to keep
32678 down the size of log files. Two-character flag sequences make it easy to pick
32679 out these lines. A number of other events are recorded in the main log. Some of
32680 them are optional, in which case the &%log_selector%& option controls whether
32681 they are included or not. A Perl script called &'eximstats'&, which does simple
32682 analysis of main log files, is provided in the Exim distribution (see section
32683 &<<SECTmailstat>>&).
32684 .next
32685 .cindex "reject log"
32686 The reject log records information from messages that are rejected as a result
32687 of a configuration option (that is, for policy reasons).
32688 The first line of each rejection is a copy of the line that is also written to
32689 the main log. Then, if the message's header has been read at the time the log
32690 is written, its contents are written to this log. Only the original header
32691 lines are available; header lines added by ACLs are not logged. You can use the
32692 reject log to check that your policy controls are working correctly; on a busy
32693 host this may be easier than scanning the main log for rejection messages. You
32694 can suppress the writing of the reject log by setting &%write_rejectlog%&
32695 false.
32696 .next
32697 .cindex "panic log"
32698 .cindex "system log"
32699 When certain serious errors occur, Exim writes entries to its panic log. If the
32700 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32701 are usually written to the main log as well, but can get lost amid the mass of
32702 other entries. The panic log should be empty under normal circumstances. It is
32703 therefore a good idea to check it (or to have a &'cron'& script check it)
32704 regularly, in order to become aware of any problems. When Exim cannot open its
32705 panic log, it tries as a last resort to write to the system log (syslog). This
32706 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32707 message itself is written at priority LOG_CRIT.
32708 .endlist
32709
32710 Every log line starts with a timestamp, in the format shown in the following
32711 example. Note that many of the examples shown in this chapter are line-wrapped.
32712 In the log file, this would be all on one line:
32713 .code
32714 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32715   by QUIT
32716 .endd
32717 By default, the timestamps are in the local timezone. There are two
32718 ways of changing this:
32719
32720 .ilist
32721 You can set the &%timezone%& option to a different time zone; in particular, if
32722 you set
32723 .code
32724 timezone = UTC
32725 .endd
32726 the timestamps will be in UTC (aka GMT).
32727 .next
32728 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32729 example:
32730 .code
32731 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32732 .endd
32733 .endlist
32734
32735 .cindex "log" "process ids in"
32736 .cindex "pid (process id)" "in log lines"
32737 Exim does not include its process id in log lines by default, but you can
32738 request that it does so by specifying the &`pid`& log selector (see section
32739 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32740 brackets, immediately after the time and date.
32741
32742
32743
32744
32745 .section "Where the logs are written" "SECTwhelogwri"
32746 .cindex "log" "destination"
32747 .cindex "log" "to file"
32748 .cindex "log" "to syslog"
32749 .cindex "syslog"
32750 The logs may be written to local files, or to syslog, or both. However, it
32751 should be noted that many syslog implementations use UDP as a transport, and
32752 are therefore unreliable in the sense that messages are not guaranteed to
32753 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32754 It has also been reported that on large log files (tens of megabytes) you may
32755 need to tweak syslog to prevent it syncing the file with each write &-- on
32756 Linux this has been seen to make syslog take 90% plus of CPU time.
32757
32758 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32759 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32760 configuration. This latter string is expanded, so it can contain, for example,
32761 references to the host name:
32762 .code
32763 log_file_path = /var/log/$primary_hostname/exim_%slog
32764 .endd
32765 It is generally advisable, however, to set the string in &_Local/Makefile_&
32766 rather than at run time, because then the setting is available right from the
32767 start of Exim's execution. Otherwise, if there's something it wants to log
32768 before it has read the configuration file (for example, an error in the
32769 configuration file) it will not use the path you want, and may not be able to
32770 log at all.
32771
32772 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32773 list, currently limited to at most two items. This is one option where the
32774 facility for changing a list separator may not be used. The list must always be
32775 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32776 otherwise the item must either be an absolute path, containing &`%s`& at the
32777 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32778 implying the use of a default path.
32779
32780 When Exim encounters an empty item in the list, it searches the list defined by
32781 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32782 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32783 mean &"use the path specified at build time"&. It no such item exists, log
32784 files are written in the &_log_& subdirectory of the spool directory. This is
32785 equivalent to the setting:
32786 .code
32787 log_file_path = $spool_directory/log/%slog
32788 .endd
32789 If you do not specify anything at build time or run time, that is where the
32790 logs are written.
32791
32792 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
32793 are in use &-- see section &<<SECTdatlogfil>>& below.
32794
32795 Here are some examples of possible settings:
32796 .display
32797 &`LOG_FILE_PATH=syslog                    `& syslog only
32798 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32799 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32800 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32801 .endd
32802 If there are more than two paths in the list, the first is used and a panic
32803 error is logged.
32804
32805
32806
32807 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32808 .cindex "log" "cycling local files"
32809 .cindex "cycling logs"
32810 .cindex "&'exicyclog'&"
32811 .cindex "log" "local files; writing to"
32812 Some operating systems provide centralized and standardized methods for cycling
32813 log files. For those that do not, a utility script called &'exicyclog'& is
32814 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32815 main and reject logs each time it is called. The maximum number of old logs to
32816 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32817
32818 An Exim delivery process opens the main log when it first needs to write to it,
32819 and it keeps the file open in case subsequent entries are required &-- for
32820 example, if a number of different deliveries are being done for the same
32821 message. However, remote SMTP deliveries can take a long time, and this means
32822 that the file may be kept open long after it is renamed if &'exicyclog'& or
32823 something similar is being used to rename log files on a regular basis. To
32824 ensure that a switch of log files is noticed as soon as possible, Exim calls
32825 &[stat()]& on the main log's name before reusing an open file, and if the file
32826 does not exist, or its inode has changed, the old file is closed and Exim
32827 tries to open the main log from scratch. Thus, an old log file may remain open
32828 for quite some time, but no Exim processes should write to it once it has been
32829 renamed.
32830
32831
32832
32833 .section "Datestamped log files" "SECTdatlogfil"
32834 .cindex "log" "datestamped files"
32835 Instead of cycling the main and reject log files by renaming them
32836 periodically, some sites like to use files whose names contain a datestamp,
32837 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
32838 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
32839 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
32840 point where the datestamp is required. For example:
32841 .code
32842 log_file_path = /var/spool/exim/log/%slog-%D
32843 log_file_path = /var/log/exim-%s-%D.log
32844 log_file_path = /var/spool/exim/log/%D-%slog
32845 log_file_path = /var/log/exim/%s.%M
32846 .endd
32847 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32848 examples of names generated by the above examples:
32849 .code
32850 /var/spool/exim/log/mainlog-20021225
32851 /var/log/exim-reject-20021225.log
32852 /var/spool/exim/log/20021225-mainlog
32853 /var/log/exim/main.200212
32854 .endd
32855 When this form of log file is specified, Exim automatically switches to new
32856 files at midnight. It does not make any attempt to compress old logs; you
32857 will need to write your own script if you require this. You should not
32858 run &'exicyclog'& with this form of logging.
32859
32860 The location of the panic log is also determined by &%log_file_path%&, but it
32861 is not datestamped, because rotation of the panic log does not make sense.
32862 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
32863 the string. In addition, if it immediately follows a slash, a following
32864 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
32865 character is removed. Thus, the four examples above would give these panic
32866 log names:
32867 .code
32868 /var/spool/exim/log/paniclog
32869 /var/log/exim-panic.log
32870 /var/spool/exim/log/paniclog
32871 /var/log/exim/panic
32872 .endd
32873
32874
32875 .section "Logging to syslog" "SECID249"
32876 .cindex "log" "syslog; writing to"
32877 The use of syslog does not change what Exim logs or the format of its messages,
32878 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32879 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32880 that, the same strings are written to syslog as to log files. The syslog
32881 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32882 by default, but you can change these by setting the &%syslog_facility%& and
32883 &%syslog_processname%& options, respectively. If Exim was compiled with
32884 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32885 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32886 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32887 the time and host name to each line.
32888 The three log streams are mapped onto syslog priorities as follows:
32889
32890 .ilist
32891 &'mainlog'& is mapped to LOG_INFO
32892 .next
32893 &'rejectlog'& is mapped to LOG_NOTICE
32894 .next
32895 &'paniclog'& is mapped to LOG_ALERT
32896 .endlist
32897
32898 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32899 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32900 these are routed by syslog to the same place. You can suppress this duplication
32901 by setting &%syslog_duplication%& false.
32902
32903 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32904 entries contain multiple lines when headers are included. To cope with both
32905 these cases, entries written to syslog are split into separate &[syslog()]&
32906 calls at each internal newline, and also after a maximum of
32907 870 data characters. (This allows for a total syslog line length of 1024, when
32908 additions such as timestamps are added.) If you are running a syslog
32909 replacement that can handle lines longer than the 1024 characters allowed by
32910 RFC 3164, you should set
32911 .code
32912 SYSLOG_LONG_LINES=yes
32913 .endd
32914 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32915 lines, but it still splits at internal newlines in &'reject'& log entries.
32916
32917 To make it easy to re-assemble split lines later, each component of a split
32918 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32919 where <&'n'&> is the component number and <&'m'&> is the total number of
32920 components in the entry. The / delimiter is used when the line was split
32921 because it was too long; if it was split because of an internal newline, the \
32922 delimiter is used. For example, supposing the length limit to be 50 instead of
32923 870, the following would be the result of a typical rejection message to
32924 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32925 name, and pid as added by syslog:
32926 .code
32927 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32928 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32929 [3/5]  when scanning for sender: missing or malformed lo
32930 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32931 [5/5] mple>)
32932 .endd
32933 The same error might cause the following lines to be written to &"rejectlog"&
32934 (LOG_NOTICE):
32935 .code
32936 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32937 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32938 [3/18] er when scanning for sender: missing or malformed
32939 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32940 [5\18] .example>)
32941 [6\18] Recipients: ph10@some.domain.cam.example
32942 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32943 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32944 [9\18]        id 16RdAL-0006pc-00
32945 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32946 [11\18] 09:43 +0100
32947 [12\18] F From: <>
32948 [13\18]   Subject: this is a test header
32949 [18\18]   X-something: this is another header
32950 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32951 [16\18] le>
32952 [17\18] B Bcc:
32953 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32954 .endd
32955 Log lines that are neither too long nor contain newlines are written to syslog
32956 without modification.
32957
32958 If only syslog is being used, the Exim monitor is unable to provide a log tail
32959 display, unless syslog is routing &'mainlog'& to a file on the local host and
32960 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32961 where it is.
32962
32963
32964
32965 .section "Log line flags" "SECID250"
32966 One line is written to the main log for each message received, and for each
32967 successful, unsuccessful, and delayed delivery. These lines can readily be
32968 picked out by the distinctive two-character flags that immediately follow the
32969 timestamp. The flags are:
32970 .display
32971 &`<=`&     message arrival
32972 &`=>`&     normal message delivery
32973 &`->`&     additional address in same delivery
32974 &`*>`&     delivery suppressed by &%-N%&
32975 &`**`&     delivery failed; address bounced
32976 &`==`&     delivery deferred; temporary problem
32977 .endd
32978
32979
32980 .section "Logging message reception" "SECID251"
32981 .cindex "log" "reception line"
32982 The format of the single-line entry in the main log that is written for every
32983 message received is shown in the basic example below, which is split over
32984 several lines in order to fit it on the page:
32985 .code
32986 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32987   H=mailer.fict.example [192.168.123.123] U=exim
32988   P=smtp S=5678 id=<incoming message id>
32989 .endd
32990 The address immediately following &"<="& is the envelope sender address. A
32991 bounce message is shown with the sender address &"<>"&, and if it is locally
32992 generated, this is followed by an item of the form
32993 .code
32994 R=<message id>
32995 .endd
32996 which is a reference to the message that caused the bounce to be sent.
32997
32998 .cindex "HELO"
32999 .cindex "EHLO"
33000 For messages from other hosts, the H and U fields identify the remote host and
33001 record the RFC 1413 identity of the user that sent the message, if one was
33002 received. The number given in square brackets is the IP address of the sending
33003 host. If there is a single, unparenthesized  host name in the H field, as
33004 above, it has been verified to correspond to the IP address (see the
33005 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33006 by the remote host in the SMTP HELO or EHLO command, and has not been
33007 verified. If verification yields a different name to that given for HELO or
33008 EHLO, the verified name appears first, followed by the HELO or EHLO
33009 name in parentheses.
33010
33011 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33012 without brackets, in the HELO or EHLO command, leading to entries in
33013 the log containing text like these examples:
33014 .code
33015 H=(10.21.32.43) [192.168.8.34]
33016 H=([10.21.32.43]) [192.168.8.34]
33017 .endd
33018 This can be confusing. Only the final address in square brackets can be relied
33019 on.
33020
33021 For locally generated messages (that is, messages not received over TCP/IP),
33022 the H field is omitted, and the U field contains the login name of the caller
33023 of Exim.
33024
33025 .cindex "authentication" "logging"
33026 .cindex "AUTH" "logging"
33027 For all messages, the P field specifies the protocol used to receive the
33028 message. This is the value that is stored in &$received_protocol$&. In the case
33029 of incoming SMTP messages, the value indicates whether or not any SMTP
33030 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33031 session was encrypted, there is an additional X field that records the cipher
33032 suite that was used.
33033
33034 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33035 hosts that have authenticated themselves using the SMTP AUTH command. The first
33036 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33037 there is an additional item A= followed by the name of the authenticator that
33038 was used. If an authenticated identification was set up by the authenticator's
33039 &%server_set_id%& option, this is logged too, separated by a colon from the
33040 authenticator name.
33041
33042 .cindex "size" "of message"
33043 The id field records the existing message id, if present. The size of the
33044 received message is given by the S field. When the message is delivered,
33045 headers may be removed or added, so that the size of delivered copies of the
33046 message may not correspond with this value (and indeed may be different to each
33047 other).
33048
33049 The &%log_selector%& option can be used to request the logging of additional
33050 data when a message is received. See section &<<SECTlogselector>>& below.
33051
33052
33053
33054 .section "Logging deliveries" "SECID252"
33055 .cindex "log" "delivery line"
33056 The format of the single-line entry in the main log that is written for every
33057 delivery is shown in one of the examples below, for local and remote
33058 deliveries, respectively. Each example has been split into two lines in order
33059 to fit it on the page:
33060 .code
33061 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33062   <marv@hitch.fict.example> R=localuser T=local_delivery
33063 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33064   monk@holistic.fict.example R=dnslookup T=remote_smtp
33065   H=holistic.fict.example [192.168.234.234]
33066 .endd
33067 For ordinary local deliveries, the original address is given in angle brackets
33068 after the final delivery address, which might be a pipe or a file. If
33069 intermediate address(es) exist between the original and the final address, the
33070 last of these is given in parentheses after the final address. The R and T
33071 fields record the router and transport that were used to process the address.
33072
33073 If a shadow transport was run after a successful local delivery, the log line
33074 for the successful delivery has an item added on the end, of the form
33075 .display
33076 &`ST=<`&&'shadow transport name'&&`>`&
33077 .endd
33078 If the shadow transport did not succeed, the error message is put in
33079 parentheses afterwards.
33080
33081 .cindex "asterisk" "after IP address"
33082 When more than one address is included in a single delivery (for example, two
33083 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33084 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33085 down a single SMTP connection, an asterisk follows the IP address in the log
33086 lines for the second and subsequent messages.
33087
33088 The generation of a reply message by a filter file gets logged as a
33089 &"delivery"& to the addressee, preceded by &">"&.
33090
33091 The &%log_selector%& option can be used to request the logging of additional
33092 data when a message is delivered. See section &<<SECTlogselector>>& below.
33093
33094
33095 .section "Discarded deliveries" "SECID253"
33096 .cindex "discarded messages"
33097 .cindex "message" "discarded"
33098 .cindex "delivery" "discarded; logging"
33099 When a message is discarded as a result of the command &"seen finish"& being
33100 obeyed in a filter file which generates no deliveries, a log entry of the form
33101 .code
33102 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33103   <low.club@bridge.example> R=userforward
33104 .endd
33105 is written, to record why no deliveries are logged. When a message is discarded
33106 because it is aliased to &":blackhole:"& the log line is like this:
33107 .code
33108 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33109   <hole@nowhere.example> R=blackhole_router
33110 .endd
33111
33112
33113 .section "Deferred deliveries" "SECID254"
33114 When a delivery is deferred, a line of the following form is logged:
33115 .code
33116 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33117   R=dnslookup T=smtp defer (146): Connection refused
33118 .endd
33119 In the case of remote deliveries, the error is the one that was given for the
33120 last IP address that was tried. Details of individual SMTP failures are also
33121 written to the log, so the above line would be preceded by something like
33122 .code
33123 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33124   mail1.endrest.example [192.168.239.239]: Connection refused
33125 .endd
33126 When a deferred address is skipped because its retry time has not been reached,
33127 a message is written to the log, but this can be suppressed by setting an
33128 appropriate value in &%log_selector%&.
33129
33130
33131
33132 .section "Delivery failures" "SECID255"
33133 .cindex "delivery" "failure; logging"
33134 If a delivery fails because an address cannot be routed, a line of the
33135 following form is logged:
33136 .code
33137 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33138   <jim@trek99.example>: unknown mail domain
33139 .endd
33140 If a delivery fails at transport time, the router and transport are shown, and
33141 the response from the remote host is included, as in this example:
33142 .code
33143 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33144   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33145   after pipelined RCPT TO:<ace400@pb.example>: host
33146   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33147   <ace400@pb.example>...Addressee unknown
33148 .endd
33149 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33150 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33151 disabling PIPELINING. The log lines for all forms of delivery failure are
33152 flagged with &`**`&.
33153
33154
33155
33156 .section "Fake deliveries" "SECID256"
33157 .cindex "delivery" "fake; logging"
33158 If a delivery does not actually take place because the &%-N%& option has been
33159 used to suppress it, a normal delivery line is written to the log, except that
33160 &"=>"& is replaced by &"*>"&.
33161
33162
33163
33164 .section "Completion" "SECID257"
33165 A line of the form
33166 .code
33167 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33168 .endd
33169 is written to the main log when a message is about to be removed from the spool
33170 at the end of its processing.
33171
33172
33173
33174
33175 .section "Summary of Fields in Log Lines" "SECID258"
33176 .cindex "log" "summary of fields"
33177 A summary of the field identifiers that are used in log lines is shown in
33178 the following table:
33179 .display
33180 &`A   `&        authenticator name (and optional id)
33181 &`C   `&        SMTP confirmation on delivery
33182 &`    `&        command list for &"no mail in SMTP session"&
33183 &`CV  `&        certificate verification status
33184 &`D   `&        duration of &"no mail in SMTP session"&
33185 &`DN  `&        distinguished name from peer certificate
33186 &`DT  `&        on &`=>`& lines: time taken for a delivery
33187 &`F   `&        sender address (on delivery lines)
33188 &`H   `&        host name and IP address
33189 &`I   `&        local interface used
33190 &`id  `&        message id for incoming message
33191 &`P   `&        on &`<=`& lines: protocol used
33192 &`    `&        on &`=>`& and &`**`& lines: return path
33193 &`QT  `&        on &`=>`& lines: time spent on queue so far
33194 &`    `&        on &"Completed"& lines: time spent on queue
33195 &`R   `&        on &`<=`& lines: reference for local bounce
33196 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33197 &`S   `&        size of message
33198 &`ST  `&        shadow transport name
33199 &`T   `&        on &`<=`& lines: message subject (topic)
33200 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33201 &`U   `&        local user or RFC 1413 identity
33202 &`X   `&        TLS cipher suite
33203 .endd
33204
33205
33206 .section "Other log entries" "SECID259"
33207 Various other types of log entry are written from time to time. Most should be
33208 self-explanatory. Among the more common are:
33209
33210 .ilist
33211 .cindex "retry" "time not reached"
33212 &'retry time not reached'&&~&~An address previously suffered a temporary error
33213 during routing or local delivery, and the time to retry has not yet arrived.
33214 This message is not written to an individual message log file unless it happens
33215 during the first delivery attempt.
33216 .next
33217 &'retry time not reached for any host'&&~&~An address previously suffered
33218 temporary errors during remote delivery, and the retry time has not yet arrived
33219 for any of the hosts to which it is routed.
33220 .next
33221 .cindex "spool directory" "file locked"
33222 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33223 some other Exim process is already working on the message. This can be quite
33224 common if queue running processes are started at frequent intervals. The
33225 &'exiwhat'& utility script can be used to find out what Exim processes are
33226 doing.
33227 .next
33228 .cindex "error" "ignored"
33229 &'error ignored'&&~&~There are several circumstances that give rise to this
33230 message:
33231 .olist
33232 Exim failed to deliver a bounce message whose age was greater than
33233 &%ignore_bounce_errors_after%&. The bounce was discarded.
33234 .next
33235 A filter file set up a delivery using the &"noerror"& option, and the delivery
33236 failed. The delivery was discarded.
33237 .next
33238 A delivery set up by a router configured with
33239 . ==== As this is a nested list, any displays it contains must be indented
33240 . ==== as otherwise they are too far to the left.
33241 .code
33242     errors_to = <>
33243 .endd
33244 failed. The delivery was discarded.
33245 .endlist olist
33246 .endlist ilist
33247
33248
33249
33250
33251
33252 .section "Reducing or increasing what is logged" "SECTlogselector"
33253 .cindex "log" "selectors"
33254 By setting the &%log_selector%& global option, you can disable some of Exim's
33255 default logging, or you can request additional logging. The value of
33256 &%log_selector%& is made up of names preceded by plus or minus characters. For
33257 example:
33258 .code
33259 log_selector = +arguments -retry_defer
33260 .endd
33261 The list of optional log items is in the following table, with the default
33262 selection marked by asterisks:
33263 .display
33264 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33265 &` address_rewrite            `&  address rewriting
33266 &` all_parents                `&  all parents in => lines
33267 &` arguments                  `&  command line arguments
33268 &`*connection_reject          `&  connection rejections
33269 &`*delay_delivery             `&  immediate delivery delayed
33270 &` deliver_time               `&  time taken to perform delivery
33271 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33272 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33273 &`*etrn                       `&  ETRN commands
33274 &`*host_lookup_failed         `&  as it says
33275 &` ident_timeout              `&  timeout for ident connection
33276 &` incoming_interface         `&  incoming interface on <= lines
33277 &` incoming_port              `&  incoming port on <= lines
33278 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33279 &` outgoing_port              `&  add remote port to => lines
33280 &`*queue_run                  `&  start and end queue runs
33281 &` queue_time                 `&  time on queue for one recipient
33282 &` queue_time_overall         `&  time on queue for whole message
33283 &` pid                        `&  Exim process id
33284 &` received_recipients        `&  recipients on <= lines
33285 &` received_sender            `&  sender on <= lines
33286 &`*rejected_header            `&  header contents on reject log
33287 &`*retry_defer                `&  &"retry time not reached"&
33288 &` return_path_on_delivery    `&  put return path on => and ** lines
33289 &` sender_on_delivery         `&  add sender to => lines
33290 &`*sender_verify_fail         `&  sender verification failures
33291 &`*size_reject                `&  rejection because too big
33292 &`*skip_delivery              `&  delivery skipped in a queue run
33293 &` smtp_confirmation          `&  SMTP confirmation on => lines
33294 &` smtp_connection            `&  SMTP connections
33295 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33296 &` smtp_no_mail               `&  session with no MAIL commands
33297 &` smtp_protocol_error        `&  SMTP protocol errors
33298 &` smtp_syntax_error          `&  SMTP syntax errors
33299 &` subject                    `&  contents of &'Subject:'& on <= lines
33300 &` tls_certificate_verified   `&  certificate verification status
33301 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33302 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33303 &` tls_sni                    `&  TLS SNI on <= lines
33304 &` unknown_in_list            `&  DNS lookup failed in list match
33305
33306 &` all                        `&  all of the above
33307 .endd
33308 More details on each of these items follows:
33309
33310 .ilist
33311 .cindex "&%warn%& ACL verb" "log when skipping"
33312 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33313 its conditions cannot be evaluated, a log line to this effect is written if
33314 this log selector is set.
33315 .next
33316 .cindex "log" "rewriting"
33317 .cindex "rewriting" "logging"
33318 &%address_rewrite%&: This applies both to global rewrites and per-transport
33319 rewrites, but not to rewrites in filters run as an unprivileged user (because
33320 such users cannot access the log).
33321 .next
33322 .cindex "log" "full parentage"
33323 &%all_parents%&: Normally only the original and final addresses are logged on
33324 delivery lines; with this selector, intermediate parents are given in
33325 parentheses between them.
33326 .next
33327 .cindex "log" "Exim arguments"
33328 .cindex "Exim arguments, logging"
33329 &%arguments%&: This causes Exim to write the arguments with which it was called
33330 to the main log, preceded by the current working directory. This is a debugging
33331 feature, added to make it easier to find out how certain MUAs call
33332 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33333 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33334 that are empty or that contain white space are quoted. Non-printing characters
33335 are shown as escape sequences. This facility cannot log unrecognized arguments,
33336 because the arguments are checked before the configuration file is read. The
33337 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33338 between the caller and Exim.
33339 .next
33340 .cindex "log" "connection rejections"
33341 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33342 connection is rejected, for whatever reason.
33343 .next
33344 .cindex "log" "delayed delivery"
33345 .cindex "delayed delivery, logging"
33346 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33347 started for an incoming message because the load is too high or too many
33348 messages were received on one connection. Logging does not occur if no delivery
33349 process is started because &%queue_only%& is set or &%-odq%& was used.
33350 .next
33351 .cindex "log" "delivery duration"
33352 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33353 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33354 .next
33355 .cindex "log" "message size on delivery"
33356 .cindex "size" "of message"
33357 &%delivery_size%&: For each delivery, the size of message delivered is added to
33358 the &"=>"& line, tagged with S=.
33359 .next
33360 .cindex "log" "dnslist defer"
33361 .cindex "DNS list" "logging defer"
33362 .cindex "black list (DNS)"
33363 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33364 DNS black list suffers a temporary error.
33365 .next
33366 .cindex "log" "ETRN commands"
33367 .cindex "ETRN" "logging"
33368 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33369 is run to determine whether or not it is actually accepted. An invalid ETRN
33370 command, or one received within a message transaction is not logged by this
33371 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33372 .next
33373 .cindex "log" "host lookup failure"
33374 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33375 any addresses, or when a lookup of an IP address fails to find a host name, a
33376 log line is written. This logging does not apply to direct DNS lookups when
33377 routing email addresses, but it does apply to &"byname"& lookups.
33378 .next
33379 .cindex "log" "ident timeout"
33380 .cindex "RFC 1413" "logging timeout"
33381 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33382 client's ident port times out.
33383 .next
33384 .cindex "log" "incoming interface"
33385 .cindex "interface" "logging"
33386 &%incoming_interface%&: The interface on which a message was received is added
33387 to the &"<="& line as an IP address in square brackets, tagged by I= and
33388 followed by a colon and the port number. The local interface and port are also
33389 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33390 rejection lines.
33391 .next
33392 .cindex "log" "incoming remote port"
33393 .cindex "port" "logging remote"
33394 .cindex "TCP/IP" "logging incoming remote port"
33395 .vindex "&$sender_fullhost$&"
33396 .vindex "&$sender_rcvhost$&"
33397 &%incoming_port%&: The remote port number from which a message was received is
33398 added to log entries and &'Received:'& header lines, following the IP address
33399 in square brackets, and separated from it by a colon. This is implemented by
33400 changing the value that is put in the &$sender_fullhost$& and
33401 &$sender_rcvhost$& variables. Recording the remote port number has become more
33402 important with the widening use of NAT (see RFC 2505).
33403 .next
33404 .cindex "log" "dropped connection"
33405 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33406 connection is unexpectedly dropped.
33407 .next
33408 .cindex "log" "outgoing remote port"
33409 .cindex "port" "logging outgoint remote"
33410 .cindex "TCP/IP" "logging ougtoing remote port"
33411 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33412 containing => tags) following the IP address. This option is not included in
33413 the default setting, because for most ordinary configurations, the remote port
33414 number is always 25 (the SMTP port).
33415 .next
33416 .cindex "log" "process ids in"
33417 .cindex "pid (process id)" "in log lines"
33418 &%pid%&: The current process id is added to every log line, in square brackets,
33419 immediately after the time and date.
33420 .next
33421 .cindex "log" "queue run"
33422 .cindex "queue runner" "logging"
33423 &%queue_run%&: The start and end of every queue run are logged.
33424 .next
33425 .cindex "log" "queue time"
33426 &%queue_time%&: The amount of time the message has been in the queue on the
33427 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33428 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33429 includes reception time as well as the delivery time for the current address.
33430 This means that it may be longer than the difference between the arrival and
33431 delivery log line times, because the arrival log line is not written until the
33432 message has been successfully received.
33433 .next
33434 &%queue_time_overall%&: The amount of time the message has been in the queue on
33435 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33436 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33437 message, so it includes reception time as well as the total delivery time.
33438 .next
33439 .cindex "log" "recipients"
33440 &%received_recipients%&: The recipients of a message are listed in the main log
33441 as soon as the message is received. The list appears at the end of the log line
33442 that is written when a message is received, preceded by the word &"for"&. The
33443 addresses are listed after they have been qualified, but before any rewriting
33444 has taken place.
33445 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33446 in the list.
33447 .next
33448 .cindex "log" "sender reception"
33449 &%received_sender%&: The unrewritten original sender of a message is added to
33450 the end of the log line that records the message's arrival, after the word
33451 &"from"& (before the recipients if &%received_recipients%& is also set).
33452 .next
33453 .cindex "log" "header lines for rejection"
33454 &%rejected_header%&: If a message's header has been received at the time a
33455 rejection is written to the reject log, the complete header is added to the
33456 log. Header logging can be turned off individually for messages that are
33457 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33458 .next
33459 .cindex "log" "retry defer"
33460 &%retry_defer%&: A log line is written if a delivery is deferred because a
33461 retry time has not yet been reached. However, this &"retry time not reached"&
33462 message is always omitted from individual message logs after the first delivery
33463 attempt.
33464 .next
33465 .cindex "log" "return path"
33466 &%return_path_on_delivery%&: The return path that is being transmitted with
33467 the message is included in delivery and bounce lines, using the tag P=.
33468 This is omitted if no delivery actually happens, for example, if routing fails,
33469 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33470 .next
33471 .cindex "log" "sender on delivery"
33472 &%sender_on_delivery%&: The message's sender address is added to every delivery
33473 and bounce line, tagged by F= (for &"from"&).
33474 This is the original sender that was received with the message; it is not
33475 necessarily the same as the outgoing return path.
33476 .next
33477 .cindex "log" "sender verify failure"
33478 &%sender_verify_fail%&: If this selector is unset, the separate log line that
33479 gives details of a sender verification failure is not written. Log lines for
33480 the rejection of SMTP commands contain just &"sender verify failed"&, so some
33481 detail is lost.
33482 .next
33483 .cindex "log" "size rejection"
33484 &%size_reject%&: A log line is written whenever a message is rejected because
33485 it is too big.
33486 .next
33487 .cindex "log" "frozen messages; skipped"
33488 .cindex "frozen messages" "logging skipping"
33489 &%skip_delivery%&: A log line is written whenever a message is skipped during a
33490 queue run because it is frozen or because another process is already delivering
33491 it.
33492 .cindex "&""spool file is locked""&"
33493 The message that is written is &"spool file is locked"&.
33494 .next
33495 .cindex "log" "smtp confirmation"
33496 .cindex "SMTP" "logging confirmation"
33497 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
33498 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
33499 A number of MTAs (including Exim) return an identifying string in this
33500 response.
33501 .next
33502 .cindex "log" "SMTP connections"
33503 .cindex "SMTP" "logging connections"
33504 &%smtp_connection%&: A log line is written whenever an SMTP connection is
33505 established or closed, unless the connection is from a host that matches
33506 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
33507 only when the closure is unexpected.) This applies to connections from local
33508 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
33509 dropped in the middle of a message, a log line is always written, whether or
33510 not this selector is set, but otherwise nothing is written at the start and end
33511 of connections unless this selector is enabled.
33512
33513 For TCP/IP connections to an Exim daemon, the current number of connections is
33514 included in the log message for each new connection, but note that the count is
33515 reset if the daemon is restarted.
33516 Also, because connections are closed (and the closure is logged) in
33517 subprocesses, the count may not include connections that have been closed but
33518 whose termination the daemon has not yet noticed. Thus, while it is possible to
33519 match up the opening and closing of connections in the log, the value of the
33520 logged counts may not be entirely accurate.
33521 .next
33522 .cindex "log" "SMTP transaction; incomplete"
33523 .cindex "SMTP" "logging incomplete transactions"
33524 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
33525 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
33526 and the message sender plus any accepted recipients are included in the log
33527 line. This can provide evidence of dictionary attacks.
33528 .next
33529 .cindex "log" "non-MAIL SMTP sessions"
33530 .cindex "MAIL" "logging session without"
33531 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
33532 connection terminates without having issued a MAIL command. This includes both
33533 the case when the connection is dropped, and the case when QUIT is used. It
33534 does not include cases where the connection is rejected right at the start (by
33535 an ACL, or because there are too many connections, or whatever). These cases
33536 already have their own log lines.
33537
33538 The log line that is written contains the identity of the client in the usual
33539 way, followed by D= and a time, which records the duration of the connection.
33540 If the connection was authenticated, this fact is logged exactly as it is for
33541 an incoming message, with an A= item. If the connection was encrypted, CV=,
33542 DN=, and X= items may appear as they do for an incoming message, controlled by
33543 the same logging options.
33544
33545 Finally, if any SMTP commands were issued during the connection, a C= item
33546 is added to the line, listing the commands that were used. For example,
33547 .code
33548 C=EHLO,QUIT
33549 .endd
33550 shows that the client issued QUIT straight after EHLO. If there were fewer
33551 than 20 commands, they are all listed. If there were more than 20 commands,
33552 the last 20 are listed, preceded by &"..."&. However, with the default
33553 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
33554 have been aborted before 20 non-mail commands are processed.
33555 .next
33556 .cindex "log" "SMTP protocol error"
33557 .cindex "SMTP" "logging protocol error"
33558 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
33559 encountered. Exim does not have perfect detection of all protocol errors
33560 because of transmission delays and the use of pipelining. If PIPELINING has
33561 been advertised to a client, an Exim server assumes that the client will use
33562 it, and therefore it does not count &"expected"& errors (for example, RCPT
33563 received after rejecting MAIL) as protocol errors.
33564 .next
33565 .cindex "SMTP" "logging syntax errors"
33566 .cindex "SMTP" "syntax errors; logging"
33567 .cindex "SMTP" "unknown command; logging"
33568 .cindex "log" "unknown SMTP command"
33569 .cindex "log" "SMTP syntax error"
33570 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
33571 encountered. An unrecognized command is treated as a syntax error. For an
33572 external connection, the host identity is given; for an internal connection
33573 using &%-bs%& the sender identification (normally the calling user) is given.
33574 .next
33575 .cindex "log" "subject"
33576 .cindex "subject, logging"
33577 &%subject%&: The subject of the message is added to the arrival log line,
33578 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
33579 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
33580 specifies whether characters with values greater than 127 should be logged
33581 unchanged, or whether they should be rendered as escape sequences.
33582 .next
33583 .cindex "log" "certificate verification"
33584 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
33585 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
33586 verified, and &`CV=no`& if not.
33587 .next
33588 .cindex "log" "TLS cipher"
33589 .cindex "TLS" "logging cipher"
33590 &%tls_cipher%&: When a message is sent or received over an encrypted
33591 connection, the cipher suite used is added to the log line, preceded by X=.
33592 .next
33593 .cindex "log" "TLS peer DN"
33594 .cindex "TLS" "logging peer DN"
33595 &%tls_peerdn%&: When a message is sent or received over an encrypted
33596 connection, and a certificate is supplied by the remote host, the peer DN is
33597 added to the log line, preceded by DN=.
33598 .next
33599 .cindex "log" "TLS SNI"
33600 .cindex "TLS" "logging SNI"
33601 &%tls_sni%&: When a message is received over an encrypted connection, and
33602 the remote host provided the Server Name Indication extension, the SNI is
33603 added to the log line, preceded by SNI=.
33604 .next
33605 .cindex "log" "DNS failure in list"
33606 &%unknown_in_list%&: This setting causes a log entry to be written when the
33607 result of a list match is failure because a DNS lookup failed.
33608 .endlist
33609
33610
33611 .section "Message log" "SECID260"
33612 .cindex "message" "log file for"
33613 .cindex "log" "message log; description of"
33614 .cindex "&_msglog_& directory"
33615 .oindex "&%preserve_message_logs%&"
33616 In addition to the general log files, Exim writes a log file for each message
33617 that it handles. The names of these per-message logs are the message ids, and
33618 they are kept in the &_msglog_& sub-directory of the spool directory. Each
33619 message log contains copies of the log lines that apply to the message. This
33620 makes it easier to inspect the status of an individual message without having
33621 to search the main log. A message log is deleted when processing of the message
33622 is complete, unless &%preserve_message_logs%& is set, but this should be used
33623 only with great care because they can fill up your disk very quickly.
33624
33625 On a heavily loaded system, it may be desirable to disable the use of
33626 per-message logs, in order to reduce disk I/O. This can be done by setting the
33627 &%message_logs%& option false.
33628 .ecindex IIDloggen
33629
33630
33631
33632
33633 . ////////////////////////////////////////////////////////////////////////////
33634 . ////////////////////////////////////////////////////////////////////////////
33635
33636 .chapter "Exim utilities" "CHAPutils"
33637 .scindex IIDutils "utilities"
33638 A number of utility scripts and programs are supplied with Exim and are
33639 described in this chapter. There is also the Exim Monitor, which is covered in
33640 the next chapter. The utilities described here are:
33641
33642 .itable none 0 0 3  7* left  15* left  40* left
33643 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
33644   "list what Exim processes are doing"
33645 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
33646 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
33647 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
33648 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
33649                                                 various criteria"
33650 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
33651 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
33652   "extract statistics from the log"
33653 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
33654   "check address acceptance from given IP"
33655 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
33656 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
33657 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
33658 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
33659 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
33660 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
33661 .endtable
33662
33663 Another utility that might be of use to sites with many MTAs is Tom Kistner's
33664 &'exilog'&. It provides log visualizations across multiple Exim servers. See
33665 &url(http://duncanthrax.net/exilog/) for details.
33666
33667
33668
33669
33670 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
33671 .cindex "&'exiwhat'&"
33672 .cindex "process, querying"
33673 .cindex "SIGUSR1"
33674 On operating systems that can restart a system call after receiving a signal
33675 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
33676 a line describing what it is doing to the file &_exim-process.info_& in the
33677 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
33678 processes it can find, having first emptied the file. It then waits for one
33679 second to allow the Exim processes to react before displaying the results. In
33680 order to run &'exiwhat'& successfully you have to have sufficient privilege to
33681 send the signal to the Exim processes, so it is normally run as root.
33682
33683 &*Warning*&: This is not an efficient process. It is intended for occasional
33684 use by system administrators. It is not sensible, for example, to set up a
33685 script that sends SIGUSR1 signals to Exim processes at short intervals.
33686
33687
33688 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
33689 varies in different operating systems. Not only are different options used,
33690 but the format of the output is different. For this reason, there are some
33691 system configuration options that configure exactly how &'exiwhat'& works. If
33692 it doesn't seem to be working for you, check the following compile-time
33693 options:
33694 .display
33695 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33696 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33697 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33698 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33699 .endd
33700 An example of typical output from &'exiwhat'& is
33701 .code
33702 164 daemon: -q1h, listening on port 25
33703 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33704 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33705   [10.19.42.42] (editor@ref.example)
33706 10592 handling incoming call from [192.168.243.242]
33707 10628 accepting a local non-SMTP message
33708 .endd
33709 The first number in the output line is the process number. The third line has
33710 been split here, in order to fit it on the page.
33711
33712
33713
33714 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33715 .cindex "&'exiqgrep'&"
33716 .cindex "queue" "grepping"
33717 This utility is a Perl script contributed by Matt Hubbard. It runs
33718 .code
33719 exim -bpu
33720 .endd
33721 to obtain a queue listing with undelivered recipients only, and then greps the
33722 output to select messages that match given criteria. The following selection
33723 options are available:
33724
33725 .vlist
33726 .vitem &*-f*&&~<&'regex'&>
33727 Match the sender address. The field that is tested is enclosed in angle
33728 brackets, so you can test for bounce messages with
33729 .code
33730 exiqgrep -f '^<>$'
33731 .endd
33732 .vitem &*-r*&&~<&'regex'&>
33733 Match a recipient address. The field that is tested is not enclosed in angle
33734 brackets.
33735
33736 .vitem &*-s*&&~<&'regex'&>
33737 Match against the size field.
33738
33739 .vitem &*-y*&&~<&'seconds'&>
33740 Match messages that are younger than the given time.
33741
33742 .vitem &*-o*&&~<&'seconds'&>
33743 Match messages that are older than the given time.
33744
33745 .vitem &*-z*&
33746 Match only frozen messages.
33747
33748 .vitem &*-x*&
33749 Match only non-frozen messages.
33750 .endlist
33751
33752 The following options control the format of the output:
33753
33754 .vlist
33755 .vitem &*-c*&
33756 Display only the count of matching messages.
33757
33758 .vitem &*-l*&
33759 Long format &-- display the full message information as output by Exim. This is
33760 the default.
33761
33762 .vitem &*-i*&
33763 Display message ids only.
33764
33765 .vitem &*-b*&
33766 Brief format &-- one line per message.
33767
33768 .vitem &*-R*&
33769 Display messages in reverse order.
33770 .endlist
33771
33772 There is one more option, &%-h%&, which outputs a list of options.
33773
33774
33775
33776 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33777 .cindex "&'exiqsumm'&"
33778 .cindex "queue" "summary"
33779 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33780 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33781 running a command such as
33782 .code
33783 exim -bp | exiqsumm
33784 .endd
33785 The output consists of one line for each domain that has messages waiting for
33786 it, as in the following example:
33787 .code
33788 3   2322   74m   66m  msn.com.example
33789 .endd
33790 Each line lists the number of pending deliveries for a domain, their total
33791 volume, and the length of time that the oldest and the newest messages have
33792 been waiting. Note that the number of pending deliveries is greater than the
33793 number of messages when messages have more than one recipient.
33794
33795 A summary line is output at the end. By default the output is sorted on the
33796 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33797 the output to be sorted by oldest message and by count of messages,
33798 respectively. There are also three options that split the messages for each
33799 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33800 separates frozen messages, and &%-s%& separates messages according to their
33801 sender.
33802
33803 The output of &'exim -bp'& contains the original addresses in the message, so
33804 this also applies to the output from &'exiqsumm'&. No domains from addresses
33805 generated by aliasing or forwarding are included (unless the &%one_time%&
33806 option of the &(redirect)& router has been used to convert them into &"top
33807 level"& addresses).
33808
33809
33810
33811
33812 .section "Extracting specific information from the log (exigrep)" &&&
33813          "SECTextspeinf"
33814 .cindex "&'exigrep'&"
33815 .cindex "log" "extracts; grepping for"
33816 The &'exigrep'& utility is a Perl script that searches one or more main log
33817 files for entries that match a given pattern. When it finds a match, it
33818 extracts all the log entries for the relevant message, not just those that
33819 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33820 given message, or all mail for a given user, or for a given host, for example.
33821 The input files can be in Exim log format or syslog format.
33822 If a matching log line is not associated with a specific message, it is
33823 included in &'exigrep'&'s output without any additional lines. The usage is:
33824 .display
33825 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33826 .endd
33827 If no log file names are given on the command line, the standard input is read.
33828
33829 The &%-t%& argument specifies a number of seconds. It adds an additional
33830 condition for message selection. Messages that are complete are shown only if
33831 they spent more than <&'n'&> seconds on the queue.
33832
33833 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33834 makes it case-sensitive. This may give a performance improvement when searching
33835 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33836 option; with &%-I%& they do not. In both cases it is possible to change the
33837 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33838
33839 The &%-l%& option means &"literal"&, that is, treat all characters in the
33840 pattern as standing for themselves. Otherwise the pattern must be a Perl
33841 regular expression.
33842
33843 The &%-v%& option inverts the matching condition. That is, a line is selected
33844 if it does &'not'& match the pattern.
33845
33846 If the location of a &'zcat'& command is known from the definition of
33847 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33848 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33849
33850
33851 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33852 .cindex "&'exipick'&"
33853 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33854 lists messages from the queue according to a variety of criteria. For details
33855 of &'exipick'&'s facilities, visit the web page at
33856 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33857 the &%--help%& option.
33858
33859
33860 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33861 .cindex "log" "cycling local files"
33862 .cindex "cycling logs"
33863 .cindex "&'exicyclog'&"
33864 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33865 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33866 you are using log files with datestamps in their names (see section
33867 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33868 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33869 There are two command line options for &'exicyclog'&:
33870 .ilist
33871 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33872 default that is set when Exim is built. The default default is 10.
33873 .next
33874 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33875 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33876 overriding the script's default, which is to find the setting from Exim's
33877 configuration.
33878 .endlist
33879
33880 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33881 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33882 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33883 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33884 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33885 logs are handled similarly.
33886
33887 If the limit is greater than 99, the script uses 3-digit numbers such as
33888 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33889 to one that is greater, or &'vice versa'&, you will have to fix the names of
33890 any existing log files.
33891
33892 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33893 the end are deleted. All files with numbers greater than 01 are compressed,
33894 using a compression command which is configured by the COMPRESS_COMMAND
33895 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33896 root &%crontab%& entry of the form
33897 .code
33898 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33899 .endd
33900 assuming you have used the name &"exim"& for the Exim user. You can run
33901 &'exicyclog'& as root if you wish, but there is no need.
33902
33903
33904
33905 .section "Mail statistics (eximstats)" "SECTmailstat"
33906 .cindex "statistics"
33907 .cindex "&'eximstats'&"
33908 A Perl script called &'eximstats'& is provided for extracting statistical
33909 information from log files. The output is either plain text, or HTML.
33910 Exim log files are also supported by the &'Lire'& system produced by the
33911 LogReport Foundation &url(http://www.logreport.org).
33912
33913 The &'eximstats'& script has been hacked about quite a bit over time. The
33914 latest version is the result of some extensive revision by Steve Campbell. A
33915 lot of information is given by default, but there are options for suppressing
33916 various parts of it. Following any options, the arguments to the script are a
33917 list of files, which should be main log files. For example:
33918 .code
33919 eximstats -nr /var/spool/exim/log/mainlog.01
33920 .endd
33921 By default, &'eximstats'& extracts information about the number and volume of
33922 messages received from or delivered to various hosts. The information is sorted
33923 both by message count and by volume, and the top fifty hosts in each category
33924 are listed on the standard output. Similar information, based on email
33925 addresses or domains instead of hosts can be requested by means of various
33926 options. For messages delivered and received locally, similar statistics are
33927 also produced per user.
33928
33929 The output also includes total counts and statistics about delivery errors, and
33930 histograms showing the number of messages received and deliveries made in each
33931 hour of the day. A delivery with more than one address in its envelope (for
33932 example, an SMTP transaction with more than one RCPT command) is counted
33933 as a single delivery by &'eximstats'&.
33934
33935 Though normally more deliveries than receipts are reported (as messages may
33936 have multiple recipients), it is possible for &'eximstats'& to report more
33937 messages received than delivered, even though the queue is empty at the start
33938 and end of the period in question. If an incoming message contains no valid
33939 recipients, no deliveries are recorded for it. A bounce message is handled as
33940 an entirely separate message.
33941
33942 &'eximstats'& always outputs a grand total summary giving the volume and number
33943 of messages received and deliveries made, and the number of hosts involved in
33944 each case. It also outputs the number of messages that were delayed (that is,
33945 not completely delivered at the first attempt), and the number that had at
33946 least one address that failed.
33947
33948 The remainder of the output is in sections that can be independently disabled
33949 or modified by various options. It consists of a summary of deliveries by
33950 transport, histograms of messages received and delivered per time interval
33951 (default per hour), information about the time messages spent on the queue,
33952 a list of relayed messages, lists of the top fifty sending hosts, local
33953 senders, destination hosts, and destination local users by count and by volume,
33954 and a list of delivery errors that occurred.
33955
33956 The relay information lists messages that were actually relayed, that is, they
33957 came from a remote host and were directly delivered to some other remote host,
33958 without being processed (for example, for aliasing or forwarding) locally.
33959
33960 There are quite a few options for &'eximstats'& to control exactly what it
33961 outputs. These are documented in the Perl script itself, and can be extracted
33962 by running the command &(perldoc)& on the script. For example:
33963 .code
33964 perldoc /usr/exim/bin/eximstats
33965 .endd
33966
33967 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33968 .cindex "&'exim_checkaccess'&"
33969 .cindex "policy control" "checking access"
33970 .cindex "checking access"
33971 The &%-bh%& command line argument allows you to run a fake SMTP session with
33972 debugging output, in order to check what Exim is doing when it is applying
33973 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33974 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33975 sometimes you just want to answer the question &"Does this address have
33976 access?"& without bothering with any further details.
33977
33978 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33979 two arguments, an IP address and an email address:
33980 .code
33981 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33982 .endd
33983 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33984 given email address would be accepted in a RCPT command in a TCP/IP
33985 connection from the host with the given IP address. The output of the utility
33986 is either the word &"accepted"&, or the SMTP error response, for example:
33987 .code
33988 Rejected:
33989 550 Relay not permitted
33990 .endd
33991 When running this test, the utility uses &`<>`& as the envelope sender address
33992 for the MAIL command, but you can change this by providing additional
33993 options. These are passed directly to the Exim command. For example, to specify
33994 that the test is to be run with the sender address &'himself@there.example'&
33995 you can use:
33996 .code
33997 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33998                  -f himself@there.example
33999 .endd
34000 Note that these additional Exim command line items must be given after the two
34001 mandatory arguments.
34002
34003 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34004 while running its checks. You can run checks that include callouts by using
34005 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34006
34007
34008
34009 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34010 .cindex "DBM" "building dbm files"
34011 .cindex "building DBM files"
34012 .cindex "&'exim_dbmbuild'&"
34013 .cindex "lower casing"
34014 .cindex "binary zero" "in lookup key"
34015 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34016 the format used by the &(lsearch)& lookup (see section
34017 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34018 names as keys and the remainder of the information as data. The lower-casing
34019 can be prevented by calling the program with the &%-nolc%& option.
34020
34021 A terminating zero is included as part of the key string. This is expected by
34022 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34023 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34024 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34025 files.
34026
34027 The program requires two arguments: the name of the input file (which can be a
34028 single hyphen to indicate the standard input), and the name of the output file.
34029 It creates the output under a temporary name, and then renames it if all went
34030 well.
34031
34032 .cindex "USE_DB"
34033 If the native DB interface is in use (USE_DB is set in a compile-time
34034 configuration file &-- this is common in free versions of Unix) the two file
34035 names must be different, because in this mode the Berkeley DB functions create
34036 a single output file using exactly the name given. For example,
34037 .code
34038 exim_dbmbuild /etc/aliases /etc/aliases.db
34039 .endd
34040 reads the system alias file and creates a DBM version of it in
34041 &_/etc/aliases.db_&.
34042
34043 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34044 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34045 environment, the suffixes are added to the second argument of
34046 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34047 when the Berkeley functions are used in compatibility mode (though this is not
34048 recommended), because in that case it adds a &_.db_& suffix to the file name.
34049
34050 If a duplicate key is encountered, the program outputs a warning, and when it
34051 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34052 option is used. By default, only the first of a set of duplicates is used &--
34053 this makes it compatible with &(lsearch)& lookups. There is an option
34054 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34055 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34056 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34057 return code is 2.
34058
34059
34060
34061
34062 .section "Finding individual retry times (exinext)" "SECTfinindret"
34063 .cindex "retry" "times"
34064 .cindex "&'exinext'&"
34065 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34066 fish specific information out of the retry database. Given a mail domain (or a
34067 complete address), it looks up the hosts for that domain, and outputs any retry
34068 information for the hosts or for the domain. At present, the retry information
34069 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34070 output. For example:
34071 .code
34072 $ exinext piglet@milne.fict.example
34073 kanga.milne.example:192.168.8.1 error 146: Connection refused
34074   first failed: 21-Feb-1996 14:57:34
34075   last tried:   21-Feb-1996 14:57:34
34076   next try at:  21-Feb-1996 15:02:34
34077 roo.milne.example:192.168.8.3 error 146: Connection refused
34078   first failed: 20-Jan-1996 13:12:08
34079   last tried:   21-Feb-1996 11:42:03
34080   next try at:  21-Feb-1996 19:42:03
34081   past final cutoff time
34082 .endd
34083 You can also give &'exinext'& a local part, without a domain, and it
34084 will give any retry information for that local part in your default domain.
34085 A message id can be used to obtain retry information pertaining to a specific
34086 message. This exists only when an attempt to deliver a message to a remote host
34087 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34088 &'exinext'& is not particularly efficient, but then it is not expected to be
34089 run very often.
34090
34091 The &'exinext'& utility calls Exim to find out information such as the location
34092 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34093 passed on to the &'exim'& commands. The first specifies an alternate Exim
34094 configuration file, and the second sets macros for use within the configuration
34095 file. These features are mainly to help in testing, but might also be useful in
34096 environments where more than one configuration file is in use.
34097
34098
34099
34100 .section "Hints database maintenance" "SECThindatmai"
34101 .cindex "hints database" "maintenance"
34102 .cindex "maintaining Exim's hints database"
34103 Three utility programs are provided for maintaining the DBM files that Exim
34104 uses to contain its delivery hint information. Each program requires two
34105 arguments. The first specifies the name of Exim's spool directory, and the
34106 second is the name of the database it is to operate on. These are as follows:
34107
34108 .ilist
34109 &'retry'&: the database of retry information
34110 .next
34111 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34112 for remote hosts
34113 .next
34114 &'callout'&: the callout cache
34115 .next
34116 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34117 .next
34118 &'misc'&: other hints data
34119 .endlist
34120
34121 The &'misc'& database is used for
34122
34123 .ilist
34124 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34125 .next
34126 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34127 &(smtp)& transport)
34128 .endlist
34129
34130
34131
34132 .section "exim_dumpdb" "SECID261"
34133 .cindex "&'exim_dumpdb'&"
34134 The entire contents of a database are written to the standard output by the
34135 &'exim_dumpdb'& program, which has no options or arguments other than the
34136 spool and database names. For example, to dump the retry database:
34137 .code
34138 exim_dumpdb /var/spool/exim retry
34139 .endd
34140 Two lines of output are produced for each entry:
34141 .code
34142 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34143 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34144 .endd
34145 The first item on the first line is the key of the record. It starts with one
34146 of the letters R, or T, depending on whether it refers to a routing or
34147 transport retry. For a local delivery, the next part is the local address; for
34148 a remote delivery it is the name of the remote host, followed by its failing IP
34149 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34150 transport). If the remote port is not the standard one (port 25), it is added
34151 to the IP address. Then there follows an error code, an additional error code,
34152 and a textual description of the error.
34153
34154 The three times on the second line are the time of first failure, the time of
34155 the last delivery attempt, and the computed time for the next attempt. The line
34156 ends with an asterisk if the cutoff time for the last retry rule has been
34157 exceeded.
34158
34159 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34160 consists of a host name followed by a list of ids for messages that are or were
34161 waiting to be delivered to that host. If there are a very large number for any
34162 one host, continuation records, with a sequence number added to the host name,
34163 may be seen. The data in these records is often out of date, because a message
34164 may be routed to several alternative hosts, and Exim makes no effort to keep
34165 cross-references.
34166
34167
34168
34169 .section "exim_tidydb" "SECID262"
34170 .cindex "&'exim_tidydb'&"
34171 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34172 database. If run with no options, it removes all records that are more than 30
34173 days old. The age is calculated from the date and time that the record was last
34174 updated. Note that, in the case of the retry database, it is &'not'& the time
34175 since the first delivery failure. Information about a host that has been down
34176 for more than 30 days will remain in the database, provided that the record is
34177 updated sufficiently often.
34178
34179 The cutoff date can be altered by means of the &%-t%& option, which must be
34180 followed by a time. For example, to remove all records older than a week from
34181 the retry database:
34182 .code
34183 exim_tidydb -t 7d /var/spool/exim retry
34184 .endd
34185 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34186 message ids. In the former these appear as data in records keyed by host &--
34187 they were messages that were waiting for that host &-- and in the latter they
34188 are the keys for retry information for messages that have suffered certain
34189 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34190 message ids in database records are those of messages that are still on the
34191 queue. Message ids for messages that no longer exist are removed from
34192 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34193 For the &'retry'& database, records whose keys are non-existent message ids are
34194 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34195 whenever it removes information from the database.
34196
34197 Certain records are automatically removed by Exim when they are no longer
34198 needed, but others are not. For example, if all the MX hosts for a domain are
34199 down, a retry record is created for each one. If the primary MX host comes back
34200 first, its record is removed when Exim successfully delivers to it, but the
34201 records for the others remain because Exim has not tried to use those hosts.
34202
34203 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34204 hints databases. You should do this at a quiet time of day, because it requires
34205 a database to be locked (and therefore inaccessible to Exim) while it does its
34206 work. Removing records from a DBM file does not normally make the file smaller,
34207 but all the common DBM libraries are able to re-use the space that is released.
34208 After an initial phase of increasing in size, the databases normally reach a
34209 point at which they no longer get any bigger, as long as they are regularly
34210 tidied.
34211
34212 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34213 databases is likely to keep on increasing.
34214
34215
34216
34217
34218 .section "exim_fixdb" "SECID263"
34219 .cindex "&'exim_fixdb'&"
34220 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34221 Its main use is for testing Exim, but it might also be occasionally useful for
34222 getting round problems in a live system. It has no options, and its interface
34223 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34224 key of a database record can then be entered, and the data for that record is
34225 displayed.
34226
34227 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34228 except the &'retry'& database, that is the only operation that can be carried
34229 out. For the &'retry'& database, each field is output preceded by a number, and
34230 data for individual fields can be changed by typing the field number followed
34231 by new data, for example:
34232 .code
34233 > 4 951102:1000
34234 .endd
34235 resets the time of the next delivery attempt. Time values are given as a
34236 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34237 used as optional separators.
34238
34239
34240
34241
34242 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34243 .cindex "mailbox" "maintenance"
34244 .cindex "&'exim_lock'&"
34245 .cindex "locking mailboxes"
34246 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34247 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34248 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34249 a user agent while investigating a problem. The utility requires the name of
34250 the file as its first argument. If the locking is successful, the second
34251 argument is run as a command (using C's &[system()]& function); if there is no
34252 second argument, the value of the SHELL environment variable is used; if this
34253 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34254 is unlocked and the utility ends. The following options are available:
34255
34256 .vlist
34257 .vitem &%-fcntl%&
34258 Use &[fcntl()]& locking on the open mailbox.
34259
34260 .vitem &%-flock%&
34261 Use &[flock()]& locking on the open mailbox, provided the operating system
34262 supports it.
34263
34264 .vitem &%-interval%&
34265 This must be followed by a number, which is a number of seconds; it sets the
34266 interval to sleep between retries (default 3).
34267
34268 .vitem &%-lockfile%&
34269 Create a lock file before opening the mailbox.
34270
34271 .vitem &%-mbx%&
34272 Lock the mailbox using MBX rules.
34273
34274 .vitem &%-q%&
34275 Suppress verification output.
34276
34277 .vitem &%-retries%&
34278 This must be followed by a number; it sets the number of times to try to get
34279 the lock (default 10).
34280
34281 .vitem &%-restore_time%&
34282 This option causes &%exim_lock%& to restore the modified and read times to the
34283 locked file before exiting. This allows you to access a locked mailbox (for
34284 example, to take a backup copy) without disturbing the times that the user
34285 subsequently sees.
34286
34287 .vitem &%-timeout%&
34288 This must be followed by a number, which is a number of seconds; it sets a
34289 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34290 default), a non-blocking call is used.
34291
34292 .vitem &%-v%&
34293 Generate verbose output.
34294 .endlist
34295
34296 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34297 default is to create a lock file and also to use &[fcntl()]& locking on the
34298 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34299 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34300 requires that the directory containing the file be writeable. Locking by lock
34301 file does not last for ever; Exim assumes that a lock file is expired if it is
34302 more than 30 minutes old.
34303
34304 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34305 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34306 to be taken out on the open mailbox, and an exclusive lock on the file
34307 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34308 number of the mailbox file. When the locking is released, if an exclusive lock
34309 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34310
34311 The default output contains verification of the locking that takes place. The
34312 &%-v%& option causes some additional information to be given. The &%-q%& option
34313 suppresses all output except error messages.
34314
34315 A command such as
34316 .code
34317 exim_lock /var/spool/mail/spqr
34318 .endd
34319 runs an interactive shell while the file is locked, whereas
34320 .display
34321 &`exim_lock -q /var/spool/mail/spqr <<End`&
34322 <&'some commands'&>
34323 &`End`&
34324 .endd
34325 runs a specific non-interactive sequence of commands while the file is locked,
34326 suppressing all verification output. A single command can be run by a command
34327 such as
34328 .code
34329 exim_lock -q /var/spool/mail/spqr \
34330   "cp /var/spool/mail/spqr /some/where"
34331 .endd
34332 Note that if a command is supplied, it must be entirely contained within the
34333 second argument &-- hence the quotes.
34334 .ecindex IIDutils
34335
34336
34337 . ////////////////////////////////////////////////////////////////////////////
34338 . ////////////////////////////////////////////////////////////////////////////
34339
34340 .chapter "The Exim monitor" "CHAPeximon"
34341 .scindex IIDeximon "Exim monitor" "description"
34342 .cindex "X-windows"
34343 .cindex "&'eximon'&"
34344 .cindex "Local/eximon.conf"
34345 .cindex "&_exim_monitor/EDITME_&"
34346 The Exim monitor is an application which displays in an X window information
34347 about the state of Exim's queue and what Exim is doing. An admin user can
34348 perform certain operations on messages from this GUI interface; however all
34349 such facilities are also available from the command line, and indeed, the
34350 monitor itself makes use of the command line to perform any actions requested.
34351
34352
34353
34354 .section "Running the monitor" "SECID264"
34355 The monitor is started by running the script called &'eximon'&. This is a shell
34356 script that sets up a number of environment variables, and then runs the
34357 binary called &_eximon.bin_&. The default appearance of the monitor window can
34358 be changed by editing the &_Local/eximon.conf_& file created by editing
34359 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34360 parameters are for.
34361
34362 The parameters that get built into the &'eximon'& script can be overridden for
34363 a particular invocation by setting up environment variables of the same names,
34364 preceded by &`EXIMON_`&. For example, a shell command such as
34365 .code
34366 EXIMON_LOG_DEPTH=400 eximon
34367 .endd
34368 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34369 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34370 overrides the Exim log file configuration. This makes it possible to have
34371 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34372 syslog messages are routed to a file on the local host.
34373
34374 X resources can be used to change the appearance of the window in the normal
34375 way. For example, a resource setting of the form
34376 .code
34377 Eximon*background: gray94
34378 .endd
34379 changes the colour of the background to light grey rather than white. The
34380 stripcharts are drawn with both the data lines and the reference lines in
34381 black. This means that the reference lines are not visible when on top of the
34382 data. However, their colour can be changed by setting a resource called
34383 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34384 For example, if your X server is running Unix, you could set up lighter
34385 reference lines in the stripcharts by obeying
34386 .code
34387 xrdb -merge <<End
34388 Eximon*highlight: gray
34389 End
34390 .endd
34391 .cindex "admin user"
34392 In order to see the contents of messages on the queue, and to operate on them,
34393 &'eximon'& must either be run as root or by an admin user.
34394
34395 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34396 contain X11 resource parameters interpreted by the X11 library.  In addition,
34397 if the first parameter starts with the string "gdb" then it is removed and the
34398 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34399 versioned variants of gdb can be invoked).
34400
34401 The monitor's window is divided into three parts. The first contains one or
34402 more stripcharts and two action buttons, the second contains a &"tail"& of the
34403 main log file, and the third is a display of the queue of messages awaiting
34404 delivery, with two more action buttons. The following sections describe these
34405 different parts of the display.
34406
34407
34408
34409
34410 .section "The stripcharts" "SECID265"
34411 .cindex "stripchart"
34412 The first stripchart is always a count of messages on the queue. Its name can
34413 be configured by setting QUEUE_STRIPCHART_NAME in the
34414 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34415 configuration script by regular expression matches on log file entries, making
34416 it possible to display, for example, counts of messages delivered to certain
34417 hosts or using certain transports. The supplied defaults display counts of
34418 received and delivered messages, and of local and SMTP deliveries. The default
34419 period between stripchart updates is one minute; this can be adjusted by a
34420 parameter in the &_Local/eximon.conf_& file.
34421
34422 The stripchart displays rescale themselves automatically as the value they are
34423 displaying changes. There are always 10 horizontal lines in each chart; the
34424 title string indicates the value of each division when it is greater than one.
34425 For example, &"x2"& means that each division represents a value of 2.
34426
34427 It is also possible to have a stripchart which shows the percentage fullness of
34428 a particular disk partition, which is useful when local deliveries are confined
34429 to a single partition.
34430
34431 .cindex "&%statvfs%& function"
34432 This relies on the availability of the &[statvfs()]& function or equivalent in
34433 the operating system. Most, but not all versions of Unix that support Exim have
34434 this. For this particular stripchart, the top of the chart always represents
34435 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34436 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34437 &_Local/eximon.conf_& file.
34438
34439
34440
34441
34442 .section "Main action buttons" "SECID266"
34443 .cindex "size" "of monitor window"
34444 .cindex "Exim monitor" "window size"
34445 .cindex "window size"
34446 Below the stripcharts there is an action button for quitting the monitor. Next
34447 to this is another button marked &"Size"&. They are placed here so that
34448 shrinking the window to its default minimum size leaves just the queue count
34449 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34450 the window to expand to its maximum size, unless it is already at the maximum,
34451 in which case it is reduced to its minimum.
34452
34453 When expanding to the maximum, if the window cannot be fully seen where it
34454 currently is, it is moved back to where it was the last time it was at full
34455 size. When it is expanding from its minimum size, the old position is
34456 remembered, and next time it is reduced to the minimum it is moved back there.
34457
34458 The idea is that you can keep a reduced window just showing one or two
34459 stripcharts at a convenient place on your screen, easily expand it to show
34460 the full window when required, and just as easily put it back to what it was.
34461 The idea is copied from what the &'twm'& window manager does for its
34462 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34463 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34464
34465 Normally, the monitor starts up with the window at its full size, but it can be
34466 built so that it starts up with the window at its smallest size, by setting
34467 START_SMALL=yes in &_Local/eximon.conf_&.
34468
34469
34470
34471 .section "The log display" "SECID267"
34472 .cindex "log" "tail of; in monitor"
34473 The second section of the window is an area in which a display of the tail of
34474 the main log is maintained.
34475 To save space on the screen, the timestamp on each log line is shortened by
34476 removing the date and, if &%log_timezone%& is set, the timezone.
34477 The log tail is not available when the only destination for logging data is
34478 syslog, unless the syslog lines are routed to a local file whose name is passed
34479 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
34480
34481 The log sub-window has a scroll bar at its lefthand side which can be used to
34482 move back to look at earlier text, and the up and down arrow keys also have a
34483 scrolling effect. The amount of log that is kept depends on the setting of
34484 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
34485 to use. When this is full, the earlier 50% of data is discarded &-- this is
34486 much more efficient than throwing it away line by line. The sub-window also has
34487 a horizontal scroll bar for accessing the ends of long log lines. This is the
34488 only means of horizontal scrolling; the right and left arrow keys are not
34489 available. Text can be cut from this part of the window using the mouse in the
34490 normal way. The size of this subwindow is controlled by parameters in the
34491 configuration file &_Local/eximon.conf_&.
34492
34493 Searches of the text in the log window can be carried out by means of the ^R
34494 and ^S keystrokes, which default to a reverse and a forward search,
34495 respectively. The search covers only the text that is displayed in the window.
34496 It cannot go further back up the log.
34497
34498 The point from which the search starts is indicated by a caret marker. This is
34499 normally at the end of the text in the window, but can be positioned explicitly
34500 by pointing and clicking with the left mouse button, and is moved automatically
34501 by a successful search. If new text arrives in the window when it is scrolled
34502 back, the caret remains where it is, but if the window is not scrolled back,
34503 the caret is moved to the end of the new text.
34504
34505 Pressing ^R or ^S pops up a window into which the search text can be typed.
34506 There are buttons for selecting forward or reverse searching, for carrying out
34507 the search, and for cancelling. If the &"Search"& button is pressed, the search
34508 happens and the window remains so that further searches can be done. If the
34509 &"Return"& key is pressed, a single search is done and the window is closed. If
34510 ^C is typed the search is cancelled.
34511
34512 The searching facility is implemented using the facilities of the Athena text
34513 widget. By default this pops up a window containing both &"search"& and
34514 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
34515 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
34516 However, the linkers in BSDI and HP-UX seem unable to handle an externally
34517 provided version of &%TextPop%& when the remaining parts of the text widget
34518 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
34519 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
34520 on these systems, at the expense of having unwanted items in the search popup
34521 window.
34522
34523
34524
34525 .section "The queue display" "SECID268"
34526 .cindex "queue" "display in monitor"
34527 The bottom section of the monitor window contains a list of all messages that
34528 are on the queue, which includes those currently being received or delivered,
34529 as well as those awaiting delivery. The size of this subwindow is controlled by
34530 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
34531 at which it is updated is controlled by another parameter in the same file &--
34532 the default is 5 minutes, since queue scans can be quite expensive. However,
34533 there is an &"Update"& action button just above the display which can be used
34534 to force an update of the queue display at any time.
34535
34536 When a host is down for some time, a lot of pending mail can build up for it,
34537 and this can make it hard to deal with other messages on the queue. To help
34538 with this situation there is a button next to &"Update"& called &"Hide"&. If
34539 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
34540 type anything in here and press &"Return"&, the text is added to a chain of
34541 such texts, and if every undelivered address in a message matches at least one
34542 of the texts, the message is not displayed.
34543
34544 If there is an address that does not match any of the texts, all the addresses
34545 are displayed as normal. The matching happens on the ends of addresses so, for
34546 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
34547 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
34548 has been set up, a button called &"Unhide"& is displayed. If pressed, it
34549 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
34550 a hide request is automatically cancelled after one hour.
34551
34552 While the dialogue box is displayed, you can't press any buttons or do anything
34553 else to the monitor window. For this reason, if you want to cut text from the
34554 queue display to use in the dialogue box, you have to do the cutting before
34555 pressing the &"Hide"& button.
34556
34557 The queue display contains, for each unhidden queued message, the length of
34558 time it has been on the queue, the size of the message, the message id, the
34559 message sender, and the first undelivered recipient, all on one line. If it is
34560 a bounce message, the sender is shown as &"<>"&. If there is more than one
34561 recipient to which the message has not yet been delivered, subsequent ones are
34562 listed on additional lines, up to a maximum configured number, following which
34563 an ellipsis is displayed. Recipients that have already received the message are
34564 not shown.
34565
34566 .cindex "frozen messages" "display"
34567 If a message is frozen, an asterisk is displayed at the left-hand side.
34568
34569 The queue display has a vertical scroll bar, and can also be scrolled by means
34570 of the arrow keys. Text can be cut from it using the mouse in the normal way.
34571 The text searching facilities, as described above for the log window, are also
34572 available, but the caret is always moved to the end of the text when the queue
34573 display is updated.
34574
34575
34576
34577 .section "The queue menu" "SECID269"
34578 .cindex "queue" "menu in monitor"
34579 If the &%shift%& key is held down and the left button is clicked when the mouse
34580 pointer is over the text for any message, an action menu pops up, and the first
34581 line of the queue display for the message is highlighted. This does not affect
34582 any selected text.
34583
34584 If you want to use some other event for popping up the menu, you can set the
34585 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
34586 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
34587 value set in this parameter is a standard X event description. For example, to
34588 run eximon using &%ctrl%& rather than &%shift%& you could use
34589 .code
34590 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
34591 .endd
34592 The title of the menu is the message id, and it contains entries which act as
34593 follows:
34594
34595 .ilist
34596 &'message log'&: The contents of the message log for the message are displayed
34597 in a new text window.
34598 .next
34599 &'headers'&: Information from the spool file that contains the envelope
34600 information and headers is displayed in a new text window. See chapter
34601 &<<CHAPspool>>& for a description of the format of spool files.
34602 .next
34603 &'body'&: The contents of the spool file containing the body of the message are
34604 displayed in a new text window. There is a default limit of 20,000 bytes to the
34605 amount of data displayed. This can be changed by setting the BODY_MAX
34606 option at compile time, or the EXIMON_BODY_MAX option at run time.
34607 .next
34608 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
34609 delivery of the message. This causes an automatic thaw if the message is
34610 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
34611 a new text window. The delivery is run in a separate process, to avoid holding
34612 up the monitor while the delivery proceeds.
34613 .next
34614 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
34615 that the message be frozen.
34616 .next
34617 .cindex "thawing messages"
34618 .cindex "unfreezing messages"
34619 .cindex "frozen messages" "thawing"
34620 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
34621 that the message be thawed.
34622 .next
34623 .cindex "delivery" "forcing failure"
34624 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
34625 that Exim gives up trying to deliver the message. A bounce message is generated
34626 for any remaining undelivered addresses.
34627 .next
34628 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
34629 that the message be deleted from the system without generating a bounce
34630 message.
34631 .next
34632 &'add recipient'&: A dialog box is displayed into which a recipient address can
34633 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34634 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34635 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34636 causes a call to Exim to be made using the &%-Mar%& option to request that an
34637 additional recipient be added to the message, unless the entry box is empty, in
34638 which case no action is taken.
34639 .next
34640 &'mark delivered'&: A dialog box is displayed into which a recipient address
34641 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34642 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34643 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34644 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
34645 recipient address as already delivered, unless the entry box is empty, in which
34646 case no action is taken.
34647 .next
34648 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
34649 mark all recipient addresses as already delivered.
34650 .next
34651 &'edit sender'&: A dialog box is displayed initialized with the current
34652 sender's address. Pressing RETURN causes a call to Exim to be made using the
34653 &%-Mes%& option to replace the sender address, unless the entry box is empty,
34654 in which case no action is taken. If you want to set an empty sender (as in
34655 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
34656 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
34657 the address is qualified with that domain.
34658 .endlist
34659
34660 When a delivery is forced, a window showing the &%-v%& output is displayed. In
34661 other cases when a call to Exim is made, if there is any output from Exim (in
34662 particular, if the command fails) a window containing the command and the
34663 output is displayed. Otherwise, the results of the action are normally apparent
34664 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
34665 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
34666 if no output is generated.
34667
34668 The queue display is automatically updated for actions such as freezing and
34669 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
34670 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
34671 force an update of the display after one of these actions.
34672
34673 In any text window that is displayed as result of a menu action, the normal
34674 cut-and-paste facility is available, and searching can be carried out using ^R
34675 and ^S, as described above for the log tail window.
34676 .ecindex IIDeximon
34677
34678
34679
34680
34681
34682 . ////////////////////////////////////////////////////////////////////////////
34683 . ////////////////////////////////////////////////////////////////////////////
34684
34685 .chapter "Security considerations" "CHAPsecurity"
34686 .scindex IIDsecurcon "security" "discussion of"
34687 This chapter discusses a number of issues concerned with security, some of
34688 which are also covered in other parts of this manual.
34689
34690 For reasons that this author does not understand, some people have promoted
34691 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
34692 existence of this chapter in the documentation. However, the intent of the
34693 chapter is simply to describe the way Exim works in relation to certain
34694 security concerns, not to make any specific claims about the effectiveness of
34695 its security as compared with other MTAs.
34696
34697 What follows is a description of the way Exim is supposed to be. Best efforts
34698 have been made to try to ensure that the code agrees with the theory, but an
34699 absence of bugs can never be guaranteed. Any that are reported will get fixed
34700 as soon as possible.
34701
34702
34703 .section "Building a more &""hardened""& Exim" "SECID286"
34704 .cindex "security" "build-time features"
34705 There are a number of build-time options that can be set in &_Local/Makefile_&
34706 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34707 Exim administrator who does not have the root password, or by someone who has
34708 penetrated the Exim (but not the root) account. These options are as follows:
34709
34710 .ilist
34711 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34712 start of any file names used with the &%-C%& option. When it is set, these file
34713 names are also not allowed to contain the sequence &"/../"&. (However, if the
34714 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34715 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34716 default setting for &%ALT_CONFIG_PREFIX%&.
34717
34718 If the permitted configuration files are confined to a directory to
34719 which only root has access, this guards against someone who has broken
34720 into the Exim account from running a privileged Exim with an arbitrary
34721 configuration file, and using it to break into other accounts.
34722 .next
34723
34724 If a non-trusted configuration file (i.e. not the default configuration file
34725 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34726 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34727 the next item), then root privilege is retained only if the caller of Exim is
34728 root. This locks out the possibility of testing a configuration using &%-C%&
34729 right through message reception and delivery, even if the caller is root. The
34730 reception works, but by that time, Exim is running as the Exim user, so when
34731 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34732 privilege to be lost. However, root can test reception and delivery using two
34733 separate commands.
34734
34735 .next
34736 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34737 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34738 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34739 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34740 the restrictive side.  Requiring build-time selection of safe macros is onerous
34741 but this option is intended solely as a transition mechanism to permit
34742 previously-working configurations to continue to work after release 4.73.
34743 .next
34744 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34745 is disabled.
34746 .next
34747 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34748 never to be used for any deliveries. This is like the &%never_users%& runtime
34749 option, but it cannot be overridden; the runtime option adds additional users
34750 to the list. The default setting is &"root"&; this prevents a non-root user who
34751 is permitted to modify the runtime file from using Exim as a way to get root.
34752 .endlist
34753
34754
34755
34756 .section "Root privilege" "SECID270"
34757 .cindex "setuid"
34758 .cindex "root privilege"
34759 The Exim binary is normally setuid to root, which means that it gains root
34760 privilege (runs as root) when it starts execution. In some special cases (for
34761 example, when the daemon is not in use and there are no local deliveries), it
34762 may be possible to run Exim setuid to some user other than root. This is
34763 discussed in the next section. However, in most installations, root privilege
34764 is required for two things:
34765
34766 .ilist
34767 To set up a socket connected to the standard SMTP port (25) when initialising
34768 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34769 not required.
34770 .next
34771 To be able to change uid and gid in order to read users' &_.forward_& files and
34772 perform local deliveries as the receiving user or as specified in the
34773 configuration.
34774 .endlist
34775
34776 It is not necessary to be root to do any of the other things Exim does, such as
34777 receiving messages and delivering them externally over SMTP, and it is
34778 obviously more secure if Exim does not run as root except when necessary.
34779 For this reason, a user and group for Exim to use must be defined in
34780 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34781 group"&. Their values can be changed by the run time configuration, though this
34782 is not recommended. Often a user called &'exim'& is used, but some sites use
34783 &'mail'& or another user name altogether.
34784
34785 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34786 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34787 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34788
34789 After a new Exim process has interpreted its command line options, it changes
34790 uid and gid in the following cases:
34791
34792 .ilist
34793 .oindex "&%-C%&"
34794 .oindex "&%-D%&"
34795 If the &%-C%& option is used to specify an alternate configuration file, or if
34796 the &%-D%& option is used to define macro values for the configuration, and the
34797 calling process is not running as root, the uid and gid are changed to those of
34798 the calling process.
34799 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34800 option may not be used at all.
34801 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34802 can be supplied if the calling process is running as root, the Exim run-time
34803 user or CONFIGURE_OWNER, if defined.
34804 .next
34805 .oindex "&%-be%&"
34806 .oindex "&%-bf%&"
34807 .oindex "&%-bF%&"
34808 If the expansion test option (&%-be%&) or one of the filter testing options
34809 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34810 calling process.
34811 .next
34812 If the process is not a daemon process or a queue runner process or a delivery
34813 process or a process for testing address routing (started with &%-bt%&), the
34814 uid and gid are changed to the Exim user and group. This means that Exim always
34815 runs under its own uid and gid when receiving messages. This also applies when
34816 testing address verification
34817 .oindex "&%-bv%&"
34818 .oindex "&%-bh%&"
34819 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34820 option).
34821 .next
34822 For a daemon, queue runner, delivery, or address testing process, the uid
34823 remains as root at this stage, but the gid is changed to the Exim group.
34824 .endlist
34825
34826 The processes that initially retain root privilege behave as follows:
34827
34828 .ilist
34829 A daemon process changes the gid to the Exim group and the uid to the Exim
34830 user after setting up one or more listening sockets. The &[initgroups()]&
34831 function is called, so that if the Exim user is in any additional groups, they
34832 will be used during message reception.
34833 .next
34834 A queue runner process retains root privilege throughout its execution. Its
34835 job is to fork a controlled sequence of delivery processes.
34836 .next
34837 A delivery process retains root privilege throughout most of its execution,
34838 but any actual deliveries (that is, the transports themselves) are run in
34839 subprocesses which always change to a non-root uid and gid. For local
34840 deliveries this is typically the uid and gid of the owner of the mailbox; for
34841 remote deliveries, the Exim uid and gid are used. Once all the delivery
34842 subprocesses have been run, a delivery process changes to the Exim uid and gid
34843 while doing post-delivery tidying up such as updating the retry database and
34844 generating bounce and warning messages.
34845
34846 While the recipient addresses in a message are being routed, the delivery
34847 process runs as root. However, if a user's filter file has to be processed,
34848 this is done in a subprocess that runs under the individual user's uid and
34849 gid. A system filter is run as root unless &%system_filter_user%& is set.
34850 .next
34851 A process that is testing addresses (the &%-bt%& option) runs as root so that
34852 the routing is done in the same environment as a message delivery.
34853 .endlist
34854
34855
34856
34857
34858 .section "Running Exim without privilege" "SECTrunexiwitpri"
34859 .cindex "privilege, running without"
34860 .cindex "unprivileged running"
34861 .cindex "root privilege" "running without"
34862 Some installations like to run Exim in an unprivileged state for more of its
34863 operation, for added security. Support for this mode of operation is provided
34864 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34865 gid are changed to the Exim user and group at the start of a delivery process
34866 (and also queue runner and address testing processes). This means that address
34867 routing is no longer run as root, and the deliveries themselves cannot change
34868 to any other uid.
34869
34870 .cindex SIGHUP
34871 .cindex "daemon" "restarting"
34872 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34873 that the daemon can still be started in the usual way, and it can respond
34874 correctly to SIGHUP because the re-invocation regains root privilege.
34875
34876 An alternative approach is to make Exim setuid to the Exim user and also setgid
34877 to the Exim group. If you do this, the daemon must be started from a root
34878 process. (Calling Exim from a root process makes it behave in the way it does
34879 when it is setuid root.) However, the daemon cannot restart itself after a
34880 SIGHUP signal because it cannot regain privilege.
34881
34882 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34883 stops Exim from trying to re-invoke itself to do a delivery after a message has
34884 been received. Such a re-invocation is a waste of resources because it has no
34885 effect.
34886
34887 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34888 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34889 to the Exim user seems a clean approach, but there is one complication:
34890
34891 In this style of operation, Exim is running with the real uid and gid set to
34892 those of the calling process, and the effective uid/gid set to Exim's values.
34893 Ideally, any association with the calling process' uid/gid should be dropped,
34894 that is, the real uid/gid should be reset to the effective values so as to
34895 discard any privileges that the caller may have. While some operating systems
34896 have a function that permits this action for a non-root effective uid, quite a
34897 number of them do not. Because of this lack of standardization, Exim does not
34898 address this problem at this time.
34899
34900 For this reason, the recommended approach for &"mostly unprivileged"& running
34901 is to keep the Exim binary setuid to root, and to set
34902 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34903 be used in the most straightforward way.
34904
34905 If you configure Exim not to run delivery processes as root, there are a
34906 number of restrictions on what you can do:
34907
34908 .ilist
34909 You can deliver only as the Exim user/group. You should  explicitly use the
34910 &%user%& and &%group%& options to override routers or local transports that
34911 normally deliver as the recipient. This makes sure that configurations that
34912 work in this mode function the same way in normal mode. Any implicit or
34913 explicit specification of another user causes an error.
34914 .next
34915 Use of &_.forward_& files is severely restricted, such that it is usually
34916 not worthwhile to include them in the configuration.
34917 .next
34918 Users who wish to use &_.forward_& would have to make their home directory and
34919 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34920 and their equivalents in Exim filters, cannot be used. While they could be
34921 enabled in the Exim user's name, that would be insecure and not very useful.
34922 .next
34923 Unless the local user mailboxes are all owned by the Exim user (possible in
34924 some POP3 or IMAP-only environments):
34925
34926 .olist
34927 They must be owned by the Exim group and be writeable by that group. This
34928 implies you must set &%mode%& in the appendfile configuration, as well as the
34929 mode of the mailbox files themselves.
34930 .next
34931 You must set &%no_check_owner%&, since most or all of the files will not be
34932 owned by the Exim user.
34933 .next
34934 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34935 on a newly created mailbox when unprivileged. This also implies that new
34936 mailboxes need to be created manually.
34937 .endlist olist
34938 .endlist ilist
34939
34940
34941 These restrictions severely restrict what can be done in local deliveries.
34942 However, there are no restrictions on remote deliveries. If you are running a
34943 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34944 gives more security at essentially no cost.
34945
34946 If you are using the &%mua_wrapper%& facility (see chapter
34947 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34948
34949
34950
34951
34952 .section "Delivering to local files" "SECID271"
34953 Full details of the checks applied by &(appendfile)& before it writes to a file
34954 are given in chapter &<<CHAPappendfile>>&.
34955
34956
34957
34958 .section "IPv4 source routing" "SECID272"
34959 .cindex "source routing" "in IP packets"
34960 .cindex "IP source routing"
34961 Many operating systems suppress IP source-routed packets in the kernel, but
34962 some cannot be made to do this, so Exim does its own check. It logs incoming
34963 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34964 IPv6. No special checking is currently done.
34965
34966
34967
34968 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34969 Support for these SMTP commands is disabled by default. If required, they can
34970 be enabled by defining suitable ACLs.
34971
34972
34973
34974
34975 .section "Privileged users" "SECID274"
34976 .cindex "trusted users"
34977 .cindex "admin user"
34978 .cindex "privileged user"
34979 .cindex "user" "trusted"
34980 .cindex "user" "admin"
34981 Exim recognizes two sets of users with special privileges. Trusted users are
34982 able to submit new messages to Exim locally, but supply their own sender
34983 addresses and information about a sending host. For other users submitting
34984 local messages, Exim sets up the sender address from the uid, and doesn't
34985 permit a remote host to be specified.
34986
34987 .oindex "&%-f%&"
34988 However, an untrusted user is permitted to use the &%-f%& command line option
34989 in the special form &%-f <>%& to indicate that a delivery failure for the
34990 message should not cause an error report. This affects the message's envelope,
34991 but it does not affect the &'Sender:'& header. Untrusted users may also be
34992 permitted to use specific forms of address with the &%-f%& option by setting
34993 the &%untrusted_set_sender%& option.
34994
34995 Trusted users are used to run processes that receive mail messages from some
34996 other mail domain and pass them on to Exim for delivery either locally, or over
34997 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34998 as any user listed in the &%trusted_users%& configuration option, or under any
34999 group listed in the &%trusted_groups%& option.
35000
35001 Admin users are permitted to do things to the messages on Exim's queue. They
35002 can freeze or thaw messages, cause them to be returned to their senders, remove
35003 them entirely, or modify them in various ways. In addition, admin users can run
35004 the Exim monitor and see all the information it is capable of providing, which
35005 includes the contents of files on the spool.
35006
35007 .oindex "&%-M%&"
35008 .oindex "&%-q%&"
35009 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35010 delivery of messages on its queue is restricted to admin users. This
35011 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35012 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35013 queue is also restricted to admin users. This restriction can be relaxed by
35014 setting &%no_queue_list_requires_admin%&.
35015
35016 Exim recognizes an admin user if the calling process is running as root or as
35017 the Exim user or if any of the groups associated with the calling process is
35018 the Exim group. It is not necessary actually to be running under the Exim
35019 group. However, if admin users who are not root or the Exim user are to access
35020 the contents of files on the spool via the Exim monitor (which runs
35021 unprivileged), Exim must be built to allow group read access to its spool
35022 files.
35023
35024
35025
35026 .section "Spool files" "SECID275"
35027 .cindex "spool directory" "files"
35028 Exim's spool directory and everything it contains is owned by the Exim user and
35029 set to the Exim group. The mode for spool files is defined in the
35030 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35031 any user who is a member of the Exim group can access these files.
35032
35033
35034
35035 .section "Use of argv[0]" "SECID276"
35036 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35037 of specific strings, Exim assumes certain options. For example, calling Exim
35038 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35039 to calling it with the option &%-bS%&. There are no security implications in
35040 this.
35041
35042
35043
35044 .section "Use of %f formatting" "SECID277"
35045 The only use made of &"%f"& by Exim is in formatting load average values. These
35046 are actually stored in integer variables as 1000 times the load average.
35047 Consequently, their range is limited and so therefore is the length of the
35048 converted output.
35049
35050
35051
35052 .section "Embedded Exim path" "SECID278"
35053 Exim uses its own path name, which is embedded in the code, only when it needs
35054 to re-exec in order to regain root privilege. Therefore, it is not root when it
35055 does so. If some bug allowed the path to get overwritten, it would lead to an
35056 arbitrary program's being run as exim, not as root.
35057
35058
35059
35060 .section "Dynamic module directory" "SECTdynmoddir"
35061 Any dynamically loadable modules must be installed into the directory
35062 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35063 loading it.
35064
35065
35066 .section "Use of sprintf()" "SECID279"
35067 .cindex "&[sprintf()]&"
35068 A large number of occurrences of &"sprintf"& in the code are actually calls to
35069 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35070 The intermediate formatting is done into a large fixed buffer by a function
35071 that runs through the format string itself, and checks the length of each
35072 conversion before performing it, thus preventing buffer overruns.
35073
35074 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35075 the output buffer is known to be sufficiently long to contain the converted
35076 string.
35077
35078
35079
35080 .section "Use of debug_printf() and log_write()" "SECID280"
35081 Arbitrary strings are passed to both these functions, but they do their
35082 formatting by calling the function &'string_vformat()'&, which runs through
35083 the format string itself, and checks the length of each conversion.
35084
35085
35086
35087 .section "Use of strcat() and strcpy()" "SECID281"
35088 These are used only in cases where the output buffer is known to be large
35089 enough to hold the result.
35090 .ecindex IIDsecurcon
35091
35092
35093
35094
35095 . ////////////////////////////////////////////////////////////////////////////
35096 . ////////////////////////////////////////////////////////////////////////////
35097
35098 .chapter "Format of spool files" "CHAPspool"
35099 .scindex IIDforspo1 "format" "spool files"
35100 .scindex IIDforspo2 "spool directory" "format of files"
35101 .scindex IIDforspo3 "spool files" "format of"
35102 .cindex "spool files" "editing"
35103 A message on Exim's queue consists of two files, whose names are the message id
35104 followed by -D and -H, respectively. The data portion of the message is kept in
35105 the -D file on its own. The message's envelope, status, and headers are all
35106 kept in the -H file, whose format is described in this chapter. Each of these
35107 two files contains the final component of its own name as its first line. This
35108 is insurance against disk crashes where the directory is lost but the files
35109 themselves are recoverable.
35110
35111 Some people are tempted into editing -D files in order to modify messages. You
35112 need to be extremely careful if you do this; it is not recommended and you are
35113 on your own if you do it. Here are some of the pitfalls:
35114
35115 .ilist
35116 You must ensure that Exim does not try to deliver the message while you are
35117 fiddling with it. The safest way is to take out a write lock on the -D file,
35118 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35119 place, the lock will be retained. If you write a new file and rename it, the
35120 lock will be lost at the instant of rename.
35121 .next
35122 .vindex "&$body_linecount$&"
35123 If you change the number of lines in the file, the value of
35124 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35125 present, this value is not used by Exim, but there is no guarantee that this
35126 will always be the case.
35127 .next
35128 If the message is in MIME format, you must take care not to break it.
35129 .next
35130 If the message is cryptographically signed, any change will invalidate the
35131 signature.
35132 .endlist
35133 All in all, modifying -D files is fraught with danger.
35134
35135 Files whose names end with -J may also be seen in the &_input_& directory (or
35136 its subdirectories when &%split_spool_directory%& is set). These are journal
35137 files, used to record addresses to which the message has been delivered during
35138 the course of a delivery attempt. If there are still undelivered recipients at
35139 the end, the -H file is updated, and the -J file is deleted. If, however, there
35140 is some kind of crash (for example, a power outage) before this happens, the -J
35141 file remains in existence. When Exim next processes the message, it notices the
35142 -J file and uses it to update the -H file before starting the next delivery
35143 attempt.
35144
35145 .section "Format of the -H file" "SECID282"
35146 .cindex "uid (user id)" "in spool file"
35147 .cindex "gid (group id)" "in spool file"
35148 The second line of the -H file contains the login name for the uid of the
35149 process that called Exim to read the message, followed by the numerical uid and
35150 gid. For a locally generated message, this is normally the user who sent the
35151 message. For a message received over TCP/IP via the daemon, it is
35152 normally the Exim user.
35153
35154 The third line of the file contains the address of the message's sender as
35155 transmitted in the envelope, contained in angle brackets. The sender address is
35156 empty for bounce messages. For incoming SMTP mail, the sender address is given
35157 in the MAIL command. For locally generated mail, the sender address is
35158 created by Exim from the login name of the current user and the configured
35159 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35160 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35161 &"<>"& or an address that matches &%untrusted_set_senders%&.
35162
35163 The fourth line contains two numbers. The first is the time that the message
35164 was received, in the conventional Unix form &-- the number of seconds since the
35165 start of the epoch. The second number is a count of the number of messages
35166 warning of delayed delivery that have been sent to the sender.
35167
35168 There follow a number of lines starting with a hyphen. These can appear in any
35169 order, and are omitted when not relevant:
35170
35171 .vlist
35172 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35173 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35174 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35175 recognized, to provide backward compatibility. In the old format, a line of
35176 this form is present for every ACL variable that is not empty. The number
35177 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35178 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35179 the data string for the variable. The string itself starts at the beginning of
35180 the next line, and is followed by a newline character. It may contain internal
35181 newlines.
35182
35183 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35184 A line of this form is present for every ACL connection variable that is
35185 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35186 The length is the length of the data string for the variable. The string itself
35187 starts at the beginning of the next line, and is followed by a newline
35188 character. It may contain internal newlines.
35189
35190 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35191 A line of this form is present for every ACL message variable that is defined.
35192 Note that there is a space between &%-aclm%& and the rest of the name. The
35193 length is the length of the data string for the variable. The string itself
35194 starts at the beginning of the next line, and is followed by a newline
35195 character. It may contain internal newlines.
35196
35197 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35198 This is present if, when the message was received over SMTP, the value of
35199 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35200
35201 .vitem &%-allow_unqualified_recipient%&
35202 This is present if unqualified recipient addresses are permitted in header
35203 lines (to stop such addresses from being qualified if rewriting occurs at
35204 transport time). Local messages that were input using &%-bnq%& and remote
35205 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35206
35207 .vitem &%-allow_unqualified_sender%&
35208 This is present if unqualified sender addresses are permitted in header lines
35209 (to stop such addresses from being qualified if rewriting occurs at transport
35210 time). Local messages that were input using &%-bnq%& and remote messages from
35211 hosts that match &%sender_unqualified_hosts%& set this flag.
35212
35213 .vitem "&%-auth_id%&&~<&'text'&>"
35214 The id information for a message received on an authenticated SMTP connection
35215 &-- the value of the &$authenticated_id$& variable.
35216
35217 .vitem "&%-auth_sender%&&~<&'address'&>"
35218 The address of an authenticated sender &-- the value of the
35219 &$authenticated_sender$& variable.
35220
35221 .vitem "&%-body_linecount%&&~<&'number'&>"
35222 This records the number of lines in the body of the message, and is always
35223 present.
35224
35225 .vitem "&%-body_zerocount%&&~<&'number'&>"
35226 This records the number of binary zero bytes in the body of the message, and is
35227 present if the number is greater than zero.
35228
35229 .vitem &%-deliver_firsttime%&
35230 This is written when a new message is first added to the spool. When the spool
35231 file is updated after a deferral, it is omitted.
35232
35233 .vitem "&%-frozen%&&~<&'time'&>"
35234 .cindex "frozen messages" "spool data"
35235 The message is frozen, and the freezing happened at <&'time'&>.
35236
35237 .vitem "&%-helo_name%&&~<&'text'&>"
35238 This records the host name as specified by a remote host in a HELO or EHLO
35239 command.
35240
35241 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35242 This records the IP address of the host from which the message was received and
35243 the remote port number that was used. It is omitted for locally generated
35244 messages.
35245
35246 .vitem "&%-host_auth%&&~<&'text'&>"
35247 If the message was received on an authenticated SMTP connection, this records
35248 the name of the authenticator &-- the value of the
35249 &$sender_host_authenticated$& variable.
35250
35251 .vitem &%-host_lookup_failed%&
35252 This is present if an attempt to look up the sending host's name from its IP
35253 address failed. It corresponds to the &$host_lookup_failed$& variable.
35254
35255 .vitem "&%-host_name%&&~<&'text'&>"
35256 .cindex "reverse DNS lookup"
35257 .cindex "DNS" "reverse lookup"
35258 This records the name of the remote host from which the message was received,
35259 if the host name was looked up from the IP address when the message was being
35260 received. It is not present if no reverse lookup was done.
35261
35262 .vitem "&%-ident%&&~<&'text'&>"
35263 For locally submitted messages, this records the login of the originating user,
35264 unless it was a trusted user and the &%-oMt%& option was used to specify an
35265 ident value. For messages received over TCP/IP, this records the ident string
35266 supplied by the remote host, if any.
35267
35268 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35269 This records the IP address of the local interface and the port number through
35270 which a message was received from a remote host. It is omitted for locally
35271 generated messages.
35272
35273 .vitem &%-local%&
35274 The message is from a local sender.
35275
35276 .vitem &%-localerror%&
35277 The message is a locally-generated bounce message.
35278
35279 .vitem "&%-local_scan%&&~<&'string'&>"
35280 This records the data string that was returned by the &[local_scan()]& function
35281 when the message was received &-- the value of the &$local_scan_data$&
35282 variable. It is omitted if no data was returned.
35283
35284 .vitem &%-manual_thaw%&
35285 The message was frozen but has been thawed manually, that is, by an explicit
35286 Exim command rather than via the auto-thaw process.
35287
35288 .vitem &%-N%&
35289 A testing delivery process was started using the &%-N%& option to suppress any
35290 actual deliveries, but delivery was deferred. At any further delivery attempts,
35291 &%-N%& is assumed.
35292
35293 .vitem &%-received_protocol%&
35294 This records the value of the &$received_protocol$& variable, which contains
35295 the name of the protocol by which the message was received.
35296
35297 .vitem &%-sender_set_untrusted%&
35298 The envelope sender of this message was set by an untrusted local caller (used
35299 to ensure that the caller is displayed in queue listings).
35300
35301 .vitem "&%-spam_score_int%&&~<&'number'&>"
35302 If a message was scanned by SpamAssassin, this is present. It records the value
35303 of &$spam_score_int$&.
35304
35305 .vitem &%-tls_certificate_verified%&
35306 A TLS certificate was received from the client that sent this message, and the
35307 certificate was verified by the server.
35308
35309 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35310 When the message was received over an encrypted connection, this records the
35311 name of the cipher suite that was used.
35312
35313 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35314 When the message was received over an encrypted connection, and a certificate
35315 was received from the client, this records the Distinguished Name from that
35316 certificate.
35317 .endlist
35318
35319 Following the options there is a list of those addresses to which the message
35320 is not to be delivered. This set of addresses is initialized from the command
35321 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35322 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35323 the address is added to this set. The addresses are kept internally as a
35324 balanced binary tree, and it is a representation of that tree which is written
35325 to the spool file. If an address is expanded via an alias or forward file, the
35326 original address is added to the tree when deliveries to all its child
35327 addresses are complete.
35328
35329 If the tree is empty, there is a single line in the spool file containing just
35330 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35331 Y or N, followed by an address. The address is the value for the node of the
35332 tree, and the letters indicate whether the node has a left branch and/or a
35333 right branch attached to it, respectively. If branches exist, they immediately
35334 follow. Here is an example of a three-node tree:
35335 .code
35336 YY darcy@austen.fict.example
35337 NN alice@wonderland.fict.example
35338 NN editor@thesaurus.ref.example
35339 .endd
35340 After the non-recipients tree, there is a list of the message's recipients.
35341 This is a simple list, preceded by a count. It includes all the original
35342 recipients of the message, including those to whom the message has already been
35343 delivered. In the simplest case, the list contains one address per line. For
35344 example:
35345 .code
35346 4
35347 editor@thesaurus.ref.example
35348 darcy@austen.fict.example
35349 rdo@foundation
35350 alice@wonderland.fict.example
35351 .endd
35352 However, when a child address has been added to the top-level addresses as a
35353 result of the use of the &%one_time%& option on a &(redirect)& router, each
35354 line is of the following form:
35355 .display
35356 <&'top-level address'&> <&'errors_to address'&> &&&
35357   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35358 .endd
35359 The 01 flag bit indicates the presence of the three other fields that follow
35360 the top-level address. Other bits may be used in future to support additional
35361 fields. The <&'parent number'&> is the offset in the recipients list of the
35362 original parent of the &"one time"& address. The first two fields are the
35363 envelope sender that is associated with this address and its length. If the
35364 length is zero, there is no special envelope sender (there are then two space
35365 characters in the line). A non-empty field can arise from a &(redirect)& router
35366 that has an &%errors_to%& setting.
35367
35368
35369 A blank line separates the envelope and status information from the headers
35370 which follow. A header may occupy several lines of the file, and to save effort
35371 when reading it in, each header is preceded by a number and an identifying
35372 character. The number is the number of characters in the header, including any
35373 embedded newlines and the terminating newline. The character is one of the
35374 following:
35375
35376 .table2 50pt
35377 .row <&'blank'&>         "header in which Exim has no special interest"
35378 .row &`B`&               "&'Bcc:'& header"
35379 .row &`C`&               "&'Cc:'& header"
35380 .row &`F`&               "&'From:'& header"
35381 .row &`I`&               "&'Message-id:'& header"
35382 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35383 .row &`R`&               "&'Reply-To:'& header"
35384 .row &`S`&               "&'Sender:'& header"
35385 .row &`T`&               "&'To:'& header"
35386 .row &`*`&               "replaced or deleted header"
35387 .endtable
35388
35389 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35390 purposes. They are not transmitted when the message is delivered. Here is a
35391 typical set of headers:
35392 .code
35393 111P Received: by hobbit.fict.example with local (Exim 4.00)
35394 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35395 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35396 038* X-rewrote-sender: bb@hobbit.fict.example
35397 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35398 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35399 099* To: alice@wonderland.fict.example, rdo@foundation,
35400 darcy@austen.fict.example, editor@thesaurus.ref.example
35401 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35402 darcy@austen.fict.example, editor@thesaurus.ref.example
35403 038  Date: Fri, 11 May 2001 10:28:59 +0100
35404 .endd
35405 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35406 &'To:'& header have been rewritten, the last one because routing expanded the
35407 unqualified domain &'foundation'&.
35408 .ecindex IIDforspo1
35409 .ecindex IIDforspo2
35410 .ecindex IIDforspo3
35411
35412 . ////////////////////////////////////////////////////////////////////////////
35413 . ////////////////////////////////////////////////////////////////////////////
35414
35415 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35416          "DKIM Support"
35417 .cindex "DKIM"
35418
35419 DKIM is a mechanism by which messages sent by some entity can be provably
35420 linked to a domain which that entity controls.  It permits reputation to
35421 be tracked on a per-domain basis, rather than merely upon source IP address.
35422 DKIM is documented in RFC 4871.
35423
35424 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35425 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35426
35427 Exim's DKIM implementation allows to
35428 .olist
35429 Sign outgoing messages: This function is implemented in the SMTP transport.
35430 It can co-exist with all other Exim features, including transport filters.
35431 .next
35432 Verify signatures in incoming messages: This is implemented by an additional
35433 ACL (acl_smtp_dkim), which can be called several times per message, with
35434 different signature contexts.
35435 .endlist
35436
35437 In typical Exim style, the verification implementation does not include any
35438 default "policy". Instead it enables you to build your own policy using
35439 Exim's standard controls.
35440
35441 Please note that verification of DKIM signatures in incoming mail is turned
35442 on by default for logging purposes. For each signature in incoming email,
35443 exim will log a line displaying the most important signature details, and the
35444 signature status. Here is an example (with line-breaks added for clarity):
35445 .code
35446 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35447     d=facebookmail.com s=q1-2009b
35448     c=relaxed/relaxed a=rsa-sha1
35449     i=@facebookmail.com t=1252484542 [verification succeeded]
35450 .endd
35451 You might want to turn off DKIM verification processing entirely for internal
35452 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35453 control modifier. This should typically be done in the RCPT ACL, at points
35454 where you accept mail from relay sources (internal hosts or authenticated
35455 senders).
35456
35457
35458 .section "Signing outgoing messages" "SECID513"
35459 .cindex "DKIM" "signing"
35460
35461 Signing is implemented by setting private options on the SMTP transport.
35462 These options take (expandable) strings as arguments.
35463
35464 .option dkim_domain smtp string&!! unset
35465 MANDATORY:
35466 The domain you want to sign with. The result of this expanded
35467 option is put into the &%$dkim_domain%& expansion variable.
35468
35469 .option dkim_selector smtp string&!! unset
35470 MANDATORY:
35471 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35472 variable to look up a matching selector. The result is put in the expansion
35473 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35474 option along with &%$dkim_domain%&.
35475
35476 .option dkim_private_key smtp string&!! unset
35477 MANDATORY:
35478 This sets the private key to use. You can use the &%$dkim_domain%& and
35479 &%$dkim_selector%& expansion variables to determine the private key to use.
35480 The result can either
35481 .ilist
35482 be a valid RSA private key in ASCII armor, including line breaks.
35483 .next
35484 start with a slash, in which case it is treated as a file that contains
35485 the private key.
35486 .next
35487 be "0", "false" or the empty string, in which case the message will not
35488 be signed. This case will not result in an error, even if &%dkim_strict%&
35489 is set.
35490 .endlist
35491
35492 .option dkim_canon smtp string&!! unset
35493 OPTIONAL:
35494 This option sets the canonicalization method used when signing a message.
35495 The DKIM RFC currently supports two methods: "simple" and "relaxed".
35496 The option defaults to "relaxed" when unset. Note: the current implementation
35497 only supports using the same canonicalization method for both headers and body.
35498
35499 .option dkim_strict smtp string&!! unset
35500 OPTIONAL:
35501 This  option  defines  how  Exim  behaves  when  signing a message that
35502 should be signed fails for some reason.  When the expansion evaluates to
35503 either "1" or "true", Exim will defer. Otherwise Exim will send the message
35504 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
35505 variables here.
35506
35507 .option dkim_sign_headers smtp string&!! unset
35508 OPTIONAL:
35509 When set, this option must expand to (or be specified as) a colon-separated
35510 list of header names. Headers with these names will be included in the message
35511 signature. When unspecified, the header names recommended in RFC4871 will be
35512 used.
35513
35514
35515 .section "Verifying DKIM signatures in incoming mail" "SECID514"
35516 .cindex "DKIM" "verification"
35517
35518 Verification of DKIM signatures in incoming email is implemented via the
35519 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
35520 syntactically(!) correct signature in the incoming message.
35521
35522 To evaluate the signature in the ACL a large number of expansion variables
35523 containing the signature status and its details are set up during the
35524 runtime of the ACL.
35525
35526 Calling the ACL only for existing signatures is not sufficient to build
35527 more advanced policies. For that reason, the global option
35528 &%dkim_verify_signers%&, and a global expansion variable
35529 &%$dkim_signers%& exist.
35530
35531 The global option &%dkim_verify_signers%& can be set to a colon-separated
35532 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
35533 called. It is expanded when the message has been received. At this point,
35534 the expansion variable &%$dkim_signers%& already contains a colon-separated
35535 list of signer domains and identities for the message. When
35536 &%dkim_verify_signers%& is not specified in the main configuration,
35537 it defaults as:
35538 .code
35539 dkim_verify_signers = $dkim_signers
35540 .endd
35541 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
35542 DKIM signature in the message. Current DKIM verifiers may want to explicitly
35543 call the ACL for known domains or identities. This would be achieved as follows:
35544 .code
35545 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
35546 .endd
35547 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
35548 and "ebay.com", plus all domains and identities that have signatures in the message.
35549 You can also be more creative in constructing your policy. For example:
35550 .code
35551 dkim_verify_signers = $sender_address_domain:$dkim_signers
35552 .endd
35553
35554 If a domain or identity is listed several times in the (expanded) value of
35555 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
35556
35557
35558 Inside the &%acl_smtp_dkim%&, the following expansion variables are
35559 available (from most to least important):
35560
35561
35562 .vlist
35563 .vitem &%$dkim_cur_signer%&
35564 The signer that is being evaluated in this ACL run. This can be a domain or
35565 an identity. This is one of the list items from the expanded main option
35566 &%dkim_verify_signers%& (see above).
35567 .vitem &%$dkim_verify_status%&
35568 A string describing the general status of the signature. One of
35569 .ilist
35570 &%none%&: There is no signature in the message for the current domain or
35571 identity (as reflected by &%$dkim_cur_signer%&).
35572 .next
35573 &%invalid%&: The signature could not be verified due to a processing error.
35574 More detail is available in &%$dkim_verify_reason%&.
35575 .next
35576 &%fail%&: Verification of the signature failed.  More detail is
35577 available in &%$dkim_verify_reason%&.
35578 .next
35579 &%pass%&: The signature passed verification. It is valid.
35580 .endlist
35581 .vitem &%$dkim_verify_reason%&
35582 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
35583 "fail" or "invalid". One of
35584 .ilist
35585 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
35586 key for the domain could not be retrieved. This may be a temporary problem.
35587 .next
35588 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
35589 record for the domain is syntactically invalid.
35590 .next
35591 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
35592 body hash does not match the one specified in the signature header. This
35593 means that the message body was modified in transit.
35594 .next
35595 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
35596 could not be verified. This may mean that headers were modified,
35597 re-written or otherwise changed in a way which is incompatible with
35598 DKIM verification. It may of course also mean that the signature is forged.
35599 .endlist
35600 .vitem &%$dkim_domain%&
35601 The signing domain. IMPORTANT: This variable is only populated if there is
35602 an actual signature in the message for the current domain or identity (as
35603 reflected by &%$dkim_cur_signer%&).
35604 .vitem &%$dkim_identity%&
35605 The signing identity, if present. IMPORTANT: This variable is only populated
35606 if there is an actual signature in the message for the current domain or
35607 identity (as reflected by &%$dkim_cur_signer%&).
35608 .vitem &%$dkim_selector%&
35609 The key record selector string.
35610 .vitem &%$dkim_algo%&
35611 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
35612 .vitem &%$dkim_canon_body%&
35613 The body canonicalization method. One of 'relaxed' or 'simple'.
35614 .vitem &%dkim_canon_headers%&
35615 The header canonicalization method. One of 'relaxed' or 'simple'.
35616 .vitem &%$dkim_copiedheaders%&
35617 A transcript of headers and their values which are included in the signature
35618 (copied from the 'z=' tag of the signature).
35619 .vitem &%$dkim_bodylength%&
35620 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
35621 limit was set by the signer, "9999999999999" is returned. This makes sure
35622 that this variable always expands to an integer value.
35623 .vitem &%$dkim_created%&
35624 UNIX timestamp reflecting the date and time when the signature was created.
35625 When this was not specified by the signer, "0" is returned.
35626 .vitem &%$dkim_expires%&
35627 UNIX timestamp reflecting the date and time when the signer wants the
35628 signature to be treated as "expired". When this was not specified by the
35629 signer, "9999999999999" is returned. This makes it possible to do useful
35630 integer size comparisons against this value.
35631 .vitem &%$dkim_headernames%&
35632 A colon-separated list of names of headers included in the signature.
35633 .vitem &%$dkim_key_testing%&
35634 "1" if the key record has the "testing" flag set, "0" if not.
35635 .vitem &%$nosubdomains%&
35636 "1" if the key record forbids subdomaining, "0" otherwise.
35637 .vitem &%$dkim_key_srvtype%&
35638 Service type (tag s=) from the key record. Defaults to "*" if not specified
35639 in the key record.
35640 .vitem &%$dkim_key_granularity%&
35641 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
35642 in the key record.
35643 .vitem &%$dkim_key_notes%&
35644 Notes from the key record (tag n=).
35645 .endlist
35646
35647 In addition, two ACL conditions are provided:
35648
35649 .vlist
35650 .vitem &%dkim_signers%&
35651 ACL condition that checks a colon-separated list of domains or identities
35652 for a match against the domain or identity that the ACL is currently verifying
35653 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
35654 verb to a group of domains or identities. For example:
35655
35656 .code
35657 # Warn when Mail purportedly from GMail has no signature at all
35658 warn log_message = GMail sender without DKIM signature
35659      sender_domains = gmail.com
35660      dkim_signers = gmail.com
35661      dkim_status = none
35662 .endd
35663
35664 .vitem &%dkim_status%&
35665 ACL condition that checks a colon-separated list of possible DKIM verification
35666 results agains the actual result of verification. This is typically used
35667 to restrict an ACL verb to a list of verification outcomes, for example:
35668
35669 .code
35670 deny message = Mail from Paypal with invalid/missing signature
35671      sender_domains = paypal.com:paypal.de
35672      dkim_signers = paypal.com:paypal.de
35673      dkim_status = none:invalid:fail
35674 .endd
35675
35676 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
35677 see the documentation of the &%$dkim_verify_status%& expansion variable above
35678 for more information of what they mean.
35679 .endlist
35680
35681 . ////////////////////////////////////////////////////////////////////////////
35682 . ////////////////////////////////////////////////////////////////////////////
35683
35684 .chapter "Adding new drivers or lookup types" "CHID13" &&&
35685          "Adding drivers or lookups"
35686 .cindex "adding drivers"
35687 .cindex "new drivers, adding"
35688 .cindex "drivers" "adding new"
35689 The following actions have to be taken in order to add a new router, transport,
35690 authenticator, or lookup type to Exim:
35691
35692 .olist
35693 Choose a name for the driver or lookup type that does not conflict with any
35694 existing name; I will use &"newdriver"& in what follows.
35695 .next
35696 Add to &_src/EDITME_& the line:
35697 .display
35698 <&'type'&>&`_NEWDRIVER=yes`&
35699 .endd
35700 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35701 code is not to be included in the binary by default, comment this line out. You
35702 should also add any relevant comments about the driver or lookup type.
35703 .next
35704 Add to &_src/config.h.defaults_& the line:
35705 .code
35706 #define <type>_NEWDRIVER
35707 .endd
35708 .next
35709 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35710 and create a table entry as is done for all the other drivers and lookup types.
35711 .next
35712 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35713 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35714 driver or lookup type and add it to the definition of OBJ.
35715 .next
35716 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35717 &_src_&.
35718 .next
35719 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35720 as for other drivers and lookups.
35721 .endlist
35722
35723 Then all you need to do is write the code! A good way to start is to make a
35724 proforma by copying an existing module of the same type, globally changing all
35725 occurrences of the name, and cutting out most of the code. Note that any
35726 options you create must be listed in alphabetical order, because the tables are
35727 searched using a binary chop procedure.
35728
35729 There is a &_README_& file in each of the sub-directories of &_src_& describing
35730 the interface that is expected.
35731
35732
35733
35734
35735 . ////////////////////////////////////////////////////////////////////////////
35736 . ////////////////////////////////////////////////////////////////////////////
35737
35738 . /////////////////////////////////////////////////////////////////////////////
35739 . These lines are processing instructions for the Simple DocBook Processor that
35740 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35741 . PDFs than using xmlto and fop. They will be ignored by all other XML
35742 . processors.
35743 . /////////////////////////////////////////////////////////////////////////////
35744
35745 .literal xml
35746 <?sdop
35747   format="newpage"
35748   foot_right_recto="&chaptertitle;"
35749   foot_right_verso="&chaptertitle;"
35750 ?>
35751 .literal off
35752
35753 .makeindex "Options index"   "option"
35754 .makeindex "Variables index" "variable"
35755 .makeindex "Concept index"   "concept"
35756
35757
35758 . /////////////////////////////////////////////////////////////////////////////
35759 . /////////////////////////////////////////////////////////////////////////////