Add -bI:help and -bI:sieve
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing. Remember that
45 . the <bookinfo> element must also be updated for each new edition.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.80"
49 .set version "4.80"
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54
55 . /////////////////////////////////////////////////////////////////////////////
56 . Additional xfpt markup used by this document, over and above the default
57 . provided in the xfpt library.
58 . /////////////////////////////////////////////////////////////////////////////
59
60 . --- Override the &$ flag to automatically insert a $ with the variable name
61
62 .flag &$  $&   "<varname>$"  "</varname>"
63
64 . --- Short flags for daggers in option headings. They will always be inside
65 . --- an italic string, but we want the daggers to be roman.
66
67 .flag &!!      "</emphasis>&dagger;<emphasis>"
68 .flag &!?      "</emphasis>&Dagger;<emphasis>"
69
70 . --- A macro for an Exim option definition heading, generating a one-line
71 . --- table with four columns. For cases when the option name is given with
72 . --- a space, so that it can be split, a fifth argument is used for the
73 . --- index entry.
74
75 .macro option
76 .arg 5
77 .oindex "&%$5%&"
78 .endarg
79 .arg -5
80 .oindex "&%$1%&"
81 .endarg
82 .itable all 0 0 4 8* left 6* center 6* center 6* right
83 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
84 .endtable
85 .endmacro
86
87 . --- A macro for the common 2-column tables. The width of the first column
88 . --- is suitable for the many tables at the start of the main options chapter;
89 . --- the small number of other 2-column tables override it.
90
91 .macro table2 196pt 254pt
92 .itable none 0 0 2 $1 left $2 left
93 .endmacro
94
95 . --- A macro that generates .row, but puts &I; at the start of the first
96 . --- argument, thus indenting it. Assume a minimum of two arguments, and
97 . --- allow up to four arguments, which is as many as we'll ever need.
98
99 .macro irow
100 .arg 4
101 .row "&I;$1" "$2" "$3" "$4"
102 .endarg
103 .arg -4
104 .arg 3
105 .row "&I;$1" "$2" "$3"
106 .endarg
107 .arg -3
108 .row "&I;$1" "$2"
109 .endarg
110 .endarg
111 .endmacro
112
113 . --- Macros for option, variable, and concept index entries. For a "range"
114 . --- style of entry, use .scindex for the start and .ecindex for the end. The
115 . --- first argument of .scindex and the only argument of .ecindex must be the
116 . --- ID that ties them together.
117
118 .macro cindex
119 &<indexterm role="concept">&
120 &<primary>&$1&</primary>&
121 .arg 2
122 &<secondary>&$2&</secondary>&
123 .endarg
124 &</indexterm>&
125 .endmacro
126
127 .macro scindex
128 &<indexterm role="concept" id="$1" class="startofrange">&
129 &<primary>&$2&</primary>&
130 .arg 3
131 &<secondary>&$3&</secondary>&
132 .endarg
133 &</indexterm>&
134 .endmacro
135
136 .macro ecindex
137 &<indexterm role="concept" startref="$1" class="endofrange"/>&
138 .endmacro
139
140 .macro oindex
141 &<indexterm role="option">&
142 &<primary>&$1&</primary>&
143 .arg 2
144 &<secondary>&$2&</secondary>&
145 .endarg
146 &</indexterm>&
147 .endmacro
148
149 .macro vindex
150 &<indexterm role="variable">&
151 &<primary>&$1&</primary>&
152 .arg 2
153 &<secondary>&$2&</secondary>&
154 .endarg
155 &</indexterm>&
156 .endmacro
157
158 .macro index
159 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
160 .endmacro
161 . ////////////////////////////////////////////////////////////////////////////
162
163
164 . ////////////////////////////////////////////////////////////////////////////
165 . The <bookinfo> element is removed from the XML before processing for Ascii
166 . output formats.
167 . ////////////////////////////////////////////////////////////////////////////
168
169 .literal xml
170 <bookinfo>
171 <title>Specification of the Exim Mail Transfer Agent</title>
172 <titleabbrev>The Exim MTA</titleabbrev>
173 <date>17 May 2012</date>
174 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
175 <authorinitials>EM</authorinitials>
176 <revhistory><revision>
177   <revnumber>4.80</revnumber>
178   <date>17 May 2012</date>
179   <authorinitials>EM</authorinitials>
180 </revision></revhistory>
181 <copyright><year>2012</year><holder>University of Cambridge</holder></copyright>
182 </bookinfo>
183 .literal off
184
185
186 . /////////////////////////////////////////////////////////////////////////////
187 . This chunk of literal XML implements index entries of the form "x, see y" and
188 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
189 . at the top level, so we have to put the .chapter directive first.
190 . /////////////////////////////////////////////////////////////////////////////
191
192 .chapter "Introduction" "CHID1"
193 .literal xml
194
195 <indexterm role="variable">
196   <primary>$1, $2, etc.</primary>
197   <see><emphasis>numerical variables</emphasis></see>
198 </indexterm>
199 <indexterm role="concept">
200   <primary>address</primary>
201   <secondary>rewriting</secondary>
202   <see><emphasis>rewriting</emphasis></see>
203 </indexterm>
204 <indexterm role="concept">
205   <primary>Bounce Address Tag Validation</primary>
206   <see><emphasis>BATV</emphasis></see>
207 </indexterm>
208 <indexterm role="concept">
209   <primary>Client SMTP Authorization</primary>
210   <see><emphasis>CSA</emphasis></see>
211 </indexterm>
212 <indexterm role="concept">
213   <primary>CR character</primary>
214   <see><emphasis>carriage return</emphasis></see>
215 </indexterm>
216 <indexterm role="concept">
217   <primary>CRL</primary>
218   <see><emphasis>certificate revocation list</emphasis></see>
219 </indexterm>
220 <indexterm role="concept">
221   <primary>delivery</primary>
222   <secondary>failure report</secondary>
223   <see><emphasis>bounce message</emphasis></see>
224 </indexterm>
225 <indexterm role="concept">
226   <primary>dialup</primary>
227   <see><emphasis>intermittently connected hosts</emphasis></see>
228 </indexterm>
229 <indexterm role="concept">
230   <primary>exiscan</primary>
231   <see><emphasis>content scanning</emphasis></see>
232 </indexterm>
233 <indexterm role="concept">
234   <primary>failover</primary>
235   <see><emphasis>fallback</emphasis></see>
236 </indexterm>
237 <indexterm role="concept">
238   <primary>fallover</primary>
239   <see><emphasis>fallback</emphasis></see>
240 </indexterm>
241 <indexterm role="concept">
242   <primary>filter</primary>
243   <secondary>Sieve</secondary>
244   <see><emphasis>Sieve filter</emphasis></see>
245 </indexterm>
246 <indexterm role="concept">
247   <primary>ident</primary>
248   <see><emphasis>RFC 1413</emphasis></see>
249 </indexterm>
250 <indexterm role="concept">
251   <primary>LF character</primary>
252   <see><emphasis>linefeed</emphasis></see>
253 </indexterm>
254 <indexterm role="concept">
255   <primary>maximum</primary>
256   <seealso><emphasis>limit</emphasis></seealso>
257 </indexterm>
258 <indexterm role="concept">
259   <primary>monitor</primary>
260   <see><emphasis>Exim monitor</emphasis></see>
261 </indexterm>
262 <indexterm role="concept">
263   <primary>no_<emphasis>xxx</emphasis></primary>
264   <see>entry for xxx</see>
265 </indexterm>
266 <indexterm role="concept">
267   <primary>NUL</primary>
268   <see><emphasis>binary zero</emphasis></see>
269 </indexterm>
270 <indexterm role="concept">
271   <primary>passwd file</primary>
272   <see><emphasis>/etc/passwd</emphasis></see>
273 </indexterm>
274 <indexterm role="concept">
275   <primary>process id</primary>
276   <see><emphasis>pid</emphasis></see>
277 </indexterm>
278 <indexterm role="concept">
279   <primary>RBL</primary>
280   <see><emphasis>DNS list</emphasis></see>
281 </indexterm>
282 <indexterm role="concept">
283   <primary>redirection</primary>
284   <see><emphasis>address redirection</emphasis></see>
285 </indexterm>
286 <indexterm role="concept">
287   <primary>return path</primary>
288   <seealso><emphasis>envelope sender</emphasis></seealso>
289 </indexterm>
290 <indexterm role="concept">
291   <primary>scanning</primary>
292   <see><emphasis>content scanning</emphasis></see>
293 </indexterm>
294 <indexterm role="concept">
295   <primary>SSL</primary>
296   <see><emphasis>TLS</emphasis></see>
297 </indexterm>
298 <indexterm role="concept">
299   <primary>string</primary>
300   <secondary>expansion</secondary>
301   <see><emphasis>expansion</emphasis></see>
302 </indexterm>
303 <indexterm role="concept">
304   <primary>top bit</primary>
305   <see><emphasis>8-bit characters</emphasis></see>
306 </indexterm>
307 <indexterm role="concept">
308   <primary>variables</primary>
309   <see><emphasis>expansion, variables</emphasis></see>
310 </indexterm>
311 <indexterm role="concept">
312   <primary>zero, binary</primary>
313   <see><emphasis>binary zero</emphasis></see>
314 </indexterm>
315
316 .literal off
317
318
319 . /////////////////////////////////////////////////////////////////////////////
320 . This is the real start of the first chapter. See the comment above as to why
321 . we can't have the .chapter line here.
322 . chapter "Introduction"
323 . /////////////////////////////////////////////////////////////////////////////
324
325 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
326 Unix-like operating systems. It was designed on the assumption that it would be
327 run on hosts that are permanently connected to the Internet. However, it can be
328 used on intermittently connected hosts with suitable configuration adjustments.
329
330 Configuration files currently exist for the following operating systems: AIX,
331 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
332 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
333 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
334 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
335 Some of these operating systems are no longer current and cannot easily be
336 tested, so the configuration files may no longer work in practice.
337
338 There are also configuration files for compiling Exim in the Cygwin environment
339 that can be installed on systems running Windows. However, this document does
340 not contain any information about running Exim in the Cygwin environment.
341
342 The terms and conditions for the use and distribution of Exim are contained in
343 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
344 Public Licence, a copy of which may be found in the file &_LICENCE_&.
345
346 The use, supply or promotion of Exim for the purpose of sending bulk,
347 unsolicited electronic mail is incompatible with the basic aims of the program,
348 which revolve around the free provision of a service that enhances the quality
349 of personal communications. The author of Exim regards indiscriminate
350 mass-mailing as an antisocial, irresponsible abuse of the Internet.
351
352 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
353 experience of running and working on the Smail 3 code, I could never have
354 contemplated starting to write a new MTA. Many of the ideas and user interfaces
355 were originally taken from Smail 3, though the actual code of Exim is entirely
356 new, and has developed far beyond the initial concept.
357
358 Many people, both in Cambridge and around the world, have contributed to the
359 development and the testing of Exim, and to porting it to various operating
360 systems. I am grateful to them all. The distribution now contains a file called
361 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
362 contributors.
363
364
365 .section "Exim documentation" "SECID1"
366 . Keep this example change bar when updating the documentation!
367
368 .new
369 .cindex "documentation"
370 This edition of the Exim specification applies to version &version; of Exim.
371 Substantive changes from the &previousversion; edition are marked in some
372 renditions of the document; this paragraph is so marked if the rendition is
373 capable of showing a change indicator.
374 .wen
375
376 This document is very much a reference manual; it is not a tutorial. The reader
377 is expected to have some familiarity with the SMTP mail transfer protocol and
378 with general Unix system administration. Although there are some discussions
379 and examples in places, the information is mostly organized in a way that makes
380 it easy to look up, rather than in a natural order for sequential reading.
381 Furthermore, the manual aims to cover every aspect of Exim in detail, including
382 a number of rarely-used, special-purpose features that are unlikely to be of
383 very wide interest.
384
385 .cindex "books about Exim"
386 An &"easier"& discussion of Exim which provides more in-depth explanatory,
387 introductory, and tutorial material can be found in a book entitled &'The Exim
388 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
389 (&url(http://www.uit.co.uk/exim-book/)).
390
391 This book also contains a chapter that gives a general introduction to SMTP and
392 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
393 with the latest release of Exim. (Note that the earlier book about Exim,
394 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
395
396 .cindex "Debian" "information sources"
397 If you are using a Debian distribution of Exim, you will find information about
398 Debian-specific features in the file
399 &_/usr/share/doc/exim4-base/README.Debian_&.
400 The command &(man update-exim.conf)& is another source of Debian-specific
401 information.
402
403 .cindex "&_doc/NewStuff_&"
404 .cindex "&_doc/ChangeLog_&"
405 .cindex "change log"
406 As the program develops, there may be features in newer versions that have not
407 yet made it into this document, which is updated only when the most significant
408 digit of the fractional part of the version number changes. Specifications of
409 new features that are not yet in this manual are placed in the file
410 &_doc/NewStuff_& in the Exim distribution.
411
412 Some features may be classified as &"experimental"&. These may change
413 incompatibly while they are developing, or even be withdrawn. For this reason,
414 they are not documented in this manual. Information about experimental features
415 can be found in the file &_doc/experimental.txt_&.
416
417 All changes to the program (whether new features, bug fixes, or other kinds of
418 change) are noted briefly in the file called &_doc/ChangeLog_&.
419
420 .cindex "&_doc/spec.txt_&"
421 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
422 that it can easily be searched with a text editor. Other files in the &_doc_&
423 directory are:
424
425 .table2 100pt
426 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
427 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
428 .row &_exim.8_&              "a man page of Exim's command line options"
429 .row &_experimental.txt_&    "documentation of experimental features"
430 .row &_filter.txt_&          "specification of the filter language"
431 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
432 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
433 .endtable
434
435 The main specification and the specification of the filtering language are also
436 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
437 &<<SECTavail>>& below tells you how to get hold of these.
438
439
440
441 .section "FTP and web sites" "SECID2"
442 .cindex "web site"
443 .cindex "FTP site"
444 The primary site for Exim source distributions is currently the University of
445 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
446 distribution'& below. In addition, there is a web site and an FTP site at
447 &%exim.org%&. These are now also hosted at the University of Cambridge. The
448 &%exim.org%& site was previously hosted for a number of years by Energis
449 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
450
451 .cindex "wiki"
452 .cindex "FAQ"
453 As well as Exim distribution tar files, the Exim web site contains a number of
454 differently formatted versions of the documentation. A recent addition to the
455 online information is the Exim wiki (&url(http://wiki.exim.org)),
456 which contains what used to be a separate FAQ, as well as various other
457 examples, tips, and know-how that have been contributed by Exim users.
458
459 .cindex Bugzilla
460 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
461 this to report bugs, and also to add items to the wish list. Please search
462 first to check that you are not duplicating a previous entry.
463
464
465
466 .section "Mailing lists" "SECID3"
467 .cindex "mailing lists" "for Exim users"
468 The following Exim mailing lists exist:
469
470 .table2 140pt
471 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
472 .row &'exim-users@exim.org'&      "General discussion list"
473 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
474 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
475 .endtable
476
477 You can subscribe to these lists, change your existing subscriptions, and view
478 or search the archives via the mailing lists link on the Exim home page.
479 .cindex "Debian" "mailing list for"
480 If you are using a Debian distribution of Exim, you may wish to subscribe to
481 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
482 via this web page:
483 .display
484 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
485 .endd
486 Please ask Debian-specific questions on this list and not on the general Exim
487 lists.
488
489 .section "Exim training" "SECID4"
490 .cindex "training courses"
491 Training courses in Cambridge (UK) used to be run annually by the author of
492 Exim, before he retired. At the time of writing, there are no plans to run
493 further Exim courses in Cambridge. However, if that changes, relevant
494 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
495
496 .section "Bug reports" "SECID5"
497 .cindex "bug reports"
498 .cindex "reporting bugs"
499 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
500 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
501 whether some behaviour is a bug or not, the best thing to do is to post a
502 message to the &'exim-dev'& mailing list and have it discussed.
503
504
505
506 .section "Where to find the Exim distribution" "SECTavail"
507 .cindex "FTP site"
508 .cindex "distribution" "ftp site"
509 The master ftp site for the Exim distribution is
510 .display
511 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
512 .endd
513 This is mirrored by
514 .display
515 &*ftp://ftp.exim.org/pub/exim*&
516 .endd
517 The file references that follow are relative to the &_exim_& directories at
518 these sites. There are now quite a number of independent mirror sites around
519 the world. Those that I know about are listed in the file called &_Mirrors_&.
520
521 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
522 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
523 distributions), and &_Testing_& for testing versions. In the &_exim4_&
524 subdirectory, the current release can always be found in files called
525 .display
526 &_exim-n.nn.tar.gz_&
527 &_exim-n.nn.tar.bz2_&
528 .endd
529 where &'n.nn'& is the highest such version number in the directory. The two
530 files contain identical data; the only difference is the type of compression.
531 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
532
533 .cindex "distribution" "signing details"
534 .cindex "distribution" "public key"
535 .cindex "public key for signed distribution"
536 The distributions are currently signed with Nigel Metheringham's GPG key. The
537 corresponding public key is available from a number of keyservers, and there is
538 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
539 in:
540 .display
541 &_exim-n.nn.tar.gz.asc_&
542 &_exim-n.nn.tar.bz2.asc_&
543 .endd
544 For each released version, the log of changes is made separately available in a
545 separate file in the directory &_ChangeLogs_& so that it is possible to
546 find out what has changed without having to download the entire distribution.
547
548 .cindex "documentation" "available formats"
549 The main distribution contains ASCII versions of this specification and other
550 documentation; other formats of the documents are available in separate files
551 inside the &_exim4_& directory of the FTP site:
552 .display
553 &_exim-html-n.nn.tar.gz_&
554 &_exim-pdf-n.nn.tar.gz_&
555 &_exim-postscript-n.nn.tar.gz_&
556 &_exim-texinfo-n.nn.tar.gz_&
557 .endd
558 These tar files contain only the &_doc_& directory, not the complete
559 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
560
561
562 .section "Limitations" "SECID6"
563 .ilist
564 .cindex "limitations of Exim"
565 .cindex "bang paths" "not handled by Exim"
566 Exim is designed for use as an Internet MTA, and therefore handles addresses in
567 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
568 simple two-component bang paths can be converted by a straightforward rewriting
569 configuration. This restriction does not prevent Exim from being interfaced to
570 UUCP as a transport mechanism, provided that domain addresses are used.
571 .next
572 .cindex "domainless addresses"
573 .cindex "address" "without domain"
574 Exim insists that every address it handles has a domain attached. For incoming
575 local messages, domainless addresses are automatically qualified with a
576 configured domain value. Configuration options specify from which remote
577 systems unqualified addresses are acceptable. These are then qualified on
578 arrival.
579 .next
580 .cindex "transport" "external"
581 .cindex "external transports"
582 The only external transport mechanisms that are currently implemented are SMTP
583 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
584 transport is available, and there are facilities for writing messages to files
585 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
586 to send messages to other transport mechanisms such as UUCP, provided they can
587 handle domain-style addresses. Batched SMTP input is also catered for.
588 .next
589 Exim is not designed for storing mail for dial-in hosts. When the volumes of
590 such mail are large, it is better to get the messages &"delivered"& into files
591 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
592 other means.
593 .next
594 Although Exim does have basic facilities for scanning incoming messages, these
595 are not comprehensive enough to do full virus or spam scanning. Such operations
596 are best carried out using additional specialized software packages. If you
597 compile Exim with the content-scanning extension, straightforward interfaces to
598 a number of common scanners are provided.
599 .endlist
600
601
602 .section "Run time configuration" "SECID7"
603 Exim's run time configuration is held in a single text file that is divided
604 into a number of sections. The entries in this file consist of keywords and
605 values, in the style of Smail 3 configuration files. A default configuration
606 file which is suitable for simple online installations is provided in the
607 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
608
609
610 .section "Calling interface" "SECID8"
611 .cindex "Sendmail compatibility" "command line interface"
612 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
613 can be a straight replacement for &_/usr/lib/sendmail_& or
614 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
615 about Sendmail in order to run Exim. For actions other than sending messages,
616 Sendmail-compatible options also exist, but those that produce output (for
617 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
618 format. There are also some additional options that are compatible with Smail
619 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
620 documents all Exim's command line options. This information is automatically
621 made into the man page that forms part of the Exim distribution.
622
623 Control of messages on the queue can be done via certain privileged command
624 line options. There is also an optional monitor program called &'eximon'&,
625 which displays current information in an X window, and which contains a menu
626 interface to Exim's command line administration options.
627
628
629
630 .section "Terminology" "SECID9"
631 .cindex "terminology definitions"
632 .cindex "body of message" "definition of"
633 The &'body'& of a message is the actual data that the sender wants to transmit.
634 It is the last part of a message, and is separated from the &'header'& (see
635 below) by a blank line.
636
637 .cindex "bounce message" "definition of"
638 When a message cannot be delivered, it is normally returned to the sender in a
639 delivery failure message or a &"non-delivery report"& (NDR). The term
640 &'bounce'& is commonly used for this action, and the error reports are often
641 called &'bounce messages'&. This is a convenient shorthand for &"delivery
642 failure error report"&. Such messages have an empty sender address in the
643 message's &'envelope'& (see below) to ensure that they cannot themselves give
644 rise to further bounce messages.
645
646 The term &'default'& appears frequently in this manual. It is used to qualify a
647 value which is used in the absence of any setting in the configuration. It may
648 also qualify an action which is taken unless a configuration setting specifies
649 otherwise.
650
651 The term &'defer'& is used when the delivery of a message to a specific
652 destination cannot immediately take place for some reason (a remote host may be
653 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
654 until a later time.
655
656 The word &'domain'& is sometimes used to mean all but the first component of a
657 host's name. It is &'not'& used in that sense here, where it normally refers to
658 the part of an email address following the @ sign.
659
660 .cindex "envelope, definition of"
661 .cindex "sender" "definition of"
662 A message in transit has an associated &'envelope'&, as well as a header and a
663 body. The envelope contains a sender address (to which bounce messages should
664 be delivered), and any number of recipient addresses. References to the
665 sender or the recipients of a message usually mean the addresses in the
666 envelope. An MTA uses these addresses for delivery, and for returning bounce
667 messages, not the addresses that appear in the header lines.
668
669 .cindex "message" "header, definition of"
670 .cindex "header section" "definition of"
671 The &'header'& of a message is the first part of a message's text, consisting
672 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
673 &'Subject:'&, etc. Long header lines can be split over several text lines by
674 indenting the continuations. The header is separated from the body by a blank
675 line.
676
677 .cindex "local part" "definition of"
678 .cindex "domain" "definition of"
679 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
680 part of an email address that precedes the @ sign. The part that follows the
681 @ sign is called the &'domain'& or &'mail domain'&.
682
683 .cindex "local delivery" "definition of"
684 .cindex "remote delivery, definition of"
685 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
686 delivery to a file or a pipe on the local host from delivery by SMTP over
687 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
688 host it is running on are &'remote'&.
689
690 .cindex "return path" "definition of"
691 &'Return path'& is another name that is used for the sender address in a
692 message's envelope.
693
694 .cindex "queue" "definition of"
695 The term &'queue'& is used to refer to the set of messages awaiting delivery,
696 because this term is in widespread use in the context of MTAs. However, in
697 Exim's case the reality is more like a pool than a queue, because there is
698 normally no ordering of waiting messages.
699
700 .cindex "queue runner" "definition of"
701 The term &'queue runner'& is used to describe a process that scans the queue
702 and attempts to deliver those messages whose retry times have come. This term
703 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
704 the waiting messages are normally processed in an unpredictable order.
705
706 .cindex "spool directory" "definition of"
707 The term &'spool directory'& is used for a directory in which Exim keeps the
708 messages on its queue &-- that is, those that it is in the process of
709 delivering. This should not be confused with the directory in which local
710 mailboxes are stored, which is called a &"spool directory"& by some people. In
711 the Exim documentation, &"spool"& is always used in the first sense.
712
713
714
715
716
717
718 . ////////////////////////////////////////////////////////////////////////////
719 . ////////////////////////////////////////////////////////////////////////////
720
721 .chapter "Incorporated code" "CHID2"
722 .cindex "incorporated code"
723 .cindex "regular expressions" "library"
724 .cindex "PCRE"
725 A number of pieces of external code are included in the Exim distribution.
726
727 .ilist
728 Regular expressions are supported in the main Exim program and in the
729 Exim monitor using the freely-distributable PCRE library, copyright
730 &copy; University of Cambridge. The source to PCRE is no longer shipped with
731 Exim, so you will need to use the version of PCRE shipped with your system,
732 or obtain and install the full version of the library from
733 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
734 .next
735 .cindex "cdb" "acknowledgment"
736 Support for the cdb (Constant DataBase) lookup method is provided by code
737 contributed by Nigel Metheringham of (at the time he contributed it) Planet
738 Online Ltd. The implementation is completely contained within the code of Exim.
739 It does not link against an external cdb library. The code contains the
740 following statements:
741
742 .blockquote
743 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
744
745 This program is free software; you can redistribute it and/or modify it under
746 the terms of the GNU General Public License as published by the Free Software
747 Foundation; either version 2 of the License, or (at your option) any later
748 version.
749 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
750 the spec and sample code for cdb can be obtained from
751 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
752 some code from Dan Bernstein's implementation (which has no license
753 restrictions applied to it).
754 .endblockquote
755 .next
756 .cindex "SPA authentication"
757 .cindex "Samba project"
758 .cindex "Microsoft Secure Password Authentication"
759 Client support for Microsoft's &'Secure Password Authentication'& is provided
760 by code contributed by Marc Prud'hommeaux. Server support was contributed by
761 Tom Kistner. This includes code taken from the Samba project, which is released
762 under the Gnu GPL.
763 .next
764 .cindex "Cyrus"
765 .cindex "&'pwcheck'& daemon"
766 .cindex "&'pwauthd'& daemon"
767 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
768 by code taken from the Cyrus-SASL library and adapted by Alexander S.
769 Sabourenkov. The permission notice appears below, in accordance with the
770 conditions expressed therein.
771
772 .blockquote
773 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
774
775 Redistribution and use in source and binary forms, with or without
776 modification, are permitted provided that the following conditions
777 are met:
778
779 .olist
780 Redistributions of source code must retain the above copyright
781 notice, this list of conditions and the following disclaimer.
782 .next
783 Redistributions in binary form must reproduce the above copyright
784 notice, this list of conditions and the following disclaimer in
785 the documentation and/or other materials provided with the
786 distribution.
787 .next
788 The name &"Carnegie Mellon University"& must not be used to
789 endorse or promote products derived from this software without
790 prior written permission. For permission or any other legal
791 details, please contact
792 .display
793               Office of Technology Transfer
794               Carnegie Mellon University
795               5000 Forbes Avenue
796               Pittsburgh, PA  15213-3890
797               (412) 268-4387, fax: (412) 268-7395
798               tech-transfer@andrew.cmu.edu
799 .endd
800 .next
801 Redistributions of any form whatsoever must retain the following
802 acknowledgment:
803
804 &"This product includes software developed by Computing Services
805 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
806
807 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
808 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
809 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
810 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
811 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
812 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
813 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
814 .endlist
815 .endblockquote
816
817 .next
818 .cindex "Exim monitor" "acknowledgment"
819 .cindex "X-windows"
820 .cindex "Athena"
821 The Exim Monitor program, which is an X-Window application, includes
822 modified versions of the Athena StripChart and TextPop widgets.
823 This code is copyright by DEC and MIT, and their permission notice appears
824 below, in accordance with the conditions expressed therein.
825
826 .blockquote
827 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
828 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
829
830 All Rights Reserved
831
832 Permission to use, copy, modify, and distribute this software and its
833 documentation for any purpose and without fee is hereby granted,
834 provided that the above copyright notice appear in all copies and that
835 both that copyright notice and this permission notice appear in
836 supporting documentation, and that the names of Digital or MIT not be
837 used in advertising or publicity pertaining to distribution of the
838 software without specific, written prior permission.
839
840 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
841 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
842 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
843 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
844 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
845 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
846 SOFTWARE.
847 .endblockquote
848
849 .next
850 Many people have contributed code fragments, some large, some small, that were
851 not covered by any specific licence requirements. It is assumed that the
852 contributors are happy to see their code incorporated into Exim under the GPL.
853 .endlist
854
855
856
857
858
859 . ////////////////////////////////////////////////////////////////////////////
860 . ////////////////////////////////////////////////////////////////////////////
861
862 .chapter "How Exim receives and delivers mail" "CHID11" &&&
863          "Receiving and delivering mail"
864
865
866 .section "Overall philosophy" "SECID10"
867 .cindex "design philosophy"
868 Exim is designed to work efficiently on systems that are permanently connected
869 to the Internet and are handling a general mix of mail. In such circumstances,
870 most messages can be delivered immediately. Consequently, Exim does not
871 maintain independent queues of messages for specific domains or hosts, though
872 it does try to send several messages in a single SMTP connection after a host
873 has been down, and it also maintains per-host retry information.
874
875
876 .section "Policy control" "SECID11"
877 .cindex "policy control" "overview"
878 Policy controls are now an important feature of MTAs that are connected to the
879 Internet. Perhaps their most important job is to stop MTAs being abused as
880 &"open relays"& by misguided individuals who send out vast amounts of
881 unsolicited junk, and want to disguise its source. Exim provides flexible
882 facilities for specifying policy controls on incoming mail:
883
884 .ilist
885 .cindex "&ACL;" "introduction"
886 Exim 4 (unlike previous versions of Exim) implements policy controls on
887 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
888 series of statements that may either grant or deny access. ACLs can be used at
889 several places in the SMTP dialogue while receiving a message from a remote
890 host. However, the most common places are after each RCPT command, and at the
891 very end of the message. The sysadmin can specify conditions for accepting or
892 rejecting individual recipients or the entire message, respectively, at these
893 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
894 error code.
895 .next
896 An ACL is also available for locally generated, non-SMTP messages. In this
897 case, the only available actions are to accept or deny the entire message.
898 .next
899 When Exim is compiled with the content-scanning extension, facilities are
900 provided in the ACL mechanism for passing the message to external virus and/or
901 spam scanning software. The result of such a scan is passed back to the ACL,
902 which can then use it to decide what to do with the message.
903 .next
904 When a message has been received, either from a remote host or from the local
905 host, but before the final acknowledgment has been sent, a locally supplied C
906 function called &[local_scan()]& can be run to inspect the message and decide
907 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
908 is accepted, the list of recipients can be modified by the function.
909 .next
910 Using the &[local_scan()]& mechanism is another way of calling external scanner
911 software. The &%SA-Exim%& add-on package works this way. It does not require
912 Exim to be compiled with the content-scanning extension.
913 .next
914 After a message has been accepted, a further checking mechanism is available in
915 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
916 runs at the start of every delivery process.
917 .endlist
918
919
920
921 .section "User filters" "SECID12"
922 .cindex "filter" "introduction"
923 .cindex "Sieve filter"
924 In a conventional Exim configuration, users are able to run private filters by
925 setting up appropriate &_.forward_& files in their home directories. See
926 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
927 configuration needed to support this, and the separate document entitled
928 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
929 of filtering are available:
930
931 .ilist
932 Sieve filters are written in the standard filtering language that is defined
933 by RFC 3028.
934 .next
935 Exim filters are written in a syntax that is unique to Exim, but which is more
936 powerful than Sieve, which it pre-dates.
937 .endlist
938
939 User filters are run as part of the routing process, described below.
940
941
942
943 .section "Message identification" "SECTmessiden"
944 .cindex "message ids" "details of format"
945 .cindex "format" "of message id"
946 .cindex "id of message"
947 .cindex "base62"
948 .cindex "base36"
949 .cindex "Darwin"
950 .cindex "Cygwin"
951 Every message handled by Exim is given a &'message id'& which is sixteen
952 characters long. It is divided into three parts, separated by hyphens, for
953 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
954 normally encoding numbers in base 62. However, in the Darwin operating
955 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
956 (avoiding the use of lower case letters) is used instead, because the message
957 id is used to construct file names, and the names of files in those systems are
958 not always case-sensitive.
959
960 .cindex "pid (process id)" "re-use of"
961 The detail of the contents of the message id have changed as Exim has evolved.
962 Earlier versions relied on the operating system not re-using a process id (pid)
963 within one second. On modern operating systems, this assumption can no longer
964 be made, so the algorithm had to be changed. To retain backward compatibility,
965 the format of the message id was retained, which is why the following rules are
966 somewhat eccentric:
967
968 .ilist
969 The first six characters of the message id are the time at which the message
970 started to be received, to a granularity of one second. That is, this field
971 contains the number of seconds since the start of the epoch (the normal Unix
972 way of representing the date and time of day).
973 .next
974 After the first hyphen, the next six characters are the id of the process that
975 received the message.
976 .next
977 There are two different possibilities for the final two characters:
978 .olist
979 .oindex "&%localhost_number%&"
980 If &%localhost_number%& is not set, this value is the fractional part of the
981 time of reception, normally in units of 1/2000 of a second, but for systems
982 that must use base 36 instead of base 62 (because of case-insensitive file
983 systems), the units are 1/1000 of a second.
984 .next
985 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
986 the fractional part of the time, which in this case is in units of 1/200
987 (1/100) of a second.
988 .endlist
989 .endlist
990
991 After a message has been received, Exim waits for the clock to tick at the
992 appropriate resolution before proceeding, so that if another message is
993 received by the same process, or by another process with the same (re-used)
994 pid, it is guaranteed that the time will be different. In most cases, the clock
995 will already have ticked while the message was being received.
996
997
998 .section "Receiving mail" "SECID13"
999 .cindex "receiving mail"
1000 .cindex "message" "reception"
1001 The only way Exim can receive mail from another host is using SMTP over
1002 TCP/IP, in which case the sender and recipient addresses are transferred using
1003 SMTP commands. However, from a locally running process (such as a user's MUA),
1004 there are several possibilities:
1005
1006 .ilist
1007 If the process runs Exim with the &%-bm%& option, the message is read
1008 non-interactively (usually via a pipe), with the recipients taken from the
1009 command line, or from the body of the message if &%-t%& is also used.
1010 .next
1011 If the process runs Exim with the &%-bS%& option, the message is also read
1012 non-interactively, but in this case the recipients are listed at the start of
1013 the message in a series of SMTP RCPT commands, terminated by a DATA
1014 command. This is so-called &"batch SMTP"& format,
1015 but it isn't really SMTP. The SMTP commands are just another way of passing
1016 envelope addresses in a non-interactive submission.
1017 .next
1018 If the process runs Exim with the &%-bs%& option, the message is read
1019 interactively, using the SMTP protocol. A two-way pipe is normally used for
1020 passing data between the local process and the Exim process.
1021 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1022 example, the ACLs for SMTP commands are used for this form of submission.
1023 .next
1024 A local process may also make a TCP/IP call to the host's loopback address
1025 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1026 does not treat the loopback address specially. It treats all such connections
1027 in the same way as connections from other hosts.
1028 .endlist
1029
1030
1031 .cindex "message sender, constructed by Exim"
1032 .cindex "sender" "constructed by Exim"
1033 In the three cases that do not involve TCP/IP, the sender address is
1034 constructed from the login name of the user that called Exim and a default
1035 qualification domain (which can be set by the &%qualify_domain%& configuration
1036 option). For local or batch SMTP, a sender address that is passed using the
1037 SMTP MAIL command is ignored. However, the system administrator may allow
1038 certain users (&"trusted users"&) to specify a different sender address
1039 unconditionally, or all users to specify certain forms of different sender
1040 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1041 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1042 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1043 users to change sender addresses.
1044
1045 Messages received by either of the non-interactive mechanisms are subject to
1046 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1047 (either over TCP/IP, or interacting with a local process) can be checked by a
1048 number of ACLs that operate at different times during the SMTP session. Either
1049 individual recipients, or the entire message, can be rejected if local policy
1050 requirements are not met. The &[local_scan()]& function (see chapter
1051 &<<CHAPlocalscan>>&) is run for all incoming messages.
1052
1053 Exim can be configured not to start a delivery process when a message is
1054 received; this can be unconditional, or depend on the number of incoming SMTP
1055 connections or the system load. In these situations, new messages wait on the
1056 queue until a queue runner process picks them up. However, in standard
1057 configurations under normal conditions, delivery is started as soon as a
1058 message is received.
1059
1060
1061
1062
1063
1064 .section "Handling an incoming message" "SECID14"
1065 .cindex "spool directory" "files that hold a message"
1066 .cindex "file" "how a message is held"
1067 When Exim accepts a message, it writes two files in its spool directory. The
1068 first contains the envelope information, the current status of the message, and
1069 the header lines, and the second contains the body of the message. The names of
1070 the two spool files consist of the message id, followed by &`-H`& for the
1071 file containing the envelope and header, and &`-D`& for the data file.
1072
1073 .cindex "spool directory" "&_input_& sub-directory"
1074 By default all these message files are held in a single directory called
1075 &_input_& inside the general Exim spool directory. Some operating systems do
1076 not perform very well if the number of files in a directory gets large; to
1077 improve performance in such cases, the &%split_spool_directory%& option can be
1078 used. This causes Exim to split up the input files into 62 sub-directories
1079 whose names are single letters or digits. When this is done, the queue is
1080 processed one sub-directory at a time instead of all at once, which can improve
1081 overall performance even when there are not enough files in each directory to
1082 affect file system performance.
1083
1084 The envelope information consists of the address of the message's sender and
1085 the addresses of the recipients. This information is entirely separate from
1086 any addresses contained in the header lines. The status of the message includes
1087 a list of recipients who have already received the message. The format of the
1088 first spool file is described in chapter &<<CHAPspool>>&.
1089
1090 .cindex "rewriting" "addresses"
1091 Address rewriting that is specified in the rewrite section of the configuration
1092 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1093 both in the header lines and the envelope, at the time the message is accepted.
1094 If during the course of delivery additional addresses are generated (for
1095 example, via aliasing), these new addresses are rewritten as soon as they are
1096 generated. At the time a message is actually delivered (transported) further
1097 rewriting can take place; because this is a transport option, it can be
1098 different for different forms of delivery. It is also possible to specify the
1099 addition or removal of certain header lines at the time the message is
1100 delivered (see chapters &<<CHAProutergeneric>>& and
1101 &<<CHAPtransportgeneric>>&).
1102
1103
1104
1105 .section "Life of a message" "SECID15"
1106 .cindex "message" "life of"
1107 .cindex "message" "frozen"
1108 A message remains in the spool directory until it is completely delivered to
1109 its recipients or to an error address, or until it is deleted by an
1110 administrator or by the user who originally created it. In cases when delivery
1111 cannot proceed &-- for example, when a message can neither be delivered to its
1112 recipients nor returned to its sender, the message is marked &"frozen"& on the
1113 spool, and no more deliveries are attempted.
1114
1115 .cindex "frozen messages" "thawing"
1116 .cindex "message" "thawing frozen"
1117 An administrator can &"thaw"& such messages when the problem has been
1118 corrected, and can also freeze individual messages by hand if necessary. In
1119 addition, an administrator can force a delivery error, causing a bounce message
1120 to be sent.
1121
1122 .oindex "&%timeout_frozen_after%&"
1123 .oindex "&%ignore_bounce_errors_after%&"
1124 There are options called &%ignore_bounce_errors_after%& and
1125 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1126 The first applies only to frozen bounces, the second to any frozen messages.
1127
1128 .cindex "message" "log file for"
1129 .cindex "log" "file for each message"
1130 While Exim is working on a message, it writes information about each delivery
1131 attempt to its main log file. This includes successful, unsuccessful, and
1132 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1133 lines are also written to a separate &'message log'& file for each message.
1134 These logs are solely for the benefit of the administrator, and are normally
1135 deleted along with the spool files when processing of a message is complete.
1136 The use of individual message logs can be disabled by setting
1137 &%no_message_logs%&; this might give an improvement in performance on very busy
1138 systems.
1139
1140 .cindex "journal file"
1141 .cindex "file" "journal"
1142 All the information Exim itself needs to set up a delivery is kept in the first
1143 spool file, along with the header lines. When a successful delivery occurs, the
1144 address is immediately written at the end of a journal file, whose name is the
1145 message id followed by &`-J`&. At the end of a delivery run, if there are some
1146 addresses left to be tried again later, the first spool file (the &`-H`& file)
1147 is updated to indicate which these are, and the journal file is then deleted.
1148 Updating the spool file is done by writing a new file and renaming it, to
1149 minimize the possibility of data loss.
1150
1151 Should the system or the program crash after a successful delivery but before
1152 the spool file has been updated, the journal is left lying around. The next
1153 time Exim attempts to deliver the message, it reads the journal file and
1154 updates the spool file before proceeding. This minimizes the chances of double
1155 deliveries caused by crashes.
1156
1157
1158
1159 .section "Processing an address for delivery" "SECTprocaddress"
1160 .cindex "drivers" "definition of"
1161 .cindex "router" "definition of"
1162 .cindex "transport" "definition of"
1163 The main delivery processing elements of Exim are called &'routers'& and
1164 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1165 number of them is provided in the source distribution, and compile-time options
1166 specify which ones are included in the binary. Run time options specify which
1167 ones are actually used for delivering messages.
1168
1169 .cindex "drivers" "instance definition"
1170 Each driver that is specified in the run time configuration is an &'instance'&
1171 of that particular driver type. Multiple instances are allowed; for example,
1172 you can set up several different &(smtp)& transports, each with different
1173 option values that might specify different ports or different timeouts. Each
1174 instance has its own identifying name. In what follows we will normally use the
1175 instance name when discussing one particular instance (that is, one specific
1176 configuration of the driver), and the generic driver name when discussing
1177 the driver's features in general.
1178
1179 A &'router'& is a driver that operates on an address, either determining how
1180 its delivery should happen, by assigning it to a specific transport, or
1181 converting the address into one or more new addresses (for example, via an
1182 alias file). A router may also explicitly choose to fail an address, causing it
1183 to be bounced.
1184
1185 A &'transport'& is a driver that transmits a copy of the message from Exim's
1186 spool to some destination. There are two kinds of transport: for a &'local'&
1187 transport, the destination is a file or a pipe on the local host, whereas for a
1188 &'remote'& transport the destination is some other host. A message is passed
1189 to a specific transport as a result of successful routing. If a message has
1190 several recipients, it may be passed to a number of different transports.
1191
1192 .cindex "preconditions" "definition of"
1193 An address is processed by passing it to each configured router instance in
1194 turn, subject to certain preconditions, until a router accepts the address or
1195 specifies that it should be bounced. We will describe this process in more
1196 detail shortly. First, as a simple example, we consider how each recipient
1197 address in a message is processed in a small configuration of three routers.
1198
1199 To make this a more concrete example, it is described in terms of some actual
1200 routers, but remember, this is only an example. You can configure Exim's
1201 routers in many different ways, and there may be any number of routers in a
1202 configuration.
1203
1204 The first router that is specified in a configuration is often one that handles
1205 addresses in domains that are not recognized specially by the local host. These
1206 are typically addresses for arbitrary domains on the Internet. A precondition
1207 is set up which looks for the special domains known to the host (for example,
1208 its own domain name), and the router is run for addresses that do &'not'&
1209 match. Typically, this is a router that looks up domains in the DNS in order to
1210 find the hosts to which this address routes. If it succeeds, the address is
1211 assigned to a suitable SMTP transport; if it does not succeed, the router is
1212 configured to fail the address.
1213
1214 The second router is reached only when the domain is recognized as one that
1215 &"belongs"& to the local host. This router does redirection &-- also known as
1216 aliasing and forwarding. When it generates one or more new addresses from the
1217 original, each of them is routed independently from the start. Otherwise, the
1218 router may cause an address to fail, or it may simply decline to handle the
1219 address, in which case the address is passed to the next router.
1220
1221 The final router in many configurations is one that checks to see if the
1222 address belongs to a local mailbox. The precondition may involve a check to
1223 see if the local part is the name of a login account, or it may look up the
1224 local part in a file or a database. If its preconditions are not met, or if
1225 the router declines, we have reached the end of the routers. When this happens,
1226 the address is bounced.
1227
1228
1229
1230 .section "Processing an address for verification" "SECID16"
1231 .cindex "router" "for verification"
1232 .cindex "verifying address" "overview"
1233 As well as being used to decide how to deliver to an address, Exim's routers
1234 are also used for &'address verification'&. Verification can be requested as
1235 one of the checks to be performed in an ACL for incoming messages, on both
1236 sender and recipient addresses, and it can be tested using the &%-bv%& and
1237 &%-bvs%& command line options.
1238
1239 When an address is being verified, the routers are run in &"verify mode"&. This
1240 does not affect the way the routers work, but it is a state that can be
1241 detected. By this means, a router can be skipped or made to behave differently
1242 when verifying. A common example is a configuration in which the first router
1243 sends all messages to a message-scanning program, unless they have been
1244 previously scanned. Thus, the first router accepts all addresses without any
1245 checking, making it useless for verifying. Normally, the &%no_verify%& option
1246 would be set for such a router, causing it to be skipped in verify mode.
1247
1248
1249
1250
1251 .section "Running an individual router" "SECTrunindrou"
1252 .cindex "router" "running details"
1253 .cindex "preconditions" "checking"
1254 .cindex "router" "result of running"
1255 As explained in the example above, a number of preconditions are checked before
1256 running a router. If any are not met, the router is skipped, and the address is
1257 passed to the next router. When all the preconditions on a router &'are'& met,
1258 the router is run. What happens next depends on the outcome, which is one of
1259 the following:
1260
1261 .ilist
1262 &'accept'&: The router accepts the address, and either assigns it to a
1263 transport, or generates one or more &"child"& addresses. Processing the
1264 original address ceases,
1265 .oindex "&%unseen%&"
1266 unless the &%unseen%& option is set on the router. This option
1267 can be used to set up multiple deliveries with different routing (for example,
1268 for keeping archive copies of messages). When &%unseen%& is set, the address is
1269 passed to the next router. Normally, however, an &'accept'& return marks the
1270 end of routing.
1271
1272 Any child addresses generated by the router are processed independently,
1273 starting with the first router by default. It is possible to change this by
1274 setting the &%redirect_router%& option to specify which router to start at for
1275 child addresses. Unlike &%pass_router%& (see below) the router specified by
1276 &%redirect_router%& may be anywhere in the router configuration.
1277 .next
1278 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1279 requests that the address be passed to another router. By default the address
1280 is passed to the next router, but this can be changed by setting the
1281 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1282 must be below the current router (to avoid loops).
1283 .next
1284 &'decline'&: The router declines to accept the address because it does not
1285 recognize it at all. By default, the address is passed to the next router, but
1286 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1287 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1288 &'decline'& into &'fail'&.
1289 .next
1290 &'fail'&: The router determines that the address should fail, and queues it for
1291 the generation of a bounce message. There is no further processing of the
1292 original address unless &%unseen%& is set on the router.
1293 .next
1294 &'defer'&: The router cannot handle the address at the present time. (A
1295 database may be offline, or a DNS lookup may have timed out.) No further
1296 processing of the address happens in this delivery attempt. It is tried again
1297 next time the message is considered for delivery.
1298 .next
1299 &'error'&: There is some error in the router (for example, a syntax error in
1300 its configuration). The action is as for defer.
1301 .endlist
1302
1303 If an address reaches the end of the routers without having been accepted by
1304 any of them, it is bounced as unrouteable. The default error message in this
1305 situation is &"unrouteable address"&, but you can set your own message by
1306 making use of the &%cannot_route_message%& option. This can be set for any
1307 router; the value from the last router that &"saw"& the address is used.
1308
1309 Sometimes while routing you want to fail a delivery when some conditions are
1310 met but others are not, instead of passing the address on for further routing.
1311 You can do this by having a second router that explicitly fails the delivery
1312 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1313 facility for this purpose.
1314
1315
1316 .section "Duplicate addresses" "SECID17"
1317 .cindex "case of local parts"
1318 .cindex "address duplicate, discarding"
1319 .cindex "duplicate addresses"
1320 Once routing is complete, Exim scans the addresses that are assigned to local
1321 and remote transports, and discards any duplicates that it finds. During this
1322 check, local parts are treated as case-sensitive. This happens only when
1323 actually delivering a message; when testing routers with &%-bt%&, all the
1324 routed addresses are shown.
1325
1326
1327
1328 .section "Router preconditions" "SECTrouprecon"
1329 .cindex "router" "preconditions, order of processing"
1330 .cindex "preconditions" "order of processing"
1331 The preconditions that are tested for each router are listed below, in the
1332 order in which they are tested. The individual configuration options are
1333 described in more detail in chapter &<<CHAProutergeneric>>&.
1334
1335 .ilist
1336 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1337 the local parts handled by the router may or must have certain prefixes and/or
1338 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1339 skipped. These conditions are tested first. When an affix is present, it is
1340 removed from the local part before further processing, including the evaluation
1341 of any other conditions.
1342 .next
1343 Routers can be designated for use only when not verifying an address, that is,
1344 only when routing it for delivery (or testing its delivery routing). If the
1345 &%verify%& option is set false, the router is skipped when Exim is verifying an
1346 address.
1347 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1348 &%verify_recipient%&, which independently control the use of the router for
1349 sender and recipient verification. You can set these options directly if
1350 you want a router to be used for only one type of verification.
1351 .next
1352 If the &%address_test%& option is set false, the router is skipped when Exim is
1353 run with the &%-bt%& option to test an address routing. This can be helpful
1354 when the first router sends all new messages to a scanner of some sort; it
1355 makes it possible to use &%-bt%& to test subsequent delivery routing without
1356 having to simulate the effect of the scanner.
1357 .next
1358 Routers can be designated for use only when verifying an address, as
1359 opposed to routing it for delivery. The &%verify_only%& option controls this.
1360 .next
1361 Individual routers can be explicitly skipped when running the routers to
1362 check an address given in the SMTP EXPN command (see the &%expn%& option).
1363 .next
1364 If the &%domains%& option is set, the domain of the address must be in the set
1365 of domains that it defines.
1366 .next
1367 .vindex "&$local_part_prefix$&"
1368 .vindex "&$local_part$&"
1369 .vindex "&$local_part_suffix$&"
1370 If the &%local_parts%& option is set, the local part of the address must be in
1371 the set of local parts that it defines. If &%local_part_prefix%& or
1372 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1373 part before this check. If you want to do precondition tests on local parts
1374 that include affixes, you can do so by using a &%condition%& option (see below)
1375 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1376 &$local_part_suffix$& as necessary.
1377 .next
1378 .vindex "&$local_user_uid$&"
1379 .vindex "&$local_user_gid$&"
1380 .vindex "&$home$&"
1381 If the &%check_local_user%& option is set, the local part must be the name of
1382 an account on the local host. If this check succeeds, the uid and gid of the
1383 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1384 user's home directory is placed in &$home$&; these values can be used in the
1385 remaining preconditions.
1386 .next
1387 If the &%router_home_directory%& option is set, it is expanded at this point,
1388 because it overrides the value of &$home$&. If this expansion were left till
1389 later, the value of &$home$& as set by &%check_local_user%& would be used in
1390 subsequent tests. Having two different values of &$home$& in the same router
1391 could lead to confusion.
1392 .next
1393 If the &%senders%& option is set, the envelope sender address must be in the
1394 set of addresses that it defines.
1395 .next
1396 If the &%require_files%& option is set, the existence or non-existence of
1397 specified files is tested.
1398 .next
1399 .cindex "customizing" "precondition"
1400 If the &%condition%& option is set, it is evaluated and tested. This option
1401 uses an expanded string to allow you to set up your own custom preconditions.
1402 Expanded strings are described in chapter &<<CHAPexpand>>&.
1403 .endlist
1404
1405
1406 Note that &%require_files%& comes near the end of the list, so you cannot use
1407 it to check for the existence of a file in which to lookup up a domain, local
1408 part, or sender. However, as these options are all expanded, you can use the
1409 &%exists%& expansion condition to make such tests within each condition. The
1410 &%require_files%& option is intended for checking files that the router may be
1411 going to use internally, or which are needed by a specific transport (for
1412 example, &_.procmailrc_&).
1413
1414
1415
1416 .section "Delivery in detail" "SECID18"
1417 .cindex "delivery" "in detail"
1418 When a message is to be delivered, the sequence of events is as follows:
1419
1420 .ilist
1421 If a system-wide filter file is specified, the message is passed to it. The
1422 filter may add recipients to the message, replace the recipients, discard the
1423 message, cause a new message to be generated, or cause the message delivery to
1424 fail. The format of the system filter file is the same as for Exim user filter
1425 files, described in the separate document entitled &'Exim's interfaces to mail
1426 filtering'&.
1427 .cindex "Sieve filter" "not available for system filter"
1428 (&*Note*&: Sieve cannot be used for system filter files.)
1429
1430 Some additional features are available in system filters &-- see chapter
1431 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1432 filter only once per delivery attempt, however many recipients it has. However,
1433 if there are several delivery attempts because one or more addresses could not
1434 be immediately delivered, the system filter is run each time. The filter
1435 condition &%first_delivery%& can be used to detect the first run of the system
1436 filter.
1437 .next
1438 Each recipient address is offered to each configured router in turn, subject to
1439 its preconditions, until one is able to handle it. If no router can handle the
1440 address, that is, if they all decline, the address is failed. Because routers
1441 can be targeted at particular domains, several locally handled domains can be
1442 processed entirely independently of each other.
1443 .next
1444 .cindex "routing" "loops in"
1445 .cindex "loop" "while routing"
1446 A router that accepts an address may assign it to a local or a remote
1447 transport. However, the transport is not run at this time. Instead, the address
1448 is placed on a list for the particular transport, which will be run later.
1449 Alternatively, the router may generate one or more new addresses (typically
1450 from alias, forward, or filter files). New addresses are fed back into this
1451 process from the top, but in order to avoid loops, a router ignores any address
1452 which has an identically-named ancestor that was processed by itself.
1453 .next
1454 When all the routing has been done, addresses that have been successfully
1455 handled are passed to their assigned transports. When local transports are
1456 doing real local deliveries, they handle only one address at a time, but if a
1457 local transport is being used as a pseudo-remote transport (for example, to
1458 collect batched SMTP messages for transmission by some other means) multiple
1459 addresses can be handled. Remote transports can always handle more than one
1460 address at a time, but can be configured not to do so, or to restrict multiple
1461 addresses to the same domain.
1462 .next
1463 Each local delivery to a file or a pipe runs in a separate process under a
1464 non-privileged uid, and these deliveries are run one at a time. Remote
1465 deliveries also run in separate processes, normally under a uid that is private
1466 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1467 run in parallel. The maximum number of simultaneous remote deliveries for any
1468 one message is set by the &%remote_max_parallel%& option.
1469 The order in which deliveries are done is not defined, except that all local
1470 deliveries happen before any remote deliveries.
1471 .next
1472 .cindex "queue runner"
1473 When it encounters a local delivery during a queue run, Exim checks its retry
1474 database to see if there has been a previous temporary delivery failure for the
1475 address before running the local transport. If there was a previous failure,
1476 Exim does not attempt a new delivery until the retry time for the address is
1477 reached. However, this happens only for delivery attempts that are part of a
1478 queue run. Local deliveries are always attempted when delivery immediately
1479 follows message reception, even if retry times are set for them. This makes for
1480 better behaviour if one particular message is causing problems (for example,
1481 causing quota overflow, or provoking an error in a filter file).
1482 .next
1483 .cindex "delivery" "retry in remote transports"
1484 Remote transports do their own retry handling, since an address may be
1485 deliverable to one of a number of hosts, each of which may have a different
1486 retry time. If there have been previous temporary failures and no host has
1487 reached its retry time, no delivery is attempted, whether in a queue run or
1488 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1489 .next
1490 If there were any permanent errors, a bounce message is returned to an
1491 appropriate address (the sender in the common case), with details of the error
1492 for each failing address. Exim can be configured to send copies of bounce
1493 messages to other addresses.
1494 .next
1495 .cindex "delivery" "deferral"
1496 If one or more addresses suffered a temporary failure, the message is left on
1497 the queue, to be tried again later. Delivery of these addresses is said to be
1498 &'deferred'&.
1499 .next
1500 When all the recipient addresses have either been delivered or bounced,
1501 handling of the message is complete. The spool files and message log are
1502 deleted, though the message log can optionally be preserved if required.
1503 .endlist
1504
1505
1506
1507
1508 .section "Retry mechanism" "SECID19"
1509 .cindex "delivery" "retry mechanism"
1510 .cindex "retry" "description of mechanism"
1511 .cindex "queue runner"
1512 Exim's mechanism for retrying messages that fail to get delivered at the first
1513 attempt is the queue runner process. You must either run an Exim daemon that
1514 uses the &%-q%& option with a time interval to start queue runners at regular
1515 intervals, or use some other means (such as &'cron'&) to start them. If you do
1516 not arrange for queue runners to be run, messages that fail temporarily at the
1517 first attempt will remain on your queue for ever. A queue runner process works
1518 its way through the queue, one message at a time, trying each delivery that has
1519 passed its retry time.
1520 You can run several queue runners at once.
1521
1522 Exim uses a set of configured rules to determine when next to retry the failing
1523 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1524 should give up trying to deliver to the address, at which point it generates a
1525 bounce message. If no retry rules are set for a particular host, address, and
1526 error combination, no retries are attempted, and temporary errors are treated
1527 as permanent.
1528
1529
1530
1531 .section "Temporary delivery failure" "SECID20"
1532 .cindex "delivery" "temporary failure"
1533 There are many reasons why a message may not be immediately deliverable to a
1534 particular address. Failure to connect to a remote machine (because it, or the
1535 connection to it, is down) is one of the most common. Temporary failures may be
1536 detected during routing as well as during the transport stage of delivery.
1537 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1538 is on a file system where the user is over quota. Exim can be configured to
1539 impose its own quotas on local mailboxes; where system quotas are set they will
1540 also apply.
1541
1542 If a host is unreachable for a period of time, a number of messages may be
1543 waiting for it by the time it recovers, and sending them in a single SMTP
1544 connection is clearly beneficial. Whenever a delivery to a remote host is
1545 deferred,
1546 .cindex "hints database"
1547 Exim makes a note in its hints database, and whenever a successful
1548 SMTP delivery has happened, it looks to see if any other messages are waiting
1549 for the same host. If any are found, they are sent over the same SMTP
1550 connection, subject to a configuration limit as to the maximum number in any
1551 one connection.
1552
1553
1554
1555 .section "Permanent delivery failure" "SECID21"
1556 .cindex "delivery" "permanent failure"
1557 .cindex "bounce message" "when generated"
1558 When a message cannot be delivered to some or all of its intended recipients, a
1559 bounce message is generated. Temporary delivery failures turn into permanent
1560 errors when their timeout expires. All the addresses that fail in a given
1561 delivery attempt are listed in a single message. If the original message has
1562 many recipients, it is possible for some addresses to fail in one delivery
1563 attempt and others to fail subsequently, giving rise to more than one bounce
1564 message. The wording of bounce messages can be customized by the administrator.
1565 See chapter &<<CHAPemsgcust>>& for details.
1566
1567 .cindex "&'X-Failed-Recipients:'& header line"
1568 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1569 failed addresses, for the benefit of programs that try to analyse such messages
1570 automatically.
1571
1572 .cindex "bounce message" "recipient of"
1573 A bounce message is normally sent to the sender of the original message, as
1574 obtained from the message's envelope. For incoming SMTP messages, this is the
1575 address given in the MAIL command. However, when an address is expanded via a
1576 forward or alias file, an alternative address can be specified for delivery
1577 failures of the generated addresses. For a mailing list expansion (see section
1578 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1579 of the list.
1580
1581
1582
1583 .section "Failures to deliver bounce messages" "SECID22"
1584 .cindex "bounce message" "failure to deliver"
1585 If a bounce message (either locally generated or received from a remote host)
1586 itself suffers a permanent delivery failure, the message is left on the queue,
1587 but it is frozen, awaiting the attention of an administrator. There are options
1588 that can be used to make Exim discard such failed messages, or to keep them
1589 for only a short time (see &%timeout_frozen_after%& and
1590 &%ignore_bounce_errors_after%&).
1591
1592
1593
1594
1595
1596 . ////////////////////////////////////////////////////////////////////////////
1597 . ////////////////////////////////////////////////////////////////////////////
1598
1599 .chapter "Building and installing Exim" "CHID3"
1600 .scindex IIDbuex "building Exim"
1601
1602 .section "Unpacking" "SECID23"
1603 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1604 creates a directory with the name of the current release (for example,
1605 &_exim-&version;_&) into which the following files are placed:
1606
1607 .table2 140pt
1608 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1609 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1610   documented"
1611 .irow &_LICENCE_&         "the GNU General Public Licence"
1612 .irow &_Makefile_&        "top-level make file"
1613 .irow &_NOTICE_&          "conditions for the use of Exim"
1614 .irow &_README_&          "list of files, directories and simple build &&&
1615   instructions"
1616 .endtable
1617
1618 Other files whose names begin with &_README_& may also be present. The
1619 following subdirectories are created:
1620
1621 .table2 140pt
1622 .irow &_Local_&           "an empty directory for local configuration files"
1623 .irow &_OS_&              "OS-specific files"
1624 .irow &_doc_&             "documentation files"
1625 .irow &_exim_monitor_&    "source files for the Exim monitor"
1626 .irow &_scripts_&         "scripts used in the build process"
1627 .irow &_src_&             "remaining source files"
1628 .irow &_util_&            "independent utilities"
1629 .endtable
1630
1631 The main utility programs are contained in the &_src_& directory, and are built
1632 with the Exim binary. The &_util_& directory contains a few optional scripts
1633 that may be useful to some sites.
1634
1635
1636 .section "Multiple machine architectures and operating systems" "SECID24"
1637 .cindex "building Exim" "multiple OS/architectures"
1638 The building process for Exim is arranged to make it easy to build binaries for
1639 a number of different architectures and operating systems from the same set of
1640 source files. Compilation does not take place in the &_src_& directory.
1641 Instead, a &'build directory'& is created for each architecture and operating
1642 system.
1643 .cindex "symbolic link" "to build directory"
1644 Symbolic links to the sources are installed in this directory, which is where
1645 the actual building takes place. In most cases, Exim can discover the machine
1646 architecture and operating system for itself, but the defaults can be
1647 overridden if necessary.
1648
1649
1650 .section "PCRE library" "SECTpcre"
1651 .cindex "PCRE library"
1652 Exim no longer has an embedded PCRE library as the vast majority of
1653 modern systems include PCRE as a system library, although you may need
1654 to install the PCRE or PCRE development package for your operating
1655 system. If your system has a normal PCRE installation the Exim build
1656 process will need no further configuration. If the library or the
1657 headers are in an unusual location you will need to either set the PCRE_LIBS
1658 and INCLUDE directives appropriately,
1659 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1660 If your operating system has no
1661 PCRE support then you will need to obtain and build the current PCRE
1662 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1663 More information on PCRE is available at &url(http://www.pcre.org/).
1664
1665 .section "DBM libraries" "SECTdb"
1666 .cindex "DBM libraries" "discussion of"
1667 .cindex "hints database" "DBM files used for"
1668 Even if you do not use any DBM files in your configuration, Exim still needs a
1669 DBM library in order to operate, because it uses indexed files for its hints
1670 databases. Unfortunately, there are a number of DBM libraries in existence, and
1671 different operating systems often have different ones installed.
1672
1673 .cindex "Solaris" "DBM library for"
1674 .cindex "IRIX, DBM library for"
1675 .cindex "BSD, DBM library for"
1676 .cindex "Linux, DBM library for"
1677 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1678 Linux distribution, the DBM configuration should happen automatically, and you
1679 may be able to ignore this section. Otherwise, you may have to learn more than
1680 you would like about DBM libraries from what follows.
1681
1682 .cindex "&'ndbm'& DBM library"
1683 Licensed versions of Unix normally contain a library of DBM functions operating
1684 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1685 versions of Unix seem to vary in what they contain as standard. In particular,
1686 some early versions of Linux have no default DBM library, and different
1687 distributors have chosen to bundle different libraries with their packaged
1688 versions. However, the more recent releases seem to have standardized on the
1689 Berkeley DB library.
1690
1691 Different DBM libraries have different conventions for naming the files they
1692 use. When a program opens a file called &_dbmfile_&, there are several
1693 possibilities:
1694
1695 .olist
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1698 .next
1699 .cindex "&'gdbm'& DBM library"
1700 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1701 compatibility interface it makes two different hard links to it with names
1702 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1703 file name is used unmodified.
1704 .next
1705 .cindex "Berkeley DB library"
1706 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1707 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1708 programmer exactly the same as the traditional &'ndbm'& implementation.
1709 .next
1710 If the Berkeley package is used in its native mode, it operates on a single
1711 file called &_dbmfile_&; the programmer's interface is somewhat different to
1712 the traditional &'ndbm'& interface.
1713 .next
1714 To complicate things further, there are several very different versions of the
1715 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1716 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1717 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1718 versions of Berkeley DB can be obtained from
1719 &url(http://www.sleepycat.com/).
1720 .next
1721 .cindex "&'tdb'& DBM library"
1722 Yet another DBM library, called &'tdb'&, is available from
1723 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1724 operates on a single file.
1725 .endlist
1726
1727 .cindex "USE_DB"
1728 .cindex "DBM libraries" "configuration for building"
1729 Exim and its utilities can be compiled to use any of these interfaces. In order
1730 to use any version of the Berkeley DB package in native mode, you must set
1731 USE_DB in an appropriate configuration file (typically
1732 &_Local/Makefile_&). For example:
1733 .code
1734 USE_DB=yes
1735 .endd
1736 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1737 error is diagnosed if you set more than one of these.
1738
1739 At the lowest level, the build-time configuration sets none of these options,
1740 thereby assuming an interface of type (1). However, some operating system
1741 configuration files (for example, those for the BSD operating systems and
1742 Linux) assume type (4) by setting USE_DB as their default, and the
1743 configuration files for Cygwin set USE_GDBM. Anything you set in
1744 &_Local/Makefile_&, however, overrides these system defaults.
1745
1746 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1747 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1748 in one of these lines:
1749 .code
1750 DBMLIB = -ldb
1751 DBMLIB = -ltdb
1752 .endd
1753 Settings like that will work if the DBM library is installed in the standard
1754 place. Sometimes it is not, and the library's header file may also not be in
1755 the default path. You may need to set INCLUDE to specify where the header
1756 file is, and to specify the path to the library more fully in DBMLIB, as in
1757 this example:
1758 .code
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1761 .endd
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1764
1765
1766
1767 .section "Pre-building configuration" "SECID25"
1768 .cindex "building Exim" "pre-building configuration"
1769 .cindex "configuration for building Exim"
1770 .cindex "&_Local/Makefile_&"
1771 .cindex "&_src/EDITME_&"
1772 Before building Exim, a local configuration file that specifies options
1773 independent of any operating system has to be created with the name
1774 &_Local/Makefile_&. A template for this file is supplied as the file
1775 &_src/EDITME_&, and it contains full descriptions of all the option settings
1776 therein. These descriptions are therefore not repeated here. If you are
1777 building Exim for the first time, the simplest thing to do is to copy
1778 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1779
1780 There are three settings that you must supply, because Exim will not build
1781 without them. They are the location of the run time configuration file
1782 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1783 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1784 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1785 a colon-separated list of file names; Exim uses the first of them that exists.
1786
1787 There are a few other parameters that can be specified either at build time or
1788 at run time, to enable the same binary to be used on a number of different
1789 machines. However, if the locations of Exim's spool directory and log file
1790 directory (if not within the spool directory) are fixed, it is recommended that
1791 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1792 detected early in Exim's execution (such as a malformed configuration file) can
1793 be logged.
1794
1795 .cindex "content scanning" "specifying at build time"
1796 Exim's interfaces for calling virus and spam scanning software directly from
1797 access control lists are not compiled by default. If you want to include these
1798 facilities, you need to set
1799 .code
1800 WITH_CONTENT_SCAN=yes
1801 .endd
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
1804
1805
1806 .cindex "&_Local/eximon.conf_&"
1807 .cindex "&_exim_monitor/EDITME_&"
1808 If you are going to build the Exim monitor, a similar configuration process is
1809 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1810 your installation and saved under the name &_Local/eximon.conf_&. If you are
1811 happy with the default settings described in &_exim_monitor/EDITME_&,
1812 &_Local/eximon.conf_& can be empty, but it must exist.
1813
1814 This is all the configuration that is needed in straightforward cases for known
1815 operating systems. However, the building process is set up so that it is easy
1816 to override options that are set by default or by operating-system-specific
1817 configuration files, for example to change the name of the C compiler, which
1818 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1819 do this.
1820
1821
1822
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
1825 .cindex "RFC 2047"
1826 The contents of header lines in messages may be encoded according to the rules
1827 described RFC 2047. This makes it possible to transmit characters that are not
1828 in the ASCII character set, and to label them as being in a particular
1829 character set. When Exim is inspecting header lines by means of the &%$h_%&
1830 mechanism, it decodes them, and translates them into a specified character set
1831 (default ISO-8859-1). The translation is possible only if the operating system
1832 supports the &[iconv()]& function.
1833
1834 However, some of the operating systems that supply &[iconv()]& do not support
1835 very many conversions. The GNU &%libiconv%& library (available from
1836 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1837 systems to remedy this deficiency, as well as on systems that do not supply
1838 &[iconv()]& at all. After installing &%libiconv%&, you should add
1839 .code
1840 HAVE_ICONV=yes
1841 .endd
1842 to your &_Local/Makefile_& and rebuild Exim.
1843
1844
1845
1846 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1847 .cindex "TLS" "including support for TLS"
1848 .cindex "encryption" "including support for"
1849 .cindex "SUPPORT_TLS"
1850 .cindex "OpenSSL" "building Exim with"
1851 .cindex "GnuTLS" "building Exim with"
1852 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1853 command as per RFC 2487. It can also support legacy clients that expect to
1854 start a TLS session immediately on connection to a non-standard port (see the
1855 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1856 line option).
1857
1858 If you want to build Exim with TLS support, you must first install either the
1859 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1860 implementing SSL.
1861
1862 If OpenSSL is installed, you should set
1863 .code
1864 SUPPORT_TLS=yes
1865 TLS_LIBS=-lssl -lcrypto
1866 .endd
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1869 .code
1870 SUPPORT_TLS=yes
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1873 .endd
1874 .cindex "pkg-config" "OpenSSL"
1875 If you have &'pkg-config'& available, then instead you can just use:
1876 .code
1877 SUPPORT_TLS=yes
1878 USE_OPENSSL_PC=openssl
1879 .endd
1880 .cindex "USE_GNUTLS"
1881 If GnuTLS is installed, you should set
1882 .code
1883 SUPPORT_TLS=yes
1884 USE_GNUTLS=yes
1885 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1886 .endd
1887 in &_Local/Makefile_&, and again you may need to specify the locations of the
1888 library and include files. For example:
1889 .code
1890 SUPPORT_TLS=yes
1891 USE_GNUTLS=yes
1892 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1893 TLS_INCLUDE=-I/usr/gnu/include
1894 .endd
1895 .cindex "pkg-config" "GnuTLS"
1896 If you have &'pkg-config'& available, then instead you can just use:
1897 .code
1898 SUPPORT_TLS=yes
1899 USE_GNUTLS=yes
1900 USE_GNUTLS_PC=gnutls
1901 .endd
1902
1903 You do not need to set TLS_INCLUDE if the relevant directory is already
1904 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1905 given in chapter &<<CHAPTLS>>&.
1906
1907
1908
1909
1910 .section "Use of tcpwrappers" "SECID27"
1911
1912 .cindex "tcpwrappers, building Exim to support"
1913 .cindex "USE_TCP_WRAPPERS"
1914 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1915 .cindex "tcp_wrappers_daemon_name"
1916 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1917 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1918 alternative to Exim's own checking facilities for installations that are
1919 already making use of &'tcpwrappers'& for other purposes. To do this, you
1920 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1921 &_tcpd.h_& to be available at compile time, and also ensure that the library
1922 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1923 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1924 you might have
1925 .code
1926 USE_TCP_WRAPPERS=yes
1927 CFLAGS=-O -I/usr/local/include
1928 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1929 .endd
1930 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1931 files is &"exim"&. For example, the line
1932 .code
1933 exim : LOCAL  192.168.1.  .friendly.domain.example
1934 .endd
1935 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1936 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1937 All other connections are denied. The daemon name used by &'tcpwrappers'&
1938 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1939 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1940 configure file. Consult the &'tcpwrappers'& documentation for
1941 further details.
1942
1943
1944 .section "Including support for IPv6" "SECID28"
1945 .cindex "IPv6" "including support for"
1946 Exim contains code for use on systems that have IPv6 support. Setting
1947 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1948 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1949 where the IPv6 support is not fully integrated into the normal include and
1950 library files.
1951
1952 Two different types of DNS record for handling IPv6 addresses have been
1953 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1954 currently seen as the mainstream. Another record type called A6 was proposed
1955 as better than AAAA because it had more flexibility. However, it was felt to be
1956 over-complex, and its status was reduced to &"experimental"&. It is not known
1957 if anyone is actually using A6 records. Exim has support for A6 records, but
1958 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1959 support has not been tested for some time.
1960
1961
1962
1963 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1964 .cindex "lookup modules"
1965 .cindex "dynamic modules"
1966 .cindex ".so building"
1967 On some platforms, Exim supports not compiling all lookup types directly into
1968 the main binary, instead putting some into external modules which can be loaded
1969 on demand.
1970 This permits packagers to build Exim with support for lookups with extensive
1971 library dependencies without requiring all users to install all of those
1972 dependencies.
1973 Most, but not all, lookup types can be built this way.
1974
1975 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1976 installed; Exim will only load modules from that directory, as a security
1977 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1978 for your OS; see &_OS/Makefile-Linux_& for an example.
1979 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1980 see &_src/EDITME_& for details.
1981
1982 Then, for each module to be loaded dynamically, define the relevant
1983 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1984 For example, this will build in lsearch but load sqlite and mysql support
1985 on demand:
1986 .code
1987 LOOKUP_LSEARCH=yes
1988 LOOKUP_SQLITE=2
1989 LOOKUP_MYSQL=2
1990 .endd
1991
1992
1993 .section "The building process" "SECID29"
1994 .cindex "build directory"
1995 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1996 created, run &'make'& at the top level. It determines the architecture and
1997 operating system types, and creates a build directory if one does not exist.
1998 For example, on a Sun system running Solaris 8, the directory
1999 &_build-SunOS5-5.8-sparc_& is created.
2000 .cindex "symbolic link" "to source files"
2001 Symbolic links to relevant source files are installed in the build directory.
2002
2003 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2004 building process fails if it is set.
2005
2006 If this is the first time &'make'& has been run, it calls a script that builds
2007 a make file inside the build directory, using the configuration files from the
2008 &_Local_& directory. The new make file is then passed to another instance of
2009 &'make'&. This does the real work, building a number of utility scripts, and
2010 then compiling and linking the binaries for the Exim monitor (if configured), a
2011 number of utility programs, and finally Exim itself. The command &`make
2012 makefile`& can be used to force a rebuild of the make file in the build
2013 directory, should this ever be necessary.
2014
2015 If you have problems building Exim, check for any comments there may be in the
2016 &_README_& file concerning your operating system, and also take a look at the
2017 FAQ, where some common problems are covered.
2018
2019
2020
2021 .section 'Output from &"make"&' "SECID283"
2022 The output produced by the &'make'& process for compile lines is often very
2023 unreadable, because these lines can be very long. For this reason, the normal
2024 output is suppressed by default, and instead output similar to that which
2025 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2026 each module that is being compiled or linked. However, it is still possible to
2027 get the full output, by calling &'make'& like this:
2028 .code
2029 FULLECHO='' make -e
2030 .endd
2031 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2032 command reflection in &'make'&. When you ask for the full output, it is
2033 given in addition to the short output.
2034
2035
2036
2037 .section "Overriding build-time options for Exim" "SECToverride"
2038 .cindex "build-time options, overriding"
2039 The main make file that is created at the beginning of the building process
2040 consists of the concatenation of a number of files which set configuration
2041 values, followed by a fixed set of &'make'& instructions. If a value is set
2042 more than once, the last setting overrides any previous ones. This provides a
2043 convenient way of overriding defaults. The files that are concatenated are, in
2044 order:
2045 .display
2046 &_OS/Makefile-Default_&
2047 &_OS/Makefile-_&<&'ostype'&>
2048 &_Local/Makefile_&
2049 &_Local/Makefile-_&<&'ostype'&>
2050 &_Local/Makefile-_&<&'archtype'&>
2051 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2052 &_OS/Makefile-Base_&
2053 .endd
2054 .cindex "&_Local/Makefile_&"
2055 .cindex "building Exim" "operating system type"
2056 .cindex "building Exim" "architecture type"
2057 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2058 architecture type. &_Local/Makefile_& is required to exist, and the building
2059 process fails if it is absent. The other three &_Local_& files are optional,
2060 and are often not needed.
2061
2062 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2063 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2064 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2065 values are used, thereby providing a means of forcing particular settings.
2066 Otherwise, the scripts try to get values from the &%uname%& command. If this
2067 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2068 of &'ad hoc'& transformations are then applied, to produce the standard names
2069 that Exim expects. You can run these scripts directly from the shell in order
2070 to find out what values are being used on your system.
2071
2072
2073 &_OS/Makefile-Default_& contains comments about the variables that are set
2074 therein. Some (but not all) are mentioned below. If there is something that
2075 needs changing, review the contents of this file and the contents of the make
2076 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2077 default values are.
2078
2079
2080 .cindex "building Exim" "overriding default settings"
2081 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2082 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2083 need to change the original files. Instead, you should make the changes by
2084 putting the new values in an appropriate &_Local_& file. For example,
2085 .cindex "Tru64-Unix build-time settings"
2086 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2087 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2088 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2089 called with the option &%-std1%&, to make it recognize some of the features of
2090 Standard C that Exim uses. (Most other compilers recognize Standard C by
2091 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2092 containing the lines
2093 .code
2094 CC=cc
2095 CFLAGS=-std1
2096 .endd
2097 If you are compiling for just one operating system, it may be easier to put
2098 these lines directly into &_Local/Makefile_&.
2099
2100 Keeping all your local configuration settings separate from the distributed
2101 files makes it easy to transfer them to new versions of Exim simply by copying
2102 the contents of the &_Local_& directory.
2103
2104
2105 .cindex "NIS lookup type" "including support for"
2106 .cindex "NIS+ lookup type" "including support for"
2107 .cindex "LDAP" "including support for"
2108 .cindex "lookup" "inclusion in binary"
2109 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2110 lookup, but not all systems have these components installed, so the default is
2111 not to include the relevant code in the binary. All the different kinds of file
2112 and database lookup that Exim supports are implemented as separate code modules
2113 which are included only if the relevant compile-time options are set. In the
2114 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2115 .code
2116 LOOKUP_LDAP=yes
2117 LOOKUP_NIS=yes
2118 LOOKUP_NISPLUS=yes
2119 .endd
2120 and similar settings apply to the other lookup types. They are all listed in
2121 &_src/EDITME_&. In many cases the relevant include files and interface
2122 libraries need to be installed before compiling Exim.
2123 .cindex "cdb" "including support for"
2124 However, there are some optional lookup types (such as cdb) for which
2125 the code is entirely contained within Exim, and no external include
2126 files or libraries are required. When a lookup type is not included in the
2127 binary, attempts to configure Exim to use it cause run time configuration
2128 errors.
2129
2130 .cindex "pkg-config" "lookups"
2131 .cindex "pkg-config" "authenticators"
2132 Many systems now use a tool called &'pkg-config'& to encapsulate information
2133 about how to compile against a library; Exim has some initial support for
2134 being able to use pkg-config for lookups and authenticators.  For any given
2135 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2136 variable with the &`_PC`& suffix in the name and assign as the value the
2137 name of the package to be queried.  The results of querying via the
2138 &'pkg-config'& command will be added to the appropriate Makefile variables
2139 with &`+=`& directives, so your version of &'make'& will need to support that
2140 syntax.  For instance:
2141 .code
2142 LOOKUP_SQLITE=yes
2143 LOOKUP_SQLITE_PC=sqlite3
2144 AUTH_GSASL=yes
2145 AUTH_GSASL_PC=libgsasl
2146 AUTH_HEIMDAL_GSSAPI=yes
2147 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2148 .endd
2149
2150 .cindex "Perl" "including support for"
2151 Exim can be linked with an embedded Perl interpreter, allowing Perl
2152 subroutines to be called during string expansion. To enable this facility,
2153 .code
2154 EXIM_PERL=perl.o
2155 .endd
2156 must be defined in &_Local/Makefile_&. Details of this facility are given in
2157 chapter &<<CHAPperl>>&.
2158
2159 .cindex "X11 libraries, location of"
2160 The location of the X11 libraries is something that varies a lot between
2161 operating systems, and there may be different versions of X11 to cope
2162 with. Exim itself makes no use of X11, but if you are compiling the Exim
2163 monitor, the X11 libraries must be available.
2164 The following three variables are set in &_OS/Makefile-Default_&:
2165 .code
2166 X11=/usr/X11R6
2167 XINCLUDE=-I$(X11)/include
2168 XLFLAGS=-L$(X11)/lib
2169 .endd
2170 These are overridden in some of the operating-system configuration files. For
2171 example, in &_OS/Makefile-SunOS5_& there is
2172 .code
2173 X11=/usr/openwin
2174 XINCLUDE=-I$(X11)/include
2175 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2176 .endd
2177 If you need to override the default setting for your operating system, place a
2178 definition of all three of these variables into your
2179 &_Local/Makefile-<ostype>_& file.
2180
2181 .cindex "EXTRALIBS"
2182 If you need to add any extra libraries to the link steps, these can be put in a
2183 variable called EXTRALIBS, which appears in all the link commands, but by
2184 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2185 command for linking the main Exim binary, and not for any associated utilities.
2186
2187 .cindex "DBM libraries" "configuration for building"
2188 There is also DBMLIB, which appears in the link commands for binaries that
2189 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2190 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2191 binary, and which can be used, for example, to include additional X11
2192 libraries.
2193
2194 .cindex "configuration file" "editing"
2195 The make file copes with rebuilding Exim correctly if any of the configuration
2196 files are edited. However, if an optional configuration file is deleted, it is
2197 necessary to touch the associated non-optional file (that is,
2198 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2199
2200
2201 .section "OS-specific header files" "SECID30"
2202 .cindex "&_os.h_&"
2203 .cindex "building Exim" "OS-specific C header files"
2204 The &_OS_& directory contains a number of files with names of the form
2205 &_os.h-<ostype>_&. These are system-specific C header files that should not
2206 normally need to be changed. There is a list of macro settings that are
2207 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2208 are porting Exim to a new operating system.
2209
2210
2211
2212 .section "Overriding build-time options for the monitor" "SECID31"
2213 .cindex "building Eximon"
2214 A similar process is used for overriding things when building the Exim monitor,
2215 where the files that are involved are
2216 .display
2217 &_OS/eximon.conf-Default_&
2218 &_OS/eximon.conf-_&<&'ostype'&>
2219 &_Local/eximon.conf_&
2220 &_Local/eximon.conf-_&<&'ostype'&>
2221 &_Local/eximon.conf-_&<&'archtype'&>
2222 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2223 .endd
2224 .cindex "&_Local/eximon.conf_&"
2225 As with Exim itself, the final three files need not exist, and in this case the
2226 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2227 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2228 variables of the same name, preceded by EXIMON_. For example, setting
2229 EXIMON_LOG_DEPTH in the environment overrides the value of
2230 LOG_DEPTH at run time.
2231 .ecindex IIDbuex
2232
2233
2234 .section "Installing Exim binaries and scripts" "SECID32"
2235 .cindex "installing Exim"
2236 .cindex "BIN_DIRECTORY"
2237 The command &`make install`& runs the &(exim_install)& script with no
2238 arguments. The script copies binaries and utility scripts into the directory
2239 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2240 .cindex "setuid" "installing Exim with"
2241 The install script copies files only if they are newer than the files they are
2242 going to replace. The Exim binary is required to be owned by root and have the
2243 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2244 install`& as root so that it can set up the Exim binary in this way. However, in
2245 some special situations (for example, if a host is doing no local deliveries)
2246 it may be possible to run Exim without making the binary setuid root (see
2247 chapter &<<CHAPsecurity>>& for details).
2248
2249 .cindex "CONFIGURE_FILE"
2250 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2251 in &_Local/Makefile_&. If this names a single file, and the file does not
2252 exist, the default configuration file &_src/configure.default_& is copied there
2253 by the installation script. If a run time configuration file already exists, it
2254 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2255 alternative files, no default is installed.
2256
2257 .cindex "system aliases file"
2258 .cindex "&_/etc/aliases_&"
2259 One change is made to the default configuration file when it is installed: the
2260 default configuration contains a router that references a system aliases file.
2261 The path to this file is set to the value specified by
2262 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2263 If the system aliases file does not exist, the installation script creates it,
2264 and outputs a comment to the user.
2265
2266 The created file contains no aliases, but it does contain comments about the
2267 aliases a site should normally have. Mail aliases have traditionally been
2268 kept in &_/etc/aliases_&. However, some operating systems are now using
2269 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2270 Exim's configuration if necessary.
2271
2272 The default configuration uses the local host's name as the only local domain,
2273 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2274 running as the local user. System aliases and &_.forward_& files in users' home
2275 directories are supported, but no NIS or NIS+ support is configured. Domains
2276 other than the name of the local host are routed using the DNS, with delivery
2277 over SMTP.
2278
2279 It is possible to install Exim for special purposes (such as building a binary
2280 distribution) in a private part of the file system. You can do this by a
2281 command such as
2282 .code
2283 make DESTDIR=/some/directory/ install
2284 .endd
2285 This has the effect of pre-pending the specified directory to all the file
2286 paths, except the name of the system aliases file that appears in the default
2287 configuration. (If a default alias file is created, its name &'is'& modified.)
2288 For backwards compatibility, ROOT is used if DESTDIR is not set,
2289 but this usage is deprecated.
2290
2291 .cindex "installing Exim" "what is not installed"
2292 Running &'make install'& does not copy the Exim 4 conversion script
2293 &'convert4r4'&. You will probably run this only once if you are
2294 upgrading from Exim 3. None of the documentation files in the &_doc_&
2295 directory are copied, except for the info files when you have set
2296 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2297
2298 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2299 to their names. The Exim binary itself, however, is handled differently. It is
2300 installed under a name that includes the version number and the compile number,
2301 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2302 called &_exim_& to point to the binary. If you are updating a previous version
2303 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2304 from the directory (as seen by other processes).
2305
2306 .cindex "installing Exim" "testing the script"
2307 If you want to see what the &'make install'& will do before running it for
2308 real, you can pass the &%-n%& option to the installation script by this
2309 command:
2310 .code
2311 make INSTALL_ARG=-n install
2312 .endd
2313 The contents of the variable INSTALL_ARG are passed to the installation
2314 script. You do not need to be root to run this test. Alternatively, you can run
2315 the installation script directly, but this must be from within the build
2316 directory. For example, from the top-level Exim directory you could use this
2317 command:
2318 .code
2319 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2320 .endd
2321 .cindex "installing Exim" "install script options"
2322 There are two other options that can be supplied to the installation script.
2323
2324 .ilist
2325 &%-no_chown%& bypasses the call to change the owner of the installed binary
2326 to root, and the call to make it a setuid binary.
2327 .next
2328 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2329 installed binary.
2330 .endlist
2331
2332 INSTALL_ARG can be used to pass these options to the script. For example:
2333 .code
2334 make INSTALL_ARG=-no_symlink install
2335 .endd
2336 The installation script can also be given arguments specifying which files are
2337 to be copied. For example, to install just the Exim binary, and nothing else,
2338 without creating the symbolic link, you could use:
2339 .code
2340 make INSTALL_ARG='-no_symlink exim' install
2341 .endd
2342
2343
2344
2345 .section "Installing info documentation" "SECTinsinfdoc"
2346 .cindex "installing Exim" "&'info'& documentation"
2347 Not all systems use the GNU &'info'& system for documentation, and for this
2348 reason, the Texinfo source of Exim's documentation is not included in the main
2349 distribution. Instead it is available separately from the ftp site (see section
2350 &<<SECTavail>>&).
2351
2352 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2353 source of the documentation is found in the source tree, running &`make
2354 install`& automatically builds the info files and installs them.
2355
2356
2357
2358 .section "Setting up the spool directory" "SECID33"
2359 .cindex "spool directory" "creating"
2360 When it starts up, Exim tries to create its spool directory if it does not
2361 exist. The Exim uid and gid are used for the owner and group of the spool
2362 directory. Sub-directories are automatically created in the spool directory as
2363 necessary.
2364
2365
2366
2367
2368 .section "Testing" "SECID34"
2369 .cindex "testing" "installation"
2370 Having installed Exim, you can check that the run time configuration file is
2371 syntactically valid by running the following command, which assumes that the
2372 Exim binary directory is within your PATH environment variable:
2373 .code
2374 exim -bV
2375 .endd
2376 If there are any errors in the configuration file, Exim outputs error messages.
2377 Otherwise it outputs the version number and build date,
2378 the DBM library that is being used, and information about which drivers and
2379 other optional code modules are included in the binary.
2380 Some simple routing tests can be done by using the address testing option. For
2381 example,
2382 .display
2383 &`exim -bt`& <&'local username'&>
2384 .endd
2385 should verify that it recognizes a local mailbox, and
2386 .display
2387 &`exim -bt`& <&'remote address'&>
2388 .endd
2389 a remote one. Then try getting it to deliver mail, both locally and remotely.
2390 This can be done by passing messages directly to Exim, without going through a
2391 user agent. For example:
2392 .code
2393 exim -v postmaster@your.domain.example
2394 From: user@your.domain.example
2395 To: postmaster@your.domain.example
2396 Subject: Testing Exim
2397
2398 This is a test message.
2399 ^D
2400 .endd
2401 The &%-v%& option causes Exim to output some verification of what it is doing.
2402 In this case you should see copies of three log lines, one for the message's
2403 arrival, one for its delivery, and one containing &"Completed"&.
2404
2405 .cindex "delivery" "problems with"
2406 If you encounter problems, look at Exim's log files (&'mainlog'& and
2407 &'paniclog'&) to see if there is any relevant information there. Another source
2408 of information is running Exim with debugging turned on, by specifying the
2409 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2410 with debugging turned on by a command of the form
2411 .display
2412 &`exim -d -M`& <&'exim-message-id'&>
2413 .endd
2414 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2415 produces rather a lot of output, but you can cut this down to specific areas.
2416 For example, if you use &%-d-all+route%& only the debugging information
2417 relevant to routing is included. (See the &%-d%& option in chapter
2418 &<<CHAPcommandline>>& for more details.)
2419
2420 .cindex '&"sticky"& bit'
2421 .cindex "lock files"
2422 One specific problem that has shown up on some sites is the inability to do
2423 local deliveries into a shared mailbox directory, because it does not have the
2424 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2425 writing to a mailbox file, and if it cannot create the lock file, the delivery
2426 is deferred. You can get round this either by setting the &"sticky bit"& on the
2427 directory, or by setting a specific group for local deliveries and allowing
2428 that group to create files in the directory (see the comments above the
2429 &(local_delivery)& transport in the default configuration file). Another
2430 approach is to configure Exim not to use lock files, but just to rely on
2431 &[fcntl()]& locking instead. However, you should do this only if all user
2432 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2433 see chapter &<<CHAPappendfile>>&.
2434
2435 One thing that cannot be tested on a system that is already running an MTA is
2436 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2437 &%-oX%& option can be used to run an Exim daemon that listens on some other
2438 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2439 &'exim_checkaccess'& utility can be used to check out policy controls on
2440 incoming SMTP mail.
2441
2442 Testing a new version on a system that is already running Exim can most easily
2443 be done by building a binary with a different CONFIGURE_FILE setting. From
2444 within the run time configuration, all other file and directory names
2445 that Exim uses can be altered, in order to keep it entirely clear of the
2446 production version.
2447
2448
2449 .section "Replacing another MTA with Exim" "SECID35"
2450 .cindex "replacing another MTA"
2451 Building and installing Exim for the first time does not of itself put it in
2452 general use. The name by which the system's MTA is called by mail user agents
2453 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2454 operating system), and it is necessary to make this name point to the &'exim'&
2455 binary in order to get the user agents to pass messages to Exim. This is
2456 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2457 or &_/usr/lib/sendmail_&
2458 .cindex "symbolic link" "to &'exim'& binary"
2459 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2460 privilege and executable status from the old MTA. It is then necessary to stop
2461 and restart the mailer daemon, if one is running.
2462
2463 .cindex "FreeBSD, MTA indirection"
2464 .cindex "&_/etc/mail/mailer.conf_&"
2465 Some operating systems have introduced alternative ways of switching MTAs. For
2466 example, if you are running FreeBSD, you need to edit the file
2467 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2468 described. A typical example of the contents of this file for running Exim is
2469 as follows:
2470 .code
2471 sendmail            /usr/exim/bin/exim
2472 send-mail           /usr/exim/bin/exim
2473 mailq               /usr/exim/bin/exim -bp
2474 newaliases          /usr/bin/true
2475 .endd
2476 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2477 your Exim installation is &"live"&. Check it by sending a message from your
2478 favourite user agent.
2479
2480 You should consider what to tell your users about the change of MTA. Exim may
2481 have different capabilities to what was previously running, and there are
2482 various operational differences such as the text of messages produced by
2483 command line options and in bounce messages. If you allow your users to make
2484 use of Exim's filtering capabilities, you should make the document entitled
2485 &'Exim's interface to mail filtering'& available to them.
2486
2487
2488
2489 .section "Upgrading Exim" "SECID36"
2490 .cindex "upgrading Exim"
2491 If you are already running Exim on your host, building and installing a new
2492 version automatically makes it available to MUAs, or any other programs that
2493 call the MTA directly. However, if you are running an Exim daemon, you do need
2494 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2495 new binary. You do not need to stop processing mail in order to install a new
2496 version of Exim. The install script does not modify an existing runtime
2497 configuration file.
2498
2499
2500
2501
2502 .section "Stopping the Exim daemon on Solaris" "SECID37"
2503 .cindex "Solaris" "stopping Exim on"
2504 The standard command for stopping the mailer daemon on Solaris is
2505 .code
2506 /etc/init.d/sendmail stop
2507 .endd
2508 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2509 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2510 for the text &"sendmail"&; this is not present because the actual program name
2511 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2512 solution is to replace the line that finds the process id with something like
2513 .code
2514 pid=`cat /var/spool/exim/exim-daemon.pid`
2515 .endd
2516 to obtain the daemon's pid directly from the file that Exim saves it in.
2517
2518 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2519 still be received from local processes, and if automatic delivery is configured
2520 (the normal case), deliveries will still occur.
2521
2522
2523
2524
2525 . ////////////////////////////////////////////////////////////////////////////
2526 . ////////////////////////////////////////////////////////////////////////////
2527
2528 .chapter "The Exim command line" "CHAPcommandline"
2529 .scindex IIDclo1 "command line" "options"
2530 .scindex IIDclo2 "options" "command line"
2531 Exim's command line takes the standard Unix form of a sequence of options,
2532 each starting with a hyphen character, followed by a number of arguments. The
2533 options are compatible with the main options of Sendmail, and there are also
2534 some additional options, some of which are compatible with Smail 3. Certain
2535 combinations of options do not make sense, and provoke an error if used.
2536 The form of the arguments depends on which options are set.
2537
2538
2539 .section "Setting options by program name" "SECID38"
2540 .cindex "&'mailq'&"
2541 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2542 were present before any other options.
2543 The &%-bp%& option requests a listing of the contents of the mail queue on the
2544 standard output.
2545 This feature is for compatibility with some systems that contain a command of
2546 that name in one of the standard libraries, symbolically linked to
2547 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2548
2549 .cindex "&'rsmtp'&"
2550 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2551 were present before any other options, for compatibility with Smail. The
2552 &%-bS%& option is used for reading in a number of messages in batched SMTP
2553 format.
2554
2555 .cindex "&'rmail'&"
2556 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2557 &%-oee%& options were present before any other options, for compatibility with
2558 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2559
2560 .cindex "&'runq'&"
2561 .cindex "queue runner"
2562 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2563 were present before any other options, for compatibility with Smail. The &%-q%&
2564 option causes a single queue runner process to be started.
2565
2566 .cindex "&'newaliases'&"
2567 .cindex "alias file" "building"
2568 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2569 If Exim is called under the name &'newaliases'& it behaves as if the option
2570 &%-bi%& were present before any other options, for compatibility with Sendmail.
2571 This option is used for rebuilding Sendmail's alias file. Exim does not have
2572 the concept of a single alias file, but can be configured to run a given
2573 command if called with the &%-bi%& option.
2574
2575
2576 .section "Trusted and admin users" "SECTtrustedadmin"
2577 Some Exim options are available only to &'trusted users'& and others are
2578 available only to &'admin users'&. In the description below, the phrases &"Exim
2579 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2580 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2581 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2582
2583 .ilist
2584 .cindex "trusted users" "definition of"
2585 .cindex "user" "trusted definition of"
2586 The trusted users are root, the Exim user, any user listed in the
2587 &%trusted_users%& configuration option, and any user whose current group or any
2588 supplementary group is one of those listed in the &%trusted_groups%&
2589 configuration option. Note that the Exim group is not automatically trusted.
2590
2591 .cindex '&"From"& line'
2592 .cindex "envelope sender"
2593 Trusted users are always permitted to use the &%-f%& option or a leading
2594 &"From&~"& line to specify the envelope sender of a message that is passed to
2595 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2596 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2597 users to set envelope senders.
2598
2599 .cindex "&'From:'& header line"
2600 .cindex "&'Sender:'& header line"
2601 For a trusted user, there is never any check on the contents of the &'From:'&
2602 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2603 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2604
2605 Trusted users may also specify a host name, host address, interface address,
2606 protocol name, ident value, and authentication data when submitting a message
2607 locally. Thus, they are able to insert messages into Exim's queue locally that
2608 have the characteristics of messages received from a remote host. Untrusted
2609 users may in some circumstances use &%-f%&, but can never set the other values
2610 that are available to trusted users.
2611 .next
2612 .cindex "user" "admin definition of"
2613 .cindex "admin user" "definition of"
2614 The admin users are root, the Exim user, and any user that is a member of the
2615 Exim group or of any group listed in the &%admin_groups%& configuration option.
2616 The current group does not have to be one of these groups.
2617
2618 Admin users are permitted to list the queue, and to carry out certain
2619 operations on messages, for example, to force delivery failures. It is also
2620 necessary to be an admin user in order to see the full information provided by
2621 the Exim monitor, and full debugging output.
2622
2623 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2624 Exim to attempt delivery of messages on its queue is restricted to admin users.
2625 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2626 option false (that is, specifying &%no_prod_requires_admin%&).
2627
2628 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2629 is restricted to admin users unless &%queue_list_requires_admin%& is set
2630 false.
2631 .endlist
2632
2633
2634 &*Warning*&: If you configure your system so that admin users are able to
2635 edit Exim's configuration file, you are giving those users an easy way of
2636 getting root. There is further discussion of this issue at the start of chapter
2637 &<<CHAPconf>>&.
2638
2639
2640
2641
2642 .section "Command line options" "SECID39"
2643 Exim's command line options are described in alphabetical order below. If none
2644 of the options that specifies a specific action (such as starting the daemon or
2645 a queue runner, or testing an address, or receiving a message in a specific
2646 format, or listing the queue) are present, and there is at least one argument
2647 on the command line, &%-bm%& (accept a local message on the standard input,
2648 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2649 outputs a brief message about itself and exits.
2650
2651 . ////////////////////////////////////////////////////////////////////////////
2652 . Insert a stylized XML comment here, to identify the start of the command line
2653 . options. This is for the benefit of the Perl script that automatically
2654 . creates a man page for the options.
2655 . ////////////////////////////////////////////////////////////////////////////
2656
2657 .literal xml
2658 <!-- === Start of command line options === -->
2659 .literal off
2660
2661
2662 .vlist
2663 .vitem &%--%&
2664 .oindex "--"
2665 .cindex "options" "command line; terminating"
2666 This is a pseudo-option whose only purpose is to terminate the options and
2667 therefore to cause subsequent command line items to be treated as arguments
2668 rather than options, even if they begin with hyphens.
2669
2670 .vitem &%--help%&
2671 .oindex "&%--help%&"
2672 This option causes Exim to output a few sentences stating what it is.
2673 The same output is generated if the Exim binary is called with no options and
2674 no arguments.
2675
2676 .vitem &%--version%&
2677 .oindex "&%--version%&"
2678 This option is an alias for &%-bV%& and causes version information to be
2679 displayed.
2680
2681 .vitem &%-B%&<&'type'&>
2682 .oindex "&%-B%&"
2683 .cindex "8-bit characters"
2684 .cindex "Sendmail compatibility" "8-bit characters"
2685 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2686 clean; it ignores this option.
2687
2688 .vitem &%-bd%&
2689 .oindex "&%-bd%&"
2690 .cindex "daemon"
2691 .cindex "SMTP" "listener"
2692 .cindex "queue runner"
2693 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2694 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2695 that the daemon should also initiate periodic queue runs.
2696
2697 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2698 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2699 disconnect from the controlling terminal. When running this way, it can be
2700 stopped by pressing ctrl-C.
2701
2702 By default, Exim listens for incoming connections to the standard SMTP port on
2703 all the host's running interfaces. However, it is possible to listen on other
2704 ports, on multiple ports, and only on specific interfaces. Chapter
2705 &<<CHAPinterfaces>>& contains a description of the options that control this.
2706
2707 When a listening daemon
2708 .cindex "daemon" "process id (pid)"
2709 .cindex "pid (process id)" "of daemon"
2710 is started without the use of &%-oX%& (that is, without overriding the normal
2711 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2712 in Exim's spool directory. This location can be overridden by setting
2713 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2714 running as root.
2715
2716 When &%-oX%& is used on the command line to start a listening daemon, the
2717 process id is not written to the normal pid file path. However, &%-oP%& can be
2718 used to specify a path on the command line if a pid file is required.
2719
2720 The SIGHUP signal
2721 .cindex "SIGHUP"
2722 .cindex "daemon" "restarting"
2723 can be used to cause the daemon to re-execute itself. This should be done
2724 whenever Exim's configuration file, or any file that is incorporated into it by
2725 means of the &%.include%& facility, is changed, and also whenever a new version
2726 of Exim is installed. It is not necessary to do this when other files that are
2727 referenced from the configuration (for example, alias files) are changed,
2728 because these are reread each time they are used.
2729
2730 .vitem &%-bdf%&
2731 .oindex "&%-bdf%&"
2732 This option has the same effect as &%-bd%& except that it never disconnects
2733 from the controlling terminal, even when no debugging is specified.
2734
2735 .vitem &%-be%&
2736 .oindex "&%-be%&"
2737 .cindex "testing" "string expansion"
2738 .cindex "expansion" "testing"
2739 Run Exim in expansion testing mode. Exim discards its root privilege, to
2740 prevent ordinary users from using this mode to read otherwise inaccessible
2741 files. If no arguments are given, Exim runs interactively, prompting for lines
2742 of data. Otherwise, it processes each argument in turn.
2743
2744 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2745 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2746 used without command line arguments. If successful, it uses the &[readline()]&
2747 function, which provides extensive line-editing facilities, for reading the
2748 test data. A line history is supported.
2749
2750 Long expansion expressions can be split over several lines by using backslash
2751 continuations. As in Exim's run time configuration, white space at the start of
2752 continuation lines is ignored. Each argument or data line is passed through the
2753 string expansion mechanism, and the result is output. Variable values from the
2754 configuration file (for example, &$qualify_domain$&) are available, but no
2755 message-specific values (such as &$sender_domain$&) are set, because no message
2756 is being processed (but see &%-bem%& and &%-Mset%&).
2757
2758 &*Note*&: If you use this mechanism to test lookups, and you change the data
2759 files or databases you are using, you must exit and restart Exim before trying
2760 the same lookup again. Otherwise, because each Exim process caches the results
2761 of lookups, you will just get the same result as before.
2762
2763 .vitem &%-bem%&&~<&'filename'&>
2764 .oindex "&%-bem%&"
2765 .cindex "testing" "string expansion"
2766 .cindex "expansion" "testing"
2767 This option operates like &%-be%& except that it must be followed by the name
2768 of a file. For example:
2769 .code
2770 exim -bem /tmp/testmessage
2771 .endd
2772 The file is read as a message (as if receiving a locally-submitted non-SMTP
2773 message) before any of the test expansions are done. Thus, message-specific
2774 variables such as &$message_size$& and &$header_from:$& are available. However,
2775 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2776 recipients are read from the headers in the normal way, and are shown in the
2777 &$recipients$& variable. Note that recipients cannot be given on the command
2778 line, because further arguments are taken as strings to expand (just like
2779 &%-be%&).
2780
2781 .vitem &%-bF%&&~<&'filename'&>
2782 .oindex "&%-bF%&"
2783 .cindex "system filter" "testing"
2784 .cindex "testing" "system filter"
2785 This option is the same as &%-bf%& except that it assumes that the filter being
2786 tested is a system filter. The additional commands that are available only in
2787 system filters are recognized.
2788
2789 .vitem &%-bf%&&~<&'filename'&>
2790 .oindex "&%-bf%&"
2791 .cindex "filter" "testing"
2792 .cindex "testing" "filter file"
2793 .cindex "forward file" "testing"
2794 .cindex "testing" "forward file"
2795 .cindex "Sieve filter" "testing"
2796 This option runs Exim in user filter testing mode; the file is the filter file
2797 to be tested, and a test message must be supplied on the standard input. If
2798 there are no message-dependent tests in the filter, an empty file can be
2799 supplied.
2800
2801 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2802 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2803 filter and a user filter in the same run. For example:
2804 .code
2805 exim -bF /system/filter -bf /user/filter </test/message
2806 .endd
2807 This is helpful when the system filter adds header lines or sets filter
2808 variables that are used by the user filter.
2809
2810 If the test filter file does not begin with one of the special lines
2811 .code
2812 # Exim filter
2813 # Sieve filter
2814 .endd
2815 it is taken to be a normal &_.forward_& file, and is tested for validity under
2816 that interpretation. See sections &<<SECTitenonfilred>>& to
2817 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2818 redirection lists.
2819
2820 The result of an Exim command that uses &%-bf%&, provided no errors are
2821 detected, is a list of the actions that Exim would try to take if presented
2822 with the message for real. More details of filter testing are given in the
2823 separate document entitled &'Exim's interfaces to mail filtering'&.
2824
2825 When testing a filter file,
2826 .cindex "&""From""& line"
2827 .cindex "envelope sender"
2828 .oindex "&%-f%&" "for filter testing"
2829 the envelope sender can be set by the &%-f%& option,
2830 or by a &"From&~"& line at the start of the test message. Various parameters
2831 that would normally be taken from the envelope recipient address of the message
2832 can be set by means of additional command line options (see the next four
2833 options).
2834
2835 .vitem &%-bfd%&&~<&'domain'&>
2836 .oindex "&%-bfd%&"
2837 .vindex "&$qualify_domain$&"
2838 This sets the domain of the recipient address when a filter file is being
2839 tested by means of the &%-bf%& option. The default is the value of
2840 &$qualify_domain$&.
2841
2842 .vitem &%-bfl%&&~<&'local&~part'&>
2843 .oindex "&%-bfl%&"
2844 This sets the local part of the recipient address when a filter file is being
2845 tested by means of the &%-bf%& option. The default is the username of the
2846 process that calls Exim. A local part should be specified with any prefix or
2847 suffix stripped, because that is how it appears to the filter when a message is
2848 actually being delivered.
2849
2850 .vitem &%-bfp%&&~<&'prefix'&>
2851 .oindex "&%-bfp%&"
2852 This sets the prefix of the local part of the recipient address when a filter
2853 file is being tested by means of the &%-bf%& option. The default is an empty
2854 prefix.
2855
2856 .vitem &%-bfs%&&~<&'suffix'&>
2857 .oindex "&%-bfs%&"
2858 This sets the suffix of the local part of the recipient address when a filter
2859 file is being tested by means of the &%-bf%& option. The default is an empty
2860 suffix.
2861
2862 .vitem &%-bh%&&~<&'IP&~address'&>
2863 .oindex "&%-bh%&"
2864 .cindex "testing" "incoming SMTP"
2865 .cindex "SMTP" "testing incoming"
2866 .cindex "testing" "relay control"
2867 .cindex "relaying" "testing configuration"
2868 .cindex "policy control" "testing"
2869 .cindex "debugging" "&%-bh%& option"
2870 This option runs a fake SMTP session as if from the given IP address, using the
2871 standard input and output. The IP address may include a port number at the end,
2872 after a full stop. For example:
2873 .code
2874 exim -bh 10.9.8.7.1234
2875 exim -bh fe80::a00:20ff:fe86:a061.5678
2876 .endd
2877 When an IPv6 address is given, it is converted into canonical form. In the case
2878 of the second example above, the value of &$sender_host_address$& after
2879 conversion to the canonical form is
2880 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2881
2882 Comments as to what is going on are written to the standard error file. These
2883 include lines beginning with &"LOG"& for anything that would have been logged.
2884 This facility is provided for testing configuration options for incoming
2885 messages, to make sure they implement the required policy. For example, you can
2886 test your relay controls using &%-bh%&.
2887
2888 &*Warning 1*&:
2889 .cindex "RFC 1413"
2890 You can test features of the configuration that rely on ident (RFC 1413)
2891 information by using the &%-oMt%& option. However, Exim cannot actually perform
2892 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2893 connection.
2894
2895 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2896 are also skipped when testing using &%-bh%&. If you want these callouts to
2897 occur, use &%-bhc%& instead.
2898
2899 Messages supplied during the testing session are discarded, and nothing is
2900 written to any of the real log files. There may be pauses when DNS (and other)
2901 lookups are taking place, and of course these may time out. The &%-oMi%& option
2902 can be used to specify a specific IP interface and port if this is important,
2903 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2904 session were authenticated.
2905
2906 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2907 output just states whether a given recipient address from a given host is
2908 acceptable or not. See section &<<SECTcheckaccess>>&.
2909
2910 Features such as authentication and encryption, where the client input is not
2911 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2912 specialized SMTP test program such as
2913 &url(http://jetmore.org/john/code/#swaks,swaks).
2914
2915 .vitem &%-bhc%&&~<&'IP&~address'&>
2916 .oindex "&%-bhc%&"
2917 This option operates in the same way as &%-bh%&, except that address
2918 verification callouts are performed if required. This includes consulting and
2919 updating the callout cache database.
2920
2921 .vitem &%-bi%&
2922 .oindex "&%-bi%&"
2923 .cindex "alias file" "building"
2924 .cindex "building alias file"
2925 .cindex "Sendmail compatibility" "&%-bi%& option"
2926 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2927 Exim does not have the concept of a single alias file, and so it cannot mimic
2928 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2929 tend to appear in various scripts such as NIS make files, so the option must be
2930 recognized.
2931
2932 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2933 configuration option is run, under the uid and gid of the caller of Exim. If
2934 the &%-oA%& option is used, its value is passed to the command as an argument.
2935 The command set by &%bi_command%& may not contain arguments. The command can
2936 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2937 if this is required. If the &%bi_command%& option is not set, calling Exim with
2938 &%-bi%& is a no-op.
2939
2940 .vitem &%-bI:help%&
2941 .oindex "&%-bI:help%&"
2942 .cindex "querying exim information"
2943 We shall provide various options starting &`-bI:`& for querying Exim for
2944 information.  The output of many of these will be intended for machine
2945 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2946 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2947 options shall cause Exim to exit after producing the requested output.
2948
2949 .vitem &%-bI:sieve%&
2950 .oindex "&%-bI:sieve%&"
2951 .cindex "Sieve filter" "capabilities"
2952 This option causes Exim to emit an alphabetically sorted list of all supported
2953 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2954 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2955 &`SIEVE`& capability response line.  As the precise list may depend upon
2956 compile-time build options, which this option will adapt to, this is the only
2957 way to guarantee a correct response.
2958
2959 .vitem &%-bm%&
2960 .oindex "&%-bm%&"
2961 .cindex "local message reception"
2962 This option runs an Exim receiving process that accepts an incoming,
2963 locally-generated message on the current input. The recipients are given as the
2964 command arguments (except when &%-t%& is also present &-- see below). Each
2965 argument can be a comma-separated list of RFC 2822 addresses. This is the
2966 default option for selecting the overall action of an Exim call; it is assumed
2967 if no other conflicting option is present.
2968
2969 If any addresses in the message are unqualified (have no domain), they are
2970 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2971 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2972 suppressing this for special cases.
2973
2974 Policy checks on the contents of local messages can be enforced by means of
2975 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2976
2977 .cindex "return code" "for &%-bm%&"
2978 The return code is zero if the message is successfully accepted. Otherwise, the
2979 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2980
2981 The format
2982 .cindex "message" "format"
2983 .cindex "format" "message"
2984 .cindex "&""From""& line"
2985 .cindex "UUCP" "&""From""& line"
2986 .cindex "Sendmail compatibility" "&""From""& line"
2987 of the message must be as defined in RFC 2822, except that, for
2988 compatibility with Sendmail and Smail, a line in one of the forms
2989 .code
2990 From sender Fri Jan  5 12:55 GMT 1997
2991 From sender Fri, 5 Jan 97 12:55:01
2992 .endd
2993 (with the weekday optional, and possibly with additional text after the date)
2994 is permitted to appear at the start of the message. There appears to be no
2995 authoritative specification of the format of this line. Exim recognizes it by
2996 matching against the regular expression defined by the &%uucp_from_pattern%&
2997 option, which can be changed if necessary.
2998
2999 .oindex "&%-f%&" "overriding &""From""& line"
3000 The specified sender is treated as if it were given as the argument to the
3001 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3002 preference to the address taken from the message. The caller of Exim must be a
3003 trusted user for the sender of a message to be set in this way.
3004
3005 .vitem &%-bmalware%&&~<&'filename'&>
3006 .oindex "&%-bmalware%&"
3007 .cindex "testing", "malware"
3008 .cindex "malware scan test"
3009 This debugging option causes Exim to scan the given file,
3010 using the malware scanning framework.  The option of &%av_scanner%& influences
3011 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3012 the expansion should have defaults which apply to this invocation.  ACLs are
3013 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3014 will never be populated and &%-bmalware%& will fail.
3015
3016 Exim will have changed working directory before resolving the filename, so
3017 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3018 user when it tries to open the file, rather than as the invoking user.
3019 This option requires admin privileges.
3020
3021 The &%-bmalware%& option will not be extended to be more generally useful,
3022 there are better tools for file-scanning.  This option exists to help
3023 administrators verify their Exim and AV scanner configuration.
3024
3025 .vitem &%-bnq%&
3026 .oindex "&%-bnq%&"
3027 .cindex "address qualification, suppressing"
3028 By default, Exim automatically qualifies unqualified addresses (those
3029 without domains) that appear in messages that are submitted locally (that
3030 is, not over TCP/IP). This qualification applies both to addresses in
3031 envelopes, and addresses in header lines. Sender addresses are qualified using
3032 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3033 defaults to the value of &%qualify_domain%&).
3034
3035 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3036 being used to re-submit messages that originally came from remote hosts after
3037 content scanning, you probably do not want to qualify unqualified addresses in
3038 header lines. (Such lines will be present only if you have not enabled a header
3039 syntax check in the appropriate ACL.)
3040
3041 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3042 messages that originate on the local host. When this is used, unqualified
3043 addresses in the envelope provoke errors (causing message rejection) and
3044 unqualified addresses in header lines are left alone.
3045
3046
3047 .vitem &%-bP%&
3048 .oindex "&%-bP%&"
3049 .cindex "configuration options" "extracting"
3050 .cindex "options" "configuration &-- extracting"
3051 If this option is given with no arguments, it causes the values of all Exim's
3052 main configuration options to be written to the standard output. The values
3053 of one or more specific options can be requested by giving their names as
3054 arguments, for example:
3055 .code
3056 exim -bP qualify_domain hold_domains
3057 .endd
3058 .cindex "hiding configuration option values"
3059 .cindex "configuration options" "hiding value of"
3060 .cindex "options" "hiding value of"
3061 However, any option setting that is preceded by the word &"hide"& in the
3062 configuration file is not shown in full, except to an admin user. For other
3063 users, the output is as in this example:
3064 .code
3065 mysql_servers = <value not displayable>
3066 .endd
3067 If &%configure_file%& is given as an argument, the name of the run time
3068 configuration file is output.
3069 If a list of configuration files was supplied, the value that is output here
3070 is the name of the file that was actually used.
3071
3072 .cindex "daemon" "process id (pid)"
3073 .cindex "pid (process id)" "of daemon"
3074 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3075 directories where log files and daemon pid files are written are output,
3076 respectively. If these values are unset, log files are written in a
3077 sub-directory of the spool directory called &%log%&, and the pid file is
3078 written directly into the spool directory.
3079
3080 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3081 .code
3082 exim -bP +local_domains
3083 .endd
3084 it searches for a matching named list of any type (domain, host, address, or
3085 local part) and outputs what it finds.
3086
3087 .cindex "options" "router &-- extracting"
3088 .cindex "options" "transport &-- extracting"
3089 .cindex "options" "authenticator &-- extracting"
3090 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3091 followed by the name of an appropriate driver instance, the option settings for
3092 that driver are output. For example:
3093 .code
3094 exim -bP transport local_delivery
3095 .endd
3096 The generic driver options are output first, followed by the driver's private
3097 options. A list of the names of drivers of a particular type can be obtained by
3098 using one of the words &%router_list%&, &%transport_list%&, or
3099 &%authenticator_list%&, and a complete list of all drivers with their option
3100 settings can be obtained by using &%routers%&, &%transports%&, or
3101 &%authenticators%&.
3102
3103 .cindex "options" "macro &-- extracting"
3104 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3105 are available, similarly to the drivers.  Because macros are sometimes used
3106 for storing passwords, this option is restricted.
3107 The output format is one item per line.
3108
3109 .vitem &%-bp%&
3110 .oindex "&%-bp%&"
3111 .cindex "queue" "listing messages on"
3112 .cindex "listing" "messages on the queue"
3113 This option requests a listing of the contents of the mail queue on the
3114 standard output. If the &%-bp%& option is followed by a list of message ids,
3115 just those messages are listed. By default, this option can be used only by an
3116 admin user. However, the &%queue_list_requires_admin%& option can be set false
3117 to allow any user to see the queue.
3118
3119 Each message on the queue is displayed as in the following example:
3120 .code
3121 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3122           red.king@looking-glass.fict.example
3123           <other addresses>
3124 .endd
3125 .cindex "message" "size in queue listing"
3126 .cindex "size" "of message"
3127 The first line contains the length of time the message has been on the queue
3128 (in this case 25 minutes), the size of the message (2.9K), the unique local
3129 identifier for the message, and the message sender, as contained in the
3130 envelope. For bounce messages, the sender address is empty, and appears as
3131 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3132 the default sender address, the user's login name is shown in parentheses
3133 before the sender address.
3134
3135 .cindex "frozen messages" "in queue listing"
3136 If the message is frozen (attempts to deliver it are suspended) then the text
3137 &"*** frozen ***"& is displayed at the end of this line.
3138
3139 The recipients of the message (taken from the envelope, not the headers) are
3140 displayed on subsequent lines. Those addresses to which the message has already
3141 been delivered are marked with the letter D. If an original address gets
3142 expanded into several addresses via an alias or forward file, the original is
3143 displayed with a D only when deliveries for all of its child addresses are
3144 complete.
3145
3146
3147 .vitem &%-bpa%&
3148 .oindex "&%-bpa%&"
3149 This option operates like &%-bp%&, but in addition it shows delivered addresses
3150 that were generated from the original top level address(es) in each message by
3151 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3152 of just &"D"&.
3153
3154
3155 .vitem &%-bpc%&
3156 .oindex "&%-bpc%&"
3157 .cindex "queue" "count of messages on"
3158 This option counts the number of messages on the queue, and writes the total
3159 to the standard output. It is restricted to admin users, unless
3160 &%queue_list_requires_admin%& is set false.
3161
3162
3163 .vitem &%-bpr%&
3164 .oindex "&%-bpr%&"
3165 This option operates like &%-bp%&, but the output is not sorted into
3166 chronological order of message arrival. This can speed it up when there are
3167 lots of messages on the queue, and is particularly useful if the output is
3168 going to be post-processed in a way that doesn't need the sorting.
3169
3170 .vitem &%-bpra%&
3171 .oindex "&%-bpra%&"
3172 This option is a combination of &%-bpr%& and &%-bpa%&.
3173
3174 .vitem &%-bpru%&
3175 .oindex "&%-bpru%&"
3176 This option is a combination of &%-bpr%& and &%-bpu%&.
3177
3178
3179 .vitem &%-bpu%&
3180 .oindex "&%-bpu%&"
3181 This option operates like &%-bp%& but shows only undelivered top-level
3182 addresses for each message displayed. Addresses generated by aliasing or
3183 forwarding are not shown, unless the message was deferred after processing by a
3184 router with the &%one_time%& option set.
3185
3186
3187 .vitem &%-brt%&
3188 .oindex "&%-brt%&"
3189 .cindex "testing" "retry configuration"
3190 .cindex "retry" "configuration testing"
3191 This option is for testing retry rules, and it must be followed by up to three
3192 arguments. It causes Exim to look for a retry rule that matches the values
3193 and to write it to the standard output. For example:
3194 .code
3195 exim -brt bach.comp.mus.example
3196 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3197 .endd
3198 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3199 argument, which is required, can be a complete address in the form
3200 &'local_part@domain'&, or it can be just a domain name. If the second argument
3201 contains a dot, it is interpreted as an optional second domain name; if no
3202 retry rule is found for the first argument, the second is tried. This ties in
3203 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3204 rule is found that matches the host, one that matches the mail domain is
3205 sought. Finally, an argument that is the name of a specific delivery error, as
3206 used in setting up retry rules, can be given. For example:
3207 .code
3208 exim -brt haydn.comp.mus.example quota_3d
3209 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3210 .endd
3211
3212 .vitem &%-brw%&
3213 .oindex "&%-brw%&"
3214 .cindex "testing" "rewriting"
3215 .cindex "rewriting" "testing"
3216 This option is for testing address rewriting rules, and it must be followed by
3217 a single argument, consisting of either a local part without a domain, or a
3218 complete address with a fully qualified domain. Exim outputs how this address
3219 would be rewritten for each possible place it might appear. See chapter
3220 &<<CHAPrewrite>>& for further details.
3221
3222 .vitem &%-bS%&
3223 .oindex "&%-bS%&"
3224 .cindex "SMTP" "batched incoming"
3225 .cindex "batched SMTP input"
3226 This option is used for batched SMTP input, which is an alternative interface
3227 for non-interactive local message submission. A number of messages can be
3228 submitted in a single run. However, despite its name, this is not really SMTP
3229 input. Exim reads each message's envelope from SMTP commands on the standard
3230 input, but generates no responses. If the caller is trusted, or
3231 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3232 believed; otherwise the sender is always the caller of Exim.
3233
3234 The message itself is read from the standard input, in SMTP format (leading
3235 dots doubled), terminated by a line containing just a single dot. An error is
3236 provoked if the terminating dot is missing. A further message may then follow.
3237
3238 As for other local message submissions, the contents of incoming batch SMTP
3239 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3240 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3241 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3242
3243 Some other SMTP commands are recognized in the input. HELO and EHLO act
3244 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3245 QUIT quits, ignoring the rest of the standard input.
3246
3247 .cindex "return code" "for &%-bS%&"
3248 If any error is encountered, reports are written to the standard output and
3249 error streams, and Exim gives up immediately. The return code is 0 if no error
3250 was detected; it is 1 if one or more messages were accepted before the error
3251 was detected; otherwise it is 2.
3252
3253 More details of input using batched SMTP are given in section
3254 &<<SECTincomingbatchedSMTP>>&.
3255
3256 .vitem &%-bs%&
3257 .oindex "&%-bs%&"
3258 .cindex "SMTP" "local input"
3259 .cindex "local SMTP input"
3260 This option causes Exim to accept one or more messages by reading SMTP commands
3261 on the standard input, and producing SMTP replies on the standard output. SMTP
3262 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3263 Some user agents use this interface as a way of passing locally-generated
3264 messages to the MTA.
3265
3266 In
3267 .cindex "sender" "source of"
3268 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3269 set, the senders of messages are taken from the SMTP MAIL commands.
3270 Otherwise the content of these commands is ignored and the sender is set up as
3271 the calling user. Unqualified addresses are automatically qualified using
3272 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3273 &%-bnq%& option is used.
3274
3275 .cindex "inetd"
3276 The
3277 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3278 using a listening daemon. Exim can distinguish the two cases by checking
3279 whether the standard input is a TCP/IP socket. When Exim is called from
3280 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3281 above concerning senders and qualification do not apply. In this situation,
3282 Exim behaves in exactly the same way as it does when receiving a message via
3283 the listening daemon.
3284
3285 .vitem &%-bt%&
3286 .oindex "&%-bt%&"
3287 .cindex "testing" "addresses"
3288 .cindex "address" "testing"
3289 This option runs Exim in address testing mode, in which each argument is taken
3290 as a recipient address to be tested for deliverability. The results are
3291 written to the standard output. If a test fails, and the caller is not an admin
3292 user, no details of the failure are output, because these might contain
3293 sensitive information such as usernames and passwords for database lookups.
3294
3295 If no arguments are given, Exim runs in an interactive manner, prompting with a
3296 right angle bracket for addresses to be tested.
3297
3298 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3299 &[readline()]& function, because it is running as &'root'& and there are
3300 security issues.
3301
3302 Each address is handled as if it were the recipient address of a message
3303 (compare the &%-bv%& option). It is passed to the routers and the result is
3304 written to the standard output. However, any router that has
3305 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3306 genuine routing tests if your first router passes everything to a scanner
3307 program.
3308
3309 .cindex "return code" "for &%-bt%&"
3310 The return code is 2 if any address failed outright; it is 1 if no address
3311 failed outright but at least one could not be resolved for some reason. Return
3312 code 0 is given only when all addresses succeed.
3313
3314 .cindex "duplicate addresses"
3315 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3316 addresses after routing is complete, so that only one delivery takes place.
3317 This does not happen when testing with &%-bt%&; the full results of routing are
3318 always shown.
3319
3320 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3321 routers in the configuration makes any tests on the sender address of a
3322 message,
3323 .oindex "&%-f%&" "for address testing"
3324 you can use the &%-f%& option to set an appropriate sender when running
3325 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3326 default qualifying domain. However, if you have set up (for example) routers
3327 whose behaviour depends on the contents of an incoming message, you cannot test
3328 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3329 doing such tests.
3330
3331 .vitem &%-bV%&
3332 .oindex "&%-bV%&"
3333 .cindex "version number of Exim"
3334 This option causes Exim to write the current version number, compilation
3335 number, and compilation date of the &'exim'& binary to the standard output.
3336 It also lists the DBM library that is being used, the optional modules (such as
3337 specific lookup types), the drivers that are included in the binary, and the
3338 name of the run time configuration file that is in use.
3339
3340 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3341 configuration file. However, this is a static check only. It cannot check
3342 values that are to be expanded. For example, although a misspelt ACL verb is
3343 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3344 alone to discover (for example) all the typos in the configuration; some
3345 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3346 dynamic testing facilities.
3347
3348 .vitem &%-bv%&
3349 .oindex "&%-bv%&"
3350 .cindex "verifying address" "using &%-bv%&"
3351 .cindex "address" "verification"
3352 This option runs Exim in address verification mode, in which each argument is
3353 taken as a recipient address to be verified by the routers. (This does
3354 not involve any verification callouts). During normal operation, verification
3355 happens mostly as a consequence processing a &%verify%& condition in an ACL
3356 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3357 including callouts, see the &%-bh%& and &%-bhc%& options.
3358
3359 If verification fails, and the caller is not an admin user, no details of the
3360 failure are output, because these might contain sensitive information such as
3361 usernames and passwords for database lookups.
3362
3363 If no arguments are given, Exim runs in an interactive manner, prompting with a
3364 right angle bracket for addresses to be verified.
3365
3366 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3367 &[readline()]& function, because it is running as &'exim'& and there are
3368 security issues.
3369
3370 Verification differs from address testing (the &%-bt%& option) in that routers
3371 that have &%no_verify%& set are skipped, and if the address is accepted by a
3372 router that has &%fail_verify%& set, verification fails. The address is
3373 verified as a recipient if &%-bv%& is used; to test verification for a sender
3374 address, &%-bvs%& should be used.
3375
3376 If the &%-v%& option is not set, the output consists of a single line for each
3377 address, stating whether it was verified or not, and giving a reason in the
3378 latter case. Without &%-v%&, generating more than one address by redirection
3379 causes verification to end successfully, without considering the generated
3380 addresses. However, if just one address is generated, processing continues,
3381 and the generated address must verify successfully for the overall verification
3382 to succeed.
3383
3384 When &%-v%& is set, more details are given of how the address has been handled,
3385 and in the case of address redirection, all the generated addresses are also
3386 considered. Verification may succeed for some and fail for others.
3387
3388 The
3389 .cindex "return code" "for &%-bv%&"
3390 return code is 2 if any address failed outright; it is 1 if no address
3391 failed outright but at least one could not be resolved for some reason. Return
3392 code 0 is given only when all addresses succeed.
3393
3394 If any of the routers in the configuration makes any tests on the sender
3395 address of a message, you should use the &%-f%& option to set an appropriate
3396 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3397 calling user at the default qualifying domain.
3398
3399 .vitem &%-bvs%&
3400 .oindex "&%-bvs%&"
3401 This option acts like &%-bv%&, but verifies the address as a sender rather
3402 than a recipient address. This affects any rewriting and qualification that
3403 might happen.
3404
3405 .vitem &%-bw%&
3406 .oindex "&%-bw%&"
3407 .cindex "daemon"
3408 .cindex "inetd"
3409 .cindex "inetd" "wait mode"
3410 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3411 similarly to the &%-bd%& option.  All port specifications on the command-line
3412 and in the configuration file are ignored.  Queue-running may not be specified.
3413
3414 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3415 listening for connections.  This permits the system to start up and have
3416 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3417 each port only when the first connection is received.
3418
3419 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3420 which the daemon will exit, which should cause inetd to listen once more.
3421
3422 .vitem &%-C%&&~<&'filelist'&>
3423 .oindex "&%-C%&"
3424 .cindex "configuration file" "alternate"
3425 .cindex "CONFIGURE_FILE"
3426 .cindex "alternate configuration file"
3427 This option causes Exim to find the run time configuration file from the given
3428 list instead of from the list specified by the CONFIGURE_FILE
3429 compile-time setting. Usually, the list will consist of just a single file
3430 name, but it can be a colon-separated list of names. In this case, the first
3431 file that exists is used. Failure to open an existing file stops Exim from
3432 proceeding any further along the list, and an error is generated.
3433
3434 When this option is used by a caller other than root, and the list is different
3435 from the compiled-in list, Exim gives up its root privilege immediately, and
3436 runs with the real and effective uid and gid set to those of the caller.
3437 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3438 file contains a list of full pathnames, one per line, for configuration files
3439 which are trusted. Root privilege is retained for any configuration file so
3440 listed, as long as the caller is the Exim user (or the user specified in the
3441 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3442 not writeable by inappropriate users or groups.
3443
3444 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3445 configuration using &%-C%& right through message reception and delivery,
3446 even if the caller is root. The reception works, but by that time, Exim is
3447 running as the Exim user, so when it re-executes to regain privilege for the
3448 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3449 test reception and delivery using two separate commands (one to put a message
3450 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3451
3452 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3453 prefix string with which any file named in a &%-C%& command line option
3454 must start. In addition, the file name must not contain the sequence &`/../`&.
3455 However, if the value of the &%-C%& option is identical to the value of
3456 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3457 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3458 unset, any file name can be used with &%-C%&.
3459
3460 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3461 to a directory to which only root has access. This prevents someone who has
3462 broken into the Exim account from running a privileged Exim with an arbitrary
3463 configuration file.
3464
3465 The &%-C%& facility is useful for ensuring that configuration files are
3466 syntactically correct, but cannot be used for test deliveries, unless the
3467 caller is privileged, or unless it is an exotic configuration that does not
3468 require privilege. No check is made on the owner or group of the files
3469 specified by this option.
3470
3471
3472 .vitem &%-D%&<&'macro'&>=<&'value'&>
3473 .oindex "&%-D%&"
3474 .cindex "macro" "setting on command line"
3475 This option can be used to override macro definitions in the configuration file
3476 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3477 unprivileged caller, it causes Exim to give up its root privilege.
3478 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3479 completely disabled, and its use causes an immediate error exit.
3480
3481 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3482 colon-separated list of macros which are considered safe and, if &%-D%& only
3483 supplies macros from this list, and the values are acceptable, then Exim will
3484 not give up root privilege if the caller is root, the Exim run-time user, or
3485 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3486 to be removed in the future.  Acceptable values for the macros satisfy the
3487 regexp: &`^[A-Za-z0-9_/.-]*$`&
3488
3489 The entire option (including equals sign if present) must all be within one
3490 command line item. &%-D%& can be used to set the value of a macro to the empty
3491 string, in which case the equals sign is optional. These two commands are
3492 synonymous:
3493 .code
3494 exim -DABC  ...
3495 exim -DABC= ...
3496 .endd
3497 To include spaces in a macro definition item, quotes must be used. If you use
3498 quotes, spaces are permitted around the macro name and the equals sign. For
3499 example:
3500 .code
3501 exim '-D ABC = something' ...
3502 .endd
3503 &%-D%& may be repeated up to 10 times on a command line.
3504
3505
3506 .vitem &%-d%&<&'debug&~options'&>
3507 .oindex "&%-d%&"
3508 .cindex "debugging" "list of selectors"
3509 .cindex "debugging" "&%-d%& option"
3510 This option causes debugging information to be written to the standard
3511 error stream. It is restricted to admin users because debugging output may show
3512 database queries that contain password information. Also, the details of users'
3513 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3514 writes an error message to the standard error stream and exits with a non-zero
3515 return code.
3516
3517 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3518 standard debugging data is output. This can be reduced, or increased to include
3519 some more rarely needed information, by directly following &%-d%& with a string
3520 made up of names preceded by plus or minus characters. These add or remove sets
3521 of debugging data, respectively. For example, &%-d+filter%& adds filter
3522 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3523 no spaces are allowed in the debug setting. The available debugging categories
3524 are:
3525 .display
3526 &`acl            `& ACL interpretation
3527 &`auth           `& authenticators
3528 &`deliver        `& general delivery logic
3529 &`dns            `& DNS lookups (see also resolver)
3530 &`dnsbl          `& DNS black list (aka RBL) code
3531 &`exec           `& arguments for &[execv()]& calls
3532 &`expand         `& detailed debugging for string expansions
3533 &`filter         `& filter handling
3534 &`hints_lookup   `& hints data lookups
3535 &`host_lookup    `& all types of name-to-IP address handling
3536 &`ident          `& ident lookup
3537 &`interface      `& lists of local interfaces
3538 &`lists          `& matching things in lists
3539 &`load           `& system load checks
3540 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3541                     &<<CHAPlocalscan>>&)
3542 &`lookup         `& general lookup code and all lookups
3543 &`memory         `& memory handling
3544 &`pid            `& add pid to debug output lines
3545 &`process_info   `& setting info for the process log
3546 &`queue_run      `& queue runs
3547 &`receive        `& general message reception logic
3548 &`resolver       `& turn on the DNS resolver's debugging output
3549 &`retry          `& retry handling
3550 &`rewrite        `& address rewriting
3551 &`route          `& address routing
3552 &`timestamp      `& add timestamp to debug output lines
3553 &`tls            `& TLS logic
3554 &`transport      `& transports
3555 &`uid            `& changes of uid/gid and looking up uid/gid
3556 &`verify         `& address verification logic
3557 &`all            `& almost all of the above (see below), and also &%-v%&
3558 .endd
3559 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3560 for &`-all`&. The reason for this is that &`+all`& is something that people
3561 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3562 is included, an awful lot of output that is very rarely of interest is
3563 generated, so it now has to be explicitly requested. However, &`-all`& does
3564 turn everything off.
3565
3566 .cindex "resolver, debugging output"
3567 .cindex "DNS resolver, debugging output"
3568 The &`resolver`& option produces output only if the DNS resolver was compiled
3569 with DEBUG enabled. This is not the case in some operating systems. Also,
3570 unfortunately, debugging output from the DNS resolver is written to stdout
3571 rather than stderr.
3572
3573 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3574 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3575 However, the &`pid`& selector is forced when debugging is turned on for a
3576 daemon, which then passes it on to any re-executed Exims. Exim also
3577 automatically adds the pid to debug lines when several remote deliveries are
3578 run in parallel.
3579
3580 The &`timestamp`& selector causes the current time to be inserted at the start
3581 of all debug output lines. This can be useful when trying to track down delays
3582 in processing.
3583
3584 If the &%debug_print%& option is set in any driver, it produces output whenever
3585 any debugging is selected, or if &%-v%& is used.
3586
3587 .vitem &%-dd%&<&'debug&~options'&>
3588 .oindex "&%-dd%&"
3589 This option behaves exactly like &%-d%& except when used on a command that
3590 starts a daemon process. In that case, debugging is turned off for the
3591 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3592 behaviour of the daemon without creating as much output as full debugging does.
3593
3594 .vitem &%-dropcr%&
3595 .oindex "&%-dropcr%&"
3596 This is an obsolete option that is now a no-op. It used to affect the way Exim
3597 handled CR and LF characters in incoming messages. What happens now is
3598 described in section &<<SECTlineendings>>&.
3599
3600 .vitem &%-E%&
3601 .oindex "&%-E%&"
3602 .cindex "bounce message" "generating"
3603 This option specifies that an incoming message is a locally-generated delivery
3604 failure report. It is used internally by Exim when handling delivery failures
3605 and is not intended for external use. Its only effect is to stop Exim
3606 generating certain messages to the postmaster, as otherwise message cascades
3607 could occur in some situations. As part of the same option, a message id may
3608 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3609 new message contains the id, following &"R="&, as a cross-reference.
3610
3611 .vitem &%-e%&&'x'&
3612 .oindex "&%-e%&&'x'&"
3613 There are a number of Sendmail options starting with &%-oe%& which seem to be
3614 called by various programs without the leading &%o%& in the option. For
3615 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3616 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3617
3618 .vitem &%-F%&&~<&'string'&>
3619 .oindex "&%-F%&"
3620 .cindex "sender" "name"
3621 .cindex "name" "of sender"
3622 This option sets the sender's full name for use when a locally-generated
3623 message is being accepted. In the absence of this option, the user's &'gecos'&
3624 entry from the password data is used. As users are generally permitted to alter
3625 their &'gecos'& entries, no security considerations are involved. White space
3626 between &%-F%& and the <&'string'&> is optional.
3627
3628 .vitem &%-f%&&~<&'address'&>
3629 .oindex "&%-f%&"
3630 .cindex "sender" "address"
3631 .cindex "address" "sender"
3632 .cindex "trusted users"
3633 .cindex "envelope sender"
3634 .cindex "user" "trusted"
3635 This option sets the address of the envelope sender of a locally-generated
3636 message (also known as the return path). The option can normally be used only
3637 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3638 users to use it.
3639
3640 Processes running as root or the Exim user are always trusted. Other
3641 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3642 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3643 of a local message is set to the caller's login name at the default qualify
3644 domain.
3645
3646 There is one exception to the restriction on the use of &%-f%&: an empty sender
3647 can be specified by any user, trusted or not, to create a message that can
3648 never provoke a bounce. An empty sender can be specified either as an empty
3649 string, or as a pair of angle brackets with nothing between them, as in these
3650 examples of shell commands:
3651 .code
3652 exim -f '<>' user@domain
3653 exim -f "" user@domain
3654 .endd
3655 In addition, the use of &%-f%& is not restricted when testing a filter file
3656 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3657 &%-bv%& options.
3658
3659 Allowing untrusted users to change the sender address does not of itself make
3660 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3661 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3662 though this can be overridden by setting &%no_local_from_check%&.
3663
3664 White
3665 .cindex "&""From""& line"
3666 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3667 given as two arguments or one combined argument). The sender of a
3668 locally-generated message can also be set (when permitted) by an initial
3669 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3670 if &%-f%& is also present, it overrides &"From&~"&.
3671
3672 .vitem &%-G%&
3673 .oindex "&%-G%&"
3674 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3675 This is a Sendmail option which is ignored by Exim.
3676
3677 .vitem &%-h%&&~<&'number'&>
3678 .oindex "&%-h%&"
3679 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3680 This option is accepted for compatibility with Sendmail, but has no effect. (In
3681 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3682 headers.)
3683
3684 .vitem &%-i%&
3685 .oindex "&%-i%&"
3686 .cindex "Solaris" "&'mail'& command"
3687 .cindex "dot" "in incoming non-SMTP message"
3688 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3689 line by itself should not terminate an incoming, non-SMTP message. I can find
3690 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3691 command in Solaris 2.4 uses it. See also &%-ti%&.
3692
3693 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3694 .oindex "&%-M%&"
3695 .cindex "forcing delivery"
3696 .cindex "delivery" "forcing attempt"
3697 .cindex "frozen messages" "forcing delivery"
3698 This option requests Exim to run a delivery attempt on each message in turn. If
3699 any of the messages are frozen, they are automatically thawed before the
3700 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3701 and &%hold_domains%& are ignored.
3702
3703 Retry
3704 .cindex "hints database" "overriding retry hints"
3705 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3706 the normal retry time has not yet been reached. This option requires the caller
3707 to be an admin user. However, there is an option called &%prod_requires_admin%&
3708 which can be set false to relax this restriction (and also the same requirement
3709 for the &%-q%&, &%-R%&, and &%-S%& options).
3710
3711 The deliveries happen synchronously, that is, the original Exim process does
3712 not terminate until all the delivery attempts have finished. No output is
3713 produced unless there is a serious error. If you want to see what is happening,
3714 use the &%-v%& option as well, or inspect Exim's main log.
3715
3716 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3717 .oindex "&%-Mar%&"
3718 .cindex "message" "adding recipients"
3719 .cindex "recipient" "adding"
3720 This option requests Exim to add the addresses to the list of recipients of the
3721 message (&"ar"& for &"add recipients"&). The first argument must be a message
3722 id, and the remaining ones must be email addresses. However, if the message is
3723 active (in the middle of a delivery attempt), it is not altered. This option
3724 can be used only by an admin user.
3725
3726 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3727         &~<&'message&~id'&>"
3728 .oindex "&%-MC%&"
3729 .cindex "SMTP" "passed connection"
3730 .cindex "SMTP" "multiple deliveries"
3731 .cindex "multiple SMTP deliveries"
3732 This option is not intended for use by external callers. It is used internally
3733 by Exim to invoke another instance of itself to deliver a waiting message using
3734 an existing SMTP connection, which is passed as the standard input. Details are
3735 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3736 must be root or the Exim user in order to use it.
3737
3738 .vitem &%-MCA%&
3739 .oindex "&%-MCA%&"
3740 This option is not intended for use by external callers. It is used internally
3741 by Exim in conjunction with the &%-MC%& option. It signifies that the
3742 connection to the remote host has been authenticated.
3743
3744 .vitem &%-MCP%&
3745 .oindex "&%-MCP%&"
3746 This option is not intended for use by external callers. It is used internally
3747 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3748 which Exim is connected supports pipelining.
3749
3750 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3751 .oindex "&%-MCQ%&"
3752 This option is not intended for use by external callers. It is used internally
3753 by Exim in conjunction with the &%-MC%& option when the original delivery was
3754 started by a queue runner. It passes on the process id of the queue runner,
3755 together with the file descriptor number of an open pipe. Closure of the pipe
3756 signals the final completion of the sequence of processes that are passing
3757 messages through the same SMTP connection.
3758
3759 .vitem &%-MCS%&
3760 .oindex "&%-MCS%&"
3761 This option is not intended for use by external callers. It is used internally
3762 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3763 SMTP SIZE option should be used on messages delivered down the existing
3764 connection.
3765
3766 .vitem &%-MCT%&
3767 .oindex "&%-MCT%&"
3768 This option is not intended for use by external callers. It is used internally
3769 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3770 host to which Exim is connected supports TLS encryption.
3771
3772 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3773 .oindex "&%-Mc%&"
3774 .cindex "hints database" "not overridden by &%-Mc%&"
3775 .cindex "delivery" "manually started &-- not forced"
3776 This option requests Exim to run a delivery attempt on each message in turn,
3777 but unlike the &%-M%& option, it does check for retry hints, and respects any
3778 that are found. This option is not very useful to external callers. It is
3779 provided mainly for internal use by Exim when it needs to re-invoke itself in
3780 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3781 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3782 respects retry times and other options such as &%hold_domains%& that are
3783 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3784 If you want to run a specific delivery as if in a queue run, you should use
3785 &%-q%& with a message id argument. A distinction between queue run deliveries
3786 and other deliveries is made in one or two places.
3787
3788 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3789 .oindex "&%-Mes%&"
3790 .cindex "message" "changing sender"
3791 .cindex "sender" "changing"
3792 This option requests Exim to change the sender address in the message to the
3793 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3794 &"edit sender"&). There must be exactly two arguments. The first argument must
3795 be a message id, and the second one an email address. However, if the message
3796 is active (in the middle of a delivery attempt), its status is not altered.
3797 This option can be used only by an admin user.
3798
3799 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3800 .oindex "&%-Mf%&"
3801 .cindex "freezing messages"
3802 .cindex "message" "manually freezing"
3803 This option requests Exim to mark each listed message as &"frozen"&. This
3804 prevents any delivery attempts taking place until the message is &"thawed"&,
3805 either manually or as a result of the &%auto_thaw%& configuration option.
3806 However, if any of the messages are active (in the middle of a delivery
3807 attempt), their status is not altered. This option can be used only by an admin
3808 user.
3809
3810 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3811 .oindex "&%-Mg%&"
3812 .cindex "giving up on messages"
3813 .cindex "message" "abandoning delivery attempts"
3814 .cindex "delivery" "abandoning further attempts"
3815 This option requests Exim to give up trying to deliver the listed messages,
3816 including any that are frozen. However, if any of the messages are active,
3817 their status is not altered. For non-bounce messages, a delivery error message
3818 is sent to the sender, containing the text &"cancelled by administrator"&.
3819 Bounce messages are just discarded. This option can be used only by an admin
3820 user.
3821
3822 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3823 .oindex "&%-Mmad%&"
3824 .cindex "delivery" "cancelling all"
3825 This option requests Exim to mark all the recipient addresses in the messages
3826 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3827 message is active (in the middle of a delivery attempt), its status is not
3828 altered. This option can be used only by an admin user.
3829
3830 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3831 .oindex "&%-Mmd%&"
3832 .cindex "delivery" "cancelling by address"
3833 .cindex "recipient" "removing"
3834 .cindex "removing recipients"
3835 This option requests Exim to mark the given addresses as already delivered
3836 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3837 the remaining ones must be email addresses. These are matched to recipient
3838 addresses in the message in a case-sensitive manner. If the message is active
3839 (in the middle of a delivery attempt), its status is not altered. This option
3840 can be used only by an admin user.
3841
3842 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3843 .oindex "&%-Mrm%&"
3844 .cindex "removing messages"
3845 .cindex "abandoning mail"
3846 .cindex "message" "manually discarding"
3847 This option requests Exim to remove the given messages from the queue. No
3848 bounce messages are sent; each message is simply forgotten. However, if any of
3849 the messages are active, their status is not altered. This option can be used
3850 only by an admin user or by the user who originally caused the message to be
3851 placed on the queue.
3852
3853 .vitem &%-Mset%&&~<&'message&~id'&>
3854 .oindex "&%-Mset%&
3855 .cindex "testing" "string expansion"
3856 .cindex "expansion" "testing"
3857 This option is useful only in conjunction with &%-be%& (that is, when testing
3858 string expansions). Exim loads the given message from its spool before doing
3859 the test expansions, thus setting message-specific variables such as
3860 &$message_size$& and the header variables. The &$recipients$& variable is made
3861 available. This feature is provided to make it easier to test expansions that
3862 make use of these variables. However, this option can be used only by an admin
3863 user. See also &%-bem%&.
3864
3865 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3866 .oindex "&%-Mt%&"
3867 .cindex "thawing messages"
3868 .cindex "unfreezing messages"
3869 .cindex "frozen messages" "thawing"
3870 .cindex "message" "thawing frozen"
3871 This option requests Exim to &"thaw"& any of the listed messages that are
3872 &"frozen"&, so that delivery attempts can resume. However, if any of the
3873 messages are active, their status is not altered. This option can be used only
3874 by an admin user.
3875
3876 .vitem &%-Mvb%&&~<&'message&~id'&>
3877 .oindex "&%-Mvb%&"
3878 .cindex "listing" "message body"
3879 .cindex "message" "listing body of"
3880 This option causes the contents of the message body (-D) spool file to be
3881 written to the standard output. This option can be used only by an admin user.
3882
3883 .vitem &%-Mvc%&&~<&'message&~id'&>
3884 .oindex "&%-Mvc%&"
3885 .cindex "message" "listing in RFC 2822 format"
3886 .cindex "listing" "message in RFC 2822 format"
3887 This option causes a copy of the complete message (header lines plus body) to
3888 be written to the standard output in RFC 2822 format. This option can be used
3889 only by an admin user.
3890
3891 .vitem &%-Mvh%&&~<&'message&~id'&>
3892 .oindex "&%-Mvh%&"
3893 .cindex "listing" "message headers"
3894 .cindex "header lines" "listing"
3895 .cindex "message" "listing header lines"
3896 This option causes the contents of the message headers (-H) spool file to be
3897 written to the standard output. This option can be used only by an admin user.
3898
3899 .vitem &%-Mvl%&&~<&'message&~id'&>
3900 .oindex "&%-Mvl%&"
3901 .cindex "listing" "message log"
3902 .cindex "message" "listing message log"
3903 This option causes the contents of the message log spool file to be written to
3904 the standard output. This option can be used only by an admin user.
3905
3906 .vitem &%-m%&
3907 .oindex "&%-m%&"
3908 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3909 treats it that way too.
3910
3911 .vitem &%-N%&
3912 .oindex "&%-N%&"
3913 .cindex "debugging" "&%-N%& option"
3914 .cindex "debugging" "suppressing delivery"
3915 This is a debugging option that inhibits delivery of a message at the transport
3916 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3917 it just doesn't actually transport the message, but instead behaves as if it
3918 had successfully done so. However, it does not make any updates to the retry
3919 database, and the log entries for deliveries are flagged with &"*>"& rather
3920 than &"=>"&.
3921
3922 Because &%-N%& discards any message to which it applies, only root or the Exim
3923 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3924 words, an ordinary user can use it only when supplying an incoming message to
3925 which it will apply. Although transportation never fails when &%-N%& is set, an
3926 address may be deferred because of a configuration problem on a transport, or a
3927 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3928 the message, and applies to any subsequent delivery attempts that may happen
3929 for that message.
3930
3931 .vitem &%-n%&
3932 .oindex "&%-n%&"
3933 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3934 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3935 by Exim.
3936
3937 .vitem &%-O%&&~<&'data'&>
3938 .oindex "&%-O%&"
3939 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3940 Exim.
3941
3942 .vitem &%-oA%&&~<&'file&~name'&>
3943 .oindex "&%-oA%&"
3944 .cindex "Sendmail compatibility" "&%-oA%& option"
3945 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3946 alternative alias file name. Exim handles &%-bi%& differently; see the
3947 description above.
3948
3949 .vitem &%-oB%&&~<&'n'&>
3950 .oindex "&%-oB%&"
3951 .cindex "SMTP" "passed connection"
3952 .cindex "SMTP" "multiple deliveries"
3953 .cindex "multiple SMTP deliveries"
3954 This is a debugging option which limits the maximum number of messages that can
3955 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3956 transport. If <&'n'&> is omitted, the limit is set to 1.
3957
3958 .vitem &%-odb%&
3959 .oindex "&%-odb%&"
3960 .cindex "background delivery"
3961 .cindex "delivery" "in the background"
3962 This option applies to all modes in which Exim accepts incoming messages,
3963 including the listening daemon. It requests &"background"& delivery of such
3964 messages, which means that the accepting process automatically starts a
3965 delivery process for each message received, but does not wait for the delivery
3966 processes to finish.
3967
3968 When all the messages have been received, the reception process exits,
3969 leaving the delivery processes to finish in their own time. The standard output
3970 and error streams are closed at the start of each delivery process.
3971 This is the default action if none of the &%-od%& options are present.
3972
3973 If one of the queueing options in the configuration file
3974 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3975 overrides it if &%queue_only_override%& is set true, which is the default
3976 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3977
3978 .vitem &%-odf%&
3979 .oindex "&%-odf%&"
3980 .cindex "foreground delivery"
3981 .cindex "delivery" "in the foreground"
3982 This option requests &"foreground"& (synchronous) delivery when Exim has
3983 accepted a locally-generated message. (For the daemon it is exactly the same as
3984 &%-odb%&.) A delivery process is automatically started to deliver the message,
3985 and Exim waits for it to complete before proceeding.
3986
3987 The original Exim reception process does not finish until the delivery
3988 process for the final message has ended. The standard error stream is left open
3989 during deliveries.
3990
3991 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3992 false and one of the queueing options in the configuration file is in effect.
3993
3994 If there is a temporary delivery error during foreground delivery, the
3995 message is left on the queue for later delivery, and the original reception
3996 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3997 restricted configuration that never queues messages.
3998
3999
4000 .vitem &%-odi%&
4001 .oindex "&%-odi%&"
4002 This option is synonymous with &%-odf%&. It is provided for compatibility with
4003 Sendmail.
4004
4005 .vitem &%-odq%&
4006 .oindex "&%-odq%&"
4007 .cindex "non-immediate delivery"
4008 .cindex "delivery" "suppressing immediate"
4009 .cindex "queueing incoming messages"
4010 This option applies to all modes in which Exim accepts incoming messages,
4011 including the listening daemon. It specifies that the accepting process should
4012 not automatically start a delivery process for each message received. Messages
4013 are placed on the queue, and remain there until a subsequent queue runner
4014 process encounters them. There are several configuration options (such as
4015 &%queue_only%&) that can be used to queue incoming messages under certain
4016 conditions. This option overrides all of them and also &%-odqs%&. It always
4017 forces queueing.
4018
4019 .vitem &%-odqs%&
4020 .oindex "&%-odqs%&"
4021 .cindex "SMTP" "delaying delivery"
4022 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4023 However, like &%-odb%& and &%-odi%&, this option has no effect if
4024 &%queue_only_override%& is false and one of the queueing options in the
4025 configuration file is in effect.
4026
4027 When &%-odqs%& does operate, a delivery process is started for each incoming
4028 message, in the background by default, but in the foreground if &%-odi%& is
4029 also present. The recipient addresses are routed, and local deliveries are done
4030 in the normal way. However, if any SMTP deliveries are required, they are not
4031 done at this time, so the message remains on the queue until a subsequent queue
4032 runner process encounters it. Because routing was done, Exim knows which
4033 messages are waiting for which hosts, and so a number of messages for the same
4034 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4035 configuration option has the same effect for specific domains. See also the
4036 &%-qq%& option.
4037
4038 .vitem &%-oee%&
4039 .oindex "&%-oee%&"
4040 .cindex "error" "reporting"
4041 If an error is detected while a non-SMTP message is being received (for
4042 example, a malformed address), the error is reported to the sender in a mail
4043 message.
4044
4045 .cindex "return code" "for &%-oee%&"
4046 Provided
4047 this error message is successfully sent, the Exim receiving process
4048 exits with a return code of zero. If not, the return code is 2 if the problem
4049 is that the original message has no recipients, or 1 any other error. This is
4050 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4051
4052 .vitem &%-oem%&
4053 .oindex "&%-oem%&"
4054 .cindex "error" "reporting"
4055 .cindex "return code" "for &%-oem%&"
4056 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4057 return code, whether or not the error message was successfully sent.
4058 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4059
4060 .vitem &%-oep%&
4061 .oindex "&%-oep%&"
4062 .cindex "error" "reporting"
4063 If an error is detected while a non-SMTP message is being received, the
4064 error is reported by writing a message to the standard error file (stderr).
4065 .cindex "return code" "for &%-oep%&"
4066 The return code is 1 for all errors.
4067
4068 .vitem &%-oeq%&
4069 .oindex "&%-oeq%&"
4070 .cindex "error" "reporting"
4071 This option is supported for compatibility with Sendmail, but has the same
4072 effect as &%-oep%&.
4073
4074 .vitem &%-oew%&
4075 .oindex "&%-oew%&"
4076 .cindex "error" "reporting"
4077 This option is supported for compatibility with Sendmail, but has the same
4078 effect as &%-oem%&.
4079
4080 .vitem &%-oi%&
4081 .oindex "&%-oi%&"
4082 .cindex "dot" "in incoming non-SMTP message"
4083 This option, which has the same effect as &%-i%&, specifies that a dot on a
4084 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4085 single dot does terminate, though Exim does no special processing for other
4086 lines that start with a dot. This option is set by default if Exim is called as
4087 &'rmail'&. See also &%-ti%&.
4088
4089 .vitem &%-oitrue%&
4090 .oindex "&%-oitrue%&"
4091 This option is treated as synonymous with &%-oi%&.
4092
4093 .vitem &%-oMa%&&~<&'host&~address'&>
4094 .oindex "&%-oMa%&"
4095 .cindex "sender" "host address, specifying for local message"
4096 A number of options starting with &%-oM%& can be used to set values associated
4097 with remote hosts on locally-submitted messages (that is, messages not received
4098 over TCP/IP). These options can be used by any caller in conjunction with the
4099 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4100 other circumstances, they are ignored unless the caller is trusted.
4101
4102 The &%-oMa%& option sets the sender host address. This may include a port
4103 number at the end, after a full stop (period). For example:
4104 .code
4105 exim -bs -oMa 10.9.8.7.1234
4106 .endd
4107 An alternative syntax is to enclose the IP address in square brackets,
4108 followed by a colon and the port number:
4109 .code
4110 exim -bs -oMa [10.9.8.7]:1234
4111 .endd
4112 The IP address is placed in the &$sender_host_address$& variable, and the
4113 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4114 are present on the command line, the sender host IP address is taken from
4115 whichever one is last.
4116
4117 .vitem &%-oMaa%&&~<&'name'&>
4118 .oindex "&%-oMaa%&"
4119 .cindex "authentication" "name, specifying for local message"
4120 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4121 option sets the value of &$sender_host_authenticated$& (the authenticator
4122 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4123 This option can be used with &%-bh%& and &%-bs%& to set up an
4124 authenticated SMTP session without actually using the SMTP AUTH command.
4125
4126 .vitem &%-oMai%&&~<&'string'&>
4127 .oindex "&%-oMai%&"
4128 .cindex "authentication" "id, specifying for local message"
4129 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4130 option sets the value of &$authenticated_id$& (the id that was authenticated).
4131 This overrides the default value (the caller's login id, except with &%-bh%&,
4132 where there is no default) for messages from local sources. See chapter
4133 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4134
4135 .vitem &%-oMas%&&~<&'address'&>
4136 .oindex "&%-oMas%&"
4137 .cindex "authentication" "sender, specifying for local message"
4138 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4139 option sets the authenticated sender value in &$authenticated_sender$&. It
4140 overrides the sender address that is created from the caller's login id for
4141 messages from local sources, except when &%-bh%& is used, when there is no
4142 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4143 specified on a MAIL command overrides this value. See chapter
4144 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4145
4146 .vitem &%-oMi%&&~<&'interface&~address'&>
4147 .oindex "&%-oMi%&"
4148 .cindex "interface" "address, specifying for local message"
4149 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4150 option sets the IP interface address value. A port number may be included,
4151 using the same syntax as for &%-oMa%&. The interface address is placed in
4152 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4153
4154 .vitem &%-oMr%&&~<&'protocol&~name'&>
4155 .oindex "&%-oMr%&"
4156 .cindex "protocol, specifying for local message"
4157 .vindex "&$received_protocol$&"
4158 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4159 option sets the received protocol value that is stored in
4160 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4161 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4162 SMTP protocol names (see the description of &$received_protocol$& in section
4163 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4164 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4165 be set by &%-oMr%&.
4166
4167 .vitem &%-oMs%&&~<&'host&~name'&>
4168 .oindex "&%-oMs%&"
4169 .cindex "sender" "host name, specifying for local message"
4170 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4171 option sets the sender host name in &$sender_host_name$&. When this option is
4172 present, Exim does not attempt to look up a host name from an IP address; it
4173 uses the name it is given.
4174
4175 .vitem &%-oMt%&&~<&'ident&~string'&>
4176 .oindex "&%-oMt%&"
4177 .cindex "sender" "ident string, specifying for local message"
4178 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4179 option sets the sender ident value in &$sender_ident$&. The default setting for
4180 local callers is the login id of the calling process, except when &%-bh%& is
4181 used, when there is no default.
4182
4183 .vitem &%-om%&
4184 .oindex "&%-om%&"
4185 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4186 In Sendmail, this option means &"me too"&, indicating that the sender of a
4187 message should receive a copy of the message if the sender appears in an alias
4188 expansion. Exim always does this, so the option does nothing.
4189
4190 .vitem &%-oo%&
4191 .oindex "&%-oo%&"
4192 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4193 This option is ignored. In Sendmail it specifies &"old style headers"&,
4194 whatever that means.
4195
4196 .vitem &%-oP%&&~<&'path'&>
4197 .oindex "&%-oP%&"
4198 .cindex "pid (process id)" "of daemon"
4199 .cindex "daemon" "process id (pid)"
4200 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4201 value. The option specifies the file to which the process id of the daemon is
4202 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4203 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4204 because in those cases, the normal pid file is not used.
4205
4206 .vitem &%-or%&&~<&'time'&>
4207 .oindex "&%-or%&"
4208 .cindex "timeout" "for non-SMTP input"
4209 This option sets a timeout value for incoming non-SMTP messages. If it is not
4210 set, Exim will wait forever for the standard input. The value can also be set
4211 by the &%receive_timeout%& option. The format used for specifying times is
4212 described in section &<<SECTtimeformat>>&.
4213
4214 .vitem &%-os%&&~<&'time'&>
4215 .oindex "&%-os%&"
4216 .cindex "timeout" "for SMTP input"
4217 .cindex "SMTP" "input timeout"
4218 This option sets a timeout value for incoming SMTP messages. The timeout
4219 applies to each SMTP command and block of data. The value can also be set by
4220 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4221 for specifying times is described in section &<<SECTtimeformat>>&.
4222
4223 .vitem &%-ov%&
4224 .oindex "&%-ov%&"
4225 This option has exactly the same effect as &%-v%&.
4226
4227 .vitem &%-oX%&&~<&'number&~or&~string'&>
4228 .oindex "&%-oX%&"
4229 .cindex "TCP/IP" "setting listening ports"
4230 .cindex "TCP/IP" "setting listening interfaces"
4231 .cindex "port" "receiving TCP/IP"
4232 This option is relevant only when the &%-bd%& (start listening daemon) option
4233 is also given. It controls which ports and interfaces the daemon uses. Details
4234 of the syntax, and how it interacts with configuration file options, are given
4235 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4236 file is written unless &%-oP%& is also present to specify a pid file name.
4237
4238 .vitem &%-pd%&
4239 .oindex "&%-pd%&"
4240 .cindex "Perl" "starting the interpreter"
4241 This option applies when an embedded Perl interpreter is linked with Exim (see
4242 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4243 option, forcing the starting of the interpreter to be delayed until it is
4244 needed.
4245
4246 .vitem &%-ps%&
4247 .oindex "&%-ps%&"
4248 .cindex "Perl" "starting the interpreter"
4249 This option applies when an embedded Perl interpreter is linked with Exim (see
4250 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4251 option, forcing the starting of the interpreter to occur as soon as Exim is
4252 started.
4253
4254 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4255 .oindex "&%-p%&"
4256 For compatibility with Sendmail, this option is equivalent to
4257 .display
4258 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4259 .endd
4260 It sets the incoming protocol and host name (for trusted callers). The
4261 host name and its colon can be omitted when only the protocol is to be set.
4262 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4263 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4264 or &`s`& using this option (but that does not seem a real limitation).
4265
4266 .vitem &%-q%&
4267 .oindex "&%-q%&"
4268 .cindex "queue runner" "starting manually"
4269 This option is normally restricted to admin users. However, there is a
4270 configuration option called &%prod_requires_admin%& which can be set false to
4271 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4272 and &%-S%& options).
4273
4274 .cindex "queue runner" "description of operation"
4275 The &%-q%& option starts one queue runner process. This scans the queue of
4276 waiting messages, and runs a delivery process for each one in turn. It waits
4277 for each delivery process to finish before starting the next one. A delivery
4278 process may not actually do any deliveries if the retry times for the addresses
4279 have not been reached. Use &%-qf%& (see below) if you want to override this.
4280
4281 If
4282 .cindex "SMTP" "passed connection"
4283 .cindex "SMTP" "multiple deliveries"
4284 .cindex "multiple SMTP deliveries"
4285 the delivery process spawns other processes to deliver other messages down
4286 passed SMTP connections, the queue runner waits for these to finish before
4287 proceeding.
4288
4289 When all the queued messages have been considered, the original queue runner
4290 process terminates. In other words, a single pass is made over the waiting
4291 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4292 this to be repeated periodically.
4293
4294 Exim processes the waiting messages in an unpredictable order. It isn't very
4295 random, but it is likely to be different each time, which is all that matters.
4296 If one particular message screws up a remote MTA, other messages to the same
4297 MTA have a chance of getting through if they get tried first.
4298
4299 It is possible to cause the messages to be processed in lexical message id
4300 order, which is essentially the order in which they arrived, by setting the
4301 &%queue_run_in_order%& option, but this is not recommended for normal use.
4302
4303 .vitem &%-q%&<&'qflags'&>
4304 The &%-q%& option may be followed by one or more flag letters that change its
4305 behaviour. They are all optional, but if more than one is present, they must
4306 appear in the correct order. Each flag is described in a separate item below.
4307
4308 .vitem &%-qq...%&
4309 .oindex "&%-qq%&"
4310 .cindex "queue" "double scanning"
4311 .cindex "queue" "routing"
4312 .cindex "routing" "whole queue before delivery"
4313 An option starting with &%-qq%& requests a two-stage queue run. In the first
4314 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4315 every domain. Addresses are routed, local deliveries happen, but no remote
4316 transports are run.
4317
4318 .cindex "hints database" "remembering routing"
4319 The hints database that remembers which messages are waiting for specific hosts
4320 is updated, as if delivery to those hosts had been deferred. After this is
4321 complete, a second, normal queue scan happens, with routing and delivery taking
4322 place as normal. Messages that are routed to the same host should mostly be
4323 delivered down a single SMTP
4324 .cindex "SMTP" "passed connection"
4325 .cindex "SMTP" "multiple deliveries"
4326 .cindex "multiple SMTP deliveries"
4327 connection because of the hints that were set up during the first queue scan.
4328 This option may be useful for hosts that are connected to the Internet
4329 intermittently.
4330
4331 .vitem &%-q[q]i...%&
4332 .oindex "&%-qi%&"
4333 .cindex "queue" "initial delivery"
4334 If the &'i'& flag is present, the queue runner runs delivery processes only for
4335 those messages that haven't previously been tried. (&'i'& stands for &"initial
4336 delivery"&.) This can be helpful if you are putting messages on the queue using
4337 &%-odq%& and want a queue runner just to process the new messages.
4338
4339 .vitem &%-q[q][i]f...%&
4340 .oindex "&%-qf%&"
4341 .cindex "queue" "forcing delivery"
4342 .cindex "delivery" "forcing in queue run"
4343 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4344 message, whereas without &'f'& only those non-frozen addresses that have passed
4345 their retry times are tried.
4346
4347 .vitem &%-q[q][i]ff...%&
4348 .oindex "&%-qff%&"
4349 .cindex "frozen messages" "forcing delivery"
4350 If &'ff'& is present, a delivery attempt is forced for every message, whether
4351 frozen or not.
4352
4353 .vitem &%-q[q][i][f[f]]l%&
4354 .oindex "&%-ql%&"
4355 .cindex "queue" "local deliveries only"
4356 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4357 be done. If a message requires any remote deliveries, it remains on the queue
4358 for later delivery.
4359
4360 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4361 .cindex "queue" "delivering specific messages"
4362 When scanning the queue, Exim can be made to skip over messages whose ids are
4363 lexically less than a given value by following the &%-q%& option with a
4364 starting message id. For example:
4365 .code
4366 exim -q 0t5C6f-0000c8-00
4367 .endd
4368 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4369 second message id is given, messages whose ids are lexically greater than it
4370 are also skipped. If the same id is given twice, for example,
4371 .code
4372 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4373 .endd
4374 just one delivery process is started, for that message. This differs from
4375 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4376 that it counts as a delivery from a queue run. Note that the selection
4377 mechanism does not affect the order in which the messages are scanned. There
4378 are also other ways of selecting specific sets of messages for delivery in a
4379 queue run &-- see &%-R%& and &%-S%&.
4380
4381 .vitem &%-q%&<&'qflags'&><&'time'&>
4382 .cindex "queue runner" "starting periodically"
4383 .cindex "periodic queue running"
4384 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4385 starting a queue runner process at intervals specified by the given time value
4386 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4387 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4388 single daemon process handles both functions. A common way of starting up a
4389 combined daemon at system boot time is to use a command such as
4390 .code
4391 /usr/exim/bin/exim -bd -q30m
4392 .endd
4393 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4394 process every 30 minutes.
4395
4396 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4397 pid file is written unless one is explicitly requested by the &%-oP%& option.
4398
4399 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4400 .oindex "&%-qR%&"
4401 This option is synonymous with &%-R%&. It is provided for Sendmail
4402 compatibility.
4403
4404 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4405 .oindex "&%-qS%&"
4406 This option is synonymous with &%-S%&.
4407
4408 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4409 .oindex "&%-R%&"
4410 .cindex "queue runner" "for specific recipients"
4411 .cindex "delivery" "to given domain"
4412 .cindex "domain" "delivery to"
4413 The <&'rsflags'&> may be empty, in which case the white space before the string
4414 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4415 which are the possible values for <&'rsflags'&>. White space is required if
4416 <&'rsflags'&> is not empty.
4417
4418 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4419 perform a single queue run, except that, when scanning the messages on the
4420 queue, Exim processes only those that have at least one undelivered recipient
4421 address containing the given string, which is checked in a case-independent
4422 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4423 regular expression; otherwise it is a literal string.
4424
4425 If you want to do periodic queue runs for messages with specific recipients,
4426 you can combine &%-R%& with &%-q%& and a time value. For example:
4427 .code
4428 exim -q25m -R @special.domain.example
4429 .endd
4430 This example does a queue run for messages with recipients in the given domain
4431 every 25 minutes. Any additional flags that are specified with &%-q%& are
4432 applied to each queue run.
4433
4434 Once a message is selected for delivery by this mechanism, all its addresses
4435 are processed. For the first selected message, Exim overrides any retry
4436 information and forces a delivery attempt for each undelivered address. This
4437 means that if delivery of any address in the first message is successful, any
4438 existing retry information is deleted, and so delivery attempts for that
4439 address in subsequently selected messages (which are processed without forcing)
4440 will run. However, if delivery of any address does not succeed, the retry
4441 information is updated, and in subsequently selected messages, the failing
4442 address will be skipped.
4443
4444 .cindex "frozen messages" "forcing delivery"
4445 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4446 all selected messages, not just the first; frozen messages are included when
4447 &'ff'& is present.
4448
4449 The &%-R%& option makes it straightforward to initiate delivery of all messages
4450 to a given domain after a host has been down for some time. When the SMTP
4451 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4452 effect is to run Exim with the &%-R%& option, but it can be configured to run
4453 an arbitrary command instead.
4454
4455 .vitem &%-r%&
4456 .oindex "&%-r%&"
4457 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4458
4459 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4460 .oindex "&%-S%&"
4461 .cindex "delivery" "from given sender"
4462 .cindex "queue runner" "for specific senders"
4463 This option acts like &%-R%& except that it checks the string against each
4464 message's sender instead of against the recipients. If &%-R%& is also set, both
4465 conditions must be met for a message to be selected. If either of the options
4466 has &'f'& or &'ff'& in its flags, the associated action is taken.
4467
4468 .vitem &%-Tqt%&&~<&'times'&>
4469 .oindex "&%-Tqt%&"
4470 This an option that is exclusively for use by the Exim testing suite. It is not
4471 recognized when Exim is run normally. It allows for the setting up of explicit
4472 &"queue times"& so that various warning/retry features can be tested.
4473
4474 .vitem &%-t%&
4475 .oindex "&%-t%&"
4476 .cindex "recipient" "extracting from header lines"
4477 .cindex "&'Bcc:'& header line"
4478 .cindex "&'Cc:'& header line"
4479 .cindex "&'To:'& header line"
4480 When Exim is receiving a locally-generated, non-SMTP message on its standard
4481 input, the &%-t%& option causes the recipients of the message to be obtained
4482 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4483 from the command arguments. The addresses are extracted before any rewriting
4484 takes place and the &'Bcc:'& header line, if present, is then removed.
4485
4486 .cindex "Sendmail compatibility" "&%-t%& option"
4487 If the command has any arguments, they specify addresses to which the message
4488 is &'not'& to be delivered. That is, the argument addresses are removed from
4489 the recipients list obtained from the headers. This is compatible with Smail 3
4490 and in accordance with the documented behaviour of several versions of
4491 Sendmail, as described in man pages on a number of operating systems (e.g.
4492 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4493 argument addresses to those obtained from the headers, and the O'Reilly
4494 Sendmail book documents it that way. Exim can be made to add argument addresses
4495 instead of subtracting them by setting the option
4496 &%extract_addresses_remove_arguments%& false.
4497
4498 .cindex "&%Resent-%& header lines" "with &%-t%&"
4499 If there are any &%Resent-%& header lines in the message, Exim extracts
4500 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4501 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4502 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4503 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4504
4505 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4506 message is resent several times). The RFC also specifies that they should be
4507 added at the front of the message, and separated by &'Received:'& lines. It is
4508 not at all clear how &%-t%& should operate in the present of multiple sets,
4509 nor indeed exactly what constitutes a &"set"&.
4510 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4511 are often added at the end of the header, and if a message is resent more than
4512 once, it is common for the original set of &%Resent-%& headers to be renamed as
4513 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4514
4515 .vitem &%-ti%&
4516 .oindex "&%-ti%&"
4517 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4518 compatibility with Sendmail.
4519
4520 .vitem &%-tls-on-connect%&
4521 .oindex "&%-tls-on-connect%&"
4522 .cindex "TLS" "use without STARTTLS"
4523 .cindex "TLS" "automatic start"
4524 This option is available when Exim is compiled with TLS support. It forces all
4525 incoming SMTP connections to behave as if the incoming port is listed in the
4526 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4527 &<<CHAPTLS>>& for further details.
4528
4529
4530 .vitem &%-U%&
4531 .oindex "&%-U%&"
4532 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4533 Sendmail uses this option for &"initial message submission"&, and its
4534 documentation states that in future releases, it may complain about
4535 syntactically invalid messages rather than fixing them when this flag is not
4536 set. Exim ignores this option.
4537
4538 .vitem &%-v%&
4539 .oindex "&%-v%&"
4540 This option causes Exim to write information to the standard error stream,
4541 describing what it is doing. In particular, it shows the log lines for
4542 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4543 dialogue is shown. Some of the log lines shown may not actually be written to
4544 the log if the setting of &%log_selector%& discards them. Any relevant
4545 selectors are shown with each log line. If none are shown, the logging is
4546 unconditional.
4547
4548 .vitem &%-x%&
4549 .oindex "&%-x%&"
4550 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4551 National Language Support extended characters in the body of the mail item"&).
4552 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4553 this option.
4554 .endlist
4555
4556 .ecindex IIDclo1
4557 .ecindex IIDclo2
4558
4559
4560 . ////////////////////////////////////////////////////////////////////////////
4561 . Insert a stylized DocBook comment here, to identify the end of the command
4562 . line options. This is for the benefit of the Perl script that automatically
4563 . creates a man page for the options.
4564 . ////////////////////////////////////////////////////////////////////////////
4565
4566 .literal xml
4567 <!-- === End of command line options === -->
4568 .literal off
4569
4570
4571
4572
4573
4574 . ////////////////////////////////////////////////////////////////////////////
4575 . ////////////////////////////////////////////////////////////////////////////
4576
4577
4578 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4579          "The runtime configuration file"
4580
4581 .cindex "run time configuration"
4582 .cindex "configuration file" "general description"
4583 .cindex "CONFIGURE_FILE"
4584 .cindex "configuration file" "errors in"
4585 .cindex "error" "in configuration file"
4586 .cindex "return code" "for bad configuration"
4587 Exim uses a single run time configuration file that is read whenever an Exim
4588 binary is executed. Note that in normal operation, this happens frequently,
4589 because Exim is designed to operate in a distributed manner, without central
4590 control.
4591
4592 If a syntax error is detected while reading the configuration file, Exim
4593 writes a message on the standard error, and exits with a non-zero return code.
4594 The message is also written to the panic log. &*Note*&: Only simple syntax
4595 errors can be detected at this time. The values of any expanded options are
4596 not checked until the expansion happens, even when the expansion does not
4597 actually alter the string.
4598
4599 The name of the configuration file is compiled into the binary for security
4600 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4601 most configurations, this specifies a single file. However, it is permitted to
4602 give a colon-separated list of file names, in which case Exim uses the first
4603 existing file in the list.
4604
4605 .cindex "EXIM_USER"
4606 .cindex "EXIM_GROUP"
4607 .cindex "CONFIGURE_OWNER"
4608 .cindex "CONFIGURE_GROUP"
4609 .cindex "configuration file" "ownership"
4610 .cindex "ownership" "configuration file"
4611 The run time configuration file must be owned by root or by the user that is
4612 specified at compile time by the CONFIGURE_OWNER option (if set). The
4613 configuration file must not be world-writeable, or group-writeable unless its
4614 group is the root group or the one specified at compile time by the
4615 CONFIGURE_GROUP option.
4616
4617 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4618 to root, anybody who is able to edit the run time configuration file has an
4619 easy way to run commands as root. If you specify a user or group in the
4620 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4621 who are members of that group will trivially be able to obtain root privileges.
4622
4623 Up to Exim version 4.72, the run time configuration file was also permitted to
4624 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4625 since it offered a simple privilege escalation for any attacker who managed to
4626 compromise the Exim user account.
4627
4628 A default configuration file, which will work correctly in simple situations,
4629 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4630 defines just one file name, the installation process copies the default
4631 configuration to a new file of that name if it did not previously exist. If
4632 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4633 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4634 configuration.
4635
4636
4637
4638 .section "Using a different configuration file" "SECID40"
4639 .cindex "configuration file" "alternate"
4640 A one-off alternate configuration can be specified by the &%-C%& command line
4641 option, which may specify a single file or a list of files. However, when
4642 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4643 unless the argument for &%-C%& is identical to the built-in value from
4644 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4645 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4646 is useful mainly for checking the syntax of configuration files before
4647 installing them. No owner or group checks are done on a configuration file
4648 specified by &%-C%&, if root privilege has been dropped.
4649
4650 Even the Exim user is not trusted to specify an arbitrary configuration file
4651 with the &%-C%& option to be used with root privileges, unless that file is
4652 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4653 testing a configuration using &%-C%& right through message reception and
4654 delivery, even if the caller is root. The reception works, but by that time,
4655 Exim is running as the Exim user, so when it re-execs to regain privilege for
4656 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4657 can test reception and delivery using two separate commands (one to put a
4658 message on the queue, using &%-odq%&, and another to do the delivery, using
4659 &%-M%&).
4660
4661 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4662 prefix string with which any file named in a &%-C%& command line option must
4663 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4664 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4665 name can be used with &%-C%&.
4666
4667 One-off changes to a configuration can be specified by the &%-D%& command line
4668 option, which defines and overrides values for macros used inside the
4669 configuration file. However, like &%-C%&, the use of this option by a
4670 non-privileged user causes Exim to discard its root privilege.
4671 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4672 completely disabled, and its use causes an immediate error exit.
4673
4674 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4675 to declare certain macro names trusted, such that root privilege will not
4676 necessarily be discarded.
4677 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4678 considered safe and, if &%-D%& only supplies macros from this list, and the
4679 values are acceptable, then Exim will not give up root privilege if the caller
4680 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4681 transition mechanism and is expected to be removed in the future.  Acceptable
4682 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4683
4684 Some sites may wish to use the same Exim binary on different machines that
4685 share a file system, but to use different configuration files on each machine.
4686 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4687 looks for a file whose name is the configuration file name followed by a dot
4688 and the machine's node name, as obtained from the &[uname()]& function. If this
4689 file does not exist, the standard name is tried. This processing occurs for
4690 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4691
4692 In some esoteric situations different versions of Exim may be run under
4693 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4694 help with this. See the comments in &_src/EDITME_& for details.
4695
4696
4697
4698 .section "Configuration file format" "SECTconffilfor"
4699 .cindex "configuration file" "format of"
4700 .cindex "format" "configuration file"
4701 Exim's configuration file is divided into a number of different parts. General
4702 option settings must always appear at the start of the file. The other parts
4703 are all optional, and may appear in any order. Each part other than the first
4704 is introduced by the word &"begin"& followed by the name of the part. The
4705 optional parts are:
4706
4707 .ilist
4708 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4709 &<<CHAPACL>>&).
4710 .next
4711 .cindex "AUTH" "configuration"
4712 &'authenticators'&: Configuration settings for the authenticator drivers. These
4713 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4714 .next
4715 &'routers'&: Configuration settings for the router drivers. Routers process
4716 addresses and determine how the message is to be delivered (see chapters
4717 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4718 .next
4719 &'transports'&: Configuration settings for the transport drivers. Transports
4720 define mechanisms for copying messages to destinations (see chapters
4721 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4722 .next
4723 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4724 If there is no retry section, or if it is empty (that is, no retry rules are
4725 defined), Exim will not retry deliveries. In this situation, temporary errors
4726 are treated the same as permanent errors. Retry rules are discussed in chapter
4727 &<<CHAPretry>>&.
4728 .next
4729 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4730 when new addresses are generated during delivery. Rewriting is discussed in
4731 chapter &<<CHAPrewrite>>&.
4732 .next
4733 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4734 want to use this feature, you must set
4735 .code
4736 LOCAL_SCAN_HAS_OPTIONS=yes
4737 .endd
4738 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4739 facility are given in chapter &<<CHAPlocalscan>>&.
4740 .endlist
4741
4742 .cindex "configuration file" "leading white space in"
4743 .cindex "configuration file" "trailing white space in"
4744 .cindex "white space" "in configuration file"
4745 Leading and trailing white space in configuration lines is always ignored.
4746
4747 Blank lines in the file, and lines starting with a # character (ignoring
4748 leading white space) are treated as comments and are ignored. &*Note*&: A
4749 # character other than at the beginning of a line is not treated specially,
4750 and does not introduce a comment.
4751
4752 Any non-comment line can be continued by ending it with a backslash. Note that
4753 the general rule for white space means that trailing white space after the
4754 backslash and leading white space at the start of continuation
4755 lines is ignored. Comment lines beginning with # (but not empty lines) may
4756 appear in the middle of a sequence of continuation lines.
4757
4758 A convenient way to create a configuration file is to start from the
4759 default, which is supplied in &_src/configure.default_&, and add, delete, or
4760 change settings as required.
4761
4762 The ACLs, retry rules, and rewriting rules have their own syntax which is
4763 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4764 respectively. The other parts of the configuration file have some syntactic
4765 items in common, and these are described below, from section &<<SECTcos>>&
4766 onwards. Before that, the inclusion, macro, and conditional facilities are
4767 described.
4768
4769
4770
4771 .section "File inclusions in the configuration file" "SECID41"
4772 .cindex "inclusions in configuration file"
4773 .cindex "configuration file" "including other files"
4774 .cindex "&`.include`& in configuration file"
4775 .cindex "&`.include_if_exists`& in configuration file"
4776 You can include other files inside Exim's run time configuration file by
4777 using this syntax:
4778 .display
4779 &`.include`& <&'file name'&>
4780 &`.include_if_exists`& <&'file name'&>
4781 .endd
4782 on a line by itself. Double quotes round the file name are optional. If you use
4783 the first form, a configuration error occurs if the file does not exist; the
4784 second form does nothing for non-existent files. In all cases, an absolute file
4785 name is required.
4786
4787 Includes may be nested to any depth, but remember that Exim reads its
4788 configuration file often, so it is a good idea to keep them to a minimum.
4789 If you change the contents of an included file, you must HUP the daemon,
4790 because an included file is read only when the configuration itself is read.
4791
4792 The processing of inclusions happens early, at a physical line level, so, like
4793 comment lines, an inclusion can be used in the middle of an option setting,
4794 for example:
4795 .code
4796 hosts_lookup = a.b.c \
4797                .include /some/file
4798 .endd
4799 Include processing happens after macro processing (see below). Its effect is to
4800 process the lines of the included file as if they occurred inline where the
4801 inclusion appears.
4802
4803
4804
4805 .section "Macros in the configuration file" "SECTmacrodefs"
4806 .cindex "macro" "description of"
4807 .cindex "configuration file" "macros"
4808 If a line in the main part of the configuration (that is, before the first
4809 &"begin"& line) begins with an upper case letter, it is taken as a macro
4810 definition, and must be of the form
4811 .display
4812 <&'name'&> = <&'rest of line'&>
4813 .endd
4814 The name must consist of letters, digits, and underscores, and need not all be
4815 in upper case, though that is recommended. The rest of the line, including any
4816 continuations, is the replacement text, and has leading and trailing white
4817 space removed. Quotes are not removed. The replacement text can never end with
4818 a backslash character, but this doesn't seem to be a serious limitation.
4819
4820 Macros may also be defined between router, transport, authenticator, or ACL
4821 definitions. They may not, however, be defined within an individual driver or
4822 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4823
4824 .section "Macro substitution" "SECID42"
4825 Once a macro is defined, all subsequent lines in the file (and any included
4826 files) are scanned for the macro name; if there are several macros, the line is
4827 scanned for each in turn, in the order in which the macros are defined. The
4828 replacement text is not re-scanned for the current macro, though it is scanned
4829 for subsequently defined macros. For this reason, a macro name may not contain
4830 the name of a previously defined macro as a substring. You could, for example,
4831 define
4832 .display
4833 &`ABCD_XYZ = `&<&'something'&>
4834 &`ABCD = `&<&'something else'&>
4835 .endd
4836 but putting the definitions in the opposite order would provoke a configuration
4837 error. Macro expansion is applied to individual physical lines from the file,
4838 before checking for line continuation or file inclusion (see above). If a line
4839 consists solely of a macro name, and the expansion of the macro is empty, the
4840 line is ignored. A macro at the start of a line may turn the line into a
4841 comment line or a &`.include`& line.
4842
4843
4844 .section "Redefining macros" "SECID43"
4845 Once defined, the value of a macro can be redefined later in the configuration
4846 (or in an included file). Redefinition is specified by using &'=='& instead of
4847 &'='&. For example:
4848 .code
4849 MAC =  initial value
4850 ...
4851 MAC == updated value
4852 .endd
4853 Redefinition does not alter the order in which the macros are applied to the
4854 subsequent lines of the configuration file. It is still the same order in which
4855 the macros were originally defined. All that changes is the macro's value.
4856 Redefinition makes it possible to accumulate values. For example:
4857 .code
4858 MAC =  initial value
4859 ...
4860 MAC == MAC and something added
4861 .endd
4862 This can be helpful in situations where the configuration file is built
4863 from a number of other files.
4864
4865 .section "Overriding macro values" "SECID44"
4866 The values set for macros in the configuration file can be overridden by the
4867 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4868 used, unless called by root or the Exim user. A definition on the command line
4869 using the &%-D%& option causes all definitions and redefinitions within the
4870 file to be ignored.
4871
4872
4873
4874 .section "Example of macro usage" "SECID45"
4875 As an example of macro usage, consider a configuration where aliases are looked
4876 up in a MySQL database. It helps to keep the file less cluttered if long
4877 strings such as SQL statements are defined separately as macros, for example:
4878 .code
4879 ALIAS_QUERY = select mailbox from user where \
4880               login='${quote_mysql:$local_part}';
4881 .endd
4882 This can then be used in a &(redirect)& router setting like this:
4883 .code
4884 data = ${lookup mysql{ALIAS_QUERY}}
4885 .endd
4886 In earlier versions of Exim macros were sometimes used for domain, host, or
4887 address lists. In Exim 4 these are handled better by named lists &-- see
4888 section &<<SECTnamedlists>>&.
4889
4890
4891 .section "Conditional skips in the configuration file" "SECID46"
4892 .cindex "configuration file" "conditional skips"
4893 .cindex "&`.ifdef`&"
4894 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4895 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4896 portions of the configuration file. The processing happens whenever the file is
4897 read (that is, when an Exim binary starts to run).
4898
4899 The implementation is very simple. Instances of the first four directives must
4900 be followed by text that includes the names of one or macros. The condition
4901 that is tested is whether or not any macro substitution has taken place in the
4902 line. Thus:
4903 .code
4904 .ifdef AAA
4905 message_size_limit = 50M
4906 .else
4907 message_size_limit = 100M
4908 .endif
4909 .endd
4910 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4911 otherwise. If there is more than one macro named on the line, the condition
4912 is true if any of them are defined. That is, it is an &"or"& condition. To
4913 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4914
4915 Although you can use a macro expansion to generate one of these directives,
4916 it is not very useful, because the condition &"there was a macro substitution
4917 in this line"& will always be true.
4918
4919 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4920 to clarify complicated nestings.
4921
4922
4923
4924 .section "Common option syntax" "SECTcos"
4925 .cindex "common option syntax"
4926 .cindex "syntax of common options"
4927 .cindex "configuration file" "common option syntax"
4928 For the main set of options, driver options, and &[local_scan()]& options,
4929 each setting is on a line by itself, and starts with a name consisting of
4930 lower-case letters and underscores. Many options require a data value, and in
4931 these cases the name must be followed by an equals sign (with optional white
4932 space) and then the value. For example:
4933 .code
4934 qualify_domain = mydomain.example.com
4935 .endd
4936 .cindex "hiding configuration option values"
4937 .cindex "configuration options" "hiding value of"
4938 .cindex "options" "hiding value of"
4939 Some option settings may contain sensitive data, for example, passwords for
4940 accessing databases. To stop non-admin users from using the &%-bP%& command
4941 line option to read these values, you can precede the option settings with the
4942 word &"hide"&. For example:
4943 .code
4944 hide mysql_servers = localhost/users/admin/secret-password
4945 .endd
4946 For non-admin users, such options are displayed like this:
4947 .code
4948 mysql_servers = <value not displayable>
4949 .endd
4950 If &"hide"& is used on a driver option, it hides the value of that option on
4951 all instances of the same driver.
4952
4953 The following sections describe the syntax used for the different data types
4954 that are found in option settings.
4955
4956
4957 .section "Boolean options" "SECID47"
4958 .cindex "format" "boolean"
4959 .cindex "boolean configuration values"
4960 .oindex "&%no_%&&'xxx'&"
4961 .oindex "&%not_%&&'xxx'&"
4962 Options whose type is given as boolean are on/off switches. There are two
4963 different ways of specifying such options: with and without a data value. If
4964 the option name is specified on its own without data, the switch is turned on;
4965 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4966 boolean options may be followed by an equals sign and one of the words
4967 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4968 the following two settings have exactly the same effect:
4969 .code
4970 queue_only
4971 queue_only = true
4972 .endd
4973 The following two lines also have the same (opposite) effect:
4974 .code
4975 no_queue_only
4976 queue_only = false
4977 .endd
4978 You can use whichever syntax you prefer.
4979
4980
4981
4982
4983 .section "Integer values" "SECID48"
4984 .cindex "integer configuration values"
4985 .cindex "format" "integer"
4986 If an option's type is given as &"integer"&, the value can be given in decimal,
4987 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4988 number is assumed. Otherwise, it is treated as an octal number unless it starts
4989 with the characters &"0x"&, in which case the remainder is interpreted as a
4990 hexadecimal number.
4991
4992 If an integer value is followed by the letter K, it is multiplied by 1024; if
4993 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4994 of integer option settings are output, values which are an exact multiple of
4995 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4996 and M. The printing style is independent of the actual input format that was
4997 used.
4998
4999
5000 .section "Octal integer values" "SECID49"
5001 .cindex "integer format"
5002 .cindex "format" "octal integer"
5003 If an option's type is given as &"octal integer"&, its value is always
5004 interpreted as an octal number, whether or not it starts with the digit zero.
5005 Such options are always output in octal.
5006
5007
5008 .section "Fixed point numbers" "SECID50"
5009 .cindex "fixed point configuration values"
5010 .cindex "format" "fixed point"
5011 If an option's type is given as &"fixed-point"&, its value must be a decimal
5012 integer, optionally followed by a decimal point and up to three further digits.
5013
5014
5015
5016 .section "Time intervals" "SECTtimeformat"
5017 .cindex "time interval" "specifying in configuration"
5018 .cindex "format" "time interval"
5019 A time interval is specified as a sequence of numbers, each followed by one of
5020 the following letters, with no intervening white space:
5021
5022 .table2 30pt
5023 .irow &%s%& seconds
5024 .irow &%m%& minutes
5025 .irow &%h%& hours
5026 .irow &%d%& days
5027 .irow &%w%& weeks
5028 .endtable
5029
5030 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5031 intervals are output in the same format. Exim does not restrict the values; it
5032 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5033
5034
5035
5036 .section "String values" "SECTstrings"
5037 .cindex "string" "format of configuration values"
5038 .cindex "format" "string"
5039 If an option's type is specified as &"string"&, the value can be specified with
5040 or without double-quotes. If it does not start with a double-quote, the value
5041 consists of the remainder of the line plus any continuation lines, starting at
5042 the first character after any leading white space, with trailing white space
5043 removed, and with no interpretation of the characters in the string. Because
5044 Exim removes comment lines (those beginning with #) at an early stage, they can
5045 appear in the middle of a multi-line string. The following two settings are
5046 therefore equivalent:
5047 .code
5048 trusted_users = uucp:mail
5049 trusted_users = uucp:\
5050                 # This comment line is ignored
5051                 mail
5052 .endd
5053 .cindex "string" "quoted"
5054 .cindex "escape characters in quoted strings"
5055 If a string does start with a double-quote, it must end with a closing
5056 double-quote, and any backslash characters other than those used for line
5057 continuation are interpreted as escape characters, as follows:
5058
5059 .table2 100pt
5060 .irow &`\\`&                     "single backslash"
5061 .irow &`\n`&                     "newline"
5062 .irow &`\r`&                     "carriage return"
5063 .irow &`\t`&                     "tab"
5064 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5065 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5066                                    character"
5067 .endtable
5068
5069 If a backslash is followed by some other character, including a double-quote
5070 character, that character replaces the pair.
5071
5072 Quoting is necessary only if you want to make use of the backslash escapes to
5073 insert special characters, or if you need to specify a value with leading or
5074 trailing spaces. These cases are rare, so quoting is almost never needed in
5075 current versions of Exim. In versions of Exim before 3.14, quoting was required
5076 in order to continue lines, so you may come across older configuration files
5077 and examples that apparently quote unnecessarily.
5078
5079
5080 .section "Expanded strings" "SECID51"
5081 .cindex "expansion" "definition of"
5082 Some strings in the configuration file are subjected to &'string expansion'&,
5083 by which means various parts of the string may be changed according to the
5084 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5085 is as just described; in particular, the handling of backslashes in quoted
5086 strings is done as part of the input process, before expansion takes place.
5087 However, backslash is also an escape character for the expander, so any
5088 backslashes that are required for that reason must be doubled if they are
5089 within a quoted configuration string.
5090
5091
5092 .section "User and group names" "SECID52"
5093 .cindex "user name" "format of"
5094 .cindex "format" "user name"
5095 .cindex "groups" "name format"
5096 .cindex "format" "group name"
5097 User and group names are specified as strings, using the syntax described
5098 above, but the strings are interpreted specially. A user or group name must
5099 either consist entirely of digits, or be a name that can be looked up using the
5100 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5101
5102
5103 .section "List construction" "SECTlistconstruct"
5104 .cindex "list" "syntax of in configuration"
5105 .cindex "format" "list item in configuration"
5106 .cindex "string" "list, definition of"
5107 The data for some configuration options is a list of items, with colon as the
5108 default separator. Many of these options are shown with type &"string list"& in
5109 the descriptions later in this document. Others are listed as &"domain list"&,
5110 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5111 are all the same; however, those other than &"string list"& are subject to
5112 particular kinds of interpretation, as described in chapter
5113 &<<CHAPdomhosaddlists>>&.
5114
5115 In all these cases, the entire list is treated as a single string as far as the
5116 input syntax is concerned. The &%trusted_users%& setting in section
5117 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5118 in a list, it must be entered as two colons. Leading and trailing white space
5119 on each item in a list is ignored. This makes it possible to include items that
5120 start with a colon, and in particular, certain forms of IPv6 address. For
5121 example, the list
5122 .code
5123 local_interfaces = 127.0.0.1 : ::::1
5124 .endd
5125 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5126
5127 &*Note*&: Although leading and trailing white space is ignored in individual
5128 list items, it is not ignored when parsing the list. The space after the first
5129 colon in the example above is necessary. If it were not there, the list would
5130 be interpreted as the two items 127.0.0.1:: and 1.
5131
5132 .section "Changing list separators" "SECID53"
5133 .cindex "list separator" "changing"
5134 .cindex "IPv6" "addresses in lists"
5135 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5136 introduced to allow the separator character to be changed. If a list begins
5137 with a left angle bracket, followed by any punctuation character, that
5138 character is used instead of colon as the list separator. For example, the list
5139 above can be rewritten to use a semicolon separator like this:
5140 .code
5141 local_interfaces = <; 127.0.0.1 ; ::1
5142 .endd
5143 This facility applies to all lists, with the exception of the list in
5144 &%log_file_path%&. It is recommended that the use of non-colon separators be
5145 confined to circumstances where they really are needed.
5146
5147 .cindex "list separator" "newline as"
5148 .cindex "newline" "as list separator"
5149 It is also possible to use newline and other control characters (those with
5150 code values less than 32, plus DEL) as separators in lists. Such separators
5151 must be provided literally at the time the list is processed. For options that
5152 are string-expanded, you can write the separator using a normal escape
5153 sequence. This will be processed by the expander before the string is
5154 interpreted as a list. For example, if a newline-separated list of domains is
5155 generated by a lookup, you can process it directly by a line such as this:
5156 .code
5157 domains = <\n ${lookup mysql{.....}}
5158 .endd
5159 This avoids having to change the list separator in such data. You are unlikely
5160 to want to use a control character as a separator in an option that is not
5161 expanded, because the value is literal text. However, it can be done by giving
5162 the value in quotes. For example:
5163 .code
5164 local_interfaces = "<\n 127.0.0.1 \n ::1"
5165 .endd
5166 Unlike printing character separators, which can be included in list items by
5167 doubling, it is not possible to include a control character as data when it is
5168 set as the separator. Two such characters in succession are interpreted as
5169 enclosing an empty list item.
5170
5171
5172
5173 .section "Empty items in lists" "SECTempitelis"
5174 .cindex "list" "empty item in"
5175 An empty item at the end of a list is always ignored. In other words, trailing
5176 separator characters are ignored. Thus, the list in
5177 .code
5178 senders = user@domain :
5179 .endd
5180 contains only a single item. If you want to include an empty string as one item
5181 in a list, it must not be the last item. For example, this list contains three
5182 items, the second of which is empty:
5183 .code
5184 senders = user1@domain : : user2@domain
5185 .endd
5186 &*Note*&: There must be white space between the two colons, as otherwise they
5187 are interpreted as representing a single colon data character (and the list
5188 would then contain just one item). If you want to specify a list that contains
5189 just one, empty item, you can do it as in this example:
5190 .code
5191 senders = :
5192 .endd
5193 In this case, the first item is empty, and the second is discarded because it
5194 is at the end of the list.
5195
5196
5197
5198
5199 .section "Format of driver configurations" "SECTfordricon"
5200 .cindex "drivers" "configuration format"
5201 There are separate parts in the configuration for defining routers, transports,
5202 and authenticators. In each part, you are defining a number of driver
5203 instances, each with its own set of options. Each driver instance is defined by
5204 a sequence of lines like this:
5205 .display
5206 <&'instance name'&>:
5207   <&'option'&>
5208   ...
5209   <&'option'&>
5210 .endd
5211 In the following example, the instance name is &(localuser)&, and it is
5212 followed by three options settings:
5213 .code
5214 localuser:
5215   driver = accept
5216   check_local_user
5217   transport = local_delivery
5218 .endd
5219 For each driver instance, you specify which Exim code module it uses &-- by the
5220 setting of the &%driver%& option &-- and (optionally) some configuration
5221 settings. For example, in the case of transports, if you want a transport to
5222 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5223 a local file you would use the &(appendfile)& driver. Each of the drivers is
5224 described in detail in its own separate chapter later in this manual.
5225
5226 You can have several routers, transports, or authenticators that are based on
5227 the same underlying driver (each must have a different instance name).
5228
5229 The order in which routers are defined is important, because addresses are
5230 passed to individual routers one by one, in order. The order in which
5231 transports are defined does not matter at all. The order in which
5232 authenticators are defined is used only when Exim, as a client, is searching
5233 them to find one that matches an authentication mechanism offered by the
5234 server.
5235
5236 .cindex "generic options"
5237 .cindex "options" "generic &-- definition of"
5238 Within a driver instance definition, there are two kinds of option: &'generic'&
5239 and &'private'&. The generic options are those that apply to all drivers of the
5240 same type (that is, all routers, all transports or all authenticators). The
5241 &%driver%& option is a generic option that must appear in every definition.
5242 .cindex "private options"
5243 The private options are special for each driver, and none need appear, because
5244 they all have default values.
5245
5246 The options may appear in any order, except that the &%driver%& option must
5247 precede any private options, since these depend on the particular driver. For
5248 this reason, it is recommended that &%driver%& always be the first option.
5249
5250 Driver instance names, which are used for reference in log entries and
5251 elsewhere, can be any sequence of letters, digits, and underscores (starting
5252 with a letter) and must be unique among drivers of the same type. A router and
5253 a transport (for example) can each have the same name, but no two router
5254 instances can have the same name. The name of a driver instance should not be
5255 confused with the name of the underlying driver module. For example, the
5256 configuration lines:
5257 .code
5258 remote_smtp:
5259   driver = smtp
5260 .endd
5261 create an instance of the &(smtp)& transport driver whose name is
5262 &(remote_smtp)&. The same driver code can be used more than once, with
5263 different instance names and different option settings each time. A second
5264 instance of the &(smtp)& transport, with different options, might be defined
5265 thus:
5266 .code
5267 special_smtp:
5268   driver = smtp
5269   port = 1234
5270   command_timeout = 10s
5271 .endd
5272 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5273 these transport instances from routers, and these names would appear in log
5274 lines.
5275
5276 Comment lines may be present in the middle of driver specifications. The full
5277 list of option settings for any particular driver instance, including all the
5278 defaulted values, can be extracted by making use of the &%-bP%& command line
5279 option.
5280
5281
5282
5283
5284
5285
5286 . ////////////////////////////////////////////////////////////////////////////
5287 . ////////////////////////////////////////////////////////////////////////////
5288
5289 .chapter "The default configuration file" "CHAPdefconfil"
5290 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5291 .cindex "default" "configuration file &""walk through""&"
5292 The default configuration file supplied with Exim as &_src/configure.default_&
5293 is sufficient for a host with simple mail requirements. As an introduction to
5294 the way Exim is configured, this chapter &"walks through"& the default
5295 configuration, giving brief explanations of the settings. Detailed descriptions
5296 of the options are given in subsequent chapters. The default configuration file
5297 itself contains extensive comments about ways you might want to modify the
5298 initial settings. However, note that there are many options that are not
5299 mentioned at all in the default configuration.
5300
5301
5302
5303 .section "Main configuration settings" "SECTdefconfmain"
5304 The main (global) configuration option settings must always come first in the
5305 file. The first thing you'll see in the file, after some initial comments, is
5306 the line
5307 .code
5308 # primary_hostname =
5309 .endd
5310 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5311 to know the official, fully qualified name of your host, and this is where you
5312 can specify it. However, in most cases you do not need to set this option. When
5313 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5314
5315 The first three non-comment configuration lines are as follows:
5316 .code
5317 domainlist local_domains = @
5318 domainlist relay_to_domains =
5319 hostlist   relay_from_hosts = 127.0.0.1
5320 .endd
5321 These are not, in fact, option settings. They are definitions of two named
5322 domain lists and one named host list. Exim allows you to give names to lists of
5323 domains, hosts, and email addresses, in order to make it easier to manage the
5324 configuration file (see section &<<SECTnamedlists>>&).
5325
5326 The first line defines a domain list called &'local_domains'&; this is used
5327 later in the configuration to identify domains that are to be delivered
5328 on the local host.
5329
5330 .cindex "@ in a domain list"
5331 There is just one item in this list, the string &"@"&. This is a special form
5332 of entry which means &"the name of the local host"&. Thus, if the local host is
5333 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5334 be delivered locally. Because the local host's name is referenced indirectly,
5335 the same configuration file can be used on different hosts.
5336
5337 The second line defines a domain list called &'relay_to_domains'&, but the
5338 list itself is empty. Later in the configuration we will come to the part that
5339 controls mail relaying through the local host; it allows relaying to any
5340 domains in this list. By default, therefore, no relaying on the basis of a mail
5341 domain is permitted.
5342
5343 The third line defines a host list called &'relay_from_hosts'&. This list is
5344 used later in the configuration to permit relaying from any host or IP address
5345 that matches the list. The default contains just the IP address of the IPv4
5346 loopback interface, which means that processes on the local host are able to
5347 submit mail for relaying by sending it over TCP/IP to that interface. No other
5348 hosts are permitted to submit messages for relaying.
5349
5350 Just to be sure there's no misunderstanding: at this point in the configuration
5351 we aren't actually setting up any controls. We are just defining some domains
5352 and hosts that will be used in the controls that are specified later.
5353
5354 The next two configuration lines are genuine option settings:
5355 .code
5356 acl_smtp_rcpt = acl_check_rcpt
5357 acl_smtp_data = acl_check_data
5358 .endd
5359 These options specify &'Access Control Lists'& (ACLs) that are to be used
5360 during an incoming SMTP session for every recipient of a message (every RCPT
5361 command), and after the contents of the message have been received,
5362 respectively. The names of the lists are &'acl_check_rcpt'& and
5363 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5364 section of the configuration. The RCPT ACL controls which recipients are
5365 accepted for an incoming message &-- if a configuration does not provide an ACL
5366 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5367 contents of a message to be checked.
5368
5369 Two commented-out option settings are next:
5370 .code
5371 # av_scanner = clamd:/tmp/clamd
5372 # spamd_address = 127.0.0.1 783
5373 .endd
5374 These are example settings that can be used when Exim is compiled with the
5375 content-scanning extension. The first specifies the interface to the virus
5376 scanner, and the second specifies the interface to SpamAssassin. Further
5377 details are given in chapter &<<CHAPexiscan>>&.
5378
5379 Three more commented-out option settings follow:
5380 .code
5381 # tls_advertise_hosts = *
5382 # tls_certificate = /etc/ssl/exim.crt
5383 # tls_privatekey = /etc/ssl/exim.pem
5384 .endd
5385 These are example settings that can be used when Exim is compiled with
5386 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5387 first one specifies the list of clients that are allowed to use TLS when
5388 connecting to this server; in this case the wildcard means all clients. The
5389 other options specify where Exim should find its TLS certificate and private
5390 key, which together prove the server's identity to any clients that connect.
5391 More details are given in chapter &<<CHAPTLS>>&.
5392
5393 Another two commented-out option settings follow:
5394 .code
5395 # daemon_smtp_ports = 25 : 465 : 587
5396 # tls_on_connect_ports = 465
5397 .endd
5398 .cindex "port" "465 and 587"
5399 .cindex "port" "for message submission"
5400 .cindex "message" "submission, ports for"
5401 .cindex "ssmtp protocol"
5402 .cindex "smtps protocol"
5403 .cindex "SMTP" "ssmtp protocol"
5404 .cindex "SMTP" "smtps protocol"
5405 These options provide better support for roaming users who wish to use this
5406 server for message submission. They are not much use unless you have turned on
5407 TLS (as described in the previous paragraph) and authentication (about which
5408 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5409 on end-user networks, so RFC 4409 specifies that message submission should use
5410 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5411 configured to use port 587 correctly, so these settings also enable the
5412 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5413 &<<SECTsupobssmt>>&).
5414
5415 Two more commented-out options settings follow:
5416 .code
5417 # qualify_domain =
5418 # qualify_recipient =
5419 .endd
5420 The first of these specifies a domain that Exim uses when it constructs a
5421 complete email address from a local login name. This is often needed when Exim
5422 receives a message from a local process. If you do not set &%qualify_domain%&,
5423 the value of &%primary_hostname%& is used. If you set both of these options,
5424 you can have different qualification domains for sender and recipient
5425 addresses. If you set only the first one, its value is used in both cases.
5426
5427 .cindex "domain literal" "recognizing format"
5428 The following line must be uncommented if you want Exim to recognize
5429 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5430 (an IP address within square brackets) instead of a named domain.
5431 .code
5432 # allow_domain_literals
5433 .endd
5434 The RFCs still require this form, but many people think that in the modern
5435 Internet it makes little sense to permit mail to be sent to specific hosts by
5436 quoting their IP addresses. This ancient format has been used by people who
5437 try to abuse hosts by using them for unwanted relaying. However, some
5438 people believe there are circumstances (for example, messages addressed to
5439 &'postmaster'&) where domain literals are still useful.
5440
5441 The next configuration line is a kind of trigger guard:
5442 .code
5443 never_users = root
5444 .endd
5445 It specifies that no delivery must ever be run as the root user. The normal
5446 convention is to set up &'root'& as an alias for the system administrator. This
5447 setting is a guard against slips in the configuration.
5448 The list of users specified by &%never_users%& is not, however, the complete
5449 list; the build-time configuration in &_Local/Makefile_& has an option called
5450 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5451 contents of &%never_users%& are added to this list. By default
5452 FIXED_NEVER_USERS also specifies root.
5453
5454 When a remote host connects to Exim in order to send mail, the only information
5455 Exim has about the host's identity is its IP address. The next configuration
5456 line,
5457 .code
5458 host_lookup = *
5459 .endd
5460 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5461 in order to get a host name. This improves the quality of the logging
5462 information, but if you feel it is too expensive, you can remove it entirely,
5463 or restrict the lookup to hosts on &"nearby"& networks.
5464 Note that it is not always possible to find a host name from an IP address,
5465 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5466 unreachable.
5467
5468 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5469 1413 (hence their names):
5470 .code
5471 rfc1413_hosts = *
5472 rfc1413_query_timeout = 5s
5473 .endd
5474 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5475 You can limit the hosts to which these calls are made, or change the timeout
5476 that is used. If you set the timeout to zero, all ident calls are disabled.
5477 Although they are cheap and can provide useful information for tracing problem
5478 messages, some hosts and firewalls have problems with ident calls. This can
5479 result in a timeout instead of an immediate refused connection, leading to
5480 delays on starting up an incoming SMTP session.
5481
5482 When Exim receives messages over SMTP connections, it expects all addresses to
5483 be fully qualified with a domain, as required by the SMTP definition. However,
5484 if you are running a server to which simple clients submit messages, you may
5485 find that they send unqualified addresses. The two commented-out options:
5486 .code
5487 # sender_unqualified_hosts =
5488 # recipient_unqualified_hosts =
5489 .endd
5490 show how you can specify hosts that are permitted to send unqualified sender
5491 and recipient addresses, respectively.
5492
5493 The &%percent_hack_domains%& option is also commented out:
5494 .code
5495 # percent_hack_domains =
5496 .endd
5497 It provides a list of domains for which the &"percent hack"& is to operate.
5498 This is an almost obsolete form of explicit email routing. If you do not know
5499 anything about it, you can safely ignore this topic.
5500
5501 The last two settings in the main part of the default configuration are
5502 concerned with messages that have been &"frozen"& on Exim's queue. When a
5503 message is frozen, Exim no longer continues to try to deliver it. Freezing
5504 occurs when a bounce message encounters a permanent failure because the sender
5505 address of the original message that caused the bounce is invalid, so the
5506 bounce cannot be delivered. This is probably the most common case, but there
5507 are also other conditions that cause freezing, and frozen messages are not
5508 always bounce messages.
5509 .code
5510 ignore_bounce_errors_after = 2d
5511 timeout_frozen_after = 7d
5512 .endd
5513 The first of these options specifies that failing bounce messages are to be
5514 discarded after 2 days on the queue. The second specifies that any frozen
5515 message (whether a bounce message or not) is to be timed out (and discarded)
5516 after a week. In this configuration, the first setting ensures that no failing
5517 bounce message ever lasts a week.
5518
5519
5520
5521 .section "ACL configuration" "SECID54"
5522 .cindex "default" "ACLs"
5523 .cindex "&ACL;" "default configuration"
5524 In the default configuration, the ACL section follows the main configuration.
5525 It starts with the line
5526 .code
5527 begin acl
5528 .endd
5529 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5530 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5531 and &%acl_smtp_data%& above.
5532
5533 .cindex "RCPT" "ACL for"
5534 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5535 RCPT command specifies one of the message's recipients. The ACL statements
5536 are considered in order, until the recipient address is either accepted or
5537 rejected. The RCPT command is then accepted or rejected, according to the
5538 result of the ACL processing.
5539 .code
5540 acl_check_rcpt:
5541 .endd
5542 This line, consisting of a name terminated by a colon, marks the start of the
5543 ACL, and names it.
5544 .code
5545 accept  hosts = :
5546 .endd
5547 This ACL statement accepts the recipient if the sending host matches the list.
5548 But what does that strange list mean? It doesn't actually contain any host
5549 names or IP addresses. The presence of the colon puts an empty item in the
5550 list; Exim matches this only if the incoming message did not come from a remote
5551 host, because in that case, the remote hostname is empty. The colon is
5552 important. Without it, the list itself is empty, and can never match anything.
5553
5554 What this statement is doing is to accept unconditionally all recipients in
5555 messages that are submitted by SMTP from local processes using the standard
5556 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5557 manner.
5558 .code
5559 deny    message       = Restricted characters in address
5560         domains       = +local_domains
5561         local_parts   = ^[.] : ^.*[@%!/|]
5562
5563 deny    message       = Restricted characters in address
5564         domains       = !+local_domains
5565         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5566 .endd
5567 These statements are concerned with local parts that contain any of the
5568 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5569 Although these characters are entirely legal in local parts (in the case of
5570 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5571 in Internet mail addresses.
5572
5573 The first three have in the past been associated with explicitly routed
5574 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5575 option). Addresses containing these characters are regularly tried by spammers
5576 in an attempt to bypass relaying restrictions, and also by open relay testing
5577 programs. Unless you really need them it is safest to reject these characters
5578 at this early stage. This configuration is heavy-handed in rejecting these
5579 characters for all messages it accepts from remote hosts. This is a deliberate
5580 policy of being as safe as possible.
5581
5582 The first rule above is stricter, and is applied to messages that are addressed
5583 to one of the local domains handled by this host. This is implemented by the
5584 first condition, which restricts it to domains that are listed in the
5585 &'local_domains'& domain list. The &"+"& character is used to indicate a
5586 reference to a named list. In this configuration, there is just one domain in
5587 &'local_domains'&, but in general there may be many.
5588
5589 The second condition on the first statement uses two regular expressions to
5590 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5591 or &"|"&. If you have local accounts that include these characters, you will
5592 have to modify this rule.
5593
5594 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5595 allows them because they have been encountered in practice. (Consider the
5596 common convention of local parts constructed as
5597 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5598 the author of Exim, who has no second initial.) However, a local part starting
5599 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5600 file name (for example, for a mailing list). This is also true for local parts
5601 that contain slashes. A pipe symbol can also be troublesome if the local part
5602 is incorporated unthinkingly into a shell command line.
5603
5604 The second rule above applies to all other domains, and is less strict. This
5605 allows your own users to send outgoing messages to sites that use slashes
5606 and vertical bars in their local parts. It blocks local parts that begin
5607 with a dot, slash, or vertical bar, but allows these characters within the
5608 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5609 and &"!"& is blocked, as before. The motivation here is to prevent your users
5610 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5611 .code
5612 accept  local_parts   = postmaster
5613         domains       = +local_domains
5614 .endd
5615 This statement, which has two conditions, accepts an incoming address if the
5616 local part is &'postmaster'& and the domain is one of those listed in the
5617 &'local_domains'& domain list. The &"+"& character is used to indicate a
5618 reference to a named list. In this configuration, there is just one domain in
5619 &'local_domains'&, but in general there may be many.
5620
5621 The presence of this statement means that mail to postmaster is never blocked
5622 by any of the subsequent tests. This can be helpful while sorting out problems
5623 in cases where the subsequent tests are incorrectly denying access.
5624 .code
5625 require verify        = sender
5626 .endd
5627 This statement requires the sender address to be verified before any subsequent
5628 ACL statement can be used. If verification fails, the incoming recipient
5629 address is refused. Verification consists of trying to route the address, to
5630 see if a bounce message could be delivered to it. In the case of remote
5631 addresses, basic verification checks only the domain, but &'callouts'& can be
5632 used for more verification if required. Section &<<SECTaddressverification>>&
5633 discusses the details of address verification.
5634 .code
5635 accept  hosts         = +relay_from_hosts
5636         control       = submission
5637 .endd
5638 This statement accepts the address if the message is coming from one of the
5639 hosts that are defined as being allowed to relay through this host. Recipient
5640 verification is omitted here, because in many cases the clients are dumb MUAs
5641 that do not cope well with SMTP error responses. For the same reason, the
5642 second line specifies &"submission mode"& for messages that are accepted. This
5643 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5644 messages that are deficient in some way, for example, because they lack a
5645 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5646 probably add recipient verification here, and disable submission mode.
5647 .code
5648 accept  authenticated = *
5649         control       = submission
5650 .endd
5651 This statement accepts the address if the client host has authenticated itself.
5652 Submission mode is again specified, on the grounds that such messages are most
5653 likely to come from MUAs. The default configuration does not define any
5654 authenticators, though it does include some nearly complete commented-out
5655 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5656 fact authenticate until you complete the authenticator definitions.
5657 .code
5658 require message = relay not permitted
5659         domains = +local_domains : +relay_domains
5660 .endd
5661 This statement rejects the address if its domain is neither a local domain nor
5662 one of the domains for which this host is a relay.
5663 .code
5664 require verify = recipient
5665 .endd
5666 This statement requires the recipient address to be verified; if verification
5667 fails, the address is rejected.
5668 .code
5669 # deny    message     = rejected because $sender_host_address \
5670 #                       is in a black list at $dnslist_domain\n\
5671 #                       $dnslist_text
5672 #         dnslists    = black.list.example
5673 #
5674 # warn    dnslists    = black.list.example
5675 #         add_header  = X-Warning: $sender_host_address is in \
5676 #                       a black list at $dnslist_domain
5677 #         log_message = found in $dnslist_domain
5678 .endd
5679 These commented-out lines are examples of how you could configure Exim to check
5680 sending hosts against a DNS black list. The first statement rejects messages
5681 from blacklisted hosts, whereas the second just inserts a warning header
5682 line.
5683 .code
5684 # require verify = csa
5685 .endd
5686 This commented-out line is an example of how you could turn on client SMTP
5687 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5688 records.
5689 .code
5690 accept
5691 .endd
5692 The final statement in the first ACL unconditionally accepts any recipient
5693 address that has successfully passed all the previous tests.
5694 .code
5695 acl_check_data:
5696 .endd
5697 This line marks the start of the second ACL, and names it. Most of the contents
5698 of this ACL are commented out:
5699 .code
5700 # deny    malware   = *
5701 #         message   = This message contains a virus \
5702 #                     ($malware_name).
5703 .endd
5704 These lines are examples of how to arrange for messages to be scanned for
5705 viruses when Exim has been compiled with the content-scanning extension, and a
5706 suitable virus scanner is installed. If the message is found to contain a
5707 virus, it is rejected with the given custom error message.
5708 .code
5709 # warn    spam      = nobody
5710 #         message   = X-Spam_score: $spam_score\n\
5711 #                     X-Spam_score_int: $spam_score_int\n\
5712 #                     X-Spam_bar: $spam_bar\n\
5713 #                     X-Spam_report: $spam_report
5714 .endd
5715 These lines are an example of how to arrange for messages to be scanned by
5716 SpamAssassin when Exim has been compiled with the content-scanning extension,
5717 and SpamAssassin has been installed. The SpamAssassin check is run with
5718 &`nobody`& as its user parameter, and the results are added to the message as a
5719 series of extra header line. In this case, the message is not rejected,
5720 whatever the spam score.
5721 .code
5722 accept
5723 .endd
5724 This final line in the DATA ACL accepts the message unconditionally.
5725
5726
5727 .section "Router configuration" "SECID55"
5728 .cindex "default" "routers"
5729 .cindex "routers" "default"
5730 The router configuration comes next in the default configuration, introduced
5731 by the line
5732 .code
5733 begin routers
5734 .endd
5735 Routers are the modules in Exim that make decisions about where to send
5736 messages. An address is passed to each router in turn, until it is either
5737 accepted, or failed. This means that the order in which you define the routers
5738 matters. Each router is fully described in its own chapter later in this
5739 manual. Here we give only brief overviews.
5740 .code
5741 # domain_literal:
5742 #   driver = ipliteral
5743 #   domains = !+local_domains
5744 #   transport = remote_smtp
5745 .endd
5746 .cindex "domain literal" "default router"
5747 This router is commented out because the majority of sites do not want to
5748 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5749 you uncomment this router, you also need to uncomment the setting of
5750 &%allow_domain_literals%& in the main part of the configuration.
5751 .code
5752 dnslookup:
5753   driver = dnslookup
5754   domains = ! +local_domains
5755   transport = remote_smtp
5756   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5757   no_more
5758 .endd
5759 The first uncommented router handles addresses that do not involve any local
5760 domains. This is specified by the line
5761 .code
5762 domains = ! +local_domains
5763 .endd
5764 The &%domains%& option lists the domains to which this router applies, but the
5765 exclamation mark is a negation sign, so the router is used only for domains
5766 that are not in the domain list called &'local_domains'& (which was defined at
5767 the start of the configuration). The plus sign before &'local_domains'&
5768 indicates that it is referring to a named list. Addresses in other domains are
5769 passed on to the following routers.
5770
5771 The name of the router driver is &(dnslookup)&,
5772 and is specified by the &%driver%& option. Do not be confused by the fact that
5773 the name of this router instance is the same as the name of the driver. The
5774 instance name is arbitrary, but the name set in the &%driver%& option must be
5775 one of the driver modules that is in the Exim binary.
5776
5777 The &(dnslookup)& router routes addresses by looking up their domains in the
5778 DNS in order to obtain a list of hosts to which the address is routed. If the
5779 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5780 specified by the &%transport%& option. If the router does not find the domain
5781 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5782 the address fails and is bounced.
5783
5784 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5785 be entirely ignored. This option is present because a number of cases have been
5786 encountered where MX records in the DNS point to host names
5787 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5788 Completely ignoring these IP addresses causes Exim to fail to route the
5789 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5790 continue to try to deliver the message periodically until the address timed
5791 out.
5792 .code
5793 system_aliases:
5794   driver = redirect
5795   allow_fail
5796   allow_defer
5797   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5798 # user = exim
5799   file_transport = address_file
5800   pipe_transport = address_pipe
5801 .endd
5802 Control reaches this and subsequent routers only for addresses in the local
5803 domains. This router checks to see whether the local part is defined as an
5804 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5805 data that it looks up from that file. If no data is found for the local part,
5806 the value of the &%data%& option is empty, causing the address to be passed to
5807 the next router.
5808
5809 &_/etc/aliases_& is a conventional name for the system aliases file that is
5810 often used. That is why it is referenced by from the default configuration
5811 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5812 &_Local/Makefile_& before building Exim.
5813 .code
5814 userforward:
5815   driver = redirect
5816   check_local_user
5817 # local_part_suffix = +* : -*
5818 # local_part_suffix_optional
5819   file = $home/.forward
5820 # allow_filter
5821   no_verify
5822   no_expn
5823   check_ancestor
5824   file_transport = address_file
5825   pipe_transport = address_pipe
5826   reply_transport = address_reply
5827 .endd
5828 This is the most complicated router in the default configuration. It is another
5829 redirection router, but this time it is looking for forwarding data set up by
5830 individual users. The &%check_local_user%& setting specifies a check that the
5831 local part of the address is the login name of a local user. If it is not, the
5832 router is skipped. The two commented options that follow &%check_local_user%&,
5833 namely:
5834 .code
5835 # local_part_suffix = +* : -*
5836 # local_part_suffix_optional
5837 .endd
5838 .vindex "&$local_part_suffix$&"
5839 show how you can specify the recognition of local part suffixes. If the first
5840 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5841 by any sequence of characters, is removed from the local part and placed in the
5842 variable &$local_part_suffix$&. The second suffix option specifies that the
5843 presence of a suffix in the local part is optional. When a suffix is present,
5844 the check for a local login uses the local part with the suffix removed.
5845
5846 When a local user account is found, the file called &_.forward_& in the user's
5847 home directory is consulted. If it does not exist, or is empty, the router
5848 declines. Otherwise, the contents of &_.forward_& are interpreted as
5849 redirection data (see chapter &<<CHAPredirect>>& for more details).
5850
5851 .cindex "Sieve filter" "enabling in default router"
5852 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5853 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5854 is commented out by default), the contents of the file are interpreted as a set
5855 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5856 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5857 separate document entitled &'Exim's interfaces to mail filtering'&.
5858
5859 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5860 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5861 There are two reasons for doing this:
5862
5863 .olist
5864 Whether or not a local user has a &_.forward_& file is not really relevant when
5865 checking an address for validity; it makes sense not to waste resources doing
5866 unnecessary work.
5867 .next
5868 More importantly, when Exim is verifying addresses or handling an EXPN
5869 command during an SMTP session, it is running as the Exim user, not as root.
5870 The group is the Exim group, and no additional groups are set up.
5871 It may therefore not be possible for Exim to read users' &_.forward_& files at
5872 this time.
5873 .endlist
5874
5875 The setting of &%check_ancestor%& prevents the router from generating a new
5876 address that is the same as any previous address that was redirected. (This
5877 works round a problem concerning a bad interaction between aliasing and
5878 forwarding &-- see section &<<SECTredlocmai>>&).
5879
5880 The final three option settings specify the transports that are to be used when
5881 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5882 auto-reply, respectively. For example, if a &_.forward_& file contains
5883 .code
5884 a.nother@elsewhere.example, /home/spqr/archive
5885 .endd
5886 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5887 transport.
5888 .code
5889 localuser:
5890   driver = accept
5891   check_local_user
5892 # local_part_suffix = +* : -*
5893 # local_part_suffix_optional
5894   transport = local_delivery
5895 .endd
5896 The final router sets up delivery into local mailboxes, provided that the local
5897 part is the name of a local login, by accepting the address and assigning it to
5898 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5899 routers, so the address is bounced. The commented suffix settings fulfil the
5900 same purpose as they do for the &(userforward)& router.
5901
5902
5903 .section "Transport configuration" "SECID56"
5904 .cindex "default" "transports"
5905 .cindex "transports" "default"
5906 Transports define mechanisms for actually delivering messages. They operate
5907 only when referenced from routers, so the order in which they are defined does
5908 not matter. The transports section of the configuration starts with
5909 .code
5910 begin transports
5911 .endd
5912 One remote transport and four local transports are defined.
5913 .code
5914 remote_smtp:
5915   driver = smtp
5916 .endd
5917 This transport is used for delivering messages over SMTP connections. All its
5918 options are defaulted. The list of remote hosts comes from the router.
5919 .code
5920 local_delivery:
5921   driver = appendfile
5922   file = /var/mail/$local_part
5923   delivery_date_add
5924   envelope_to_add
5925   return_path_add
5926 # group = mail
5927 # mode = 0660
5928 .endd
5929 This &(appendfile)& transport is used for local delivery to user mailboxes in
5930 traditional BSD mailbox format. By default it runs under the uid and gid of the
5931 local user, which requires the sticky bit to be set on the &_/var/mail_&
5932 directory. Some systems use the alternative approach of running mail deliveries
5933 under a particular group instead of using the sticky bit. The commented options
5934 show how this can be done.
5935
5936 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5937 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5938 similarly-named options above.
5939 .code
5940 address_pipe:
5941   driver = pipe
5942   return_output
5943 .endd
5944 This transport is used for handling deliveries to pipes that are generated by
5945 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5946 option specifies that any output generated by the pipe is to be returned to the
5947 sender.
5948 .code
5949 address_file:
5950   driver = appendfile
5951   delivery_date_add
5952   envelope_to_add
5953   return_path_add
5954 .endd
5955 This transport is used for handling deliveries to files that are generated by
5956 redirection. The name of the file is not specified in this instance of
5957 &(appendfile)&, because it comes from the &(redirect)& router.
5958 .code
5959 address_reply:
5960   driver = autoreply
5961 .endd
5962 This transport is used for handling automatic replies generated by users'
5963 filter files.
5964
5965
5966
5967 .section "Default retry rule" "SECID57"
5968 .cindex "retry" "default rule"
5969 .cindex "default" "retry rule"
5970 The retry section of the configuration file contains rules which affect the way
5971 Exim retries deliveries that cannot be completed at the first attempt. It is
5972 introduced by the line
5973 .code
5974 begin retry
5975 .endd
5976 In the default configuration, there is just one rule, which applies to all
5977 errors:
5978 .code
5979 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5980 .endd
5981 This causes any temporarily failing address to be retried every 15 minutes for
5982 2 hours, then at intervals starting at one hour and increasing by a factor of
5983 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5984 is not delivered after 4 days of temporary failure, it is bounced.
5985
5986 If the retry section is removed from the configuration, or is empty (that is,
5987 if no retry rules are defined), Exim will not retry deliveries. This turns
5988 temporary errors into permanent errors.
5989
5990
5991 .section "Rewriting configuration" "SECID58"
5992 The rewriting section of the configuration, introduced by
5993 .code
5994 begin rewrite
5995 .endd
5996 contains rules for rewriting addresses in messages as they arrive. There are no
5997 rewriting rules in the default configuration file.
5998
5999
6000
6001 .section "Authenticators configuration" "SECTdefconfauth"
6002 .cindex "AUTH" "configuration"
6003 The authenticators section of the configuration, introduced by
6004 .code
6005 begin authenticators
6006 .endd
6007 defines mechanisms for the use of the SMTP AUTH command. The default
6008 configuration file contains two commented-out example authenticators
6009 which support plaintext username/password authentication using the
6010 standard PLAIN mechanism and the traditional but non-standard LOGIN
6011 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6012 to support most MUA software.
6013
6014 The example PLAIN authenticator looks like this:
6015 .code
6016 #PLAIN:
6017 #  driver                  = plaintext
6018 #  server_set_id           = $auth2
6019 #  server_prompts          = :
6020 #  server_condition        = Authentication is not yet configured
6021 #  server_advertise_condition = ${if def:tls_cipher }
6022 .endd
6023 And the example LOGIN authenticator looks like this:
6024 .code
6025 #LOGIN:
6026 #  driver                  = plaintext
6027 #  server_set_id           = $auth1
6028 #  server_prompts          = <| Username: | Password:
6029 #  server_condition        = Authentication is not yet configured
6030 #  server_advertise_condition = ${if def:tls_cipher }
6031 .endd
6032
6033 The &%server_set_id%& option makes Exim remember the authenticated username
6034 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6035 &%server_prompts%& option configures the &(plaintext)& authenticator so
6036 that it implements the details of the specific authentication mechanism,
6037 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6038 when Exim offers authentication to clients; in the examples, this is only
6039 when TLS or SSL has been started, so to enable the authenticators you also
6040 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6041
6042 The &%server_condition%& setting defines how to verify that the username and
6043 password are correct. In the examples it just produces an error message.
6044 To make the authenticators work, you can use a string expansion
6045 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6046
6047 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6048 usercode and password are in different positions.
6049 Chapter &<<CHAPplaintext>>& covers both.
6050
6051 .ecindex IIDconfiwal
6052
6053
6054
6055 . ////////////////////////////////////////////////////////////////////////////
6056 . ////////////////////////////////////////////////////////////////////////////
6057
6058 .chapter "Regular expressions" "CHAPregexp"
6059
6060 .cindex "regular expressions" "library"
6061 .cindex "PCRE"
6062 Exim supports the use of regular expressions in many of its options. It
6063 uses the PCRE regular expression library; this provides regular expression
6064 matching that is compatible with Perl 5. The syntax and semantics of
6065 regular expressions is discussed in many Perl reference books, and also in
6066 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6067 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6068
6069 The documentation for the syntax and semantics of the regular expressions that
6070 are supported by PCRE is included in the PCRE distribution, and no further
6071 description is included here. The PCRE functions are called from Exim using
6072 the default option settings (that is, with no PCRE options set), except that
6073 the PCRE_CASELESS option is set when the matching is required to be
6074 case-insensitive.
6075
6076 In most cases, when a regular expression is required in an Exim configuration,
6077 it has to start with a circumflex, in order to distinguish it from plain text
6078 or an &"ends with"& wildcard. In this example of a configuration setting, the
6079 second item in the colon-separated list is a regular expression.
6080 .code
6081 domains = a.b.c : ^\\d{3} : *.y.z : ...
6082 .endd
6083 The doubling of the backslash is required because of string expansion that
6084 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6085 of this issue, and a way of avoiding the need for doubling backslashes. The
6086 regular expression that is eventually used in this example contains just one
6087 backslash. The circumflex is included in the regular expression, and has the
6088 normal effect of &"anchoring"& it to the start of the string that is being
6089 matched.
6090
6091 There are, however, two cases where a circumflex is not required for the
6092 recognition of a regular expression: these are the &%match%& condition in a
6093 string expansion, and the &%matches%& condition in an Exim filter file. In
6094 these cases, the relevant string is always treated as a regular expression; if
6095 it does not start with a circumflex, the expression is not anchored, and can
6096 match anywhere in the subject string.
6097
6098 In all cases, if you want a regular expression to match at the end of a string,
6099 you must code the $ metacharacter to indicate this. For example:
6100 .code
6101 domains = ^\\d{3}\\.example
6102 .endd
6103 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6104 You need to use:
6105 .code
6106 domains = ^\\d{3}\\.example\$
6107 .endd
6108 if you want &'example'& to be the top-level domain. The backslash before the
6109 $ is needed because string expansion also interprets dollar characters.
6110
6111
6112
6113 . ////////////////////////////////////////////////////////////////////////////
6114 . ////////////////////////////////////////////////////////////////////////////
6115
6116 .chapter "File and database lookups" "CHAPfdlookup"
6117 .scindex IIDfidalo1 "file" "lookups"
6118 .scindex IIDfidalo2 "database" "lookups"
6119 .cindex "lookup" "description of"
6120 Exim can be configured to look up data in files or databases as it processes
6121 messages. Two different kinds of syntax are used:
6122
6123 .olist
6124 A string that is to be expanded may contain explicit lookup requests. These
6125 cause parts of the string to be replaced by data that is obtained from the
6126 lookup. Lookups of this type are conditional expansion items. Different results
6127 can be defined for the cases of lookup success and failure. See chapter
6128 &<<CHAPexpand>>&, where string expansions are described in detail.
6129 .next
6130 Lists of domains, hosts, and email addresses can contain lookup requests as a
6131 way of avoiding excessively long linear lists. In this case, the data that is
6132 returned by the lookup is often (but not always) discarded; whether the lookup
6133 succeeds or fails is what really counts. These kinds of list are described in
6134 chapter &<<CHAPdomhosaddlists>>&.
6135 .endlist
6136
6137 String expansions, lists, and lookups interact with each other in such a way
6138 that there is no order in which to describe any one of them that does not
6139 involve references to the others. Each of these three chapters makes more sense
6140 if you have read the other two first. If you are reading this for the first
6141 time, be aware that some of it will make a lot more sense after you have read
6142 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6143
6144 .section "Examples of different lookup syntax" "SECID60"
6145 It is easy to confuse the two different kinds of lookup, especially as the
6146 lists that may contain the second kind are always expanded before being
6147 processed as lists. Therefore, they may also contain lookups of the first kind.
6148 Be careful to distinguish between the following two examples:
6149 .code
6150 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6151 domains = lsearch;/some/file
6152 .endd
6153 The first uses a string expansion, the result of which must be a domain list.
6154 No strings have been specified for a successful or a failing lookup; the
6155 defaults in this case are the looked-up data and an empty string, respectively.
6156 The expansion takes place before the string is processed as a list, and the
6157 file that is searched could contain lines like this:
6158 .code
6159 192.168.3.4: domain1:domain2:...
6160 192.168.1.9: domain3:domain4:...
6161 .endd
6162 When the lookup succeeds, the result of the expansion is a list of domains (and
6163 possibly other types of item that are allowed in domain lists).
6164
6165 In the second example, the lookup is a single item in a domain list. It causes
6166 Exim to use a lookup to see if the domain that is being processed can be found
6167 in the file. The file could contains lines like this:
6168 .code
6169 domain1:
6170 domain2:
6171 .endd
6172 Any data that follows the keys is not relevant when checking that the domain
6173 matches the list item.
6174
6175 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6176 Consider a file containing lines like this:
6177 .code
6178 192.168.5.6: lsearch;/another/file
6179 .endd
6180 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6181 first &%domains%& setting above generates the second setting, which therefore
6182 causes a second lookup to occur.
6183
6184 The rest of this chapter describes the different lookup types that are
6185 available. Any of them can be used in any part of the configuration where a
6186 lookup is permitted.
6187
6188
6189 .section "Lookup types" "SECID61"
6190 .cindex "lookup" "types of"
6191 .cindex "single-key lookup" "definition of"
6192 Two different types of data lookup are implemented:
6193
6194 .ilist
6195 The &'single-key'& type requires the specification of a file in which to look,
6196 and a single key to search for. The key must be a non-empty string for the
6197 lookup to succeed. The lookup type determines how the file is searched.
6198 .next
6199 .cindex "query-style lookup" "definition of"
6200 The &'query-style'& type accepts a generalized database query. No particular
6201 key value is assumed by Exim for query-style lookups. You can use whichever
6202 Exim variables you need to construct the database query.
6203 .endlist
6204
6205 The code for each lookup type is in a separate source file that is included in
6206 the binary of Exim only if the corresponding compile-time option is set. The
6207 default settings in &_src/EDITME_& are:
6208 .code
6209 LOOKUP_DBM=yes
6210 LOOKUP_LSEARCH=yes
6211 .endd
6212 which means that only linear searching and DBM lookups are included by default.
6213 For some types of lookup (e.g. SQL databases), you need to install appropriate
6214 libraries and header files before building Exim.
6215
6216
6217
6218
6219 .section "Single-key lookup types" "SECTsinglekeylookups"
6220 .cindex "lookup" "single-key types"
6221 .cindex "single-key lookup" "list of types"
6222 The following single-key lookup types are implemented:
6223
6224 .ilist
6225 .cindex "cdb" "description of"
6226 .cindex "lookup" "cdb"
6227 .cindex "binary zero" "in lookup key"
6228 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6229 string without a terminating binary zero. The cdb format is designed for
6230 indexed files that are read frequently and never updated, except by total
6231 re-creation. As such, it is particularly suitable for large files containing
6232 aliases or other indexed data referenced by an MTA. Information about cdb can
6233 be found in several places:
6234 .display
6235 &url(http://www.pobox.com/~djb/cdb.html)
6236 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6237 &url(http://packages.debian.org/stable/utils/freecdb.html)
6238 .endd
6239 A cdb distribution is not needed in order to build Exim with cdb support,
6240 because the code for reading cdb files is included directly in Exim itself.
6241 However, no means of building or testing cdb files is provided with Exim, so
6242 you need to obtain a cdb distribution in order to do this.
6243 .next
6244 .cindex "DBM" "lookup type"
6245 .cindex "lookup" "dbm"
6246 .cindex "binary zero" "in lookup key"
6247 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6248 DBM file by looking up the record with the given key. A terminating binary
6249 zero is included in the key that is passed to the DBM library. See section
6250 &<<SECTdb>>& for a discussion of DBM libraries.
6251
6252 .cindex "Berkeley DB library" "file format"
6253 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6254 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6255 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6256 the DB_UNKNOWN option. This enables it to handle any of the types of database
6257 that the library supports, and can be useful for accessing DBM files created by
6258 other applications. (For earlier DB versions, DB_HASH is always used.)
6259 .next
6260 .cindex "lookup" "dbmjz"
6261 .cindex "lookup" "dbm &-- embedded NULs"
6262 .cindex "sasldb2"
6263 .cindex "dbmjz lookup type"
6264 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6265 interpreted as an Exim list; the elements of the list are joined together with
6266 ASCII NUL characters to form the lookup key.  An example usage would be to
6267 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6268 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6269 &(cram_md5)& authenticator.
6270 .next
6271 .cindex "lookup" "dbmnz"
6272 .cindex "lookup" "dbm &-- terminating zero"
6273 .cindex "binary zero" "in lookup key"
6274 .cindex "Courier"
6275 .cindex "&_/etc/userdbshadow.dat_&"
6276 .cindex "dbmnz lookup type"
6277 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6278 is not included in the key that is passed to the DBM library. You may need this
6279 if you want to look up data in files that are created by or shared with some
6280 other application that does not use terminating zeros. For example, you need to
6281 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6282 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6283 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6284 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6285 .next
6286 .cindex "lookup" "dsearch"
6287 .cindex "dsearch lookup type"
6288 &(dsearch)&: The given file must be a directory; this is searched for an entry
6289 whose name is the key by calling the &[lstat()]& function. The key may not
6290 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6291 the lookup is the name of the entry, which may be a file, directory,
6292 symbolic link, or any other kind of directory entry. An example of how this
6293 lookup can be used to support virtual domains is given in section
6294 &<<SECTvirtualdomains>>&.
6295 .next
6296 .cindex "lookup" "iplsearch"
6297 .cindex "iplsearch lookup type"
6298 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6299 terminated by a colon or white space or the end of the line. The keys in the
6300 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6301 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6302 being interpreted as a key terminator. For example:
6303 .code
6304 1.2.3.4:           data for 1.2.3.4
6305 192.168.0.0/16:    data for 192.168.0.0/16
6306 "abcd::cdab":      data for abcd::cdab
6307 "abcd:abcd::/32"   data for abcd:abcd::/32
6308 .endd
6309 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6310 file is searched linearly, using the CIDR masks where present, until a matching
6311 key is found. The first key that matches is used; there is no attempt to find a
6312 &"best"& match. Apart from the way the keys are matched, the processing for
6313 &(iplsearch)& is the same as for &(lsearch)&.
6314
6315 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6316 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6317 lookup types support only literal keys.
6318
6319 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6320 the implicit key is the host's IP address rather than its name (see section
6321 &<<SECThoslispatsikey>>&).
6322 .next
6323 .cindex "linear search"
6324 .cindex "lookup" "lsearch"
6325 .cindex "lsearch lookup type"
6326 .cindex "case sensitivity" "in lsearch lookup"
6327 &(lsearch)&: The given file is a text file that is searched linearly for a
6328 line beginning with the search key, terminated by a colon or white space or the
6329 end of the line. The search is case-insensitive; that is, upper and lower case
6330 letters are treated as the same. The first occurrence of the key that is found
6331 in the file is used.
6332
6333 White space between the key and the colon is permitted. The remainder of the
6334 line, with leading and trailing white space removed, is the data. This can be
6335 continued onto subsequent lines by starting them with any amount of white
6336 space, but only a single space character is included in the data at such a
6337 junction. If the data begins with a colon, the key must be terminated by a
6338 colon, for example:
6339 .code
6340 baduser:  :fail:
6341 .endd
6342 Empty lines and lines beginning with # are ignored, even if they occur in the
6343 middle of an item. This is the traditional textual format of alias files. Note
6344 that the keys in an &(lsearch)& file are literal strings. There is no
6345 wildcarding of any kind.
6346
6347 .cindex "lookup" "lsearch &-- colons in keys"
6348 .cindex "white space" "in lsearch key"
6349 In most &(lsearch)& files, keys are not required to contain colons or #
6350 characters, or white space. However, if you need this feature, it is available.
6351 If a key begins with a doublequote character, it is terminated only by a
6352 matching quote (or end of line), and the normal escaping rules apply to its
6353 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6354 quoted keys (exactly as for unquoted keys). There is no special handling of
6355 quotes for the data part of an &(lsearch)& line.
6356
6357 .next
6358 .cindex "NIS lookup type"
6359 .cindex "lookup" "NIS"
6360 .cindex "binary zero" "in lookup key"
6361 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6362 the given key, without a terminating binary zero. There is a variant called
6363 &(nis0)& which does include the terminating binary zero in the key. This is
6364 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6365 aliases; the full map names must be used.
6366
6367 .next
6368 .cindex "wildlsearch lookup type"
6369 .cindex "lookup" "wildlsearch"
6370 .cindex "nwildlsearch lookup type"
6371 .cindex "lookup" "nwildlsearch"
6372 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6373 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6374 the file may be wildcarded. The difference between these two lookup types is
6375 that for &(wildlsearch)&, each key in the file is string-expanded before being
6376 used, whereas for &(nwildlsearch)&, no expansion takes place.
6377
6378 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6379 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6380 file that are regular expressions can be made case-sensitive by the use of
6381 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6382
6383 . ==== As this is a nested list, any displays it contains must be indented
6384 . ==== as otherwise they are too far to the left.
6385
6386 .olist
6387 The string may begin with an asterisk to mean &"ends with"&. For example:
6388 .code
6389     *.a.b.c       data for anything.a.b.c
6390     *fish         data for anythingfish
6391 .endd
6392 .next
6393 The string may begin with a circumflex to indicate a regular expression. For
6394 example, for &(wildlsearch)&:
6395 .code
6396     ^\N\d+\.a\.b\N    data for <digits>.a.b
6397 .endd
6398 Note the use of &`\N`& to disable expansion of the contents of the regular
6399 expression. If you are using &(nwildlsearch)&, where the keys are not
6400 string-expanded, the equivalent entry is:
6401 .code
6402     ^\d+\.a\.b        data for <digits>.a.b
6403 .endd
6404 The case-insensitive flag is set at the start of compiling the regular
6405 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6406 For example, to make the entire pattern case-sensitive:
6407 .code
6408     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6409 .endd
6410
6411 If the regular expression contains white space or colon characters, you must
6412 either quote it (see &(lsearch)& above), or represent these characters in other
6413 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6414 colon. This may be easier than quoting, because if you quote, you have to
6415 escape all the backslashes inside the quotes.
6416
6417 &*Note*&: It is not possible to capture substrings in a regular expression
6418 match for later use, because the results of all lookups are cached. If a lookup
6419 is repeated, the result is taken from the cache, and no actual pattern matching
6420 takes place. The values of all the numeric variables are unset after a
6421 &((n)wildlsearch)& match.
6422
6423 .next
6424 Although I cannot see it being of much use, the general matching function that
6425 is used to implement &((n)wildlsearch)& means that the string may begin with a
6426 lookup name terminated by a semicolon, and followed by lookup data. For
6427 example:
6428 .code
6429     cdb;/some/file  data for keys that match the file
6430 .endd
6431 The data that is obtained from the nested lookup is discarded.
6432 .endlist olist
6433
6434 Keys that do not match any of these patterns are interpreted literally. The
6435 continuation rules for the data are the same as for &(lsearch)&, and keys may
6436 be followed by optional colons.
6437
6438 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6439 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6440 lookup types support only literal keys.
6441 .endlist ilist
6442
6443
6444 .section "Query-style lookup types" "SECID62"
6445 .cindex "lookup" "query-style types"
6446 .cindex "query-style lookup" "list of types"
6447 The supported query-style lookup types are listed below. Further details about
6448 many of them are given in later sections.
6449
6450 .ilist
6451 .cindex "DNS" "as a lookup type"
6452 .cindex "lookup" "DNS"
6453 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6454 are given in the supplied query. The resulting data is the contents of the
6455 records. See section &<<SECTdnsdb>>&.
6456 .next
6457 .cindex "InterBase lookup type"
6458 .cindex "lookup" "InterBase"
6459 &(ibase)&: This does a lookup in an InterBase database.
6460 .next
6461 .cindex "LDAP" "lookup type"
6462 .cindex "lookup" "LDAP"
6463 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6464 returns attributes from a single entry. There is a variant called &(ldapm)&
6465 that permits values from multiple entries to be returned. A third variant
6466 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6467 any attribute values. See section &<<SECTldap>>&.
6468 .next
6469 .cindex "MySQL" "lookup type"
6470 .cindex "lookup" "MySQL"
6471 &(mysql)&: The format of the query is an SQL statement that is passed to a
6472 MySQL database. See section &<<SECTsql>>&.
6473 .next
6474 .cindex "NIS+ lookup type"
6475 .cindex "lookup" "NIS+"
6476 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6477 the field to be returned. See section &<<SECTnisplus>>&.
6478 .next
6479 .cindex "Oracle" "lookup type"
6480 .cindex "lookup" "Oracle"
6481 &(oracle)&: The format of the query is an SQL statement that is passed to an
6482 Oracle database. See section &<<SECTsql>>&.
6483 .next
6484 .cindex "lookup" "passwd"
6485 .cindex "passwd lookup type"
6486 .cindex "&_/etc/passwd_&"
6487 &(passwd)& is a query-style lookup with queries that are just user names. The
6488 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6489 success, the result string is the same as you would get from an &(lsearch)&
6490 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6491 password value. For example:
6492 .code
6493 *:42:42:King Rat:/home/kr:/bin/bash
6494 .endd
6495 .next
6496 .cindex "PostgreSQL lookup type"
6497 .cindex "lookup" "PostgreSQL"
6498 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6499 PostgreSQL database. See section &<<SECTsql>>&.
6500
6501 .next
6502 .cindex "sqlite lookup type"
6503 .cindex "lookup" "sqlite"
6504 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6505 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6506
6507 .next
6508 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6509 not likely to be useful in normal operation.
6510 .next
6511 .cindex "whoson lookup type"
6512 .cindex "lookup" "whoson"
6513 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6514 allows a server to check whether a particular (dynamically allocated) IP
6515 address is currently allocated to a known (trusted) user and, optionally, to
6516 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6517 at one time for &"POP before SMTP"& authentication, but that approach has been
6518 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6519 &"POP before SMTP"& checking using ACL statements such as
6520 .code
6521 require condition = \
6522   ${lookup whoson {$sender_host_address}{yes}{no}}
6523 .endd
6524 The query consists of a single IP address. The value returned is the name of
6525 the authenticated user, which is stored in the variable &$value$&. However, in
6526 this example, the data in &$value$& is not used; the result of the lookup is
6527 one of the fixed strings &"yes"& or &"no"&.
6528 .endlist
6529
6530
6531
6532 .section "Temporary errors in lookups" "SECID63"
6533 .cindex "lookup" "temporary error in"
6534 Lookup functions can return temporary error codes if the lookup cannot be
6535 completed. For example, an SQL or LDAP database might be unavailable. For this
6536 reason, it is not advisable to use a lookup that might do this for critical
6537 options such as a list of local domains.
6538
6539 When a lookup cannot be completed in a router or transport, delivery
6540 of the message (to the relevant address) is deferred, as for any other
6541 temporary error. In other circumstances Exim may assume the lookup has failed,
6542 or may give up altogether.
6543
6544
6545
6546 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6547 .cindex "wildcard lookups"
6548 .cindex "lookup" "default values"
6549 .cindex "lookup" "wildcard"
6550 .cindex "lookup" "* added to type"
6551 .cindex "default" "in single-key lookups"
6552 In this context, a &"default value"& is a value specified by the administrator
6553 that is to be used if a lookup fails.
6554
6555 &*Note:*& This section applies only to single-key lookups. For query-style
6556 lookups, the facilities of the query language must be used. An attempt to
6557 specify a default for a query-style lookup provokes an error.
6558
6559 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6560 and the initial lookup fails, the key &"*"& is looked up in the file to
6561 provide a default value. See also the section on partial matching below.
6562
6563 .cindex "*@ with single-key lookup"
6564 .cindex "lookup" "*@ added to type"
6565 .cindex "alias file" "per-domain default"
6566 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6567 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6568 character, a second lookup is done with everything before the last @ replaced
6569 by *. This makes it possible to provide per-domain defaults in alias files
6570 that include the domains in the keys. If the second lookup fails (or doesn't
6571 take place because there is no @ in the key), &"*"& is looked up.
6572 For example, a &(redirect)& router might contain:
6573 .code
6574 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6575 .endd
6576 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6577 looks up these keys, in this order:
6578 .code
6579 jane@eyre.example
6580 *@eyre.example
6581 *
6582 .endd
6583 The data is taken from whichever key it finds first. &*Note*&: In an
6584 &(lsearch)& file, this does not mean the first of these keys in the file. A
6585 complete scan is done for each key, and only if it is not found at all does
6586 Exim move on to try the next key.
6587
6588
6589
6590 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6591 .cindex "partial matching"
6592 .cindex "wildcard lookups"
6593 .cindex "lookup" "partial matching"
6594 .cindex "lookup" "wildcard"
6595 .cindex "asterisk" "in search type"
6596 The normal operation of a single-key lookup is to search the file for an exact
6597 match with the given key. However, in a number of situations where domains are
6598 being looked up, it is useful to be able to do partial matching. In this case,
6599 information in the file that has a key starting with &"*."& is matched by any
6600 domain that ends with the components that follow the full stop. For example, if
6601 a key in a DBM file is
6602 .code
6603 *.dates.fict.example
6604 .endd
6605 then when partial matching is enabled this is matched by (amongst others)
6606 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6607 by &'dates.fict.example'&, if that does not appear as a separate key in the
6608 file.
6609
6610 &*Note*&: Partial matching is not available for query-style lookups. It is
6611 also not available for any lookup items in address lists (see section
6612 &<<SECTaddresslist>>&).
6613
6614 Partial matching is implemented by doing a series of separate lookups using
6615 keys constructed by modifying the original subject key. This means that it can
6616 be used with any of the single-key lookup types, provided that
6617 partial matching keys
6618 beginning with a special prefix (default &"*."&) are included in the data file.
6619 Keys in the file that do not begin with the prefix are matched only by
6620 unmodified subject keys when partial matching is in use.
6621
6622 Partial matching is requested by adding the string &"partial-"& to the front of
6623 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6624 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6625 is added at the start of the subject key, and it is looked up again. If that
6626 fails, further lookups are tried with dot-separated components removed from the
6627 start of the subject key, one-by-one, and &"*."& added on the front of what
6628 remains.
6629
6630 A minimum number of two non-* components are required. This can be adjusted
6631 by including a number before the hyphen in the search type. For example,
6632 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6633 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6634 subject key is &'2250.dates.fict.example'& then the following keys are looked
6635 up when the minimum number of non-* components is two:
6636 .code
6637 2250.dates.fict.example
6638 *.2250.dates.fict.example
6639 *.dates.fict.example
6640 *.fict.example
6641 .endd
6642 As soon as one key in the sequence is successfully looked up, the lookup
6643 finishes.
6644
6645 .cindex "lookup" "partial matching &-- changing prefix"
6646 .cindex "prefix" "for partial matching"
6647 The use of &"*."& as the partial matching prefix is a default that can be
6648 changed. The motivation for this feature is to allow Exim to operate with file
6649 formats that are used by other MTAs. A different prefix can be supplied in
6650 parentheses instead of the hyphen after &"partial"&. For example:
6651 .code
6652 domains = partial(.)lsearch;/some/file
6653 .endd
6654 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6655 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6656 components is unchanged). The prefix may consist of any punctuation characters
6657 other than a closing parenthesis. It may be empty, for example:
6658 .code
6659 domains = partial1()cdb;/some/file
6660 .endd
6661 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6662 &`a.b.c`&, &`b.c`&, and &`c`&.
6663
6664 If &"partial0"& is specified, what happens at the end (when the lookup with
6665 just one non-wild component has failed, and the original key is shortened right
6666 down to the null string) depends on the prefix:
6667
6668 .ilist
6669 If the prefix has zero length, the whole lookup fails.
6670 .next
6671 If the prefix has length 1, a lookup for just the prefix is done. For
6672 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6673 .next
6674 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6675 remainder is looked up. With the default prefix, therefore, the final lookup is
6676 for &"*"& on its own.
6677 .next
6678 Otherwise, the whole prefix is looked up.
6679 .endlist
6680
6681
6682 If the search type ends in &"*"& or &"*@"& (see section
6683 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6684 this implies happens after all partial lookups have failed. If &"partial0"& is
6685 specified, adding &"*"& to the search type has no effect with the default
6686 prefix, because the &"*"& key is already included in the sequence of partial
6687 lookups. However, there might be a use for lookup types such as
6688 &"partial0(.)lsearch*"&.
6689
6690 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6691 in domain lists and the like. Partial matching works only in terms of
6692 dot-separated components; a key such as &`*fict.example`&
6693 in a database file is useless, because the asterisk in a partial matching
6694 subject key is always followed by a dot.
6695
6696
6697
6698
6699 .section "Lookup caching" "SECID64"
6700 .cindex "lookup" "caching"
6701 .cindex "caching" "lookup data"
6702 Exim caches all lookup results in order to avoid needless repetition of
6703 lookups. However, because (apart from the daemon) Exim operates as a collection
6704 of independent, short-lived processes, this caching applies only within a
6705 single Exim process. There is no inter-process lookup caching facility.
6706
6707 For single-key lookups, Exim keeps the relevant files open in case there is
6708 another lookup that needs them. In some types of configuration this can lead to
6709 many files being kept open for messages with many recipients. To avoid hitting
6710 the operating system limit on the number of simultaneously open files, Exim
6711 closes the least recently used file when it needs to open more files than its
6712 own internal limit, which can be changed via the &%lookup_open_max%& option.
6713
6714 The single-key lookup files are closed and the lookup caches are flushed at
6715 strategic points during delivery &-- for example, after all routing is
6716 complete.
6717
6718
6719
6720
6721 .section "Quoting lookup data" "SECID65"
6722 .cindex "lookup" "quoting"
6723 .cindex "quoting" "in lookups"
6724 When data from an incoming message is included in a query-style lookup, there
6725 is the possibility of special characters in the data messing up the syntax of
6726 the query. For example, a NIS+ query that contains
6727 .code
6728 [name=$local_part]
6729 .endd
6730 will be broken if the local part happens to contain a closing square bracket.
6731 For NIS+, data can be enclosed in double quotes like this:
6732 .code
6733 [name="$local_part"]
6734 .endd
6735 but this still leaves the problem of a double quote in the data. The rule for
6736 NIS+ is that double quotes must be doubled. Other lookup types have different
6737 rules, and to cope with the differing requirements, an expansion operator
6738 of the following form is provided:
6739 .code
6740 ${quote_<lookup-type>:<string>}
6741 .endd
6742 For example, the safest way to write the NIS+ query is
6743 .code
6744 [name="${quote_nisplus:$local_part}"]
6745 .endd
6746 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6747 operator can be used for all lookup types, but has no effect for single-key
6748 lookups, since no quoting is ever needed in their key strings.
6749
6750
6751
6752
6753 .section "More about dnsdb" "SECTdnsdb"
6754 .cindex "dnsdb lookup"
6755 .cindex "lookup" "dnsdb"
6756 .cindex "DNS" "as a lookup type"
6757 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6758 of a record type and a domain name, separated by an equals sign. For example,
6759 an expansion string could contain:
6760 .code
6761 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6762 .endd
6763 If the lookup succeeds, the result is placed in &$value$&, which in this case
6764 is used on its own as the result. If the lookup does not succeed, the
6765 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6766 &<<SECTforexpfai>>& for an explanation of what this means.
6767
6768 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6769 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6770 configured). If no type is given, TXT is assumed. When the type is PTR,
6771 the data can be an IP address, written as normal; inversion and the addition of
6772 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6773 .code
6774 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6775 .endd
6776 If the data for a PTR record is not a syntactically valid IP address, it is not
6777 altered and nothing is added.
6778
6779 .cindex "MX record" "in &(dnsdb)& lookup"
6780 .cindex "SRV record" "in &(dnsdb)& lookup"
6781 For an MX lookup, both the preference value and the host name are returned for
6782 each record, separated by a space. For an SRV lookup, the priority, weight,
6783 port, and host name are returned for each record, separated by spaces.
6784
6785 For any record type, if multiple records are found (or, for A6 lookups, if a
6786 single record leads to multiple addresses), the data is returned as a
6787 concatenation, with newline as the default separator. The order, of course,
6788 depends on the DNS resolver. You can specify a different separator character
6789 between multiple records by putting a right angle-bracket followed immediately
6790 by the new separator at the start of the query. For example:
6791 .code
6792 ${lookup dnsdb{>: a=host1.example}}
6793 .endd
6794 It is permitted to specify a space as the separator character. Further
6795 white space is ignored.
6796
6797 .cindex "TXT record" "in &(dnsdb)& lookup"
6798 .cindex "SPF record" "in &(dnsdb)& lookup"
6799 For TXT records with multiple items of data, only the first item is returned,
6800 unless a separator for them is specified using a comma after the separator
6801 character followed immediately by the TXT record item separator. To concatenate
6802 items without a separator, use a semicolon instead. For SPF records the
6803 default behaviour is to concatenate multiple items without using a separator.
6804 .code
6805 ${lookup dnsdb{>\n,: txt=a.b.example}}
6806 ${lookup dnsdb{>\n; txt=a.b.example}}
6807 ${lookup dnsdb{spf=example.org}}
6808 .endd
6809 It is permitted to specify a space as the separator character. Further
6810 white space is ignored.
6811
6812 .section "Pseudo dnsdb record types" "SECID66"
6813 .cindex "MX record" "in &(dnsdb)& lookup"
6814 By default, both the preference value and the host name are returned for
6815 each MX record, separated by a space. If you want only host names, you can use
6816 the pseudo-type MXH:
6817 .code
6818 ${lookup dnsdb{mxh=a.b.example}}
6819 .endd
6820 In this case, the preference values are omitted, and just the host names are
6821 returned.
6822
6823 .cindex "name server for enclosing domain"
6824 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6825 records on the given domain, but if none are found, it removes the first
6826 component of the domain name, and tries again. This process continues until NS
6827 records are found or there are no more components left (or there is a DNS
6828 error). In other words, it may return the name servers for a top-level domain,
6829 but it never returns the root name servers. If there are no NS records for the
6830 top-level domain, the lookup fails. Consider these examples:
6831 .code
6832 ${lookup dnsdb{zns=xxx.quercite.com}}
6833 ${lookup dnsdb{zns=xxx.edu}}
6834 .endd
6835 Assuming that in each case there are no NS records for the full domain name,
6836 the first returns the name servers for &%quercite.com%&, and the second returns
6837 the name servers for &%edu%&.
6838
6839 You should be careful about how you use this lookup because, unless the
6840 top-level domain does not exist, the lookup always returns some host names. The
6841 sort of use to which this might be put is for seeing if the name servers for a
6842 given domain are on a blacklist. You can probably assume that the name servers
6843 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6844 such a list.
6845
6846 .cindex "CSA" "in &(dnsdb)& lookup"
6847 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6848 records according to the CSA rules, which are described in section
6849 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6850 not sufficient because of the extra parent domain search behaviour of CSA. The
6851 result of a successful lookup such as:
6852 .code
6853 ${lookup dnsdb {csa=$sender_helo_name}}
6854 .endd
6855 has two space-separated fields: an authorization code and a target host name.
6856 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6857 authorization required but absent, or &"?"& for unknown.
6858
6859
6860 .section "Multiple dnsdb lookups" "SECID67"
6861 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6862 However, you can specify a list of domains or IP addresses in a single
6863 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6864 the default separator, but with the ability to change this. For example:
6865 .code
6866 ${lookup dnsdb{one.domain.com:two.domain.com}}
6867 ${lookup dnsdb{a=one.host.com:two.host.com}}
6868 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6869 .endd
6870 In order to retain backwards compatibility, there is one special case: if
6871 the lookup type is PTR and no change of separator is specified, Exim looks
6872 to see if the rest of the string is precisely one IPv6 address. In this
6873 case, it does not treat it as a list.
6874
6875 The data from each lookup is concatenated, with newline separators by default,
6876 in the same way that multiple DNS records for a single item are handled. A
6877 different separator can be specified, as described above.
6878
6879 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6880 temporary DNS error for any of them, the behaviour is controlled by
6881 an optional keyword followed by a comma that may appear before the record
6882 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6883 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6884 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6885 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6886 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6887 error causes the whole lookup to defer only if none of the other lookups
6888 succeed. The default is &"lax"&, so the following lookups are equivalent:
6889 .code
6890 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6891 ${lookup dnsdb{a=one.host.com:two.host.com}}
6892 .endd
6893 Thus, in the default case, as long as at least one of the DNS lookups
6894 yields some data, the lookup succeeds.
6895
6896
6897
6898
6899 .section "More about LDAP" "SECTldap"
6900 .cindex "LDAP" "lookup, more about"
6901 .cindex "lookup" "LDAP"
6902 .cindex "Solaris" "LDAP"
6903 The original LDAP implementation came from the University of Michigan; this has
6904 become &"Open LDAP"&, and there are now two different releases. Another
6905 implementation comes from Netscape, and Solaris 7 and subsequent releases
6906 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6907 the lookup function level, their error handling is different. For this reason
6908 it is necessary to set a compile-time variable when building Exim with LDAP, to
6909 indicate which LDAP library is in use. One of the following should appear in
6910 your &_Local/Makefile_&:
6911 .code
6912 LDAP_LIB_TYPE=UMICHIGAN
6913 LDAP_LIB_TYPE=OPENLDAP1
6914 LDAP_LIB_TYPE=OPENLDAP2
6915 LDAP_LIB_TYPE=NETSCAPE
6916 LDAP_LIB_TYPE=SOLARIS
6917 .endd
6918 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6919 same interface as the University of Michigan version.
6920
6921 There are three LDAP lookup types in Exim. These behave slightly differently in
6922 the way they handle the results of a query:
6923
6924 .ilist
6925 &(ldap)& requires the result to contain just one entry; if there are more, it
6926 gives an error.
6927 .next
6928 &(ldapdn)& also requires the result to contain just one entry, but it is the
6929 Distinguished Name that is returned rather than any attribute values.
6930 .next
6931 &(ldapm)& permits the result to contain more than one entry; the attributes
6932 from all of them are returned.
6933 .endlist
6934
6935
6936 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6937 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6938 the data returned by a successful lookup is described in the next section.
6939 First we explain how LDAP queries are coded.
6940
6941
6942 .section "Format of LDAP queries" "SECTforldaque"
6943 .cindex "LDAP" "query format"
6944 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6945 the configuration of a &(redirect)& router one might have this setting:
6946 .code
6947 data = ${lookup ldap \
6948   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6949   c=UK?mailbox?base?}}
6950 .endd
6951 .cindex "LDAP" "with TLS"
6952 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6953 secure (encrypted) LDAP connections. The second of these ensures that an
6954 encrypted TLS connection is used.
6955
6956 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
6957 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
6958 See the &%ldap_start_tls%& option.
6959
6960
6961 .section "LDAP quoting" "SECID68"
6962 .cindex "LDAP" "quoting"
6963 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6964 and the second because the LDAP query is represented as a URL. Furthermore,
6965 within an LDAP query, two different kinds of quoting are required. For this
6966 reason, there are two different LDAP-specific quoting operators.
6967
6968 The &%quote_ldap%& operator is designed for use on strings that are part of
6969 filter specifications. Conceptually, it first does the following conversions on
6970 the string:
6971 .code
6972 *   =>   \2A
6973 (   =>   \28
6974 )   =>   \29
6975 \   =>   \5C
6976 .endd
6977 in accordance with RFC 2254. The resulting string is then quoted according
6978 to the rules for URLs, that is, all non-alphanumeric characters except
6979 .code
6980 ! $ ' - . _ ( ) * +
6981 .endd
6982 are converted to their hex values, preceded by a percent sign. For example:
6983 .code
6984 ${quote_ldap: a(bc)*, a<yz>; }
6985 .endd
6986 yields
6987 .code
6988 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6989 .endd
6990 Removing the URL quoting, this is (with a leading and a trailing space):
6991 .code
6992 a\28bc\29\2A, a<yz>;
6993 .endd
6994 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6995 base DN specifications in queries. Conceptually, it first converts the string
6996 by inserting a backslash in front of any of the following characters:
6997 .code
6998 , + " \ < > ;
6999 .endd
7000 It also inserts a backslash before any leading spaces or # characters, and
7001 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7002 is then quoted according to the rules for URLs. For example:
7003 .code
7004 ${quote_ldap_dn: a(bc)*, a<yz>; }
7005 .endd
7006 yields
7007 .code
7008 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7009 .endd
7010 Removing the URL quoting, this is (with a trailing space):
7011 .code
7012 \ a(bc)*\, a\<yz\>\;\
7013 .endd
7014 There are some further comments about quoting in the section on LDAP
7015 authentication below.
7016
7017
7018 .section "LDAP connections" "SECID69"
7019 .cindex "LDAP" "connections"
7020 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7021 is in use, via a Unix domain socket. The example given above does not specify
7022 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7023 by starting it with
7024 .code
7025 ldap://<hostname>:<port>/...
7026 .endd
7027 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7028 used. When no server is specified in a query, a list of default servers is
7029 taken from the &%ldap_default_servers%& configuration option. This supplies a
7030 colon-separated list of servers which are tried in turn until one successfully
7031 handles a query, or there is a serious error. Successful handling either
7032 returns the requested data, or indicates that it does not exist. Serious errors
7033 are syntactical, or multiple values when only a single value is expected.
7034 Errors which cause the next server to be tried are connection failures, bind
7035 failures, and timeouts.
7036
7037 For each server name in the list, a port number can be given. The standard way
7038 of specifying a host and port is to use a colon separator (RFC 1738). Because
7039 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7040 doubled. For example
7041 .code
7042 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7043 .endd
7044 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7045 to the LDAP library with no server name, and the library's default (normally
7046 the local host) is used.
7047
7048 If you are using the OpenLDAP library, you can connect to an LDAP server using
7049 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7050 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7051 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7052 not available.
7053
7054 For this type of connection, instead of a host name for the server, a pathname
7055 for the socket is required, and the port number is not relevant. The pathname
7056 can be specified either as an item in &%ldap_default_servers%&, or inline in
7057 the query. In the former case, you can have settings such as
7058 .code
7059 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7060 .endd
7061 When the pathname is given in the query, you have to escape the slashes as
7062 &`%2F`& to fit in with the LDAP URL syntax. For example:
7063 .code
7064 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7065 .endd
7066 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7067 a pathname, it uses the Unix domain socket code, even if the query actually
7068 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7069 socket connection. This behaviour means that you can use a setting of
7070 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7071 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7072 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7073 backup host.
7074
7075 If an explicit &`ldapi`& type is given in a query when a host name is
7076 specified, an error is diagnosed. However, if there are more items in
7077 &%ldap_default_servers%&, they are tried. In other words:
7078
7079 .ilist
7080 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7081 interface.
7082 .next
7083 Using &`ldapi`& with a host name causes an error.
7084 .endlist
7085
7086
7087 Using &`ldapi`& with no host or path in the query, and no setting of
7088 &%ldap_default_servers%&, does whatever the library does by default.
7089
7090
7091
7092 .section "LDAP authentication and control information" "SECID70"
7093 .cindex "LDAP" "authentication"
7094 The LDAP URL syntax provides no way of passing authentication and other control
7095 information to the server. To make this possible, the URL in an LDAP query may
7096 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7097 spaces. If a value contains spaces it must be enclosed in double quotes, and
7098 when double quotes are used, backslash is interpreted in the usual way inside
7099 them. The following names are recognized:
7100 .display
7101 &`DEREFERENCE`&  set the dereferencing parameter
7102 &`NETTIME    `&  set a timeout for a network operation
7103 &`USER       `&  set the DN, for authenticating the LDAP bind
7104 &`PASS       `&  set the password, likewise
7105 &`REFERRALS  `&  set the referrals parameter
7106 &`SIZE       `&  set the limit for the number of entries returned
7107 &`TIME       `&  set the maximum waiting time for a query
7108 .endd
7109 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7110 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7111 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7112 library from trying to follow referrals issued by the LDAP server.
7113
7114 The name CONNECT is an obsolete name for NETTIME, retained for
7115 backwards compatibility. This timeout (specified as a number of seconds) is
7116 enforced from the client end for operations that can be carried out over a
7117 network. Specifically, it applies to network connections and calls to the
7118 &'ldap_result()'& function. If the value is greater than zero, it is used if
7119 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7120 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7121 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7122 Netscape SDK; for OpenLDAP no action is taken.
7123
7124 The TIME parameter (also a number of seconds) is passed to the server to
7125 set a server-side limit on the time taken to complete a search.
7126
7127
7128 Here is an example of an LDAP query in an Exim lookup that uses some of these
7129 values. This is a single line, folded to fit on the page:
7130 .code
7131 ${lookup ldap
7132   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7133   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7134   {$value}fail}
7135 .endd
7136 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7137 any of the auxiliary data. Exim configuration settings that include lookups
7138 which contain password information should be preceded by &"hide"& to prevent
7139 non-admin users from using the &%-bP%& option to see their values.
7140
7141 The auxiliary data items may be given in any order. The default is no
7142 connection timeout (the system timeout is used), no user or password, no limit
7143 on the number of entries returned, and no time limit on queries.
7144
7145 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7146 removes any URL quoting that it may contain before passing it LDAP. Apparently
7147 some libraries do this for themselves, but some do not. Removing the URL
7148 quoting has two advantages:
7149
7150 .ilist
7151 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7152 DNs as with DNs inside actual queries.
7153 .next
7154 It permits spaces inside USER= DNs.
7155 .endlist
7156
7157 For example, a setting such as
7158 .code
7159 USER=cn=${quote_ldap_dn:$1}
7160 .endd
7161 should work even if &$1$& contains spaces.
7162
7163 Expanded data for the PASS= value should be quoted using the &%quote%&
7164 expansion operator, rather than the LDAP quote operators. The only reason this
7165 field needs quoting is to ensure that it conforms to the Exim syntax, which
7166 does not allow unquoted spaces. For example:
7167 .code
7168 PASS=${quote:$3}
7169 .endd
7170 The LDAP authentication mechanism can be used to check passwords as part of
7171 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7172 &<<CHAPexpand>>&.
7173
7174
7175
7176 .section "Format of data returned by LDAP" "SECID71"
7177 .cindex "LDAP" "returned data formats"
7178 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7179 as a sequence of values, for example
7180 .code
7181 cn=manager, o=University of Cambridge, c=UK
7182 .endd
7183 The &(ldap)& lookup type generates an error if more than one entry matches the
7184 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7185 the result between the data from different entries. It is possible for multiple
7186 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7187 you know that whatever values are returned all came from a single entry in the
7188 directory.
7189
7190 In the common case where you specify a single attribute in your LDAP query, the
7191 result is not quoted, and does not contain the attribute name. If the attribute
7192 has multiple values, they are separated by commas.
7193
7194 If you specify multiple attributes, the result contains space-separated, quoted
7195 strings, each preceded by the attribute name and an equals sign. Within the
7196 quotes, the quote character, backslash, and newline are escaped with
7197 backslashes, and commas are used to separate multiple values for the attribute.
7198 Apart from the escaping, the string within quotes takes the same form as the
7199 output when a single attribute is requested. Specifying no attributes is the
7200 same as specifying all of an entry's attributes.
7201
7202 Here are some examples of the output format. The first line of each pair is an
7203 LDAP query, and the second is the data that is returned. The attribute called
7204 &%attr1%& has two values, whereas &%attr2%& has only one value:
7205 .code
7206 ldap:///o=base?attr1?sub?(uid=fred)
7207 value1.1, value1.2
7208
7209 ldap:///o=base?attr2?sub?(uid=fred)
7210 value two
7211
7212 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7213 attr1="value1.1, value1.2" attr2="value two"
7214
7215 ldap:///o=base??sub?(uid=fred)
7216 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7217 .endd
7218 The &%extract%& operator in string expansions can be used to pick out
7219 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7220 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7221 results of LDAP lookups.
7222
7223
7224
7225
7226 .section "More about NIS+" "SECTnisplus"
7227 .cindex "NIS+ lookup type"
7228 .cindex "lookup" "NIS+"
7229 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7230 and field name. If this is given, the result of a successful query is the
7231 contents of the named field; otherwise the result consists of a concatenation
7232 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7233 values containing spaces are quoted. For example, the query
7234 .code
7235 [name=mg1456],passwd.org_dir
7236 .endd
7237 might return the string
7238 .code
7239 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7240 home=/home/mg1456 shell=/bin/bash shadow=""
7241 .endd
7242 (split over two lines here to fit on the page), whereas
7243 .code
7244 [name=mg1456],passwd.org_dir:gcos
7245 .endd
7246 would just return
7247 .code
7248 Martin Guerre
7249 .endd
7250 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7251 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7252 operator is to double any quote characters within the text.
7253
7254
7255
7256 .section "SQL lookups" "SECTsql"
7257 .cindex "SQL lookup types"
7258 .cindex "MySQL" "lookup type"
7259 .cindex "PostgreSQL lookup type"
7260 .cindex "lookup" "MySQL"
7261 .cindex "lookup" "PostgreSQL"
7262 .cindex "Oracle" "lookup type"
7263 .cindex "lookup" "Oracle"
7264 .cindex "InterBase lookup type"
7265 .cindex "lookup" "InterBase"
7266 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7267 databases. Queries for these databases contain SQL statements, so an example
7268 might be
7269 .code
7270 ${lookup mysql{select mailbox from users where id='userx'}\
7271   {$value}fail}
7272 .endd
7273 If the result of the query contains more than one field, the data for each
7274 field in the row is returned, preceded by its name, so the result of
7275 .code
7276 ${lookup pgsql{select home,name from users where id='userx'}\
7277   {$value}}
7278 .endd
7279 might be
7280 .code
7281 home=/home/userx name="Mister X"
7282 .endd
7283 Empty values and values containing spaces are double quoted, with embedded
7284 quotes escaped by a backslash. If the result of the query contains just one
7285 field, the value is passed back verbatim, without a field name, for example:
7286 .code
7287 Mister X
7288 .endd
7289 If the result of the query yields more than one row, it is all concatenated,
7290 with a newline between the data for each row.
7291
7292
7293 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7294 .cindex "MySQL" "lookup type"
7295 .cindex "PostgreSQL lookup type"
7296 .cindex "lookup" "MySQL"
7297 .cindex "lookup" "PostgreSQL"
7298 .cindex "Oracle" "lookup type"
7299 .cindex "lookup" "Oracle"
7300 .cindex "InterBase lookup type"
7301 .cindex "lookup" "InterBase"
7302 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7303 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7304 option (as appropriate) must be set to a colon-separated list of server
7305 information.
7306 (For MySQL and PostgreSQL only, the global option need not be set if all
7307 queries contain their own server information &-- see section
7308 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7309 items: host name, database name, user name, and password. In the case of
7310 Oracle, the host name field is used for the &"service name"&, and the database
7311 name field is not used and should be empty. For example:
7312 .code
7313 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7314 .endd
7315 Because password data is sensitive, you should always precede the setting with
7316 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7317 option. Here is an example where two MySQL servers are listed:
7318 .code
7319 hide mysql_servers = localhost/users/root/secret:\
7320                      otherhost/users/root/othersecret
7321 .endd
7322 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7323 because this is a colon-separated list, the colon has to be doubled. For each
7324 query, these parameter groups are tried in order until a connection is made and
7325 a query is successfully processed. The result of a query may be that no data is
7326 found, but that is still a successful query. In other words, the list of
7327 servers provides a backup facility, not a list of different places to look.
7328
7329 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7330 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7331 respectively, and the characters single-quote, double-quote, and backslash
7332 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7333 addition, escapes the percent and underscore characters. This cannot be done
7334 for MySQL because these escapes are not recognized in contexts where these
7335 characters are not special.
7336
7337 .section "Specifying the server in the query" "SECTspeserque"
7338 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7339 it is possible to specify a list of servers with an individual query. This is
7340 done by starting the query with
7341 .display
7342 &`servers=`&&'server1:server2:server3:...'&&`;`&
7343 .endd
7344 Each item in the list may take one of two forms:
7345 .olist
7346 If it contains no slashes it is assumed to be just a host name. The appropriate
7347 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7348 of the same name, and the remaining parameters (database, user, password) are
7349 taken from there.
7350 .next
7351 If it contains any slashes, it is taken as a complete parameter set.
7352 .endlist
7353 The list of servers is used in exactly the same way as the global list.
7354 Once a connection to a server has happened and a query has been
7355 successfully executed, processing of the lookup ceases.
7356
7357 This feature is intended for use in master/slave situations where updates
7358 are occurring and you want to update the master rather than a slave. If the
7359 master is in the list as a backup for reading, you might have a global setting
7360 like this:
7361 .code
7362 mysql_servers = slave1/db/name/pw:\
7363                 slave2/db/name/pw:\
7364                 master/db/name/pw
7365 .endd
7366 In an updating lookup, you could then write:
7367 .code
7368 ${lookup mysql{servers=master; UPDATE ...} }
7369 .endd
7370 That query would then be sent only to the master server. If, on the other hand,
7371 the master is not to be used for reading, and so is not present in the global
7372 option, you can still update it by a query of this form:
7373 .code
7374 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7375 .endd
7376
7377
7378 .section "Special MySQL features" "SECID73"
7379 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7380 causes a connection to the server on the local host by means of a Unix domain
7381 socket. An alternate socket can be specified in parentheses. The full syntax of
7382 each item in &%mysql_servers%& is:
7383 .display
7384 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7385   <&'user'&>/<&'password'&>
7386 .endd
7387 Any of the three sub-parts of the first field can be omitted. For normal use on
7388 the local host it can be left blank or set to just &"localhost"&.
7389
7390 No database need be supplied &-- but if it is absent here, it must be given in
7391 the queries.
7392
7393 If a MySQL query is issued that does not request any data (an insert, update,
7394 or delete command), the result of the lookup is the number of rows affected.
7395
7396 &*Warning*&: This can be misleading. If an update does not actually change
7397 anything (for example, setting a field to the value it already has), the result
7398 is zero because no rows are affected.
7399
7400
7401 .section "Special PostgreSQL features" "SECID74"
7402 PostgreSQL lookups can also use Unix domain socket connections to the database.
7403 This is usually faster and costs less CPU time than a TCP/IP connection.
7404 However it can be used only if the mail server runs on the same machine as the
7405 database server. A configuration line for PostgreSQL via Unix domain sockets
7406 looks like this:
7407 .code
7408 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7409 .endd
7410 In other words, instead of supplying a host name, a path to the socket is
7411 given. The path name is enclosed in parentheses so that its slashes aren't
7412 visually confused with the delimiters for the other server parameters.
7413
7414 If a PostgreSQL query is issued that does not request any data (an insert,
7415 update, or delete command), the result of the lookup is the number of rows
7416 affected.
7417
7418 .section "More about SQLite" "SECTsqlite"
7419 .cindex "lookup" "SQLite"
7420 .cindex "sqlite lookup type"
7421 SQLite is different to the other SQL lookups because a file name is required in
7422 addition to the SQL query. An SQLite database is a single file, and there is no
7423 daemon as in the other SQL databases. The interface to Exim requires the name
7424 of the file, as an absolute path, to be given at the start of the query. It is
7425 separated from the query by white space. This means that the path name cannot
7426 contain white space. Here is a lookup expansion example:
7427 .code
7428 ${lookup sqlite {/some/thing/sqlitedb \
7429   select name from aliases where id='userx';}}
7430 .endd
7431 In a list, the syntax is similar. For example:
7432 .code
7433 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7434    select * from relays where ip='$sender_host_address';
7435 .endd
7436 The only character affected by the &%quote_sqlite%& operator is a single
7437 quote, which it doubles.
7438
7439 The SQLite library handles multiple simultaneous accesses to the database
7440 internally. Multiple readers are permitted, but only one process can
7441 update at once. Attempts to access the database while it is being updated
7442 are rejected after a timeout period, during which the SQLite library
7443 waits for the lock to be released. In Exim, the default timeout is set
7444 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7445 option.
7446 .ecindex IIDfidalo1
7447 .ecindex IIDfidalo2
7448
7449
7450 . ////////////////////////////////////////////////////////////////////////////
7451 . ////////////////////////////////////////////////////////////////////////////
7452
7453 .chapter "Domain, host, address, and local part lists" &&&
7454          "CHAPdomhosaddlists" &&&
7455          "Domain, host, and address lists"
7456 .scindex IIDdohoadli "lists of domains; hosts; etc."
7457 A number of Exim configuration options contain lists of domains, hosts,
7458 email addresses, or local parts. For example, the &%hold_domains%& option
7459 contains a list of domains whose delivery is currently suspended. These lists
7460 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7461 arguments to expansion conditions such as &%match_domain%&.
7462
7463 Each item in one of these lists is a pattern to be matched against a domain,
7464 host, email address, or local part, respectively. In the sections below, the
7465 different types of pattern for each case are described, but first we cover some
7466 general facilities that apply to all four kinds of list.
7467
7468
7469
7470 .section "Expansion of lists" "SECID75"
7471 .cindex "expansion" "of lists"
7472 Each list is expanded as a single string before it is used. The result of
7473 expansion must be a list, possibly containing empty items, which is split up
7474 into separate items for matching. By default, colon is the separator character,
7475 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7476 &<<SECTempitelis>>& for details of the list syntax; the second of these
7477 discusses the way to specify empty list items.
7478
7479
7480 If the string expansion is forced to fail, Exim behaves as if the item it is
7481 testing (domain, host, address, or local part) is not in the list. Other
7482 expansion failures cause temporary errors.
7483
7484 If an item in a list is a regular expression, backslashes, dollars and possibly
7485 other special characters in the expression must be protected against
7486 misinterpretation by the string expander. The easiest way to do this is to use
7487 the &`\N`& expansion feature to indicate that the contents of the regular
7488 expression should not be expanded. For example, in an ACL you might have:
7489 .code
7490 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7491                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7492 .endd
7493 The first item is a regular expression that is protected from expansion by
7494 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7495 senders based on the receiving domain.
7496
7497
7498
7499
7500 .section "Negated items in lists" "SECID76"
7501 .cindex "list" "negation"
7502 .cindex "negation" "in lists"
7503 Items in a list may be positive or negative. Negative items are indicated by a
7504 leading exclamation mark, which may be followed by optional white space. A list
7505 defines a set of items (domains, etc). When Exim processes one of these lists,
7506 it is trying to find out whether a domain, host, address, or local part
7507 (respectively) is in the set that is defined by the list. It works like this:
7508
7509 The list is scanned from left to right. If a positive item is matched, the
7510 subject that is being checked is in the set; if a negative item is matched, the
7511 subject is not in the set. If the end of the list is reached without the
7512 subject having matched any of the patterns, it is in the set if the last item
7513 was a negative one, but not if it was a positive one. For example, the list in
7514 .code
7515 domainlist relay_domains = !a.b.c : *.b.c
7516 .endd
7517 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7518 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7519 list is positive. However, if the setting were
7520 .code
7521 domainlist relay_domains = !a.b.c
7522 .endd
7523 then all domains other than &'a.b.c'& would match because the last item in the
7524 list is negative. In other words, a list that ends with a negative item behaves
7525 as if it had an extra item &`:*`& on the end.
7526
7527 Another way of thinking about positive and negative items in lists is to read
7528 the connector as &"or"& after a positive item and as &"and"& after a negative
7529 item.
7530
7531
7532
7533 .section "File names in lists" "SECTfilnamlis"
7534 .cindex "list" "file name in"
7535 If an item in a domain, host, address, or local part list is an absolute file
7536 name (beginning with a slash character), each line of the file is read and
7537 processed as if it were an independent item in the list, except that further
7538 file names are not allowed,
7539 and no expansion of the data from the file takes place.
7540 Empty lines in the file are ignored, and the file may also contain comment
7541 lines:
7542
7543 .ilist
7544 For domain and host lists, if a # character appears anywhere in a line of the
7545 file, it and all following characters are ignored.
7546 .next
7547 Because local parts may legitimately contain # characters, a comment in an
7548 address list or local part list file is recognized only if # is preceded by
7549 white space or the start of the line. For example:
7550 .code
7551 not#comment@x.y.z   # but this is a comment
7552 .endd
7553 .endlist
7554
7555 Putting a file name in a list has the same effect as inserting each line of the
7556 file as an item in the list (blank lines and comments excepted). However, there
7557 is one important difference: the file is read each time the list is processed,
7558 so if its contents vary over time, Exim's behaviour changes.
7559
7560 If a file name is preceded by an exclamation mark, the sense of any match
7561 within the file is inverted. For example, if
7562 .code
7563 hold_domains = !/etc/nohold-domains
7564 .endd
7565 and the file contains the lines
7566 .code
7567 !a.b.c
7568 *.b.c
7569 .endd
7570 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7571 any domain matching &`*.b.c`& is not.
7572
7573
7574
7575 .section "An lsearch file is not an out-of-line list" "SECID77"
7576 As will be described in the sections that follow, lookups can be used in lists
7577 to provide indexed methods of checking list membership. There has been some
7578 confusion about the way &(lsearch)& lookups work in lists. Because
7579 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7580 sometimes thought that it is allowed to contain wild cards and other kinds of
7581 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7582 always fixed strings, just as for any other single-key lookup type.
7583
7584 If you want to use a file to contain wild-card patterns that form part of a
7585 list, just give the file name on its own, without a search type, as described
7586 in the previous section. You could also use the &(wildlsearch)& or
7587 &(nwildlsearch)&, but there is no advantage in doing this.
7588
7589
7590
7591
7592 .section "Named lists" "SECTnamedlists"
7593 .cindex "named lists"
7594 .cindex "list" "named"
7595 A list of domains, hosts, email addresses, or local parts can be given a name
7596 which is then used to refer to the list elsewhere in the configuration. This is
7597 particularly convenient if the same list is required in several different
7598 places. It also allows lists to be given meaningful names, which can improve
7599 the readability of the configuration. For example, it is conventional to define
7600 a domain list called &'local_domains'& for all the domains that are handled
7601 locally on a host, using a configuration line such as
7602 .code
7603 domainlist local_domains = localhost:my.dom.example
7604 .endd
7605 Named lists are referenced by giving their name preceded by a plus sign, so,
7606 for example, a router that is intended to handle local domains would be
7607 configured with the line
7608 .code
7609 domains = +local_domains
7610 .endd
7611 The first router in a configuration is often one that handles all domains
7612 except the local ones, using a configuration with a negated item like this:
7613 .code
7614 dnslookup:
7615   driver = dnslookup
7616   domains = ! +local_domains
7617   transport = remote_smtp
7618   no_more
7619 .endd
7620 The four kinds of named list are created by configuration lines starting with
7621 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7622 respectively. Then there follows the name that you are defining, followed by an
7623 equals sign and the list itself. For example:
7624 .code
7625 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7626 addresslist bad_senders = cdb;/etc/badsenders
7627 .endd
7628 A named list may refer to other named lists:
7629 .code
7630 domainlist  dom1 = first.example : second.example
7631 domainlist  dom2 = +dom1 : third.example
7632 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7633 .endd
7634 &*Warning*&: If the last item in a referenced list is a negative one, the
7635 effect may not be what you intended, because the negation does not propagate
7636 out to the higher level. For example, consider:
7637 .code
7638 domainlist  dom1 = !a.b
7639 domainlist  dom2 = +dom1 : *.b
7640 .endd
7641 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7642 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7643 means it matches the second list as well. The effect is not the same as
7644 .code
7645 domainlist  dom2 = !a.b : *.b
7646 .endd
7647 where &'x.y'& does not match. It's best to avoid negation altogether in
7648 referenced lists if you can.
7649
7650 Named lists may have a performance advantage. When Exim is routing an
7651 address or checking an incoming message, it caches the result of tests on named
7652 lists. So, if you have a setting such as
7653 .code
7654 domains = +local_domains
7655 .endd
7656 on several of your routers
7657 or in several ACL statements,
7658 the actual test is done only for the first one. However, the caching works only
7659 if there are no expansions within the list itself or any sublists that it
7660 references. In other words, caching happens only for lists that are known to be
7661 the same each time they are referenced.
7662
7663 By default, there may be up to 16 named lists of each type. This limit can be
7664 extended by changing a compile-time variable. The use of domain and host lists
7665 is recommended for concepts such as local domains, relay domains, and relay
7666 hosts. The default configuration is set up like this.
7667
7668
7669
7670 .section "Named lists compared with macros" "SECID78"
7671 .cindex "list" "named compared with macro"
7672 .cindex "macro" "compared with named list"
7673 At first sight, named lists might seem to be no different from macros in the
7674 configuration file. However, macros are just textual substitutions. If you
7675 write
7676 .code
7677 ALIST = host1 : host2
7678 auth_advertise_hosts = !ALIST
7679 .endd
7680 it probably won't do what you want, because that is exactly the same as
7681 .code
7682 auth_advertise_hosts = !host1 : host2
7683 .endd
7684 Notice that the second host name is not negated. However, if you use a host
7685 list, and write
7686 .code
7687 hostlist alist = host1 : host2
7688 auth_advertise_hosts = ! +alist
7689 .endd
7690 the negation applies to the whole list, and so that is equivalent to
7691 .code
7692 auth_advertise_hosts = !host1 : !host2
7693 .endd
7694
7695
7696 .section "Named list caching" "SECID79"
7697 .cindex "list" "caching of named"
7698 .cindex "caching" "named lists"
7699 While processing a message, Exim caches the result of checking a named list if
7700 it is sure that the list is the same each time. In practice, this means that
7701 the cache operates only if the list contains no $ characters, which guarantees
7702 that it will not change when it is expanded. Sometimes, however, you may have
7703 an expanded list that you know will be the same each time within a given
7704 message. For example:
7705 .code
7706 domainlist special_domains = \
7707            ${lookup{$sender_host_address}cdb{/some/file}}
7708 .endd
7709 This provides a list of domains that depends only on the sending host's IP
7710 address. If this domain list is referenced a number of times (for example,
7711 in several ACL lines, or in several routers) the result of the check is not
7712 cached by default, because Exim does not know that it is going to be the
7713 same list each time.
7714
7715 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7716 cache the result anyway. For example:
7717 .code
7718 domainlist_cache special_domains = ${lookup{...
7719 .endd
7720 If you do this, you should be absolutely sure that caching is going to do
7721 the right thing in all cases. When in doubt, leave it out.
7722
7723
7724
7725 .section "Domain lists" "SECTdomainlist"
7726 .cindex "domain list" "patterns for"
7727 .cindex "list" "domain list"
7728 Domain lists contain patterns that are to be matched against a mail domain.
7729 The following types of item may appear in domain lists:
7730
7731 .ilist
7732 .cindex "primary host name"
7733 .cindex "host name" "matched in domain list"
7734 .oindex "&%primary_hostname%&"
7735 .cindex "domain list" "matching primary host name"
7736 .cindex "@ in a domain list"
7737 If a pattern consists of a single @ character, it matches the local host name,
7738 as set by the &%primary_hostname%& option (or defaulted). This makes it
7739 possible to use the same configuration file on several different hosts that
7740 differ only in their names.
7741 .next
7742 .cindex "@[] in a domain list"
7743 .cindex "domain list" "matching local IP interfaces"
7744 .cindex "domain literal"
7745 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7746 in square brackets (as in an email address that contains a domain literal), but
7747 only if that IP address is recognized as local for email routing purposes. The
7748 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7749 control which of a host's several IP addresses are treated as local.
7750 In today's Internet, the use of domain literals is controversial.
7751 .next
7752 .cindex "@mx_any"
7753 .cindex "@mx_primary"
7754 .cindex "@mx_secondary"
7755 .cindex "domain list" "matching MX pointers to local host"
7756 If a pattern consists of the string &`@mx_any`& it matches any domain that
7757 has an MX record pointing to the local host or to any host that is listed in
7758 .oindex "&%hosts_treat_as_local%&"
7759 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7760 are similar, except that the first matches only when a primary MX target is the
7761 local host, and the second only when no primary MX target is the local host,
7762 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7763 preference value &-- there may of course be more than one of them.
7764
7765 The MX lookup that takes place when matching a pattern of this type is
7766 performed with the resolver options for widening names turned off. Thus, for
7767 example, a single-component domain will &'not'& be expanded by adding the
7768 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7769 options of the &(dnslookup)& router for a discussion of domain widening.
7770
7771 Sometimes you may want to ignore certain IP addresses when using one of these
7772 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7773 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7774 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7775 on a router). For example:
7776 .code
7777 domains = @mx_any/ignore=127.0.0.1
7778 .endd
7779 This example matches any domain that has an MX record pointing to one of
7780 the local host's IP addresses other than 127.0.0.1.
7781
7782 The list of IP addresses is in fact processed by the same code that processes
7783 host lists, so it may contain CIDR-coded network specifications and it may also
7784 contain negative items.
7785
7786 Because the list of IP addresses is a sublist within a domain list, you have to
7787 be careful about delimiters if there is more than one address. Like any other
7788 list, the default delimiter can be changed. Thus, you might have:
7789 .code
7790 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7791           an.other.domain : ...
7792 .endd
7793 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7794 involved, it is easiest to change the delimiter for the main list as well:
7795 .code
7796 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7797           an.other.domain ? ...
7798 .endd
7799 .next
7800 .cindex "asterisk" "in domain list"
7801 .cindex "domain list" "asterisk in"
7802 .cindex "domain list" "matching &""ends with""&"
7803 If a pattern starts with an asterisk, the remaining characters of the pattern
7804 are compared with the terminating characters of the domain. The use of &"*"& in
7805 domain lists differs from its use in partial matching lookups. In a domain
7806 list, the character following the asterisk need not be a dot, whereas partial
7807 matching works only in terms of dot-separated components. For example, a domain
7808 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7809 &'cipher.key.ex'&.
7810
7811 .next
7812 .cindex "regular expressions" "in domain list"
7813 .cindex "domain list" "matching regular expression"
7814 If a pattern starts with a circumflex character, it is treated as a regular
7815 expression, and matched against the domain using a regular expression matching
7816 function. The circumflex is treated as part of the regular expression.
7817 Email domains are case-independent, so this regular expression match is by
7818 default case-independent, but you can make it case-dependent by starting it
7819 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7820 are given in chapter &<<CHAPregexp>>&.
7821
7822 &*Warning*&: Because domain lists are expanded before being processed, you
7823 must escape any backslash and dollar characters in the regular expression, or
7824 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7825 it is not to be expanded (unless you really do want to build a regular
7826 expression by expansion, of course).
7827 .next
7828 .cindex "lookup" "in domain list"
7829 .cindex "domain list" "matching by lookup"
7830 If a pattern starts with the name of a single-key lookup type followed by a
7831 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7832 must be a file name in a suitable format for the lookup type. For example, for
7833 &"cdb;"& it must be an absolute path:
7834 .code
7835 domains = cdb;/etc/mail/local_domains.cdb
7836 .endd
7837 The appropriate type of lookup is done on the file using the domain name as the
7838 key. In most cases, the data that is looked up is not used; Exim is interested
7839 only in whether or not the key is present in the file. However, when a lookup
7840 is used for the &%domains%& option on a router
7841 or a &%domains%& condition in an ACL statement, the data is preserved in the
7842 &$domain_data$& variable and can be referred to in other router options or
7843 other statements in the same ACL.
7844
7845 .next
7846 Any of the single-key lookup type names may be preceded by
7847 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7848 .code
7849 domains = partial-dbm;/partial/domains
7850 .endd
7851 This causes partial matching logic to be invoked; a description of how this
7852 works is given in section &<<SECTpartiallookup>>&.
7853
7854 .next
7855 .cindex "asterisk" "in lookup type"
7856 Any of the single-key lookup types may be followed by an asterisk. This causes
7857 a default lookup for a key consisting of a single asterisk to be done if the
7858 original lookup fails. This is not a useful feature when using a domain list to
7859 select particular domains (because any domain would match), but it might have
7860 value if the result of the lookup is being used via the &$domain_data$&
7861 expansion variable.
7862 .next
7863 If the pattern starts with the name of a query-style lookup type followed by a
7864 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7865 pattern must be an appropriate query for the lookup type, as described in
7866 chapter &<<CHAPfdlookup>>&. For example:
7867 .code
7868 hold_domains = mysql;select domain from holdlist \
7869   where domain = '${quote_mysql:$domain}';
7870 .endd
7871 In most cases, the data that is looked up is not used (so for an SQL query, for
7872 example, it doesn't matter what field you select). Exim is interested only in
7873 whether or not the query succeeds. However, when a lookup is used for the
7874 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7875 variable and can be referred to in other options.
7876 .next
7877 .cindex "domain list" "matching literal domain name"
7878 If none of the above cases apply, a caseless textual comparison is made
7879 between the pattern and the domain.
7880 .endlist
7881
7882 Here is an example that uses several different kinds of pattern:
7883 .code
7884 domainlist funny_domains = \
7885   @ : \
7886   lib.unseen.edu : \
7887   *.foundation.fict.example : \
7888   \N^[1-2]\d{3}\.fict\.example$\N : \
7889   partial-dbm;/opt/data/penguin/book : \
7890   nis;domains.byname : \
7891   nisplus;[name=$domain,status=local],domains.org_dir
7892 .endd
7893 There are obvious processing trade-offs among the various matching modes. Using
7894 an asterisk is faster than a regular expression, and listing a few names
7895 explicitly probably is too. The use of a file or database lookup is expensive,
7896 but may be the only option if hundreds of names are required. Because the
7897 patterns are tested in order, it makes sense to put the most commonly matched
7898 patterns earlier.
7899
7900
7901
7902 .section "Host lists" "SECThostlist"
7903 .cindex "host list" "patterns in"
7904 .cindex "list" "host list"
7905 Host lists are used to control what remote hosts are allowed to do. For
7906 example, some hosts may be allowed to use the local host as a relay, and some
7907 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7908 two different ways, by name or by IP address. In a host list, some types of
7909 pattern are matched to a host name, and some are matched to an IP address.
7910 You need to be particularly careful with this when single-key lookups are
7911 involved, to ensure that the right value is being used as the key.
7912
7913
7914 .section "Special host list patterns" "SECID80"
7915 .cindex "empty item in hosts list"
7916 .cindex "host list" "empty string in"
7917 If a host list item is the empty string, it matches only when no remote host is
7918 involved. This is the case when a message is being received from a local
7919 process using SMTP on the standard input, that is, when a TCP/IP connection is
7920 not used.
7921
7922 .cindex "asterisk" "in host list"
7923 The special pattern &"*"& in a host list matches any host or no host. Neither
7924 the IP address nor the name is actually inspected.
7925
7926
7927
7928 .section "Host list patterns that match by IP address" "SECThoslispatip"
7929 .cindex "host list" "matching IP addresses"
7930 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7931 the incoming address actually appears in the IPv6 host as
7932 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7933 list, it is converted into a traditional IPv4 address first. (Not all operating
7934 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7935 concerns.)
7936
7937 The following types of pattern in a host list check the remote host by
7938 inspecting its IP address:
7939
7940 .ilist
7941 If the pattern is a plain domain name (not a regular expression, not starting
7942 with *, not a lookup of any kind), Exim calls the operating system function
7943 to find the associated IP address(es). Exim uses the newer
7944 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7945 This typically causes a forward DNS lookup of the name. The result is compared
7946 with the IP address of the subject host.
7947
7948 If there is a temporary problem (such as a DNS timeout) with the host name
7949 lookup, a temporary error occurs. For example, if the list is being used in an
7950 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7951 temporary SMTP error code. If no IP address can be found for the host name,
7952 what happens is described in section &<<SECTbehipnot>>& below.
7953
7954 .next
7955 .cindex "@ in a host list"
7956 If the pattern is &"@"&, the primary host name is substituted and used as a
7957 domain name, as just described.
7958
7959 .next
7960 If the pattern is an IP address, it is matched against the IP address of the
7961 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7962 IPv6 addresses can be given in colon-separated format, but the colons have to
7963 be doubled so as not to be taken as item separators when the default list
7964 separator is used. IPv6 addresses are recognized even when Exim is compiled
7965 without IPv6 support. This means that if they appear in a host list on an
7966 IPv4-only host, Exim will not treat them as host names. They are just addresses
7967 that can never match a client host.
7968
7969 .next
7970 .cindex "@[] in a host list"
7971 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7972 the local host. For example, if the local host is an IPv4 host with one
7973 interface address 10.45.23.56, these two ACL statements have the same effect:
7974 .code
7975 accept hosts = 127.0.0.1 : 10.45.23.56
7976 accept hosts = @[]
7977 .endd
7978 .next
7979 .cindex "CIDR notation"
7980 If the pattern is an IP address followed by a slash and a mask length (for
7981 example 10.11.42.0/24), it is matched against the IP address of the subject
7982 host under the given mask. This allows, an entire network of hosts to be
7983 included (or excluded) by a single item. The mask uses CIDR notation; it
7984 specifies the number of address bits that must match, starting from the most
7985 significant end of the address.
7986
7987 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7988 of a range of addresses. It is the number of bits in the network portion of the
7989 address. The above example specifies a 24-bit netmask, so it matches all 256
7990 addresses in the 10.11.42.0 network. An item such as
7991 .code
7992 192.168.23.236/31
7993 .endd
7994 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7995 32 for an IPv4 address is the same as no mask at all; just a single address
7996 matches.
7997
7998 Here is another example which shows an IPv4 and an IPv6 network:
7999 .code
8000 recipient_unqualified_hosts = 192.168.0.0/16: \
8001                               3ffe::ffff::836f::::/48
8002 .endd
8003 The doubling of list separator characters applies only when these items
8004 appear inline in a host list. It is not required when indirecting via a file.
8005 For example:
8006 .code
8007 recipient_unqualified_hosts = /opt/exim/unqualnets
8008 .endd
8009 could make use of a file containing
8010 .code
8011 172.16.0.0/12
8012 3ffe:ffff:836f::/48
8013 .endd
8014 to have exactly the same effect as the previous example. When listing IPv6
8015 addresses inline, it is usually more convenient to use the facility for
8016 changing separator characters. This list contains the same two networks:
8017 .code
8018 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8019                                  3ffe:ffff:836f::/48
8020 .endd
8021 The separator is changed to semicolon by the leading &"<;"& at the start of the
8022 list.
8023 .endlist
8024
8025
8026
8027 .section "Host list patterns for single-key lookups by host address" &&&
8028          "SECThoslispatsikey"
8029 .cindex "host list" "lookup of IP address"
8030 When a host is to be identified by a single-key lookup of its complete IP
8031 address, the pattern takes this form:
8032 .display
8033 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8034 .endd
8035 For example:
8036 .code
8037 hosts_lookup = net-cdb;/hosts-by-ip.db
8038 .endd
8039 The text form of the IP address of the subject host is used as the lookup key.
8040 IPv6 addresses are converted to an unabbreviated form, using lower case
8041 letters, with dots as separators because colon is the key terminator in
8042 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8043 quoting the keys, but this is a facility that was added later.] The data
8044 returned by the lookup is not used.
8045
8046 .cindex "IP address" "masking"
8047 .cindex "host list" "masked IP address"
8048 Single-key lookups can also be performed using masked IP addresses, using
8049 patterns of this form:
8050 .display
8051 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8052 .endd
8053 For example:
8054 .code
8055 net24-dbm;/networks.db
8056 .endd
8057 The IP address of the subject host is masked using <&'number'&> as the mask
8058 length. A textual string is constructed from the masked value, followed by the
8059 mask, and this is used as the lookup key. For example, if the host's IP address
8060 is 192.168.34.6, the key that is looked up for the above example is
8061 &"192.168.34.0/24"&.
8062
8063 When an IPv6 address is converted to a string, dots are normally used instead
8064 of colons, so that keys in &(lsearch)& files need not contain colons (which
8065 terminate &(lsearch)& keys). This was implemented some time before the ability
8066 to quote keys was made available in &(lsearch)& files. However, the more
8067 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8068 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8069 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8070 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8071 addresses are always used.
8072
8073 Ideally, it would be nice to tidy up this anomalous situation by changing to
8074 colons in all cases, given that quoting is now available for &(lsearch)&.
8075 However, this would be an incompatible change that might break some existing
8076 configurations.
8077
8078 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8079 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8080 the former case the key strings include the mask value, whereas in the latter
8081 case the IP address is used on its own.
8082
8083
8084
8085 .section "Host list patterns that match by host name" "SECThoslispatnam"
8086 .cindex "host" "lookup failures"
8087 .cindex "unknown host name"
8088 .cindex "host list" "matching host name"
8089 There are several types of pattern that require Exim to know the name of the
8090 remote host. These are either wildcard patterns or lookups by name. (If a
8091 complete hostname is given without any wildcarding, it is used to find an IP
8092 address to match against, as described in the section &<<SECThoslispatip>>&
8093 above.)
8094
8095 If the remote host name is not already known when Exim encounters one of these
8096 patterns, it has to be found from the IP address.
8097 Although many sites on the Internet are conscientious about maintaining reverse
8098 DNS data for their hosts, there are also many that do not do this.
8099 Consequently, a name cannot always be found, and this may lead to unwanted
8100 effects. Take care when configuring host lists with wildcarded name patterns.
8101 Consider what will happen if a name cannot be found.
8102
8103 Because of the problems of determining host names from IP addresses, matching
8104 against host names is not as common as matching against IP addresses.
8105
8106 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8107 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8108 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8109 are done can be changed by setting the &%host_lookup_order%& option. For
8110 security, once Exim has found one or more names, it looks up the IP addresses
8111 for these names and compares them with the IP address that it started with.
8112 Only those names whose IP addresses match are accepted. Any other names are
8113 discarded. If no names are left, Exim behaves as if the host name cannot be
8114 found. In the most common case there is only one name and one IP address.
8115
8116 There are some options that control what happens if a host name cannot be
8117 found. These are described in section &<<SECTbehipnot>>& below.
8118
8119 .cindex "host" "alias for"
8120 .cindex "alias for host"
8121 As a result of aliasing, hosts may have more than one name. When processing any
8122 of the following types of pattern, all the host's names are checked:
8123
8124 .ilist
8125 .cindex "asterisk" "in host list"
8126 If a pattern starts with &"*"& the remainder of the item must match the end of
8127 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8128 &'.b.c'&. This special simple form is provided because this is a very common
8129 requirement. Other kinds of wildcarding require the use of a regular
8130 expression.
8131 .next
8132 .cindex "regular expressions" "in host list"
8133 .cindex "host list" "regular expression in"
8134 If the item starts with &"^"& it is taken to be a regular expression which is
8135 matched against the host name. Host names are case-independent, so this regular
8136 expression match is by default case-independent, but you can make it
8137 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8138 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8139 example,
8140 .code
8141 ^(a|b)\.c\.d$
8142 .endd
8143 is a regular expression that matches either of the two hosts &'a.c.d'& or
8144 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8145 that backslash and dollar characters are not misinterpreted as part of the
8146 string expansion. The simplest way to do this is to use &`\N`& to mark that
8147 part of the string as non-expandable. For example:
8148 .code
8149 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8150 .endd
8151 &*Warning*&: If you want to match a complete host name, you must include the
8152 &`$`& terminating metacharacter in the regular expression, as in the above
8153 example. Without it, a match at the start of the host name is all that is
8154 required.
8155 .endlist
8156
8157
8158
8159
8160 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8161 .cindex "host" "lookup failures, permanent"
8162 While processing a host list, Exim may need to look up an IP address from a
8163 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8164 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8165 behaviour when it fails to find the information it is seeking is the same.
8166
8167 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8168 apply to temporary DNS errors, whose handling is described in the next section.
8169
8170 .cindex "&`+include_unknown`&"
8171 .cindex "&`+ignore_unknown`&"
8172 By default, Exim behaves as if the host does not match the list. This may not
8173 always be what you want to happen. To change Exim's behaviour, the special
8174 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8175 top level &-- they are not recognized in an indirected file).
8176
8177 .ilist
8178 If any item that follows &`+include_unknown`& requires information that
8179 cannot found, Exim behaves as if the host does match the list. For example,
8180 .code
8181 host_reject_connection = +include_unknown:*.enemy.ex
8182 .endd
8183 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8184 any hosts whose name it cannot find.
8185
8186 .next
8187 If any item that follows &`+ignore_unknown`& requires information that cannot
8188 be found, Exim ignores that item and proceeds to the rest of the list. For
8189 example:
8190 .code
8191 accept hosts = +ignore_unknown : friend.example : \
8192                192.168.4.5
8193 .endd
8194 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8195 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8196 name can be found for 192.168.4.5, it is rejected.
8197 .endlist
8198
8199 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8200 list. The effect of each one lasts until the next, or until the end of the
8201 list.
8202
8203
8204 .section "Temporary DNS errors when looking up host information" &&&
8205          "SECTtemdnserr"
8206 .cindex "host" "lookup failures, temporary"
8207 .cindex "&`+include_defer`&"
8208 .cindex "&`+ignore_defer`&"
8209 A temporary DNS lookup failure normally causes a defer action (except when
8210 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8211 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8212 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8213 section. These options should be used with care, probably only in non-critical
8214 host lists such as whitelists.
8215
8216
8217
8218 .section "Host list patterns for single-key lookups by host name" &&&
8219          "SECThoslispatnamsk"
8220 .cindex "unknown host name"
8221 .cindex "host list" "matching host name"
8222 If a pattern is of the form
8223 .display
8224 <&'single-key-search-type'&>;<&'search-data'&>
8225 .endd
8226 for example
8227 .code
8228 dbm;/host/accept/list
8229 .endd
8230 a single-key lookup is performed, using the host name as its key. If the
8231 lookup succeeds, the host matches the item. The actual data that is looked up
8232 is not used.
8233
8234 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8235 keys in the file, not IP addresses. If you want to do lookups based on IP
8236 addresses, you must precede the search type with &"net-"& (see section
8237 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8238 two items in the same list, one doing an address lookup and one doing a name
8239 lookup, both using the same file.
8240
8241
8242
8243 .section "Host list patterns for query-style lookups" "SECID81"
8244 If a pattern is of the form
8245 .display
8246 <&'query-style-search-type'&>;<&'query'&>
8247 .endd
8248 the query is obeyed, and if it succeeds, the host matches the item. The actual
8249 data that is looked up is not used. The variables &$sender_host_address$& and
8250 &$sender_host_name$& can be used in the query. For example:
8251 .code
8252 hosts_lookup = pgsql;\
8253   select ip from hostlist where ip='$sender_host_address'
8254 .endd
8255 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8256 can use the &%sg%& expansion item to change this if you need to. If you want to
8257 use masked IP addresses in database queries, you can use the &%mask%& expansion
8258 operator.
8259
8260 If the query contains a reference to &$sender_host_name$&, Exim automatically
8261 looks up the host name if has not already done so. (See section
8262 &<<SECThoslispatnam>>& for comments on finding host names.)
8263
8264 Historical note: prior to release 4.30, Exim would always attempt to find a
8265 host name before running the query, unless the search type was preceded by
8266 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8267 still recognized for query-style lookups, but its presence or absence has no
8268 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8269 See section &<<SECThoslispatsikey>>&.)
8270
8271
8272
8273 .section "Mixing wildcarded host names and addresses in host lists" &&&
8274          "SECTmixwilhos"
8275 .cindex "host list" "mixing names and addresses in"
8276 If you have name lookups or wildcarded host names and IP addresses in the same
8277 host list, you should normally put the IP addresses first. For example, in an
8278 ACL you could have:
8279 .code
8280 accept hosts = 10.9.8.7 : *.friend.example
8281 .endd
8282 The reason for this lies in the left-to-right way that Exim processes lists.
8283 It can test IP addresses without doing any DNS lookups, but when it reaches an
8284 item that requires a host name, it fails if it cannot find a host name to
8285 compare with the pattern. If the above list is given in the opposite order, the
8286 &%accept%& statement fails for a host whose name cannot be found, even if its
8287 IP address is 10.9.8.7.
8288
8289 If you really do want to do the name check first, and still recognize the IP
8290 address, you can rewrite the ACL like this:
8291 .code
8292 accept hosts = *.friend.example
8293 accept hosts = 10.9.8.7
8294 .endd
8295 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8296 &<<CHAPACL>>& for details of ACLs.
8297
8298
8299
8300
8301
8302 .section "Address lists" "SECTaddresslist"
8303 .cindex "list" "address list"
8304 .cindex "address list" "empty item"
8305 .cindex "address list" "patterns"
8306 Address lists contain patterns that are matched against mail addresses. There
8307 is one special case to be considered: the sender address of a bounce message is
8308 always empty. You can test for this by providing an empty item in an address
8309 list. For example, you can set up a router to process bounce messages by
8310 using this option setting:
8311 .code
8312 senders = :
8313 .endd
8314 The presence of the colon creates an empty item. If you do not provide any
8315 data, the list is empty and matches nothing. The empty sender can also be
8316 detected by a regular expression that matches an empty string,
8317 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8318
8319 Non-empty items in an address list can be straightforward email addresses. For
8320 example:
8321 .code
8322 senders = jbc@askone.example : hs@anacreon.example
8323 .endd
8324 A certain amount of wildcarding is permitted. If a pattern contains an @
8325 character, but is not a regular expression and does not begin with a
8326 semicolon-terminated lookup type (described below), the local part of the
8327 subject address is compared with the local part of the pattern, which may start
8328 with an asterisk. If the local parts match, the domain is checked in exactly
8329 the same way as for a pattern in a domain list. For example, the domain can be
8330 wildcarded, refer to a named list, or be a lookup:
8331 .code
8332 deny senders = *@*.spamming.site:\
8333                *@+hostile_domains:\
8334                bozo@partial-lsearch;/list/of/dodgy/sites:\
8335                *@dbm;/bad/domains.db
8336 .endd
8337 .cindex "local part" "starting with !"
8338 .cindex "address list" "local part starting with !"
8339 If a local part that begins with an exclamation mark is required, it has to be
8340 specified using a regular expression, because otherwise the exclamation mark is
8341 treated as a sign of negation, as is standard in lists.
8342
8343 If a non-empty pattern that is not a regular expression or a lookup does not
8344 contain an @ character, it is matched against the domain part of the subject
8345 address. The only two formats that are recognized this way are a literal
8346 domain, or a domain pattern that starts with *. In both these cases, the effect
8347 is the same as if &`*@`& preceded the pattern. For example:
8348 .code
8349 deny senders = enemy.domain : *.enemy.domain
8350 .endd
8351
8352 The following kinds of more complicated address list pattern can match any
8353 address, including the empty address that is characteristic of bounce message
8354 senders:
8355
8356 .ilist
8357 .cindex "regular expressions" "in address list"
8358 .cindex "address list" "regular expression in"
8359 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8360 done against the complete address, with the pattern as the regular expression.
8361 You must take care that backslash and dollar characters are not misinterpreted
8362 as part of the string expansion. The simplest way to do this is to use &`\N`&
8363 to mark that part of the string as non-expandable. For example:
8364 .code
8365 deny senders = \N^.*this.*@example\.com$\N : \
8366                \N^\d{8}.+@spamhaus.example$\N : ...
8367 .endd
8368 The &`\N`& sequences are removed by the expansion, so these items do indeed
8369 start with &"^"& by the time they are being interpreted as address patterns.
8370
8371 .next
8372 .cindex "address list" "lookup for complete address"
8373 Complete addresses can be looked up by using a pattern that starts with a
8374 lookup type terminated by a semicolon, followed by the data for the lookup. For
8375 example:
8376 .code
8377 deny senders = cdb;/etc/blocked.senders : \
8378   mysql;select address from blocked where \
8379   address='${quote_mysql:$sender_address}'
8380 .endd
8381 Both query-style and single-key lookup types can be used. For a single-key
8382 lookup type, Exim uses the complete address as the key. However, empty keys are
8383 not supported for single-key lookups, so a match against the empty address
8384 always fails. This restriction does not apply to query-style lookups.
8385
8386 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8387 cannot be used, and is ignored if specified, with an entry being written to the
8388 panic log.
8389 .cindex "*@ with single-key lookup"
8390 However, you can configure lookup defaults, as described in section
8391 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8392 default. For example, with this lookup:
8393 .code
8394 accept senders = lsearch*@;/some/file
8395 .endd
8396 the file could contains lines like this:
8397 .code
8398 user1@domain1.example
8399 *@domain2.example
8400 .endd
8401 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8402 that are tried is:
8403 .code
8404 nimrod@jaeger.example
8405 *@jaeger.example
8406 *
8407 .endd
8408 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8409 would mean that every address matches, thus rendering the test useless.
8410
8411 &*Warning 2*&: Do not confuse these two kinds of item:
8412 .code
8413 deny recipients = dbm*@;/some/file
8414 deny recipients = *@dbm;/some/file
8415 .endd
8416 The first does a whole address lookup, with defaulting, as just described,
8417 because it starts with a lookup type. The second matches the local part and
8418 domain independently, as described in a bullet point below.
8419 .endlist
8420
8421
8422 The following kinds of address list pattern can match only non-empty addresses.
8423 If the subject address is empty, a match against any of these pattern types
8424 always fails.
8425
8426
8427 .ilist
8428 .cindex "@@ with single-key lookup"
8429 .cindex "address list" "@@ lookup type"
8430 .cindex "address list" "split local part and domain"
8431 If a pattern starts with &"@@"& followed by a single-key lookup item
8432 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8433 split into a local part and a domain. The domain is looked up in the file. If
8434 it is not found, there is no match. If it is found, the data that is looked up
8435 from the file is treated as a colon-separated list of local part patterns, each
8436 of which is matched against the subject local part in turn.
8437
8438 .cindex "asterisk" "in address list"
8439 The lookup may be a partial one, and/or one involving a search for a default
8440 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8441 patterns that are looked up can be regular expressions or begin with &"*"&, or
8442 even be further lookups. They may also be independently negated. For example,
8443 with
8444 .code
8445 deny senders = @@dbm;/etc/reject-by-domain
8446 .endd
8447 the data from which the DBM file is built could contain lines like
8448 .code
8449 baddomain.com:  !postmaster : *
8450 .endd
8451 to reject all senders except &%postmaster%& from that domain.
8452
8453 .cindex "local part" "starting with !"
8454 If a local part that actually begins with an exclamation mark is required, it
8455 has to be specified using a regular expression. In &(lsearch)& files, an entry
8456 may be split over several lines by indenting the second and subsequent lines,
8457 but the separating colon must still be included at line breaks. White space
8458 surrounding the colons is ignored. For example:
8459 .code
8460 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8461 spammer3 : spammer4
8462 .endd
8463 As in all colon-separated lists in Exim, a colon can be included in an item by
8464 doubling.
8465
8466 If the last item in the list starts with a right angle-bracket, the remainder
8467 of the item is taken as a new key to look up in order to obtain a continuation
8468 list of local parts. The new key can be any sequence of characters. Thus one
8469 might have entries like
8470 .code
8471 aol.com: spammer1 : spammer 2 : >*
8472 xyz.com: spammer3 : >*
8473 *:       ^\d{8}$
8474 .endd
8475 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8476 local parts for all domains, in addition to the specific local parts listed for
8477 each domain. Of course, using this feature costs another lookup each time a
8478 chain is followed, but the effort needed to maintain the data is reduced.
8479
8480 .cindex "loop" "in lookups"
8481 It is possible to construct loops using this facility, and in order to catch
8482 them, the chains may be no more than fifty items long.
8483
8484 .next
8485 The @@<&'lookup'&> style of item can also be used with a query-style
8486 lookup, but in this case, the chaining facility is not available. The lookup
8487 can only return a single list of local parts.
8488 .endlist
8489
8490 &*Warning*&: There is an important difference between the address list items
8491 in these two examples:
8492 .code
8493 senders = +my_list
8494 senders = *@+my_list
8495 .endd
8496 In the first one, &`my_list`& is a named address list, whereas in the second
8497 example it is a named domain list.
8498
8499
8500
8501
8502 .section "Case of letters in address lists" "SECTcasletadd"
8503 .cindex "case of local parts"
8504 .cindex "address list" "case forcing"
8505 .cindex "case forcing in address lists"
8506 Domains in email addresses are always handled caselessly, but for local parts
8507 case may be significant on some systems (see &%caseful_local_part%& for how
8508 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8509 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8510 blocking lists should be done in a case-independent manner. Since most address
8511 lists in Exim are used for this kind of control, Exim attempts to do this by
8512 default.
8513
8514 The domain portion of an address is always lowercased before matching it to an
8515 address list. The local part is lowercased by default, and any string
8516 comparisons that take place are done caselessly. This means that the data in
8517 the address list itself, in files included as plain file names, and in any file
8518 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8519 keys in files that are looked up by a search type other than &(lsearch)& (which
8520 works caselessly) must be in lower case, because these lookups are not
8521 case-independent.
8522
8523 .cindex "&`+caseful`&"
8524 To allow for the possibility of caseful address list matching, if an item in
8525 an address list is the string &"+caseful"&, the original case of the local
8526 part is restored for any comparisons that follow, and string comparisons are no
8527 longer case-independent. This does not affect the domain, which remains in
8528 lower case. However, although independent matches on the domain alone are still
8529 performed caselessly, regular expressions that match against an entire address
8530 become case-sensitive after &"+caseful"& has been seen.
8531
8532
8533
8534 .section "Local part lists" "SECTlocparlis"
8535 .cindex "list" "local part list"
8536 .cindex "local part" "list"
8537 Case-sensitivity in local part lists is handled in the same way as for address
8538 lists, as just described. The &"+caseful"& item can be used if required. In a
8539 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8540 set false, the subject is lowercased and the matching is initially
8541 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8542 matching in the local part list, but not elsewhere in the router. If
8543 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8544 option is case-sensitive from the start.
8545
8546 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8547 comments are handled in the same way as address lists &-- they are recognized
8548 only if the # is preceded by white space or the start of the line.
8549 Otherwise, local part lists are matched in the same way as domain lists, except
8550 that the special items that refer to the local host (&`@`&, &`@[]`&,
8551 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8552 Refer to section &<<SECTdomainlist>>& for details of the other available item
8553 types.
8554 .ecindex IIDdohoadli
8555
8556
8557
8558
8559 . ////////////////////////////////////////////////////////////////////////////
8560 . ////////////////////////////////////////////////////////////////////////////
8561
8562 .chapter "String expansions" "CHAPexpand"
8563 .scindex IIDstrexp "expansion" "of strings"
8564 Many strings in Exim's run time configuration are expanded before use. Some of
8565 them are expanded every time they are used; others are expanded only once.
8566
8567 When a string is being expanded it is copied verbatim from left to right except
8568 when a dollar or backslash character is encountered. A dollar specifies the
8569 start of a portion of the string that is interpreted and replaced as described
8570 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8571 escape character, as described in the following section.
8572
8573 Whether a string is expanded depends upon the context.  Usually this is solely
8574 dependent upon the option for which a value is sought; in this documentation,
8575 options for which string expansion is performed are marked with &dagger; after
8576 the data type.  ACL rules always expand strings.  A couple of expansion
8577 conditions do not expand some of the brace-delimited branches, for security
8578 reasons.
8579
8580
8581
8582 .section "Literal text in expanded strings" "SECTlittext"
8583 .cindex "expansion" "including literal text"
8584 An uninterpreted dollar can be included in an expanded string by putting a
8585 backslash in front of it. A backslash can be used to prevent any special
8586 character being treated specially in an expansion, including backslash itself.
8587 If the string appears in quotes in the configuration file, two backslashes are
8588 required because the quotes themselves cause interpretation of backslashes when
8589 the string is read in (see section &<<SECTstrings>>&).
8590
8591 .cindex "expansion" "non-expandable substrings"
8592 A portion of the string can specified as non-expandable by placing it between
8593 two occurrences of &`\N`&. This is particularly useful for protecting regular
8594 expressions, which often contain backslashes and dollar signs. For example:
8595 .code
8596 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8597 .endd
8598 On encountering the first &`\N`&, the expander copies subsequent characters
8599 without interpretation until it reaches the next &`\N`& or the end of the
8600 string.
8601
8602
8603
8604 .section "Character escape sequences in expanded strings" "SECID82"
8605 .cindex "expansion" "escape sequences"
8606 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8607 expanded string is recognized as an escape sequence for the character newline,
8608 carriage return, or tab, respectively. A backslash followed by up to three
8609 octal digits is recognized as an octal encoding for a single character, and a
8610 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8611 encoding.
8612
8613 These escape sequences are also recognized in quoted strings when they are read
8614 in. Their interpretation in expansions as well is useful for unquoted strings,
8615 and for other cases such as looked-up strings that are then expanded.
8616
8617
8618 .section "Testing string expansions" "SECID83"
8619 .cindex "expansion" "testing"
8620 .cindex "testing" "string expansion"
8621 .oindex "&%-be%&"
8622 Many expansions can be tested by calling Exim with the &%-be%& option. This
8623 takes the command arguments, or lines from the standard input if there are no
8624 arguments, runs them through the string expansion code, and writes the results
8625 to the standard output. Variables based on configuration values are set up, but
8626 since no message is being processed, variables such as &$local_part$& have no
8627 value. Nevertheless the &%-be%& option can be useful for checking out file and
8628 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8629 and &%nhash%&.
8630
8631 Exim gives up its root privilege when it is called with the &%-be%& option, and
8632 instead runs under the uid and gid it was called with, to prevent users from
8633 using &%-be%& for reading files to which they do not have access.
8634
8635 .oindex "&%-bem%&"
8636 If you want to test expansions that include variables whose values are taken
8637 from a message, there are two other options that can be used. The &%-bem%&
8638 option is like &%-be%& except that it is followed by a file name. The file is
8639 read as a message before doing the test expansions. For example:
8640 .code
8641 exim -bem /tmp/test.message '$h_subject:'
8642 .endd
8643 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8644 Exim message identifier. For example:
8645 .code
8646 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8647 .endd
8648 This loads the message from Exim's spool before doing the test expansions, and
8649 is therefore restricted to admin users.
8650
8651
8652 .section "Forced expansion failure" "SECTforexpfai"
8653 .cindex "expansion" "forced failure"
8654 A number of expansions that are described in the following section have
8655 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8656 (which are sometimes called &"curly brackets"&). Which of the two strings is
8657 used depends on some condition that is evaluated as part of the expansion. If,
8658 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8659 the entire string expansion fails in a way that can be detected by the code
8660 that requested the expansion. This is called &"forced expansion failure"&, and
8661 its consequences depend on the circumstances. In some cases it is no different
8662 from any other expansion failure, but in others a different action may be
8663 taken. Such variations are mentioned in the documentation of the option that is
8664 being expanded.
8665
8666
8667
8668
8669 .section "Expansion items" "SECTexpansionitems"
8670 The following items are recognized in expanded strings. White space may be used
8671 between sub-items that are keywords or substrings enclosed in braces inside an
8672 outer set of braces, to improve readability. &*Warning*&: Within braces,
8673 white space is significant.
8674
8675 .vlist
8676 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8677 .cindex "expansion" "variables"
8678 Substitute the contents of the named variable, for example:
8679 .code
8680 $local_part
8681 ${domain}
8682 .endd
8683 The second form can be used to separate the name from subsequent alphanumeric
8684 characters. This form (using braces) is available only for variables; it does
8685 &'not'& apply to message headers. The names of the variables are given in
8686 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8687 given, the expansion fails.
8688
8689 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8690 .cindex "expansion" "operators"
8691 The string is first itself expanded, and then the operation specified by
8692 <&'op'&> is applied to it. For example:
8693 .code
8694 ${lc:$local_part}
8695 .endd
8696 The string starts with the first character after the colon, which may be
8697 leading white space. A list of operators is given in section &<<SECTexpop>>&
8698 below. The operator notation is used for simple expansion items that have just
8699 one argument, because it reduces the number of braces and therefore makes the
8700 string easier to understand.
8701
8702 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8703 This item inserts &"basic"& header lines. It is described with the &%header%&
8704 expansion item below.
8705
8706 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8707        {*&<&'arg'&>&*}...}*&"
8708 .cindex &%dlfunc%&
8709 This expansion dynamically loads and then calls a locally-written C function.
8710 This functionality is available only if Exim is compiled with
8711 .code
8712 EXPAND_DLFUNC=yes
8713 .endd
8714 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8715 object so that it doesn't reload the same object file in the same Exim process
8716 (but of course Exim does start new processes frequently).
8717
8718 There may be from zero to eight arguments to the function. When compiling
8719 a local function that is to be called in this way, &_local_scan.h_& should be
8720 included. The Exim variables and functions that are defined by that API
8721 are also available for dynamically loaded functions. The function itself
8722 must have the following type:
8723 .code
8724 int dlfunction(uschar **yield, int argc, uschar *argv[])
8725 .endd
8726 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8727 function should return one of the following values:
8728
8729 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8730 into the expanded string that is being built.
8731
8732 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8733 from &'yield'&, if it is set.
8734
8735 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8736 taken from &'yield'& if it is set.
8737
8738 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8739
8740 When compiling a function that is to be used in this way with gcc,
8741 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8742 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8743
8744 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8745        {*&<&'string3'&>&*}}*&"
8746 .cindex "expansion" "extracting substrings by key"
8747 .cindex "&%extract%&" "substrings by key"
8748 The key and <&'string1'&> are first expanded separately. Leading and trailing
8749 white space is removed from the key (but not from any of the strings). The key
8750 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8751 form:
8752 .display
8753 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8754 .endd
8755 .vindex "&$value$&"
8756 where the equals signs and spaces (but not both) are optional. If any of the
8757 values contain white space, they must be enclosed in double quotes, and any
8758 values that are enclosed in double quotes are subject to escape processing as
8759 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8760 for the value that corresponds to the key. The search is case-insensitive. If
8761 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8762 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8763 variable &$value$& contains the value that has been extracted. Afterwards, it
8764 is restored to any previous value it might have had.
8765
8766 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8767 key is not found. If {<&'string2'&>} is also omitted, the value that was
8768 extracted is used. Thus, for example, these two expansions are identical, and
8769 yield &"2001"&:
8770 .code
8771 ${extract{gid}{uid=1984 gid=2001}}
8772 ${extract{gid}{uid=1984 gid=2001}{$value}}
8773 .endd
8774 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8775 appear, for example:
8776 .code
8777 ${extract{Z}{A=... B=...}{$value} fail }
8778 .endd
8779 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8780 {<&'string2'&>} must be present for &"fail"& to be recognized.
8781
8782
8783 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8784         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8785 .cindex "expansion" "extracting substrings by number"
8786 .cindex "&%extract%&" "substrings by number"
8787 The <&'number'&> argument must consist entirely of decimal digits,
8788 apart from leading and trailing white space, which is ignored.
8789 This is what distinguishes this form of &%extract%& from the previous kind. It
8790 behaves in the same way, except that, instead of extracting a named field, it
8791 extracts from <&'string1'&> the field whose number is given as the first
8792 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8793 <&'string3'&> as before.
8794
8795 The fields in the string are separated by any one of the characters in the
8796 separator string. These may include space or tab characters.
8797 The first field is numbered one. If the number is negative, the fields are
8798 counted from the end of the string, with the rightmost one numbered -1. If the
8799 number given is zero, the entire string is returned. If the modulus of the
8800 number is greater than the number of fields in the string, the result is the
8801 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8802 provided. For example:
8803 .code
8804 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8805 .endd
8806 yields &"42"&, and
8807 .code
8808 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8809 .endd
8810 yields &"99"&. Two successive separators mean that the field between them is
8811 empty (for example, the fifth field above).
8812
8813
8814 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8815 .cindex "list" "selecting by condition"
8816 .cindex "expansion" "selecting from list by condition"
8817 .vindex "&$item$&"
8818 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8819 default, but the separator can be changed in the usual way. For each item
8820 in this list, its value is place in &$item$&, and then the condition is
8821 evaluated. If the condition is true, &$item$& is added to the output as an
8822 item in a new list; if the condition is false, the item is discarded. The
8823 separator used for the output list is the same as the one used for the
8824 input, but a separator setting is not included in the output. For example:
8825 .code
8826 ${filter{a:b:c}{!eq{$item}{b}}
8827 .endd
8828 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8829 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8830
8831
8832 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8833 .cindex "hash function" "textual"
8834 .cindex "expansion" "textual hash"
8835 This is a textual hashing function, and was the first to be implemented in
8836 early versions of Exim. In current releases, there are other hashing functions
8837 (numeric, MD5, and SHA-1), which are described below.
8838
8839 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8840 <&'n'&>. If you are using fixed values for these numbers, that is, if
8841 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8842 use the simpler operator notation that avoids some of the braces:
8843 .code
8844 ${hash_<n>_<m>:<string>}
8845 .endd
8846 The second number is optional (in both notations). If <&'n'&> is greater than
8847 or equal to the length of the string, the expansion item returns the string.
8848 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8849 function to the string. The new string consists of characters taken from the
8850 first <&'m'&> characters of the string
8851 .code
8852 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8853 .endd
8854 If <&'m'&> is not present the value 26 is used, so that only lower case
8855 letters appear. For example:
8856 .display
8857 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8858 &`$hash{5}{monty}}           `&   yields  &`monty`&
8859 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8860 .endd
8861
8862 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8863         &*$h_*&<&'header&~name'&>&*:*&" &&&
8864        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8865         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8866        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8867         &*$rh_*&<&'header&~name'&>&*:*&"
8868 .cindex "expansion" "header insertion"
8869 .vindex "&$header_$&"
8870 .vindex "&$bheader_$&"
8871 .vindex "&$rheader_$&"
8872 .cindex "header lines" "in expansion strings"
8873 .cindex "header lines" "character sets"
8874 .cindex "header lines" "decoding"
8875 Substitute the contents of the named message header line, for example
8876 .code
8877 $header_reply-to:
8878 .endd
8879 The newline that terminates a header line is not included in the expansion, but
8880 internal newlines (caused by splitting the header line over several physical
8881 lines) may be present.
8882
8883 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8884 the data in the header line is interpreted.
8885
8886 .ilist
8887 .cindex "white space" "in header lines"
8888 &%rheader%& gives the original &"raw"& content of the header line, with no
8889 processing at all, and without the removal of leading and trailing white space.
8890
8891 .next
8892 .cindex "base64 encoding" "in header lines"
8893 &%bheader%& removes leading and trailing white space, and then decodes base64
8894 or quoted-printable MIME &"words"& within the header text, but does no
8895 character set translation. If decoding of what looks superficially like a MIME
8896 &"word"& fails, the raw string is returned. If decoding
8897 .cindex "binary zero" "in header line"
8898 produces a binary zero character, it is replaced by a question mark &-- this is
8899 what Exim does for binary zeros that are actually received in header lines.
8900
8901 .next
8902 &%header%& tries to translate the string as decoded by &%bheader%& to a
8903 standard character set. This is an attempt to produce the same string as would
8904 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8905 returned. Translation is attempted only on operating systems that support the
8906 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8907 a system Makefile or in &_Local/Makefile_&.
8908 .endlist ilist
8909
8910 In a filter file, the target character set for &%header%& can be specified by a
8911 command of the following form:
8912 .code
8913 headers charset "UTF-8"
8914 .endd
8915 This command affects all references to &$h_$& (or &$header_$&) expansions in
8916 subsequently obeyed filter commands. In the absence of this command, the target
8917 character set in a filter is taken from the setting of the &%headers_charset%&
8918 option in the runtime configuration. The value of this option defaults to the
8919 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8920 ISO-8859-1.
8921
8922 Header names follow the syntax of RFC 2822, which states that they may contain
8923 any printing characters except space and colon. Consequently, curly brackets
8924 &'do not'& terminate header names, and should not be used to enclose them as
8925 if they were variables. Attempting to do so causes a syntax error.
8926
8927 Only header lines that are common to all copies of a message are visible to
8928 this mechanism. These are the original header lines that are received with the
8929 message, and any that are added by an ACL statement or by a system
8930 filter. Header lines that are added to a particular copy of a message by a
8931 router or transport are not accessible.
8932
8933 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8934 before the DATA ACL, because the header structure is not set up until the
8935 message is received. Header lines that are added in a RCPT ACL (for example)
8936 are saved until the message's incoming header lines are available, at which
8937 point they are added. When a DATA ACL is running, however, header lines added
8938 by earlier ACLs are visible.
8939
8940 Upper case and lower case letters are synonymous in header names. If the
8941 following character is white space, the terminating colon may be omitted, but
8942 this is not recommended, because you may then forget it when it is needed. When
8943 white space terminates the header name, it is included in the expanded string.
8944 If the message does not contain the given header, the expansion item is
8945 replaced by an empty string. (See the &%def%& condition in section
8946 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8947
8948 If there is more than one header with the same name, they are all concatenated
8949 to form the substitution string, up to a maximum length of 64K. Unless
8950 &%rheader%& is being used, leading and trailing white space is removed from
8951 each header before concatenation, and a completely empty header is ignored. A
8952 newline character is then inserted between non-empty headers, but there is no
8953 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8954 those headers that contain lists of addresses, a comma is also inserted at the
8955 junctions between headers. This does not happen for the &%rheader%& expansion.
8956
8957
8958 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8959 .cindex "expansion" "hmac hashing"
8960 .cindex &%hmac%&
8961 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8962 shared secret and some text into a message authentication code, as specified in
8963 RFC 2104. This differs from &`${md5:secret_text...}`& or
8964 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8965 cryptographic hash, allowing for authentication that is not possible with MD5
8966 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8967 present. For example:
8968 .code
8969 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8970 .endd
8971 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8972 produces:
8973 .code
8974 dd97e3ba5d1a61b5006108f8c8252953
8975 .endd
8976 As an example of how this might be used, you might put in the main part of
8977 an Exim configuration:
8978 .code
8979 SPAMSCAN_SECRET=cohgheeLei2thahw
8980 .endd
8981 In a router or a transport you could then have:
8982 .code
8983 headers_add = \
8984   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8985   ${hmac{md5}{SPAMSCAN_SECRET}\
8986   {${primary_hostname},${message_exim_id},$h_message-id:}}
8987 .endd
8988 Then given a message, you can check where it was scanned by looking at the
8989 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8990 this header line is authentic by recomputing the authentication code from the
8991 host name, message ID and the &'Message-id:'& header line. This can be done
8992 using Exim's &%-be%& option, or by other means, for example by using the
8993 &'hmac_md5_hex()'& function in Perl.
8994
8995
8996 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8997 .cindex "expansion" "conditional"
8998 .cindex "&%if%&, expansion item"
8999 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9000 item; otherwise <&'string2'&> is used. The available conditions are described
9001 in section &<<SECTexpcond>>& below. For example:
9002 .code
9003 ${if eq {$local_part}{postmaster} {yes}{no} }
9004 .endd
9005 The second string need not be present; if it is not and the condition is not
9006 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9007 be present instead of the second string (without any curly brackets). In this
9008 case, the expansion is forced to fail if the condition is not true (see section
9009 &<<SECTforexpfai>>&).
9010
9011 If both strings are omitted, the result is the string &`true`& if the condition
9012 is true, and the empty string if the condition is false. This makes it less
9013 cumbersome to write custom ACL and router conditions. For example, instead of
9014 .code
9015 condition = ${if >{$acl_m4}{3}{true}{false}}
9016 .endd
9017 you can use
9018 .code
9019 condition = ${if >{$acl_m4}{3}}
9020 .endd
9021
9022 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9023 .cindex "expansion" "string truncation"
9024 .cindex "&%length%& expansion item"
9025 The &%length%& item is used to extract the initial portion of a string. Both
9026 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9027 you are using a fixed value for the number, that is, if <&'string1'&> does not
9028 change when expanded, you can use the simpler operator notation that avoids
9029 some of the braces:
9030 .code
9031 ${length_<n>:<string>}
9032 .endd
9033 The result of this item is either the first <&'n'&> characters or the whole
9034 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9035 &%strlen%&, which gives the length of a string.
9036
9037
9038 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9039         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9040 This is the first of one of two different types of lookup item, which are both
9041 described in the next item.
9042
9043 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9044         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9045 .cindex "expansion" "lookup in"
9046 .cindex "file" "lookups"
9047 .cindex "lookup" "in expanded string"
9048 The two forms of lookup item specify data lookups in files and databases, as
9049 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9050 lookups, and the second is used for query-style lookups. The <&'key'&>,
9051 <&'file'&>, and <&'query'&> strings are expanded before use.
9052
9053 If there is any white space in a lookup item which is part of a filter command,
9054 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9055 other place where white space is significant, the lookup item must be enclosed
9056 in double quotes. The use of data lookups in users' filter files may be locked
9057 out by the system administrator.
9058
9059 .vindex "&$value$&"
9060 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9061 During its expansion, the variable &$value$& contains the data returned by the
9062 lookup. Afterwards it reverts to the value it had previously (at the outer
9063 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9064 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9065 string on failure. If <&'string2'&> is provided, it can itself be a nested
9066 lookup, thus providing a mechanism for looking up a default value when the
9067 original lookup fails.
9068
9069 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9070 data for the outer lookup while the parameters of the second lookup are
9071 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9072 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9073 appear, and in this case, if the lookup fails, the entire expansion is forced
9074 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9075 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9076 successful lookup, and nothing in the case of failure.
9077
9078 For single-key lookups, the string &"partial"& is permitted to precede the
9079 search type in order to do partial matching, and * or *@ may follow a search
9080 type to request default lookups if the key does not match (see sections
9081 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9082
9083 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9084 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9085 and non-wild parts of the key during the expansion of the replacement text.
9086 They return to their previous values at the end of the lookup item.
9087
9088 This example looks up the postmaster alias in the conventional alias file:
9089 .code
9090 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9091 .endd
9092 This example uses NIS+ to look up the full name of the user corresponding to
9093 the local part of an address, forcing the expansion to fail if it is not found:
9094 .code
9095 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9096   {$value}fail}
9097 .endd
9098
9099
9100 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9101 .cindex "expansion" "list creation"
9102 .vindex "&$item$&"
9103 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9104 default, but the separator can be changed in the usual way. For each item
9105 in this list, its value is place in &$item$&, and then <&'string2'&> is
9106 expanded and added to the output as an item in a new list. The separator used
9107 for the output list is the same as the one used for the input, but a separator
9108 setting is not included in the output. For example:
9109 .code
9110 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9111 .endd
9112 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9113 value of &$item$& is restored to what it was before. See also the &*filter*&
9114 and &*reduce*& expansion items.
9115
9116 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9117 .cindex "expansion" "numeric hash"
9118 .cindex "hash function" "numeric"
9119 The three strings are expanded; the first two must yield numbers. Call them
9120 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9121 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9122 can use the simpler operator notation that avoids some of the braces:
9123 .code
9124 ${nhash_<n>_<m>:<string>}
9125 .endd
9126 The second number is optional (in both notations). If there is only one number,
9127 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9128 processed by a div/mod hash function that returns two numbers, separated by a
9129 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9130 example,
9131 .code
9132 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9133 .endd
9134 returns the string &"6/33"&.
9135
9136
9137
9138 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9139 .cindex "Perl" "use in expanded string"
9140 .cindex "expansion" "calling Perl from"
9141 This item is available only if Exim has been built to include an embedded Perl
9142 interpreter. The subroutine name and the arguments are first separately
9143 expanded, and then the Perl subroutine is called with those arguments. No
9144 additional arguments need be given; the maximum number permitted, including the
9145 name of the subroutine, is nine.
9146
9147 The return value of the subroutine is inserted into the expanded string, unless
9148 the return value is &%undef%&. In that case, the expansion fails in the same
9149 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9150 Whatever you return is evaluated in a scalar context. For example, if you
9151 return the name of a Perl vector, the return value is the size of the vector,
9152 not its contents.
9153
9154 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9155 with the error message that was passed to &%die%&. More details of the embedded
9156 Perl facility are given in chapter &<<CHAPperl>>&.
9157
9158 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9159 out the use of this expansion item in filter files.
9160
9161
9162 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9163 .cindex "&%prvs%& expansion item"
9164 The first argument is a complete email address and the second is secret
9165 keystring. The third argument, specifying a key number, is optional. If absent,
9166 it defaults to 0. The result of the expansion is a prvs-signed email address,
9167 to be typically used with the &%return_path%& option on an &(smtp)& transport
9168 as part of a bounce address tag validation (BATV) scheme. For more discussion
9169 and an example, see section &<<SECTverifyPRVS>>&.
9170
9171 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9172         {*&<&'string'&>&*}}*&"
9173 .cindex "&%prvscheck%& expansion item"
9174 This expansion item is the complement of the &%prvs%& item. It is used for
9175 checking prvs-signed addresses. If the expansion of the first argument does not
9176 yield a syntactically valid prvs-signed address, the whole item expands to the
9177 empty string. When the first argument does expand to a syntactically valid
9178 prvs-signed address, the second argument is expanded, with the prvs-decoded
9179 version of the address and the key number extracted from the address in the
9180 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9181
9182 These two variables can be used in the expansion of the second argument to
9183 retrieve the secret. The validity of the prvs-signed address is then checked
9184 against the secret. The result is stored in the variable &$prvscheck_result$&,
9185 which is empty for failure or &"1"& for success.
9186
9187 The third argument is optional; if it is missing, it defaults to an empty
9188 string. This argument is now expanded. If the result is an empty string, the
9189 result of the expansion is the decoded version of the address. This is the case
9190 whether or not the signature was valid. Otherwise, the result of the expansion
9191 is the expansion of the third argument.
9192
9193 All three variables can be used in the expansion of the third argument.
9194 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9195 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9196
9197 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9198 .cindex "expansion" "inserting an entire file"
9199 .cindex "file" "inserting into expansion"
9200 .cindex "&%readfile%& expansion item"
9201 The file name and end-of-line string are first expanded separately. The file is
9202 then read, and its contents replace the entire item. All newline characters in
9203 the file are replaced by the end-of-line string if it is present. Otherwise,
9204 newlines are left in the string.
9205 String expansion is not applied to the contents of the file. If you want this,
9206 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9207 the string expansion fails.
9208
9209 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9210 locks out the use of this expansion item in filter files.
9211
9212
9213
9214 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9215         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9216 .cindex "expansion" "inserting from a socket"
9217 .cindex "socket, use of in expansion"
9218 .cindex "&%readsocket%& expansion item"
9219 This item inserts data from a Unix domain or Internet socket into the expanded
9220 string. The minimal way of using it uses just two arguments, as in these
9221 examples:
9222 .code
9223 ${readsocket{/socket/name}{request string}}
9224 ${readsocket{inet:some.host:1234}{request string}}
9225 .endd
9226 For a Unix domain socket, the first substring must be the path to the socket.
9227 For an Internet socket, the first substring must contain &`inet:`& followed by
9228 a host name or IP address, followed by a colon and a port, which can be a
9229 number or the name of a TCP port in &_/etc/services_&. An IP address may
9230 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9231 example:
9232 .code
9233 ${readsocket{inet:[::1]:1234}{request string}}
9234 .endd
9235 Only a single host name may be given, but if looking it up yields more than
9236 one IP address, they are each tried in turn until a connection is made. For
9237 both kinds of socket, Exim makes a connection, writes the request string
9238 (unless it is an empty string) and reads from the socket until an end-of-file
9239 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9240 extend what can be done. Firstly, you can vary the timeout. For example:
9241 .code
9242 ${readsocket{/socket/name}{request string}{3s}}
9243 .endd
9244 A fourth argument allows you to change any newlines that are in the data
9245 that is read, in the same way as for &%readfile%& (see above). This example
9246 turns them into spaces:
9247 .code
9248 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9249 .endd
9250 As with all expansions, the substrings are expanded before the processing
9251 happens. Errors in these sub-expansions cause the expansion to fail. In
9252 addition, the following errors can occur:
9253
9254 .ilist
9255 Failure to create a socket file descriptor;
9256 .next
9257 Failure to connect the socket;
9258 .next
9259 Failure to write the request string;
9260 .next
9261 Timeout on reading from the socket.
9262 .endlist
9263
9264 By default, any of these errors causes the expansion to fail. However, if
9265 you supply a fifth substring, it is expanded and used when any of the above
9266 errors occurs. For example:
9267 .code
9268 ${readsocket{/socket/name}{request string}{3s}{\n}\
9269   {socket failure}}
9270 .endd
9271 You can test for the existence of a Unix domain socket by wrapping this
9272 expansion in &`${if exists`&, but there is a race condition between that test
9273 and the actual opening of the socket, so it is safer to use the fifth argument
9274 if you want to be absolutely sure of avoiding an expansion error for a
9275 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9276
9277 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9278 locks out the use of this expansion item in filter files.
9279
9280
9281 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9282 .cindex "expansion" "reducing a list to a scalar"
9283 .cindex "list" "reducing to a scalar"
9284 .vindex "&$value$&"
9285 .vindex "&$item$&"
9286 This operation reduces a list to a single, scalar string. After expansion,
9287 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9288 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9289 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9290 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9291 them. The result of that expansion is assigned to &$value$& before the next
9292 iteration. When the end of the list is reached, the final value of &$value$& is
9293 added to the expansion output. The &*reduce*& expansion item can be used in a
9294 number of ways. For example, to add up a list of numbers:
9295 .code
9296 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9297 .endd
9298 The result of that expansion would be &`6`&. The maximum of a list of numbers
9299 can be found:
9300 .code
9301 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9302 .endd
9303 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9304 restored to what they were before. See also the &*filter*& and &*map*&
9305 expansion items.
9306
9307 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9308 This item inserts &"raw"& header lines. It is described with the &%header%&
9309 expansion item above.
9310
9311 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9312         {*&<&'string2'&>&*}}*&"
9313 .cindex "expansion" "running a command"
9314 .cindex "&%run%& expansion item"
9315 The command and its arguments are first expanded separately, and then the
9316 command is run in a separate process, but under the same uid and gid. As in
9317 other command executions from Exim, a shell is not used by default. If you want
9318 a shell, you must explicitly code it.
9319
9320 The standard input for the command exists, but is empty. The standard output
9321 and standard error are set to the same file descriptor.
9322 .cindex "return code" "from &%run%& expansion"
9323 .vindex "&$value$&"
9324 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9325 and replaces the entire item; during this expansion, the standard output/error
9326 from the command is in the variable &$value$&. If the command fails,
9327 <&'string2'&>, if present, is expanded and used. Once again, during the
9328 expansion, the standard output/error from the command is in the variable
9329 &$value$&.
9330
9331 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9332 can be the word &"fail"& (not in braces) to force expansion failure if the
9333 command does not succeed. If both strings are omitted, the result is contents
9334 of the standard output/error on success, and nothing on failure.
9335
9336 .vindex "&$runrc$&"
9337 The return code from the command is put in the variable &$runrc$&, and this
9338 remains set afterwards, so in a filter file you can do things like this:
9339 .code
9340 if "${run{x y z}{}}$runrc" is 1 then ...
9341   elif $runrc is 2 then ...
9342   ...
9343 endif
9344 .endd
9345 If execution of the command fails (for example, the command does not exist),
9346 the return code is 127 &-- the same code that shells use for non-existent
9347 commands.
9348
9349 &*Warning*&: In a router or transport, you cannot assume the order in which
9350 option values are expanded, except for those preconditions whose order of
9351 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9352 by the expansion of one option, and use it in another.
9353
9354 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9355 out the use of this expansion item in filter files.
9356
9357
9358 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9359 .cindex "expansion" "string substitution"
9360 .cindex "&%sg%& expansion item"
9361 This item works like Perl's substitution operator (s) with the global (/g)
9362 option; hence its name. However, unlike the Perl equivalent, Exim does not
9363 modify the subject string; instead it returns the modified string for insertion
9364 into the overall expansion. The item takes three arguments: the subject string,
9365 a regular expression, and a substitution string. For example:
9366 .code
9367 ${sg{abcdefabcdef}{abc}{xyz}}
9368 .endd
9369 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9370 if any $ or \ characters are required in the regular expression or in the
9371 substitution string, they have to be escaped. For example:
9372 .code
9373 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9374 .endd
9375 yields &"defabc"&, and
9376 .code
9377 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9378 .endd
9379 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9380 the regular expression from string expansion.
9381
9382
9383
9384 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9385 .cindex "&%substr%& expansion item"
9386 .cindex "substring extraction"
9387 .cindex "expansion" "substring extraction"
9388 The three strings are expanded; the first two must yield numbers. Call them
9389 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9390 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9391 can use the simpler operator notation that avoids some of the braces:
9392 .code
9393 ${substr_<n>_<m>:<string>}
9394 .endd
9395 The second number is optional (in both notations).
9396 If it is absent in the simpler format, the preceding underscore must also be
9397 omitted.
9398
9399 The &%substr%& item can be used to extract more general substrings than
9400 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9401 length required. For example
9402 .code
9403 ${substr{3}{2}{$local_part}}
9404 .endd
9405 If the starting offset is greater than the string length the result is the
9406 null string; if the length plus starting offset is greater than the string
9407 length, the result is the right-hand part of the string, starting from the
9408 given offset. The first character in the string has offset zero.
9409
9410 The &%substr%& expansion item can take negative offset values to count
9411 from the right-hand end of its operand. The last character is offset -1, the
9412 second-last is offset -2, and so on. Thus, for example,
9413 .code
9414 ${substr{-5}{2}{1234567}}
9415 .endd
9416 yields &"34"&. If the absolute value of a negative offset is greater than the
9417 length of the string, the substring starts at the beginning of the string, and
9418 the length is reduced by the amount of overshoot. Thus, for example,
9419 .code
9420 ${substr{-5}{2}{12}}
9421 .endd
9422 yields an empty string, but
9423 .code
9424 ${substr{-3}{2}{12}}
9425 .endd
9426 yields &"1"&.
9427
9428 When the second number is omitted from &%substr%&, the remainder of the string
9429 is taken if the offset is positive. If it is negative, all characters in the
9430 string preceding the offset point are taken. For example, an offset of -1 and
9431 no length, as in these semantically identical examples:
9432 .code
9433 ${substr_-1:abcde}
9434 ${substr{-1}{abcde}}
9435 .endd
9436 yields all but the last character of the string, that is, &"abcd"&.
9437
9438
9439
9440 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9441         {*&<&'replacements'&>&*}}*&"
9442 .cindex "expansion" "character translation"
9443 .cindex "&%tr%& expansion item"
9444 This item does single-character translation on its subject string. The second
9445 argument is a list of characters to be translated in the subject string. Each
9446 matching character is replaced by the corresponding character from the
9447 replacement list. For example
9448 .code
9449 ${tr{abcdea}{ac}{13}}
9450 .endd
9451 yields &`1b3de1`&. If there are duplicates in the second character string, the
9452 last occurrence is used. If the third string is shorter than the second, its
9453 last character is replicated. However, if it is empty, no translation takes
9454 place.
9455 .endlist
9456
9457
9458
9459 .section "Expansion operators" "SECTexpop"
9460 .cindex "expansion" "operators"
9461 For expansion items that perform transformations on a single argument string,
9462 the &"operator"& notation is used because it is simpler and uses fewer braces.
9463 The substring is first expanded before the operation is applied to it. The
9464 following operations can be performed:
9465
9466 .vlist
9467 .vitem &*${address:*&<&'string'&>&*}*&
9468 .cindex "expansion" "RFC 2822 address handling"
9469 .cindex "&%address%& expansion item"
9470 The string is interpreted as an RFC 2822 address, as it might appear in a
9471 header line, and the effective address is extracted from it. If the string does
9472 not parse successfully, the result is empty.
9473
9474
9475 .vitem &*${addresses:*&<&'string'&>&*}*&
9476 .cindex "expansion" "RFC 2822 address handling"
9477 .cindex "&%addresses%& expansion item"
9478 The string (after expansion) is interpreted as a list of addresses in RFC
9479 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9480 operative address (&'local-part@domain'&) is extracted from each item, and the
9481 result of the expansion is a colon-separated list, with appropriate
9482 doubling of colons should any happen to be present in the email addresses.
9483 Syntactically invalid RFC2822 address items are omitted from the output.
9484
9485 It is possible to specify a character other than colon for the output
9486 separator by starting the string with > followed by the new separator
9487 character. For example:
9488 .code
9489 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9490 .endd
9491 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9492 expansion item, which extracts the working address from a single RFC2822
9493 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9494 processing lists.
9495
9496
9497 .vitem &*${base62:*&<&'digits'&>&*}*&
9498 .cindex "&%base62%& expansion item"
9499 .cindex "expansion" "conversion to base 62"
9500 The string must consist entirely of decimal digits. The number is converted to
9501 base 62 and output as a string of six characters, including leading zeros. In
9502 the few operating environments where Exim uses base 36 instead of base 62 for
9503 its message identifiers (because those systems do not have case-sensitive file
9504 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9505 be absolutely clear: this is &'not'& base64 encoding.
9506
9507 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9508 .cindex "&%base62d%& expansion item"
9509 .cindex "expansion" "conversion to base 62"
9510 The string must consist entirely of base-62 digits, or, in operating
9511 environments where Exim uses base 36 instead of base 62 for its message
9512 identifiers, base-36 digits. The number is converted to decimal and output as a
9513 string.
9514
9515 .vitem &*${domain:*&<&'string'&>&*}*&
9516 .cindex "domain" "extraction"
9517 .cindex "expansion" "domain extraction"
9518 The string is interpreted as an RFC 2822 address and the domain is extracted
9519 from it. If the string does not parse successfully, the result is empty.
9520
9521
9522 .vitem &*${escape:*&<&'string'&>&*}*&
9523 .cindex "expansion" "escaping non-printing characters"
9524 .cindex "&%escape%& expansion item"
9525 If the string contains any non-printing characters, they are converted to
9526 escape sequences starting with a backslash. Whether characters with the most
9527 significant bit set (so-called &"8-bit characters"&) count as printing or not
9528 is controlled by the &%print_topbitchars%& option.
9529
9530
9531 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9532 .cindex "expansion" "expression evaluation"
9533 .cindex "expansion" "arithmetic expression"
9534 .cindex "&%eval%& expansion item"
9535 These items supports simple arithmetic and bitwise logical operations in
9536 expansion strings. The string (after expansion) must be a conventional
9537 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9538 logical operators, and parentheses. All operations are carried out using
9539 integer arithmetic. The operator priorities are as follows (the same as in the
9540 C programming language):
9541 .table2 70pt 300pt
9542 .irow &'highest:'& "not (~), negate (-)"
9543 .irow ""   "multiply (*), divide (/), remainder (%)"
9544 .irow ""   "plus (+), minus (-)"
9545 .irow ""   "shift-left (<<), shift-right (>>)"
9546 .irow ""   "and (&&)"
9547 .irow ""   "xor (^)"
9548 .irow &'lowest:'&  "or (|)"
9549 .endtable
9550 Binary operators with the same priority are evaluated from left to right. White
9551 space is permitted before or after operators.
9552
9553 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9554 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9555 decimal, even if they start with a leading zero; hexadecimal numbers are not
9556 permitted. This can be useful when processing numbers extracted from dates or
9557 times, which often do have leading zeros.
9558
9559 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9560 or 1024*1024*1024,
9561 respectively. Negative numbers are supported. The result of the computation is
9562 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9563
9564 .display
9565 &`${eval:1+1}            `&  yields 2
9566 &`${eval:1+2*3}          `&  yields 7
9567 &`${eval:(1+2)*3}        `&  yields 9
9568 &`${eval:2+42%5}         `&  yields 4
9569 &`${eval:0xc&amp;5}          `&  yields 4
9570 &`${eval:0xc|5}          `&  yields 13
9571 &`${eval:0xc^5}          `&  yields 9
9572 &`${eval:0xc>>1}         `&  yields 6
9573 &`${eval:0xc<<1}         `&  yields 24
9574 &`${eval:~255&amp;0x1234}    `&  yields 4608
9575 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9576 .endd
9577
9578 As a more realistic example, in an ACL you might have
9579 .code
9580 deny   message = Too many bad recipients
9581        condition =                    \
9582          ${if and {                   \
9583            {>{$rcpt_count}{10}}       \
9584            {                          \
9585            <                          \
9586              {$recipients_count}      \
9587              {${eval:$rcpt_count/2}}  \
9588            }                          \
9589          }{yes}{no}}
9590 .endd
9591 The condition is true if there have been more than 10 RCPT commands and
9592 fewer than half of them have resulted in a valid recipient.
9593
9594
9595 .vitem &*${expand:*&<&'string'&>&*}*&
9596 .cindex "expansion" "re-expansion of substring"
9597 The &%expand%& operator causes a string to be expanded for a second time. For
9598 example,
9599 .code
9600 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9601 .endd
9602 first looks up a string in a file while expanding the operand for &%expand%&,
9603 and then re-expands what it has found.
9604
9605
9606 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9607 .cindex "Unicode"
9608 .cindex "UTF-8" "conversion from"
9609 .cindex "expansion" "UTF-8 conversion"
9610 .cindex "&%from_utf8%& expansion item"
9611 The world is slowly moving towards Unicode, although there are no standards for
9612 email yet. However, other applications (including some databases) are starting
9613 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9614 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9615 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9616 the result is an undefined sequence of bytes.
9617
9618 Unicode code points with values less than 256 are compatible with ASCII and
9619 ISO-8859-1 (also known as Latin-1).
9620 For example, character 169 is the copyright symbol in both cases, though the
9621 way it is encoded is different. In UTF-8, more than one byte is needed for
9622 characters with code values greater than 127, whereas ISO-8859-1 is a
9623 single-byte encoding (but thereby limited to 256 characters). This makes
9624 translation from UTF-8 to ISO-8859-1 straightforward.
9625
9626
9627 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9628 .cindex "hash function" "textual"
9629 .cindex "expansion" "textual hash"
9630 The &%hash%& operator is a simpler interface to the hashing function that can
9631 be used when the two parameters are fixed numbers (as opposed to strings that
9632 change when expanded). The effect is the same as
9633 .code
9634 ${hash{<n>}{<m>}{<string>}}
9635 .endd
9636 See the description of the general &%hash%& item above for details. The
9637 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9638
9639
9640
9641 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9642 .cindex "base64 encoding" "conversion from hex"
9643 .cindex "expansion" "hex to base64"
9644 .cindex "&%hex2b64%& expansion item"
9645 This operator converts a hex string into one that is base64 encoded. This can
9646 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9647
9648
9649 .vitem &*${lc:*&<&'string'&>&*}*&
9650 .cindex "case forcing in strings"
9651 .cindex "string" "case forcing"
9652 .cindex "lower casing"
9653 .cindex "expansion" "case forcing"
9654 .cindex "&%lc%& expansion item"
9655 This forces the letters in the string into lower-case, for example:
9656 .code
9657 ${lc:$local_part}
9658 .endd
9659
9660 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9661 .cindex "expansion" "string truncation"
9662 .cindex "&%length%& expansion item"
9663 The &%length%& operator is a simpler interface to the &%length%& function that
9664 can be used when the parameter is a fixed number (as opposed to a string that
9665 changes when expanded). The effect is the same as
9666 .code
9667 ${length{<number>}{<string>}}
9668 .endd
9669 See the description of the general &%length%& item above for details. Note that
9670 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9671 when &%length%& is used as an operator.
9672
9673
9674 .vitem &*${local_part:*&<&'string'&>&*}*&
9675 .cindex "expansion" "local part extraction"
9676 .cindex "&%local_part%& expansion item"
9677 The string is interpreted as an RFC 2822 address and the local part is
9678 extracted from it. If the string does not parse successfully, the result is
9679 empty.
9680
9681
9682 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9683 .cindex "masked IP address"
9684 .cindex "IP address" "masking"
9685 .cindex "CIDR notation"
9686 .cindex "expansion" "IP address masking"
9687 .cindex "&%mask%& expansion item"
9688 If the form of the string to be operated on is not an IP address followed by a
9689 slash and an integer (that is, a network address in CIDR notation), the
9690 expansion fails. Otherwise, this operator converts the IP address to binary,
9691 masks off the least significant bits according to the bit count, and converts
9692 the result back to text, with mask appended. For example,
9693 .code
9694 ${mask:10.111.131.206/28}
9695 .endd
9696 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9697 be mostly used for looking up masked addresses in files, the result for an IPv6
9698 address uses dots to separate components instead of colons, because colon
9699 terminates a key string in lsearch files. So, for example,
9700 .code
9701 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9702 .endd
9703 returns the string
9704 .code
9705 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9706 .endd
9707 Letters in IPv6 addresses are always output in lower case.
9708
9709
9710 .vitem &*${md5:*&<&'string'&>&*}*&
9711 .cindex "MD5 hash"
9712 .cindex "expansion" "MD5 hash"
9713 .cindex "&%md5%& expansion item"
9714 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9715 as a 32-digit hexadecimal number, in which any letters are in lower case.
9716
9717
9718 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9719 .cindex "expansion" "numeric hash"
9720 .cindex "hash function" "numeric"
9721 The &%nhash%& operator is a simpler interface to the numeric hashing function
9722 that can be used when the two parameters are fixed numbers (as opposed to
9723 strings that change when expanded). The effect is the same as
9724 .code
9725 ${nhash{<n>}{<m>}{<string>}}
9726 .endd
9727 See the description of the general &%nhash%& item above for details.
9728
9729
9730 .vitem &*${quote:*&<&'string'&>&*}*&
9731 .cindex "quoting" "in string expansions"
9732 .cindex "expansion" "quoting"
9733 .cindex "&%quote%& expansion item"
9734 The &%quote%& operator puts its argument into double quotes if it
9735 is an empty string or
9736 contains anything other than letters, digits, underscores, dots, and hyphens.
9737 Any occurrences of double quotes and backslashes are escaped with a backslash.
9738 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9739 respectively For example,
9740 .code
9741 ${quote:ab"*"cd}
9742 .endd
9743 becomes
9744 .code
9745 "ab\"*\"cd"
9746 .endd
9747 The place where this is useful is when the argument is a substitution from a
9748 variable or a message header.
9749
9750 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9751 .cindex "&%quote_local_part%& expansion item"
9752 This operator is like &%quote%&, except that it quotes the string only if
9753 required to do so by the rules of RFC 2822 for quoting local parts. For
9754 example, a plus sign would not cause quoting (but it would for &%quote%&).
9755 If you are creating a new email address from the contents of &$local_part$&
9756 (or any other unknown data), you should always use this operator.
9757
9758
9759 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9760 .cindex "quoting" "lookup-specific"
9761 This operator applies lookup-specific quoting rules to the string. Each
9762 query-style lookup type has its own quoting rules which are described with
9763 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9764 .code
9765 ${quote_ldap:two * two}
9766 .endd
9767 returns
9768 .code
9769 two%20%5C2A%20two
9770 .endd
9771 For single-key lookup types, no quoting is ever necessary and this operator
9772 yields an unchanged string.
9773
9774
9775 .vitem &*${randint:*&<&'n'&>&*}*&
9776 .cindex "random number"
9777 This operator returns a somewhat random number which is less than the
9778 supplied number and is at least 0.  The quality of this randomness depends
9779 on how Exim was built; the values are not suitable for keying material.
9780 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9781 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9782 for versions of GnuTLS with that function.
9783 Otherwise, the implementation may be arc4random(), random() seeded by
9784 srandomdev() or srandom(), or a custom implementation even weaker than
9785 random().
9786
9787
9788 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9789 .cindex "expansion" "IP address"
9790 This operator reverses an IP address; for IPv4 addresses, the result is in
9791 dotted-quad decimal form, while for IPv6 addreses the result is in
9792 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9793 for DNS.  For example,
9794 .code
9795 ${reverse_ip:192.0.2.4}
9796 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9797 .endd
9798 returns
9799 .code
9800 4.2.0.192
9801 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
9802 .endd
9803
9804
9805 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9806 .cindex "expansion" "RFC 2047"
9807 .cindex "RFC 2047" "expansion operator"
9808 .cindex "&%rfc2047%& expansion item"
9809 This operator encodes text according to the rules of RFC 2047. This is an
9810 encoding that is used in header lines to encode non-ASCII characters. It is
9811 assumed that the input string is in the encoding specified by the
9812 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9813 contains only characters in the range 33&--126, and no instances of the
9814 characters
9815 .code
9816 ? = ( ) < > @ , ; : \ " . [ ] _
9817 .endd
9818 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9819 string, using as many &"encoded words"& as necessary to encode all the
9820 characters.
9821
9822
9823 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9824 .cindex "expansion" "RFC 2047"
9825 .cindex "RFC 2047" "decoding"
9826 .cindex "&%rfc2047d%& expansion item"
9827 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9828 bytes are replaced by question marks. Characters are converted into the
9829 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9830 not recognized unless &%check_rfc2047_length%& is set false.
9831
9832 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9833 access a header line, RFC 2047 decoding is done automatically. You do not need
9834 to use this operator as well.
9835
9836
9837
9838 .vitem &*${rxquote:*&<&'string'&>&*}*&
9839 .cindex "quoting" "in regular expressions"
9840 .cindex "regular expressions" "quoting"
9841 .cindex "&%rxquote%& expansion item"
9842 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9843 characters in its argument. This is useful when substituting the values of
9844 variables or headers inside regular expressions.
9845
9846
9847 .vitem &*${sha1:*&<&'string'&>&*}*&
9848 .cindex "SHA-1 hash"
9849 .cindex "expansion" "SHA-1 hashing"
9850 .cindex "&%sha2%& expansion item"
9851 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9852 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9853
9854
9855 .vitem &*${stat:*&<&'string'&>&*}*&
9856 .cindex "expansion" "statting a file"
9857 .cindex "file" "extracting characteristics"
9858 .cindex "&%stat%& expansion item"
9859 The string, after expansion, must be a file path. A call to the &[stat()]&
9860 function is made for this path. If &[stat()]& fails, an error occurs and the
9861 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9862 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9863 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9864 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9865 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9866 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9867 can extract individual fields using the &%extract%& expansion item.
9868
9869 The use of the &%stat%& expansion in users' filter files can be locked out by
9870 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9871 systems for files larger than 2GB.
9872
9873 .vitem &*${str2b64:*&<&'string'&>&*}*&
9874 .cindex "expansion" "base64 encoding"
9875 .cindex "base64 encoding" "in string expansion"
9876 .cindex "&%str2b64%& expansion item"
9877 This operator converts a string into one that is base64 encoded.
9878
9879
9880
9881 .vitem &*${strlen:*&<&'string'&>&*}*&
9882 .cindex "expansion" "string length"
9883 .cindex "string" "length in expansion"
9884 .cindex "&%strlen%& expansion item"
9885 The item is replace by the length of the expanded string, expressed as a
9886 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9887
9888
9889 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9890 .cindex "&%substr%& expansion item"
9891 .cindex "substring extraction"
9892 .cindex "expansion" "substring expansion"
9893 The &%substr%& operator is a simpler interface to the &%substr%& function that
9894 can be used when the two parameters are fixed numbers (as opposed to strings
9895 that change when expanded). The effect is the same as
9896 .code
9897 ${substr{<start>}{<length>}{<string>}}
9898 .endd
9899 See the description of the general &%substr%& item above for details. The
9900 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9901
9902 .vitem &*${time_eval:*&<&'string'&>&*}*&
9903 .cindex "&%time_eval%& expansion item"
9904 .cindex "time interval" "decoding"
9905 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9906 seconds.
9907
9908 .vitem &*${time_interval:*&<&'string'&>&*}*&
9909 .cindex "&%time_interval%& expansion item"
9910 .cindex "time interval" "formatting"
9911 The argument (after sub-expansion) must be a sequence of decimal digits that
9912 represents an interval of time as a number of seconds. It is converted into a
9913 number of larger units and output in Exim's normal time format, for example,
9914 &`1w3d4h2m6s`&.
9915
9916 .vitem &*${uc:*&<&'string'&>&*}*&
9917 .cindex "case forcing in strings"
9918 .cindex "string" "case forcing"
9919 .cindex "upper casing"
9920 .cindex "expansion" "case forcing"
9921 .cindex "&%uc%& expansion item"
9922 This forces the letters in the string into upper-case.
9923 .endlist
9924
9925
9926
9927
9928
9929
9930 .section "Expansion conditions" "SECTexpcond"
9931 .scindex IIDexpcond "expansion" "conditions"
9932 The following conditions are available for testing by the &%${if%& construct
9933 while expanding strings:
9934
9935 .vlist
9936 .vitem &*!*&<&'condition'&>
9937 .cindex "expansion" "negating a condition"
9938 .cindex "negation" "in expansion condition"
9939 Preceding any condition with an exclamation mark negates the result of the
9940 condition.
9941
9942 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9943 .cindex "numeric comparison"
9944 .cindex "expansion" "numeric comparison"
9945 There are a number of symbolic operators for doing numeric comparisons. They
9946 are:
9947 .display
9948 &`=   `&   equal
9949 &`==  `&   equal
9950 &`>   `&   greater
9951 &`>=  `&   greater or equal
9952 &`<   `&   less
9953 &`<=  `&   less or equal
9954 .endd
9955 For example:
9956 .code
9957 ${if >{$message_size}{10M} ...
9958 .endd
9959 Note that the general negation operator provides for inequality testing. The
9960 two strings must take the form of optionally signed decimal integers,
9961 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9962 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9963 As a special case, the numerical value of an empty string is taken as
9964 zero.
9965
9966 In all cases, a relative comparator OP is testing if <&'string1'&> OP
9967 <&'string2'&>; the above example is checking if &$message_size$& is larger than
9968 10M, not if 10M is larger than &$message_size$&.
9969
9970
9971 .vitem &*bool&~{*&<&'string'&>&*}*&
9972 .cindex "expansion" "boolean parsing"
9973 .cindex "&%bool%& expansion condition"
9974 This condition turns a string holding a true or false representation into
9975 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9976 (case-insensitively); also positive integer numbers map to true if non-zero,
9977 false if zero.
9978 An empty string is treated as false.
9979 Leading and trailing whitespace is ignored;
9980 thus a string consisting only of whitespace is false.
9981 All other string values will result in expansion failure.
9982
9983 When combined with ACL variables, this expansion condition will let you
9984 make decisions in one place and act on those decisions in another place.
9985 For example:
9986 .code
9987 ${if bool{$acl_m_privileged_sender} ...
9988 .endd
9989
9990
9991 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9992 .cindex "expansion" "boolean parsing"
9993 .cindex "&%bool_lax%& expansion condition"
9994 Like &%bool%&, this condition turns a string into a boolean state.  But
9995 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9996 loose definition that the Router &%condition%& option uses.  The empty string
9997 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9998 true.  Leading and trailing whitespace is ignored.
9999
10000 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10001
10002 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10003 .cindex "expansion" "encrypted comparison"
10004 .cindex "encrypted strings, comparing"
10005 .cindex "&%crypteq%& expansion condition"
10006 This condition is included in the Exim binary if it is built to support any
10007 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10008 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10009 included in the binary.
10010
10011 The &%crypteq%& condition has two arguments. The first is encrypted and
10012 compared against the second, which is already encrypted. The second string may
10013 be in the LDAP form for storing encrypted strings, which starts with the
10014 encryption type in curly brackets, followed by the data. If the second string
10015 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10016 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10017 Typically this will be a field from a password file. An example of an encrypted
10018 string in LDAP form is:
10019 .code
10020 {md5}CY9rzUYh03PK3k6DJie09g==
10021 .endd
10022 If such a string appears directly in an expansion, the curly brackets have to
10023 be quoted, because they are part of the expansion syntax. For example:
10024 .code
10025 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10026 .endd
10027 The following encryption types (whose names are matched case-independently) are
10028 supported:
10029
10030 .ilist
10031 .cindex "MD5 hash"
10032 .cindex "base64 encoding" "in encrypted password"
10033 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10034 printable characters to compare with the remainder of the second string. If the
10035 length of the comparison string is 24, Exim assumes that it is base64 encoded
10036 (as in the above example). If the length is 32, Exim assumes that it is a
10037 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10038 comparison fails.
10039
10040 .next
10041 .cindex "SHA-1 hash"
10042 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10043 printable characters to compare with the remainder of the second string. If the
10044 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10045 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10046 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10047
10048 .next
10049 .cindex "&[crypt()]&"
10050 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10051 only the first eight characters of the password. However, in modern operating
10052 systems this is no longer true, and in many cases the entire password is used,
10053 whatever its length.
10054
10055 .next
10056 .cindex "&[crypt16()]&"
10057 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10058 use up to 16 characters of the password in some operating systems. Again, in
10059 modern operating systems, more characters may be used.
10060 .endlist
10061 Exim has its own version of &[crypt16()]&, which is just a double call to
10062 &[crypt()]&. For operating systems that have their own version, setting
10063 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10064 operating system version instead of its own. This option is set by default in
10065 the OS-dependent &_Makefile_& for those operating systems that are known to
10066 support &[crypt16()]&.
10067
10068 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10069 it was not using the same algorithm as some operating systems' versions. It
10070 turns out that as well as &[crypt16()]& there is a function called
10071 &[bigcrypt()]& in some operating systems. This may or may not use the same
10072 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10073
10074 However, since there is now a move away from the traditional &[crypt()]&
10075 functions towards using SHA1 and other algorithms, tidying up this area of
10076 Exim is seen as very low priority.
10077
10078 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10079 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10080 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10081 default is &`{crypt}`&. Whatever the default, you can always use either
10082 function by specifying it explicitly in curly brackets.
10083
10084 .vitem &*def:*&<&'variable&~name'&>
10085 .cindex "expansion" "checking for empty variable"
10086 .cindex "&%def%& expansion condition"
10087 The &%def%& condition must be followed by the name of one of the expansion
10088 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10089 variable does not contain the empty string. For example:
10090 .code
10091 ${if def:sender_ident {from $sender_ident}}
10092 .endd
10093 Note that the variable name is given without a leading &%$%& character. If the
10094 variable does not exist, the expansion fails.
10095
10096 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10097         &~&*def:h_*&<&'header&~name'&>&*:*&"
10098 .cindex "expansion" "checking header line existence"
10099 This condition is true if a message is being processed and the named header
10100 exists in the message. For example,
10101 .code
10102 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10103 .endd
10104 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10105 the header name must be terminated by a colon if white space does not follow.
10106
10107 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10108        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10109 .cindex "string" "comparison"
10110 .cindex "expansion" "string comparison"
10111 .cindex "&%eq%& expansion condition"
10112 .cindex "&%eqi%& expansion condition"
10113 The two substrings are first expanded. The condition is true if the two
10114 resulting strings are identical. For &%eq%& the comparison includes the case of
10115 letters, whereas for &%eqi%& the comparison is case-independent.
10116
10117 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10118 .cindex "expansion" "file existence test"
10119 .cindex "file" "existence test"
10120 .cindex "&%exists%&, expansion condition"
10121 The substring is first expanded and then interpreted as an absolute path. The
10122 condition is true if the named file (or directory) exists. The existence test
10123 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10124 users' filter files may be locked out by the system administrator.
10125
10126 .vitem &*first_delivery*&
10127 .cindex "delivery" "first"
10128 .cindex "first delivery"
10129 .cindex "expansion" "first delivery test"
10130 .cindex "&%first_delivery%& expansion condition"
10131 This condition, which has no data, is true during a message's first delivery
10132 attempt. It is false during any subsequent delivery attempts.
10133
10134
10135 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10136        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10137 .cindex "list" "iterative conditions"
10138 .cindex "expansion" "&*forall*& condition"
10139 .cindex "expansion" "&*forany*& condition"
10140 .vindex "&$item$&"
10141 These conditions iterate over a list. The first argument is expanded to form
10142 the list. By default, the list separator is a colon, but it can be changed by
10143 the normal method. The second argument is interpreted as a condition that is to
10144 be applied to each item in the list in turn. During the interpretation of the
10145 condition, the current list item is placed in a variable called &$item$&.
10146 .ilist
10147 For &*forany*&, interpretation stops if the condition is true for any item, and
10148 the result of the whole condition is true. If the condition is false for all
10149 items in the list, the overall condition is false.
10150 .next
10151 For &*forall*&, interpretation stops if the condition is false for any item,
10152 and the result of the whole condition is false. If the condition is true for
10153 all items in the list, the overall condition is true.
10154 .endlist
10155 Note that negation of &*forany*& means that the condition must be false for all
10156 items for the overall condition to succeed, and negation of &*forall*& means
10157 that the condition must be false for at least one item. In this example, the
10158 list separator is changed to a comma:
10159 .code
10160 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10161 .endd
10162 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10163 being processed, to enable these expansion items to be nested.
10164
10165
10166 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10167        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10168 .cindex "string" "comparison"
10169 .cindex "expansion" "string comparison"
10170 .cindex "&%ge%& expansion condition"
10171 .cindex "&%gei%& expansion condition"
10172 The two substrings are first expanded. The condition is true if the first
10173 string is lexically greater than or equal to the second string. For &%ge%& the
10174 comparison includes the case of letters, whereas for &%gei%& the comparison is
10175 case-independent.
10176
10177 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10178        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10179 .cindex "string" "comparison"
10180 .cindex "expansion" "string comparison"
10181 .cindex "&%gt%& expansion condition"
10182 .cindex "&%gti%& expansion condition"
10183 The two substrings are first expanded. The condition is true if the first
10184 string is lexically greater than the second string. For &%gt%& the comparison
10185 includes the case of letters, whereas for &%gti%& the comparison is
10186 case-independent.
10187
10188 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10189        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10190 .cindex "string" "comparison"
10191 .cindex "list" "iterative conditions"
10192 Both strings are expanded; the second string is treated as a list of simple
10193 strings; if the first string is a member of the second, then the condition
10194 is true.
10195
10196 These are simpler to use versions of the more powerful &*forany*& condition.
10197 Examples, and the &*forany*& equivalents:
10198 .code
10199 ${if inlist{needle}{foo:needle:bar}}
10200   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10201 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10202   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10203 .endd
10204
10205 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10206        &*isip4&~{*&<&'string'&>&*}*& &&&
10207        &*isip6&~{*&<&'string'&>&*}*&
10208 .cindex "IP address" "testing string format"
10209 .cindex "string" "testing for IP address"
10210 .cindex "&%isip%& expansion condition"
10211 .cindex "&%isip4%& expansion condition"
10212 .cindex "&%isip6%& expansion condition"
10213 The substring is first expanded, and then tested to see if it has the form of
10214 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10215 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10216
10217 For an IPv4 address, the test is for four dot-separated components, each of
10218 which consists of from one to three digits. For an IPv6 address, up to eight
10219 colon-separated components are permitted, each containing from one to four
10220 hexadecimal digits. There may be fewer than eight components if an empty
10221 component (adjacent colons) is present. Only one empty component is permitted.
10222
10223 &*Note*&: The checks are just on the form of the address; actual numerical
10224 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10225 check. The main use of these tests is to distinguish between IP addresses and
10226 host names, or between IPv4 and IPv6 addresses. For example, you could use
10227 .code
10228 ${if isip4{$sender_host_address}...
10229 .endd
10230 to test which IP version an incoming SMTP connection is using.
10231
10232 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10233 .cindex "LDAP" "use for authentication"
10234 .cindex "expansion" "LDAP authentication test"
10235 .cindex "&%ldapauth%& expansion condition"
10236 This condition supports user authentication using LDAP. See section
10237 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10238 queries. For this use, the query must contain a user name and password. The
10239 query itself is not used, and can be empty. The condition is true if the
10240 password is not empty, and the user name and password are accepted by the LDAP
10241 server. An empty password is rejected without calling LDAP because LDAP binds
10242 with an empty password are considered anonymous regardless of the username, and
10243 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10244 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10245 this can be used.
10246
10247
10248 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10249        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10250 .cindex "string" "comparison"
10251 .cindex "expansion" "string comparison"
10252 .cindex "&%le%& expansion condition"
10253 .cindex "&%lei%& expansion condition"
10254 The two substrings are first expanded. The condition is true if the first
10255 string is lexically less than or equal to the second string. For &%le%& the
10256 comparison includes the case of letters, whereas for &%lei%& the comparison is
10257 case-independent.
10258
10259 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10260        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10261 .cindex "string" "comparison"
10262 .cindex "expansion" "string comparison"
10263 .cindex "&%lt%& expansion condition"
10264 .cindex "&%lti%& expansion condition"
10265 The two substrings are first expanded. The condition is true if the first
10266 string is lexically less than the second string. For &%lt%& the comparison
10267 includes the case of letters, whereas for &%lti%& the comparison is
10268 case-independent.
10269
10270
10271 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10272 .cindex "expansion" "regular expression comparison"
10273 .cindex "regular expressions" "match in expanded string"
10274 .cindex "&%match%& expansion condition"
10275 The two substrings are first expanded. The second is then treated as a regular
10276 expression and applied to the first. Because of the pre-expansion, if the
10277 regular expression contains dollar, or backslash characters, they must be
10278 escaped. Care must also be taken if the regular expression contains braces
10279 (curly brackets). A closing brace must be escaped so that it is not taken as a
10280 premature termination of <&'string2'&>. The easiest approach is to use the
10281 &`\N`& feature to disable expansion of the regular expression.
10282 For example,
10283 .code
10284 ${if match {$local_part}{\N^\d{3}\N} ...
10285 .endd
10286 If the whole expansion string is in double quotes, further escaping of
10287 backslashes is also required.
10288
10289 The condition is true if the regular expression match succeeds.
10290 The regular expression is not required to begin with a circumflex
10291 metacharacter, but if there is no circumflex, the expression is not anchored,
10292 and it may match anywhere in the subject, not just at the start. If you want
10293 the pattern to match at the end of the subject, you must include the &`$`&
10294 metacharacter at an appropriate point.
10295
10296 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10297 At the start of an &%if%& expansion the values of the numeric variable
10298 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10299 succeeds causes them to be reset to the substrings of that condition and they
10300 will have these values during the expansion of the success string. At the end
10301 of the &%if%& expansion, the previous values are restored. After testing a
10302 combination of conditions using &%or%&, the subsequent values of the numeric
10303 variables are those of the condition that succeeded.
10304
10305 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10306 .cindex "&%match_address%& expansion condition"
10307 See &*match_local_part*&.
10308
10309 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10310 .cindex "&%match_domain%& expansion condition"
10311 See &*match_local_part*&.
10312
10313 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10314 .cindex "&%match_ip%& expansion condition"
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 .code
10320 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10321 .endd
10322 The specific types of host list item that are permitted in the list are:
10323
10324 .ilist
10325 An IP address, optionally with a CIDR mask.
10326 .next
10327 A single asterisk, which matches any IP address.
10328 .next
10329 An empty item, which matches only if the IP address is empty. This could be
10330 useful for testing for a locally submitted message or one from specific hosts
10331 in a single test such as
10332 . ==== As this is a nested list, any displays it contains must be indented
10333 . ==== as otherwise they are too far to the left. This comment applies to
10334 . ==== the use of xmlto plus fop. There's no problem when formatting with
10335 . ==== sdop, with or without the extra indent.
10336 .code
10337   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10338 .endd
10339 where the first item in the list is the empty string.
10340 .next
10341 The item @[] matches any of the local host's interface addresses.
10342 .next
10343 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10344 even if &`net-`& is not specified. There is never any attempt to turn the IP
10345 address into a host name. The most common type of linear search for
10346 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10347 masks. For example:
10348 .code
10349   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10350 .endd
10351 It is of course possible to use other kinds of lookup, and in such a case, you
10352 do need to specify the &`net-`& prefix if you want to specify a specific
10353 address mask, for example:
10354 .code
10355   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10356 .endd
10357 However, unless you are combining a &%match_ip%& condition with others, it is
10358 just as easy to use the fact that a lookup is itself a condition, and write:
10359 .code
10360   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10361 .endd
10362 .endlist ilist
10363
10364 Note that <&'string2'&> is not itself subject to string expansion, unless
10365 Exim was built with the EXPAND_LISTMATCH_RHS option.
10366
10367 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10368
10369 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10370 .cindex "domain list" "in expansion condition"
10371 .cindex "address list" "in expansion condition"
10372 .cindex "local part" "list, in expansion condition"
10373 .cindex "&%match_local_part%& expansion condition"
10374 This condition, together with &%match_address%& and &%match_domain%&, make it
10375 possible to test domain, address, and local part lists within expansions. Each
10376 condition requires two arguments: an item and a list to match. A trivial
10377 example is:
10378 .code
10379 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10380 .endd
10381 In each case, the second argument may contain any of the allowable items for a
10382 list of the appropriate type. Also, because the second argument (after
10383 expansion) is a standard form of list, it is possible to refer to a named list.
10384 Thus, you can use conditions like this:
10385 .code
10386 ${if match_domain{$domain}{+local_domains}{...
10387 .endd
10388 .cindex "&`+caseful`&"
10389 For address lists, the matching starts off caselessly, but the &`+caseful`&
10390 item can be used, as in all address lists, to cause subsequent items to
10391 have their local parts matched casefully. Domains are always matched
10392 caselessly.
10393
10394 Note that <&'string2'&> is not itself subject to string expansion, unless
10395 Exim was built with the EXPAND_LISTMATCH_RHS option.
10396
10397 &*Note*&: Host lists are &'not'& supported in this way. This is because
10398 hosts have two identities: a name and an IP address, and it is not clear
10399 how to specify cleanly how such a test would work. However, IP addresses can be
10400 matched using &%match_ip%&.
10401
10402 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10403 .cindex "PAM authentication"
10404 .cindex "AUTH" "with PAM"
10405 .cindex "Solaris" "PAM support"
10406 .cindex "expansion" "PAM authentication test"
10407 .cindex "&%pam%& expansion condition"
10408 &'Pluggable Authentication Modules'&
10409 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10410 available in the latest releases of Solaris and in some GNU/Linux
10411 distributions. The Exim support, which is intended for use in conjunction with
10412 the SMTP AUTH command, is available only if Exim is compiled with
10413 .code
10414 SUPPORT_PAM=yes
10415 .endd
10416 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10417 in some releases of GNU/Linux &%-ldl%& is also needed.
10418
10419 The argument string is first expanded, and the result must be a
10420 colon-separated list of strings. Leading and trailing white space is ignored.
10421 The PAM module is initialized with the service name &"exim"& and the user name
10422 taken from the first item in the colon-separated data string (<&'string1'&>).
10423 The remaining items in the data string are passed over in response to requests
10424 from the authentication function. In the simple case there will only be one
10425 request, for a password, so the data consists of just two strings.
10426
10427 There can be problems if any of the strings are permitted to contain colon
10428 characters. In the usual way, these have to be doubled to avoid being taken as
10429 separators. If the data is being inserted from a variable, the &%sg%& expansion
10430 item can be used to double any existing colons. For example, the configuration
10431 of a LOGIN authenticator might contain this setting:
10432 .code
10433 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10434 .endd
10435 For a PLAIN authenticator you could use:
10436 .code
10437 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10438 .endd
10439 In some operating systems, PAM authentication can be done only from a process
10440 running as root. Since Exim is running as the Exim user when receiving
10441 messages, this means that PAM cannot be used directly in those systems.
10442 A patched version of the &'pam_unix'& module that comes with the
10443 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10444 The patched module allows one special uid/gid combination, in addition to root,
10445 to authenticate. If you build the patched module to allow the Exim user and
10446 group, PAM can then be used from an Exim authenticator.
10447
10448
10449 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10450 .cindex "&'pwcheck'& daemon"
10451 .cindex "Cyrus"
10452 .cindex "expansion" "&'pwcheck'& authentication test"
10453 .cindex "&%pwcheck%& expansion condition"
10454 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10455 This is one way of making it possible for passwords to be checked by a process
10456 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10457 deprecated. Its replacement is &'saslauthd'& (see below).
10458
10459 The pwcheck support is not included in Exim by default. You need to specify
10460 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10461 building Exim. For example:
10462 .code
10463 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10464 .endd
10465 You do not need to install the full Cyrus software suite in order to use
10466 the pwcheck daemon. You can compile and install just the daemon alone
10467 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10468 access to the &_/var/pwcheck_& directory.
10469
10470 The &%pwcheck%& condition takes one argument, which must be the user name and
10471 password, separated by a colon. For example, in a LOGIN authenticator
10472 configuration, you might have this:
10473 .code
10474 server_condition = ${if pwcheck{$auth1:$auth2}}
10475 .endd
10476 Again, for a PLAIN authenticator configuration, this would be:
10477 .code
10478 server_condition = ${if pwcheck{$auth2:$auth3}}
10479 .endd
10480 .vitem &*queue_running*&
10481 .cindex "queue runner" "detecting when delivering from"
10482 .cindex "expansion" "queue runner test"
10483 .cindex "&%queue_running%& expansion condition"
10484 This condition, which has no data, is true during delivery attempts that are
10485 initiated by queue runner processes, and false otherwise.
10486
10487
10488 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10489 .cindex "Radius"
10490 .cindex "expansion" "Radius authentication"
10491 .cindex "&%radius%& expansion condition"
10492 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10493 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10494 the Radius client configuration file in order to build Exim with Radius
10495 support.
10496
10497 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10498 library, using the original API. If you are using release 0.4.0 or later of
10499 this library, you need to set
10500 .code
10501 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10502 .endd
10503 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10504 &%libradius%& library that comes with FreeBSD. To do this, set
10505 .code
10506 RADIUS_LIB_TYPE=RADLIB
10507 .endd
10508 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10509 You may also have to supply a suitable setting in EXTRALIBS so that the
10510 Radius library can be found when Exim is linked.
10511
10512 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10513 Radius client library, which calls the Radius server. The condition is true if
10514 the authentication is successful. For example:
10515 .code
10516 server_condition = ${if radius{<arguments>}}
10517 .endd
10518
10519
10520 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10521         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10522 .cindex "&'saslauthd'& daemon"
10523 .cindex "Cyrus"
10524 .cindex "expansion" "&'saslauthd'& authentication test"
10525 .cindex "&%saslauthd%& expansion condition"
10526 This condition supports user authentication using the Cyrus &'saslauthd'&
10527 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10528 Using this daemon is one way of making it possible for passwords to be checked
10529 by a process that is not running as root.
10530
10531 The saslauthd support is not included in Exim by default. You need to specify
10532 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10533 building Exim. For example:
10534 .code
10535 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10536 .endd
10537 You do not need to install the full Cyrus software suite in order to use
10538 the saslauthd daemon. You can compile and install just the daemon alone
10539 from the Cyrus SASL library.
10540
10541 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10542 two are mandatory. For example:
10543 .code
10544 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10545 .endd
10546 The service and the realm are optional (which is why the arguments are enclosed
10547 in their own set of braces). For details of the meaning of the service and
10548 realm, and how to run the daemon, consult the Cyrus documentation.
10549 .endlist vlist
10550
10551
10552
10553 .section "Combining expansion conditions" "SECID84"
10554 .cindex "expansion" "combining conditions"
10555 Several conditions can be tested at once by combining them using the &%and%&
10556 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10557 conditions on their own, and precede their lists of sub-conditions. Each
10558 sub-condition must be enclosed in braces within the overall braces that contain
10559 the list. No repetition of &%if%& is used.
10560
10561
10562 .vlist
10563 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10564 .cindex "&""or""& expansion condition"
10565 .cindex "expansion" "&""or""& of conditions"
10566 The sub-conditions are evaluated from left to right. The condition is true if
10567 any one of the sub-conditions is true.
10568 For example,
10569 .code
10570 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10571 .endd
10572 When a true sub-condition is found, the following ones are parsed but not
10573 evaluated. If there are several &"match"& sub-conditions the values of the
10574 numeric variables afterwards are taken from the first one that succeeds.
10575
10576 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10577 .cindex "&""and""& expansion condition"
10578 .cindex "expansion" "&""and""& of conditions"
10579 The sub-conditions are evaluated from left to right. The condition is true if
10580 all of the sub-conditions are true. If there are several &"match"&
10581 sub-conditions, the values of the numeric variables afterwards are taken from
10582 the last one. When a false sub-condition is found, the following ones are
10583 parsed but not evaluated.
10584 .endlist
10585 .ecindex IIDexpcond
10586
10587
10588
10589
10590 .section "Expansion variables" "SECTexpvar"
10591 .cindex "expansion" "variables, list of"
10592 This section contains an alphabetical list of all the expansion variables. Some
10593 of them are available only when Exim is compiled with specific options such as
10594 support for TLS or the content scanning extension.
10595
10596 .vlist
10597 .vitem "&$0$&, &$1$&, etc"
10598 .cindex "numerical variables (&$1$& &$2$& etc)"
10599 When a &%match%& expansion condition succeeds, these variables contain the
10600 captured substrings identified by the regular expression during subsequent
10601 processing of the success string of the containing &%if%& expansion item.
10602 However, they do not retain their values afterwards; in fact, their previous
10603 values are restored at the end of processing an &%if%& item. The numerical
10604 variables may also be set externally by some other matching process which
10605 precedes the expansion of the string. For example, the commands available in
10606 Exim filter files include an &%if%& command with its own regular expression
10607 matching condition.
10608
10609 .vitem "&$acl_c...$&"
10610 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10611 can be given any name that starts with &$acl_c$& and is at least six characters
10612 long, but the sixth character must be either a digit or an underscore. For
10613 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10614 variables persist throughout the lifetime of an SMTP connection. They can be
10615 used to pass information between ACLs and between different invocations of the
10616 same ACL. When a message is received, the values of these variables are saved
10617 with the message, and can be accessed by filters, routers, and transports
10618 during subsequent delivery.
10619
10620 .vitem "&$acl_m...$&"
10621 These variables are like the &$acl_c...$& variables, except that their values
10622 are reset after a message has been received. Thus, if several messages are
10623 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10624 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10625 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10626 message is received, the values of these variables are saved with the message,
10627 and can be accessed by filters, routers, and transports during subsequent
10628 delivery.
10629
10630 .vitem &$acl_verify_message$&
10631 .vindex "&$acl_verify_message$&"
10632 After an address verification has failed, this variable contains the failure
10633 message. It retains its value for use in subsequent modifiers. The message can
10634 be preserved by coding like this:
10635 .code
10636 warn !verify = sender
10637      set acl_m0 = $acl_verify_message
10638 .endd
10639 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10640 &%log_message%& modifiers, to include information about the verification
10641 failure.
10642
10643 .vitem &$address_data$&
10644 .vindex "&$address_data$&"
10645 This variable is set by means of the &%address_data%& option in routers. The
10646 value then remains with the address while it is processed by subsequent routers
10647 and eventually a transport. If the transport is handling multiple addresses,
10648 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10649 for more details. &*Note*&: The contents of &$address_data$& are visible in
10650 user filter files.
10651
10652 If &$address_data$& is set when the routers are called from an ACL to verify
10653 a recipient address, the final value is still in the variable for subsequent
10654 conditions and modifiers of the ACL statement. If routing the address caused it
10655 to be redirected to just one address, the child address is also routed as part
10656 of the verification, and in this case the final value of &$address_data$& is
10657 from the child's routing.
10658
10659 If &$address_data$& is set when the routers are called from an ACL to verify a
10660 sender address, the final value is also preserved, but this time in
10661 &$sender_address_data$&, to distinguish it from data from a recipient
10662 address.
10663
10664 In both cases (recipient and sender verification), the value does not persist
10665 after the end of the current ACL statement. If you want to preserve
10666 these values for longer, you can save them in ACL variables.
10667
10668 .vitem &$address_file$&
10669 .vindex "&$address_file$&"
10670 When, as a result of aliasing, forwarding, or filtering, a message is directed
10671 to a specific file, this variable holds the name of the file when the transport
10672 is running. At other times, the variable is empty. For example, using the
10673 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10674 .code
10675 /home/r2d2/savemail
10676 .endd
10677 then when the &(address_file)& transport is running, &$address_file$&
10678 contains the text string &`/home/r2d2/savemail`&.
10679 .cindex "Sieve filter" "value of &$address_file$&"
10680 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10681 then up to the transport configuration to generate an appropriate absolute path
10682 to the relevant file.
10683
10684 .vitem &$address_pipe$&
10685 .vindex "&$address_pipe$&"
10686 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10687 this variable holds the pipe command when the transport is running.
10688
10689 .vitem "&$auth1$& &-- &$auth3$&"
10690 .vindex "&$auth1$&, &$auth2$&, etc"
10691 These variables are used in SMTP authenticators (see chapters
10692 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10693
10694 .vitem &$authenticated_id$&
10695 .cindex "authentication" "id"
10696 .vindex "&$authenticated_id$&"
10697 When a server successfully authenticates a client it may be configured to
10698 preserve some of the authentication information in the variable
10699 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10700 user/password authenticator configuration might preserve the user name for use
10701 in the routers. Note that this is not the same information that is saved in
10702 &$sender_host_authenticated$&.
10703 When a message is submitted locally (that is, not over a TCP connection)
10704 the value of &$authenticated_id$& is normally the login name of the calling
10705 process. However, a trusted user can override this by means of the &%-oMai%&
10706 command line option.
10707
10708
10709
10710
10711 .vitem &$authenticated_sender$&
10712 .cindex "sender" "authenticated"
10713 .cindex "authentication" "sender"
10714 .cindex "AUTH" "on MAIL command"
10715 .vindex "&$authenticated_sender$&"
10716 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10717 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10718 described in section &<<SECTauthparamail>>&. Unless the data is the string
10719 &"<>"&, it is set as the authenticated sender of the message, and the value is
10720 available during delivery in the &$authenticated_sender$& variable. If the
10721 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10722
10723 .vindex "&$qualify_domain$&"
10724 When a message is submitted locally (that is, not over a TCP connection), the
10725 value of &$authenticated_sender$& is an address constructed from the login
10726 name of the calling process and &$qualify_domain$&, except that a trusted user
10727 can override this by means of the &%-oMas%& command line option.
10728
10729
10730 .vitem &$authentication_failed$&
10731 .cindex "authentication" "failure"
10732 .vindex "&$authentication_failed$&"
10733 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10734 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10735 possible to distinguish between &"did not try to authenticate"&
10736 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10737 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10738 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10739 negative response to an AUTH command, including (for example) an attempt to use
10740 an undefined mechanism.
10741
10742 .vitem &$av_failed$&
10743 .cindex "content scanning" "AV scanner failure"
10744 This variable is available when Exim is compiled with the content-scanning
10745 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10746 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10747 the ACL malware condition.
10748
10749 .vitem &$body_linecount$&
10750 .cindex "message body" "line count"
10751 .cindex "body of message" "line count"
10752 .vindex "&$body_linecount$&"
10753 When a message is being received or delivered, this variable contains the
10754 number of lines in the message's body. See also &$message_linecount$&.
10755
10756 .vitem &$body_zerocount$&
10757 .cindex "message body" "binary zero count"
10758 .cindex "body of message" "binary zero count"
10759 .cindex "binary zero" "in message body"
10760 .vindex "&$body_zerocount$&"
10761 When a message is being received or delivered, this variable contains the
10762 number of binary zero bytes (ASCII NULs) in the message's body.
10763
10764 .vitem &$bounce_recipient$&
10765 .vindex "&$bounce_recipient$&"
10766 This is set to the recipient address of a bounce message while Exim is creating
10767 it. It is useful if a customized bounce message text file is in use (see
10768 chapter &<<CHAPemsgcust>>&).
10769
10770 .vitem &$bounce_return_size_limit$&
10771 .vindex "&$bounce_return_size_limit$&"
10772 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10773 up to a multiple of 1000. It is useful when a customized error message text
10774 file is in use (see chapter &<<CHAPemsgcust>>&).
10775
10776 .vitem &$caller_gid$&
10777 .cindex "gid (group id)" "caller"
10778 .vindex "&$caller_gid$&"
10779 The real group id under which the process that called Exim was running. This is
10780 not the same as the group id of the originator of a message (see
10781 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10782 incarnation normally contains the Exim gid.
10783
10784 .vitem &$caller_uid$&
10785 .cindex "uid (user id)" "caller"
10786 .vindex "&$caller_uid$&"
10787 The real user id under which the process that called Exim was running. This is
10788 not the same as the user id of the originator of a message (see
10789 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10790 incarnation normally contains the Exim uid.
10791
10792 .vitem &$compile_date$&
10793 .vindex "&$compile_date$&"
10794 The date on which the Exim binary was compiled.
10795
10796 .vitem &$compile_number$&
10797 .vindex "&$compile_number$&"
10798 The building process for Exim keeps a count of the number
10799 of times it has been compiled. This serves to distinguish different
10800 compilations of the same version of the program.
10801
10802 .vitem &$demime_errorlevel$&
10803 .vindex "&$demime_errorlevel$&"
10804 This variable is available when Exim is compiled with
10805 the content-scanning extension and the obsolete &%demime%& condition. For
10806 details, see section &<<SECTdemimecond>>&.
10807
10808 .vitem &$demime_reason$&
10809 .vindex "&$demime_reason$&"
10810 This variable is available when Exim is compiled with the
10811 content-scanning extension and the obsolete &%demime%& condition. For details,
10812 see section &<<SECTdemimecond>>&.
10813
10814 .vitem &$dnslist_domain$& &&&
10815        &$dnslist_matched$& &&&
10816        &$dnslist_text$& &&&
10817        &$dnslist_value$&
10818 .vindex "&$dnslist_domain$&"
10819 .vindex "&$dnslist_matched$&"
10820 .vindex "&$dnslist_text$&"
10821 .vindex "&$dnslist_value$&"
10822 .cindex "black list (DNS)"
10823 When a DNS (black) list lookup succeeds, these variables are set to contain
10824 the following data from the lookup: the list's domain name, the key that was
10825 looked up, the contents of any associated TXT record, and the value from the
10826 main A record. See section &<<SECID204>>& for more details.
10827
10828 .vitem &$domain$&
10829 .vindex "&$domain$&"
10830 When an address is being routed, or delivered on its own, this variable
10831 contains the domain. Uppercase letters in the domain are converted into lower
10832 case for &$domain$&.
10833
10834 Global address rewriting happens when a message is received, so the value of
10835 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10836 is set during user filtering, but not during system filtering, because a
10837 message may have many recipients and the system filter is called just once.
10838
10839 When more than one address is being delivered at once (for example, several
10840 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10841 have the same domain. Transports can be restricted to handling only one domain
10842 at a time if the value of &$domain$& is required at transport time &-- this is
10843 the default for local transports. For further details of the environment in
10844 which local transports are run, see chapter &<<CHAPenvironment>>&.
10845
10846 .oindex "&%delay_warning_condition%&"
10847 At the end of a delivery, if all deferred addresses have the same domain, it is
10848 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10849
10850 The &$domain$& variable is also used in some other circumstances:
10851
10852 .ilist
10853 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10854 the recipient address. The domain of the &'sender'& address is in
10855 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10856 normally set during the running of the MAIL ACL. However, if the sender address
10857 is verified with a callout during the MAIL ACL, the sender domain is placed in
10858 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10859 the &(smtp)& transport.
10860
10861 .next
10862 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10863 &$domain$& contains the domain portion of the address that is being rewritten;
10864 it can be used in the expansion of the replacement address, for example, to
10865 rewrite domains by file lookup.
10866
10867 .next
10868 With one important exception, whenever a domain list is being scanned,
10869 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10870 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10871 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10872 that, in a RCPT ACL, the sender domain list can be dependent on the
10873 recipient domain (which is what is in &$domain$& at this time).
10874
10875 .next
10876 .cindex "ETRN" "value of &$domain$&"
10877 .oindex "&%smtp_etrn_command%&"
10878 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10879 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10880 .endlist
10881
10882
10883 .vitem &$domain_data$&
10884 .vindex "&$domain_data$&"
10885 When the &%domains%& option on a router matches a domain by
10886 means of a lookup, the data read by the lookup is available during the running
10887 of the router as &$domain_data$&. In addition, if the driver routes the
10888 address to a transport, the value is available in that transport. If the
10889 transport is handling multiple addresses, the value from the first address is
10890 used.
10891
10892 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10893 domain by means of a lookup. The data read by the lookup is available during
10894 the rest of the ACL statement. In all other situations, this variable expands
10895 to nothing.
10896
10897 .vitem &$exim_gid$&
10898 .vindex "&$exim_gid$&"
10899 This variable contains the numerical value of the Exim group id.
10900
10901 .vitem &$exim_path$&
10902 .vindex "&$exim_path$&"
10903 This variable contains the path to the Exim binary.
10904
10905 .vitem &$exim_uid$&
10906 .vindex "&$exim_uid$&"
10907 This variable contains the numerical value of the Exim user id.
10908
10909 .vitem &$found_extension$&
10910 .vindex "&$found_extension$&"
10911 This variable is available when Exim is compiled with the
10912 content-scanning extension and the obsolete &%demime%& condition. For details,
10913 see section &<<SECTdemimecond>>&.
10914
10915 .vitem &$header_$&<&'name'&>
10916 This is not strictly an expansion variable. It is expansion syntax for
10917 inserting the message header line with the given name. Note that the name must
10918 be terminated by colon or white space, because it may contain a wide variety of
10919 characters. Note also that braces must &'not'& be used.
10920
10921 .vitem &$home$&
10922 .vindex "&$home$&"
10923 When the &%check_local_user%& option is set for a router, the user's home
10924 directory is placed in &$home$& when the check succeeds. In particular, this
10925 means it is set during the running of users' filter files. A router may also
10926 explicitly set a home directory for use by a transport; this can be overridden
10927 by a setting on the transport itself.
10928
10929 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10930 of the environment variable HOME.
10931
10932 .vitem &$host$&
10933 .vindex "&$host$&"
10934 If a router assigns an address to a transport (any transport), and passes a
10935 list of hosts with the address, the value of &$host$& when the transport starts
10936 to run is the name of the first host on the list. Note that this applies both
10937 to local and remote transports.
10938
10939 .cindex "transport" "filter"
10940 .cindex "filter" "transport filter"
10941 For the &(smtp)& transport, if there is more than one host, the value of
10942 &$host$& changes as the transport works its way through the list. In
10943 particular, when the &(smtp)& transport is expanding its options for encryption
10944 using TLS, or for specifying a transport filter (see chapter
10945 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10946 is connected.
10947
10948 When used in the client part of an authenticator configuration (see chapter
10949 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10950 client is connected.
10951
10952
10953 .vitem &$host_address$&
10954 .vindex "&$host_address$&"
10955 This variable is set to the remote host's IP address whenever &$host$& is set
10956 for a remote connection. It is also set to the IP address that is being checked
10957 when the &%ignore_target_hosts%& option is being processed.
10958
10959 .vitem &$host_data$&
10960 .vindex "&$host_data$&"
10961 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10962 result of the lookup is made available in the &$host_data$& variable. This
10963 allows you, for example, to do things like this:
10964 .code
10965 deny  hosts = net-lsearch;/some/file
10966 message = $host_data
10967 .endd
10968 .vitem &$host_lookup_deferred$&
10969 .cindex "host name" "lookup, failure of"
10970 .vindex "&$host_lookup_deferred$&"
10971 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10972 message comes from a remote host and there is an attempt to look up the host's
10973 name from its IP address, and the attempt is not successful, one of these
10974 variables is set to &"1"&.
10975
10976 .ilist
10977 If the lookup receives a definite negative response (for example, a DNS lookup
10978 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10979
10980 .next
10981 If there is any kind of problem during the lookup, such that Exim cannot
10982 tell whether or not the host name is defined (for example, a timeout for a DNS
10983 lookup), &$host_lookup_deferred$& is set to &"1"&.
10984 .endlist ilist
10985
10986 Looking up a host's name from its IP address consists of more than just a
10987 single reverse lookup. Exim checks that a forward lookup of at least one of the
10988 names it receives from a reverse lookup yields the original IP address. If this
10989 is not the case, Exim does not accept the looked up name(s), and
10990 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10991 IP address (for example, the existence of a PTR record in the DNS) is not
10992 sufficient on its own for the success of a host name lookup. If the reverse
10993 lookup succeeds, but there is a lookup problem such as a timeout when checking
10994 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10995 &"1"&. See also &$sender_host_name$&.
10996
10997 .vitem &$host_lookup_failed$&
10998 .vindex "&$host_lookup_failed$&"
10999 See &$host_lookup_deferred$&.
11000
11001
11002 .vitem &$inode$&
11003 .vindex "&$inode$&"
11004 The only time this variable is set is while expanding the &%directory_file%&
11005 option in the &(appendfile)& transport. The variable contains the inode number
11006 of the temporary file which is about to be renamed. It can be used to construct
11007 a unique name for the file.
11008
11009 .vitem &$interface_address$&
11010 .vindex "&$interface_address$&"
11011 This is an obsolete name for &$received_ip_address$&.
11012
11013 .vitem &$interface_port$&
11014 .vindex "&$interface_port$&"
11015 This is an obsolete name for &$received_port$&.
11016
11017 .vitem &$item$&
11018 .vindex "&$item$&"
11019 This variable is used during the expansion of &*forall*& and &*forany*&
11020 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11021 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11022 empty.
11023
11024 .vitem &$ldap_dn$&
11025 .vindex "&$ldap_dn$&"
11026 This variable, which is available only when Exim is compiled with LDAP support,
11027 contains the DN from the last entry in the most recently successful LDAP
11028 lookup.
11029
11030 .vitem &$load_average$&
11031 .vindex "&$load_average$&"
11032 This variable contains the system load average, multiplied by 1000 so that it
11033 is an integer. For example, if the load average is 0.21, the value of the
11034 variable is 210. The value is recomputed every time the variable is referenced.
11035
11036 .vitem &$local_part$&
11037 .vindex "&$local_part$&"
11038 When an address is being routed, or delivered on its own, this
11039 variable contains the local part. When a number of addresses are being
11040 delivered together (for example, multiple RCPT commands in an SMTP
11041 session), &$local_part$& is not set.
11042
11043 Global address rewriting happens when a message is received, so the value of
11044 &$local_part$& during routing and delivery is the value after rewriting.
11045 &$local_part$& is set during user filtering, but not during system filtering,
11046 because a message may have many recipients and the system filter is called just
11047 once.
11048
11049 .vindex "&$local_part_prefix$&"
11050 .vindex "&$local_part_suffix$&"
11051 If a local part prefix or suffix has been recognized, it is not included in the
11052 value of &$local_part$& during routing and subsequent delivery. The values of
11053 any prefix or suffix are in &$local_part_prefix$& and
11054 &$local_part_suffix$&, respectively.
11055
11056 When a message is being delivered to a file, pipe, or autoreply transport as a
11057 result of aliasing or forwarding, &$local_part$& is set to the local part of
11058 the parent address, not to the file name or command (see &$address_file$& and
11059 &$address_pipe$&).
11060
11061 When an ACL is running for a RCPT command, &$local_part$& contains the
11062 local part of the recipient address.
11063
11064 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11065 &$local_part$& contains the local part of the address that is being rewritten;
11066 it can be used in the expansion of the replacement address, for example.
11067
11068 In all cases, all quoting is removed from the local part. For example, for both
11069 the addresses
11070 .code
11071 "abc:xyz"@test.example
11072 abc\:xyz@test.example
11073 .endd
11074 the value of &$local_part$& is
11075 .code
11076 abc:xyz
11077 .endd
11078 If you use &$local_part$& to create another address, you should always wrap it
11079 inside a quoting operator. For example, in a &(redirect)& router you could
11080 have:
11081 .code
11082 data = ${quote_local_part:$local_part}@new.domain.example
11083 .endd
11084 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11085 to process local parts in a case-dependent manner in a router, you can set the
11086 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11087
11088 .vitem &$local_part_data$&
11089 .vindex "&$local_part_data$&"
11090 When the &%local_parts%& option on a router matches a local part by means of a
11091 lookup, the data read by the lookup is available during the running of the
11092 router as &$local_part_data$&. In addition, if the driver routes the address
11093 to a transport, the value is available in that transport. If the transport is
11094 handling multiple addresses, the value from the first address is used.
11095
11096 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11097 matches a local part by means of a lookup. The data read by the lookup is
11098 available during the rest of the ACL statement. In all other situations, this
11099 variable expands to nothing.
11100
11101 .vitem &$local_part_prefix$&
11102 .vindex "&$local_part_prefix$&"
11103 When an address is being routed or delivered, and a
11104 specific prefix for the local part was recognized, it is available in this
11105 variable, having been removed from &$local_part$&.
11106
11107 .vitem &$local_part_suffix$&
11108 .vindex "&$local_part_suffix$&"
11109 When an address is being routed or delivered, and a
11110 specific suffix for the local part was recognized, it is available in this
11111 variable, having been removed from &$local_part$&.
11112
11113 .vitem &$local_scan_data$&
11114 .vindex "&$local_scan_data$&"
11115 This variable contains the text returned by the &[local_scan()]& function when
11116 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11117
11118 .vitem &$local_user_gid$&
11119 .vindex "&$local_user_gid$&"
11120 See &$local_user_uid$&.
11121
11122 .vitem &$local_user_uid$&
11123 .vindex "&$local_user_uid$&"
11124 This variable and &$local_user_gid$& are set to the uid and gid after the
11125 &%check_local_user%& router precondition succeeds. This means that their values
11126 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11127 and &%condition%&), for the &%address_data%& expansion, and for any
11128 router-specific expansions. At all other times, the values in these variables
11129 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11130
11131 .vitem &$localhost_number$&
11132 .vindex "&$localhost_number$&"
11133 This contains the expanded value of the
11134 &%localhost_number%& option. The expansion happens after the main options have
11135 been read.
11136
11137 .vitem &$log_inodes$&
11138 .vindex "&$log_inodes$&"
11139 The number of free inodes in the disk partition where Exim's
11140 log files are being written. The value is recalculated whenever the variable is
11141 referenced. If the relevant file system does not have the concept of inodes,
11142 the value of is -1. See also the &%check_log_inodes%& option.
11143
11144 .vitem &$log_space$&
11145 .vindex "&$log_space$&"
11146 The amount of free space (as a number of kilobytes) in the disk
11147 partition where Exim's log files are being written. The value is recalculated
11148 whenever the variable is referenced. If the operating system does not have the
11149 ability to find the amount of free space (only true for experimental systems),
11150 the space value is -1. See also the &%check_log_space%& option.
11151
11152
11153 .vitem &$mailstore_basename$&
11154 .vindex "&$mailstore_basename$&"
11155 This variable is set only when doing deliveries in &"mailstore"& format in the
11156 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11157 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11158 contains the basename of the files that are being written, that is, the name
11159 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11160 variable is empty.
11161
11162 .vitem &$malware_name$&
11163 .vindex "&$malware_name$&"
11164 This variable is available when Exim is compiled with the
11165 content-scanning extension. It is set to the name of the virus that was found
11166 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11167
11168 .vitem &$max_received_linelength$&
11169 .vindex "&$max_received_linelength$&"
11170 .cindex "maximum" "line length"
11171 .cindex "line length" "maximum"
11172 This variable contains the number of bytes in the longest line that was
11173 received as part of the message, not counting the line termination
11174 character(s).
11175
11176 .vitem &$message_age$&
11177 .cindex "message" "age of"
11178 .vindex "&$message_age$&"
11179 This variable is set at the start of a delivery attempt to contain the number
11180 of seconds since the message was received. It does not change during a single
11181 delivery attempt.
11182
11183 .vitem &$message_body$&
11184 .cindex "body of message" "expansion variable"
11185 .cindex "message body" "in expansion"
11186 .cindex "binary zero" "in message body"
11187 .vindex "&$message_body$&"
11188 .oindex "&%message_body_visible%&"
11189 This variable contains the initial portion of a message's body while it is
11190 being delivered, and is intended mainly for use in filter files. The maximum
11191 number of characters of the body that are put into the variable is set by the
11192 &%message_body_visible%& configuration option; the default is 500.
11193
11194 .oindex "&%message_body_newlines%&"
11195 By default, newlines are converted into spaces in &$message_body$&, to make it
11196 easier to search for phrases that might be split over a line break. However,
11197 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11198 zeros are always converted into spaces.
11199
11200 .vitem &$message_body_end$&
11201 .cindex "body of message" "expansion variable"
11202 .cindex "message body" "in expansion"
11203 .vindex "&$message_body_end$&"
11204 This variable contains the final portion of a message's
11205 body while it is being delivered. The format and maximum size are as for
11206 &$message_body$&.
11207
11208 .vitem &$message_body_size$&
11209 .cindex "body of message" "size"
11210 .cindex "message body" "size"
11211 .vindex "&$message_body_size$&"
11212 When a message is being delivered, this variable contains the size of the body
11213 in bytes. The count starts from the character after the blank line that
11214 separates the body from the header. Newlines are included in the count. See
11215 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11216
11217 .vitem &$message_exim_id$&
11218 .vindex "&$message_exim_id$&"
11219 When a message is being received or delivered, this variable contains the
11220 unique message id that is generated and used by Exim to identify the message.
11221 An id is not created for a message until after its header has been successfully
11222 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11223 line; it is the local id that Exim assigns to the message, for example:
11224 &`1BXTIK-0001yO-VA`&.
11225
11226 .vitem &$message_headers$&
11227 .vindex &$message_headers$&
11228 This variable contains a concatenation of all the header lines when a message
11229 is being processed, except for lines added by routers or transports. The header
11230 lines are separated by newline characters. Their contents are decoded in the
11231 same way as a header line that is inserted by &%bheader%&.
11232
11233 .vitem &$message_headers_raw$&
11234 .vindex &$message_headers_raw$&
11235 This variable is like &$message_headers$& except that no processing of the
11236 contents of header lines is done.
11237
11238 .vitem &$message_id$&
11239 This is an old name for &$message_exim_id$&, which is now deprecated.
11240
11241 .vitem &$message_linecount$&
11242 .vindex "&$message_linecount$&"
11243 This variable contains the total number of lines in the header and body of the
11244 message. Compare &$body_linecount$&, which is the count for the body only.
11245 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11246 number of lines received. Before delivery happens (that is, before filters,
11247 routers, and transports run) the count is increased to include the
11248 &'Received:'& header line that Exim standardly adds, and also any other header
11249 lines that are added by ACLs. The blank line that separates the message header
11250 from the body is not counted.
11251
11252 As with the special case of &$message_size$&, during the expansion of the
11253 appendfile transport's maildir_tag option in maildir format, the value of
11254 &$message_linecount$& is the precise size of the number of newlines in the
11255 file that has been written (minus one for the blank line between the
11256 header and the body).
11257
11258 Here is an example of the use of this variable in a DATA ACL:
11259 .code
11260 deny message   = Too many lines in message header
11261      condition = \
11262       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11263 .endd
11264 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11265 message has not yet been received.
11266
11267 .vitem &$message_size$&
11268 .cindex "size" "of message"
11269 .cindex "message" "size"
11270 .vindex "&$message_size$&"
11271 When a message is being processed, this variable contains its size in bytes. In
11272 most cases, the size includes those headers that were received with the
11273 message, but not those (such as &'Envelope-to:'&) that are added to individual
11274 deliveries as they are written. However, there is one special case: during the
11275 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11276 doing a delivery in maildir format, the value of &$message_size$& is the
11277 precise size of the file that has been written. See also
11278 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11279
11280 .cindex "RCPT" "value of &$message_size$&"
11281 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11282 contains the size supplied on the MAIL command, or -1 if no size was given. The
11283 value may not, of course, be truthful.
11284
11285 .vitem &$mime_$&&'xxx'&
11286 A number of variables whose names start with &$mime$& are
11287 available when Exim is compiled with the content-scanning extension. For
11288 details, see section &<<SECTscanmimepart>>&.
11289
11290 .vitem "&$n0$& &-- &$n9$&"
11291 These variables are counters that can be incremented by means
11292 of the &%add%& command in filter files.
11293
11294 .vitem &$original_domain$&
11295 .vindex "&$domain$&"
11296 .vindex "&$original_domain$&"
11297 When a top-level address is being processed for delivery, this contains the
11298 same value as &$domain$&. However, if a &"child"& address (for example,
11299 generated by an alias, forward, or filter file) is being processed, this
11300 variable contains the domain of the original address (lower cased). This
11301 differs from &$parent_domain$& only when there is more than one level of
11302 aliasing or forwarding. When more than one address is being delivered in a
11303 single transport run, &$original_domain$& is not set.
11304
11305 If a new address is created by means of a &%deliver%& command in a system
11306 filter, it is set up with an artificial &"parent"& address. This has the local
11307 part &'system-filter'& and the default qualify domain.
11308
11309 .vitem &$original_local_part$&
11310 .vindex "&$local_part$&"
11311 .vindex "&$original_local_part$&"
11312 When a top-level address is being processed for delivery, this contains the
11313 same value as &$local_part$&, unless a prefix or suffix was removed from the
11314 local part, because &$original_local_part$& always contains the full local
11315 part. When a &"child"& address (for example, generated by an alias, forward, or
11316 filter file) is being processed, this variable contains the full local part of
11317 the original address.
11318
11319 If the router that did the redirection processed the local part
11320 case-insensitively, the value in &$original_local_part$& is in lower case.
11321 This variable differs from &$parent_local_part$& only when there is more than
11322 one level of aliasing or forwarding. When more than one address is being
11323 delivered in a single transport run, &$original_local_part$& is not set.
11324
11325 If a new address is created by means of a &%deliver%& command in a system
11326 filter, it is set up with an artificial &"parent"& address. This has the local
11327 part &'system-filter'& and the default qualify domain.
11328
11329 .vitem &$originator_gid$&
11330 .cindex "gid (group id)" "of originating user"
11331 .cindex "sender" "gid"
11332 .vindex "&$caller_gid$&"
11333 .vindex "&$originator_gid$&"
11334 This variable contains the value of &$caller_gid$& that was set when the
11335 message was received. For messages received via the command line, this is the
11336 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11337 normally the gid of the Exim user.
11338
11339 .vitem &$originator_uid$&
11340 .cindex "uid (user id)" "of originating user"
11341 .cindex "sender" "uid"
11342 .vindex "&$caller_uid$&"
11343 .vindex "&$originaltor_uid$&"
11344 The value of &$caller_uid$& that was set when the message was received. For
11345 messages received via the command line, this is the uid of the sending user.
11346 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11347 user.
11348
11349 .vitem &$parent_domain$&
11350 .vindex "&$parent_domain$&"
11351 This variable is similar to &$original_domain$& (see
11352 above), except that it refers to the immediately preceding parent address.
11353
11354 .vitem &$parent_local_part$&
11355 .vindex "&$parent_local_part$&"
11356 This variable is similar to &$original_local_part$&
11357 (see above), except that it refers to the immediately preceding parent address.
11358
11359 .vitem &$pid$&
11360 .cindex "pid (process id)" "of current process"
11361 .vindex "&$pid$&"
11362 This variable contains the current process id.
11363
11364 .vitem &$pipe_addresses$&
11365 .cindex "filter" "transport filter"
11366 .cindex "transport" "filter"
11367 .vindex "&$pipe_addresses$&"
11368 This is not an expansion variable, but is mentioned here because the string
11369 &`$pipe_addresses`& is handled specially in the command specification for the
11370 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11371 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11372 It cannot be used in general expansion strings, and provokes an &"unknown
11373 variable"& error if encountered.
11374
11375 .vitem &$primary_hostname$&
11376 .vindex "&$primary_hostname$&"
11377 This variable contains the value set by &%primary_hostname%& in the
11378 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11379 a single-component name, Exim calls &[gethostbyname()]& (or
11380 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11381 qualified host name. See also &$smtp_active_hostname$&.
11382
11383
11384 .vitem &$prvscheck_address$&
11385 This variable is used in conjunction with the &%prvscheck%& expansion item,
11386 which is described in sections &<<SECTexpansionitems>>& and
11387 &<<SECTverifyPRVS>>&.
11388
11389 .vitem &$prvscheck_keynum$&
11390 This variable is used in conjunction with the &%prvscheck%& expansion item,
11391 which is described in sections &<<SECTexpansionitems>>& and
11392 &<<SECTverifyPRVS>>&.
11393
11394 .vitem &$prvscheck_result$&
11395 This variable is used in conjunction with the &%prvscheck%& expansion item,
11396 which is described in sections &<<SECTexpansionitems>>& and
11397 &<<SECTverifyPRVS>>&.
11398
11399 .vitem &$qualify_domain$&
11400 .vindex "&$qualify_domain$&"
11401 The value set for the &%qualify_domain%& option in the configuration file.
11402
11403 .vitem &$qualify_recipient$&
11404 .vindex "&$qualify_recipient$&"
11405 The value set for the &%qualify_recipient%& option in the configuration file,
11406 or if not set, the value of &$qualify_domain$&.
11407
11408 .vitem &$rcpt_count$&
11409 .vindex "&$rcpt_count$&"
11410 When a message is being received by SMTP, this variable contains the number of
11411 RCPT commands received for the current message. If this variable is used in a
11412 RCPT ACL, its value includes the current command.
11413
11414 .vitem &$rcpt_defer_count$&
11415 .vindex "&$rcpt_defer_count$&"
11416 .cindex "4&'xx'& responses" "count of"
11417 When a message is being received by SMTP, this variable contains the number of
11418 RCPT commands in the current message that have previously been rejected with a
11419 temporary (4&'xx'&) response.
11420
11421 .vitem &$rcpt_fail_count$&
11422 .vindex "&$rcpt_fail_count$&"
11423 When a message is being received by SMTP, this variable contains the number of
11424 RCPT commands in the current message that have previously been rejected with a
11425 permanent (5&'xx'&) response.
11426
11427 .vitem &$received_count$&
11428 .vindex "&$received_count$&"
11429 This variable contains the number of &'Received:'& header lines in the message,
11430 including the one added by Exim (so its value is always greater than zero). It
11431 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11432 delivering.
11433
11434 .vitem &$received_for$&
11435 .vindex "&$received_for$&"
11436 If there is only a single recipient address in an incoming message, this
11437 variable contains that address when the &'Received:'& header line is being
11438 built. The value is copied after recipient rewriting has happened, but before
11439 the &[local_scan()]& function is run.
11440
11441 .vitem &$received_ip_address$&
11442 .vindex "&$received_ip_address$&"
11443 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11444 variable is set to the address of the local IP interface, and &$received_port$&
11445 is set to the local port number. (The remote IP address and port are in
11446 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11447 the port value is -1 unless it has been set using the &%-oMi%& command line
11448 option.
11449
11450 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11451 could be used, for example, to make the file name for a TLS certificate depend
11452 on which interface and/or port is being used for the incoming connection. The
11453 values of &$received_ip_address$& and &$received_port$& are saved with any
11454 messages that are received, thus making these variables available at delivery
11455 time.
11456
11457 &*Note:*& There are no equivalent variables for outgoing connections, because
11458 the values are unknown (unless they are explicitly set by options of the
11459 &(smtp)& transport).
11460
11461 .vitem &$received_port$&
11462 .vindex "&$received_port$&"
11463 See &$received_ip_address$&.
11464
11465 .vitem &$received_protocol$&
11466 .vindex "&$received_protocol$&"
11467 When a message is being processed, this variable contains the name of the
11468 protocol by which it was received. Most of the names used by Exim are defined
11469 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11470 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11471 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11472 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11473 connection and the client was successfully authenticated.
11474
11475 Exim uses the protocol name &"smtps"& for the case when encryption is
11476 automatically set up on connection without the use of STARTTLS (see
11477 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11478 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11479 where the client initially uses EHLO, sets up an encrypted connection using
11480 STARTTLS, and then uses HELO afterwards.
11481
11482 The &%-oMr%& option provides a way of specifying a custom protocol name for
11483 messages that are injected locally by trusted callers. This is commonly used to
11484 identify messages that are being re-injected after some kind of scanning.
11485
11486 .vitem &$received_time$&
11487 .vindex "&$received_time$&"
11488 This variable contains the date and time when the current message was received,
11489 as a number of seconds since the start of the Unix epoch.
11490
11491 .vitem &$recipient_data$&
11492 .vindex "&$recipient_data$&"
11493 This variable is set after an indexing lookup success in an ACL &%recipients%&
11494 condition. It contains the data from the lookup, and the value remains set
11495 until the next &%recipients%& test. Thus, you can do things like this:
11496 .display
11497 &`require recipients  = cdb*@;/some/file`&
11498 &`deny    `&&'some further test involving'& &`$recipient_data`&
11499 .endd
11500 &*Warning*&: This variable is set only when a lookup is used as an indexing
11501 method in the address list, using the semicolon syntax as in the example above.
11502 The variable is not set for a lookup that is used as part of the string
11503 expansion that all such lists undergo before being interpreted.
11504
11505 .vitem &$recipient_verify_failure$&
11506 .vindex "&$recipient_verify_failure$&"
11507 In an ACL, when a recipient verification fails, this variable contains
11508 information about the failure. It is set to one of the following words:
11509
11510 .ilist
11511 &"qualify"&: The address was unqualified (no domain), and the message
11512 was neither local nor came from an exempted host.
11513
11514 .next
11515 &"route"&: Routing failed.
11516
11517 .next
11518 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11519 or before the MAIL command (that is, on initial connection, HELO, or
11520 MAIL).
11521
11522 .next
11523 &"recipient"&: The RCPT command in a callout was rejected.
11524 .next
11525
11526 &"postmaster"&: The postmaster check in a callout was rejected.
11527 .endlist
11528
11529 The main use of this variable is expected to be to distinguish between
11530 rejections of MAIL and rejections of RCPT.
11531
11532 .vitem &$recipients$&
11533 .vindex "&$recipients$&"
11534 This variable contains a list of envelope recipients for a message. A comma and
11535 a space separate the addresses in the replacement text. However, the variable
11536 is not generally available, to prevent exposure of Bcc recipients in
11537 unprivileged users' filter files. You can use &$recipients$& only in these
11538 cases:
11539
11540 .olist
11541 In a system filter file.
11542 .next
11543 In the ACLs associated with the DATA command and with non-SMTP messages, that
11544 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11545 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11546 &%acl_not_smtp_mime%&.
11547 .next
11548 From within a &[local_scan()]& function.
11549 .endlist
11550
11551
11552 .vitem &$recipients_count$&
11553 .vindex "&$recipients_count$&"
11554 When a message is being processed, this variable contains the number of
11555 envelope recipients that came with the message. Duplicates are not excluded
11556 from the count. While a message is being received over SMTP, the number
11557 increases for each accepted recipient. It can be referenced in an ACL.
11558
11559
11560 .vitem &$regex_match_string$&
11561 .vindex "&$regex_match_string$&"
11562 This variable is set to contain the matching regular expression after a
11563 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11564
11565
11566 .vitem &$reply_address$&
11567 .vindex "&$reply_address$&"
11568 When a message is being processed, this variable contains the contents of the
11569 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11570 contents of the &'From:'& header line. Apart from the removal of leading
11571 white space, the value is not processed in any way. In particular, no RFC 2047
11572 decoding or character code translation takes place.
11573
11574 .vitem &$return_path$&
11575 .vindex "&$return_path$&"
11576 When a message is being delivered, this variable contains the return path &--
11577 the sender field that will be sent as part of the envelope. It is not enclosed
11578 in <> characters. At the start of routing an address, &$return_path$& has the
11579 same value as &$sender_address$&, but if, for example, an incoming message to a
11580 mailing list has been expanded by a router which specifies a different address
11581 for bounce messages, &$return_path$& subsequently contains the new bounce
11582 address, whereas &$sender_address$& always contains the original sender address
11583 that was received with the message. In other words, &$sender_address$& contains
11584 the incoming envelope sender, and &$return_path$& contains the outgoing
11585 envelope sender.
11586
11587 .vitem &$return_size_limit$&
11588 .vindex "&$return_size_limit$&"
11589 This is an obsolete name for &$bounce_return_size_limit$&.
11590
11591 .vitem &$runrc$&
11592 .cindex "return code" "from &%run%& expansion"
11593 .vindex "&$runrc$&"
11594 This variable contains the return code from a command that is run by the
11595 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11596 assume the order in which option values are expanded, except for those
11597 preconditions whose order of testing is documented. Therefore, you cannot
11598 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11599 another.
11600
11601 .vitem &$self_hostname$&
11602 .oindex "&%self%&" "value of host name"
11603 .vindex "&$self_hostname$&"
11604 When an address is routed to a supposedly remote host that turns out to be the
11605 local host, what happens is controlled by the &%self%& generic router option.
11606 One of its values causes the address to be passed to another router. When this
11607 happens, &$self_hostname$& is set to the name of the local host that the
11608 original router encountered. In other circumstances its contents are null.
11609
11610 .vitem &$sender_address$&
11611 .vindex "&$sender_address$&"
11612 When a message is being processed, this variable contains the sender's address
11613 that was received in the message's envelope. The case of letters in the address
11614 is retained, in both the local part and the domain. For bounce messages, the
11615 value of this variable is the empty string. See also &$return_path$&.
11616
11617 .vitem &$sender_address_data$&
11618 .vindex "&$address_data$&"
11619 .vindex "&$sender_address_data$&"
11620 If &$address_data$& is set when the routers are called from an ACL to verify a
11621 sender address, the final value is preserved in &$sender_address_data$&, to
11622 distinguish it from data from a recipient address. The value does not persist
11623 after the end of the current ACL statement. If you want to preserve it for
11624 longer, you can save it in an ACL variable.
11625
11626 .vitem &$sender_address_domain$&
11627 .vindex "&$sender_address_domain$&"
11628 The domain portion of &$sender_address$&.
11629
11630 .vitem &$sender_address_local_part$&
11631 .vindex "&$sender_address_local_part$&"
11632 The local part portion of &$sender_address$&.
11633
11634 .vitem &$sender_data$&
11635 .vindex "&$sender_data$&"
11636 This variable is set after a lookup success in an ACL &%senders%& condition or
11637 in a router &%senders%& option. It contains the data from the lookup, and the
11638 value remains set until the next &%senders%& test. Thus, you can do things like
11639 this:
11640 .display
11641 &`require senders      = cdb*@;/some/file`&
11642 &`deny    `&&'some further test involving'& &`$sender_data`&
11643 .endd
11644 &*Warning*&: This variable is set only when a lookup is used as an indexing
11645 method in the address list, using the semicolon syntax as in the example above.
11646 The variable is not set for a lookup that is used as part of the string
11647 expansion that all such lists undergo before being interpreted.
11648
11649 .vitem &$sender_fullhost$&
11650 .vindex "&$sender_fullhost$&"
11651 When a message is received from a remote host, this variable contains the host
11652 name and IP address in a single string. It ends with the IP address in square
11653 brackets, followed by a colon and a port number if the logging of ports is
11654 enabled. The format of the rest of the string depends on whether the host
11655 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11656 looking up its IP address. (Looking up the IP address can be forced by the
11657 &%host_lookup%& option, independent of verification.) A plain host name at the
11658 start of the string is a verified host name; if this is not present,
11659 verification either failed or was not requested. A host name in parentheses is
11660 the argument of a HELO or EHLO command. This is omitted if it is identical to
11661 the verified host name or to the host's IP address in square brackets.
11662
11663 .vitem &$sender_helo_name$&
11664 .vindex "&$sender_helo_name$&"
11665 When a message is received from a remote host that has issued a HELO or EHLO
11666 command, the argument of that command is placed in this variable. It is also
11667 set if HELO or EHLO is used when a message is received using SMTP locally via
11668 the &%-bs%& or &%-bS%& options.
11669
11670 .vitem &$sender_host_address$&
11671 .vindex "&$sender_host_address$&"
11672 When a message is received from a remote host, this variable contains that
11673 host's IP address. For locally submitted messages, it is empty.
11674
11675 .vitem &$sender_host_authenticated$&
11676 .vindex "&$sender_host_authenticated$&"
11677 This variable contains the name (not the public name) of the authenticator
11678 driver that successfully authenticated the client from which the message was
11679 received. It is empty if there was no successful authentication. See also
11680 &$authenticated_id$&.
11681
11682 .vitem &$sender_host_name$&
11683 .vindex "&$sender_host_name$&"
11684 When a message is received from a remote host, this variable contains the
11685 host's name as obtained by looking up its IP address. For messages received by
11686 other means, this variable is empty.
11687
11688 .vindex "&$host_lookup_failed$&"
11689 If the host name has not previously been looked up, a reference to
11690 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11691 A looked up name is accepted only if it leads back to the original IP address
11692 via a forward lookup. If either the reverse or the forward lookup fails to find
11693 any data, or if the forward lookup does not yield the original IP address,
11694 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11695
11696 .vindex "&$host_lookup_deferred$&"
11697 However, if either of the lookups cannot be completed (for example, there is a
11698 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11699 &$host_lookup_failed$& remains set to &"0"&.
11700
11701 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11702 host name again if there is a subsequent reference to &$sender_host_name$&
11703 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11704 is set to &"1"&.
11705
11706 Exim does not automatically look up every calling host's name. If you want
11707 maximum efficiency, you should arrange your configuration so that it avoids
11708 these lookups altogether. The lookup happens only if one or more of the
11709 following are true:
11710
11711 .ilist
11712 A string containing &$sender_host_name$& is expanded.
11713 .next
11714 The calling host matches the list in &%host_lookup%&. In the default
11715 configuration, this option is set to *, so it must be changed if lookups are
11716 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11717 .next
11718 Exim needs the host name in order to test an item in a host list. The items
11719 that require this are described in sections &<<SECThoslispatnam>>& and
11720 &<<SECThoslispatnamsk>>&.
11721 .next
11722 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11723 In this case, the host name is required to compare with the name quoted in any
11724 EHLO or HELO commands that the client issues.
11725 .next
11726 The remote host issues a EHLO or HELO command that quotes one of the
11727 domains in &%helo_lookup_domains%&. The default value of this option is
11728 . ==== As this is a nested list, any displays it contains must be indented
11729 . ==== as otherwise they are too far to the left.
11730 .code
11731   helo_lookup_domains = @ : @[]
11732 .endd
11733 which causes a lookup if a remote host (incorrectly) gives the server's name or
11734 IP address in an EHLO or HELO command.
11735 .endlist
11736
11737
11738 .vitem &$sender_host_port$&
11739 .vindex "&$sender_host_port$&"
11740 When a message is received from a remote host, this variable contains the port
11741 number that was used on the remote host.
11742
11743 .vitem &$sender_ident$&
11744 .vindex "&$sender_ident$&"
11745 When a message is received from a remote host, this variable contains the
11746 identification received in response to an RFC 1413 request. When a message has
11747 been received locally, this variable contains the login name of the user that
11748 called Exim.
11749
11750 .vitem &$sender_rate_$&&'xxx'&
11751 A number of variables whose names begin &$sender_rate_$& are set as part of the
11752 &%ratelimit%& ACL condition. Details are given in section
11753 &<<SECTratelimiting>>&.
11754
11755 .vitem &$sender_rcvhost$&
11756 .cindex "DNS" "reverse lookup"
11757 .cindex "reverse DNS lookup"
11758 .vindex "&$sender_rcvhost$&"
11759 This is provided specifically for use in &'Received:'& headers. It starts with
11760 either the verified host name (as obtained from a reverse DNS lookup) or, if
11761 there is no verified host name, the IP address in square brackets. After that
11762 there may be text in parentheses. When the first item is a verified host name,
11763 the first thing in the parentheses is the IP address in square brackets,
11764 followed by a colon and a port number if port logging is enabled. When the
11765 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11766 the parentheses.
11767
11768 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11769 was used and its argument was not identical to the real host name or IP
11770 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11771 all three items are present in the parentheses, a newline and tab are inserted
11772 into the string, to improve the formatting of the &'Received:'& header.
11773
11774 .vitem &$sender_verify_failure$&
11775 .vindex "&$sender_verify_failure$&"
11776 In an ACL, when a sender verification fails, this variable contains information
11777 about the failure. The details are the same as for
11778 &$recipient_verify_failure$&.
11779
11780 .vitem &$sending_ip_address$&
11781 .vindex "&$sending_ip_address$&"
11782 This variable is set whenever an outgoing SMTP connection to another host has
11783 been set up. It contains the IP address of the local interface that is being
11784 used. This is useful if a host that has more than one IP address wants to take
11785 on different personalities depending on which one is being used. For incoming
11786 connections, see &$received_ip_address$&.
11787
11788 .vitem &$sending_port$&
11789 .vindex "&$sending_port$&"
11790 This variable is set whenever an outgoing SMTP connection to another host has
11791 been set up. It contains the local port that is being used. For incoming
11792 connections, see &$received_port$&.
11793
11794 .vitem &$smtp_active_hostname$&
11795 .vindex "&$smtp_active_hostname$&"
11796 During an incoming SMTP session, this variable contains the value of the active
11797 host name, as specified by the &%smtp_active_hostname%& option. The value of
11798 &$smtp_active_hostname$& is saved with any message that is received, so its
11799 value can be consulted during routing and delivery.
11800
11801 .vitem &$smtp_command$&
11802 .vindex "&$smtp_command$&"
11803 During the processing of an incoming SMTP command, this variable contains the
11804 entire command. This makes it possible to distinguish between HELO and EHLO in
11805 the HELO ACL, and also to distinguish between commands such as these:
11806 .code
11807 MAIL FROM:<>
11808 MAIL FROM: <>
11809 .endd
11810 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11811 command, the address in &$smtp_command$& is the original address before any
11812 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11813 the address after SMTP-time rewriting.
11814
11815 .vitem &$smtp_command_argument$&
11816 .cindex "SMTP" "command, argument for"
11817 .vindex "&$smtp_command_argument$&"
11818 While an ACL is running to check an SMTP command, this variable contains the
11819 argument, that is, the text that follows the command name, with leading white
11820 space removed. Following the introduction of &$smtp_command$&, this variable is
11821 somewhat redundant, but is retained for backwards compatibility.
11822
11823 .vitem &$smtp_count_at_connection_start$&
11824 .vindex "&$smtp_count_at_connection_start$&"
11825 This variable is set greater than zero only in processes spawned by the Exim
11826 daemon for handling incoming SMTP connections. The name is deliberately long,
11827 in order to emphasize what the contents are. When the daemon accepts a new
11828 connection, it increments this variable. A copy of the variable is passed to
11829 the child process that handles the connection, but its value is fixed, and
11830 never changes. It is only an approximation of how many incoming connections
11831 there actually are, because many other connections may come and go while a
11832 single connection is being processed. When a child process terminates, the
11833 daemon decrements its copy of the variable.
11834
11835 .vitem "&$sn0$& &-- &$sn9$&"
11836 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11837 that were current at the end of the system filter file. This allows a system
11838 filter file to set values that can be tested in users' filter files. For
11839 example, a system filter could set a value indicating how likely it is that a
11840 message is junk mail.
11841
11842 .vitem &$spam_$&&'xxx'&
11843 A number of variables whose names start with &$spam$& are available when Exim
11844 is compiled with the content-scanning extension. For details, see section
11845 &<<SECTscanspamass>>&.
11846
11847
11848 .vitem &$spool_directory$&
11849 .vindex "&$spool_directory$&"
11850 The name of Exim's spool directory.
11851
11852 .vitem &$spool_inodes$&
11853 .vindex "&$spool_inodes$&"
11854 The number of free inodes in the disk partition where Exim's spool files are
11855 being written. The value is recalculated whenever the variable is referenced.
11856 If the relevant file system does not have the concept of inodes, the value of
11857 is -1. See also the &%check_spool_inodes%& option.
11858
11859 .vitem &$spool_space$&
11860 .vindex "&$spool_space$&"
11861 The amount of free space (as a number of kilobytes) in the disk partition where
11862 Exim's spool files are being written. The value is recalculated whenever the
11863 variable is referenced. If the operating system does not have the ability to
11864 find the amount of free space (only true for experimental systems), the space
11865 value is -1. For example, to check in an ACL that there is at least 50
11866 megabytes free on the spool, you could write:
11867 .code
11868 condition = ${if > {$spool_space}{50000}}
11869 .endd
11870 See also the &%check_spool_space%& option.
11871
11872
11873 .vitem &$thisaddress$&
11874 .vindex "&$thisaddress$&"
11875 This variable is set only during the processing of the &%foranyaddress%&
11876 command in a filter file. Its use is explained in the description of that
11877 command, which can be found in the separate document entitled &'Exim's
11878 interfaces to mail filtering'&.
11879
11880 .vitem &$tls_bits$&
11881 .vindex "&$tls_bits$&"
11882 Contains an approximation of the TLS cipher's bit-strength; the meaning of
11883 this depends upon the TLS implementation used.
11884 If TLS has not been negotiated, the value will be 0.
11885 The value of this is automatically fed into the Cyrus SASL authenticator
11886 when acting as a server, to specify the "external SSF" (a SASL term).
11887
11888 .vitem &$tls_certificate_verified$&
11889 .vindex "&$tls_certificate_verified$&"
11890 This variable is set to &"1"& if a TLS certificate was verified when the
11891 message was received, and &"0"& otherwise.
11892
11893 .vitem &$tls_cipher$&
11894 .vindex "&$tls_cipher$&"
11895 When a message is received from a remote host over an encrypted SMTP
11896 connection, this variable is set to the cipher suite that was negotiated, for
11897 example DES-CBC3-SHA. In other circumstances, in particular, for message
11898 received over unencrypted connections, the variable is empty. Testing
11899 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11900 non-encrypted connections during ACL processing.
11901
11902 The &$tls_cipher$& variable retains its value during message delivery, except
11903 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11904 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11905 and then set to the outgoing cipher suite if one is negotiated. See chapter
11906 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11907 details of the &(smtp)& transport.
11908
11909 .vitem &$tls_peerdn$&
11910 .vindex "&$tls_peerdn$&"
11911 When a message is received from a remote host over an encrypted SMTP
11912 connection, and Exim is configured to request a certificate from the client,
11913 the value of the Distinguished Name of the certificate is made available in the
11914 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11915 value is retained during message delivery, except during outbound SMTP
11916 deliveries.
11917
11918 .vitem &$tls_sni$&
11919 .vindex "&$tls_sni$&"
11920 .cindex "TLS" "Server Name Indication"
11921 When a TLS session is being established, if the client sends the Server
11922 Name Indication extension, the value will be placed in this variable.
11923 If the variable appears in &%tls_certificate%& then this option and
11924 some others, described in &<<SECTtlssni>>&,
11925 will be re-expanded early in the TLS session, to permit
11926 a different certificate to be presented (and optionally a different key to be
11927 used) to the client, based upon the value of the SNI extension.
11928
11929 The value will be retained for the lifetime of the message.  During outbound
11930 SMTP deliveries, it reflects the value of the &%tls_sni%& option on
11931 the transport.
11932
11933 .vitem &$tod_bsdinbox$&
11934 .vindex "&$tod_bsdinbox$&"
11935 The time of day and the date, in the format required for BSD-style mailbox
11936 files, for example: Thu Oct 17 17:14:09 1995.
11937
11938 .vitem &$tod_epoch$&
11939 .vindex "&$tod_epoch$&"
11940 The time and date as a number of seconds since the start of the Unix epoch.
11941
11942 .vitem &$tod_epoch_l$&
11943 .vindex "&$tod_epoch_l$&"
11944 The time and date as a number of microseconds since the start of the Unix epoch.
11945
11946 .vitem &$tod_full$&
11947 .vindex "&$tod_full$&"
11948 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11949 +0100. The timezone is always given as a numerical offset from UTC, with
11950 positive values used for timezones that are ahead (east) of UTC, and negative
11951 values for those that are behind (west).
11952
11953 .vitem &$tod_log$&
11954 .vindex "&$tod_log$&"
11955 The time and date in the format used for writing Exim's log files, for example:
11956 1995-10-12 15:32:29, but without a timezone.
11957
11958 .vitem &$tod_logfile$&
11959 .vindex "&$tod_logfile$&"
11960 This variable contains the date in the format yyyymmdd. This is the format that
11961 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11962 flag.
11963
11964 .vitem &$tod_zone$&
11965 .vindex "&$tod_zone$&"
11966 This variable contains the numerical value of the local timezone, for example:
11967 -0500.
11968
11969 .vitem &$tod_zulu$&
11970 .vindex "&$tod_zulu$&"
11971 This variable contains the UTC date and time in &"Zulu"& format, as specified
11972 by ISO 8601, for example: 20030221154023Z.
11973
11974 .vitem &$value$&
11975 .vindex "&$value$&"
11976 This variable contains the result of an expansion lookup, extraction operation,
11977 or external command, as described above. It is also used during a
11978 &*reduce*& expansion.
11979
11980 .vitem &$version_number$&
11981 .vindex "&$version_number$&"
11982 The version number of Exim.
11983
11984 .vitem &$warn_message_delay$&
11985 .vindex "&$warn_message_delay$&"
11986 This variable is set only during the creation of a message warning about a
11987 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11988
11989 .vitem &$warn_message_recipients$&
11990 .vindex "&$warn_message_recipients$&"
11991 This variable is set only during the creation of a message warning about a
11992 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11993 .endlist
11994 .ecindex IIDstrexp
11995
11996
11997
11998 . ////////////////////////////////////////////////////////////////////////////
11999 . ////////////////////////////////////////////////////////////////////////////
12000
12001 .chapter "Embedded Perl" "CHAPperl"
12002 .scindex IIDperl "Perl" "calling from Exim"
12003 Exim can be built to include an embedded Perl interpreter. When this is done,
12004 Perl subroutines can be called as part of the string expansion process. To make
12005 use of the Perl support, you need version 5.004 or later of Perl installed on
12006 your system. To include the embedded interpreter in the Exim binary, include
12007 the line
12008 .code
12009 EXIM_PERL = perl.o
12010 .endd
12011 in your &_Local/Makefile_& and then build Exim in the normal way.
12012
12013
12014 .section "Setting up so Perl can be used" "SECID85"
12015 .oindex "&%perl_startup%&"
12016 Access to Perl subroutines is via a global configuration option called
12017 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12018 no &%perl_startup%& option in the Exim configuration file then no Perl
12019 interpreter is started and there is almost no overhead for Exim (since none of
12020 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12021 option then the associated value is taken to be Perl code which is executed in
12022 a newly created Perl interpreter.
12023
12024 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12025 need backslashes before any characters to escape special meanings. The option
12026 should usually be something like
12027 .code
12028 perl_startup = do '/etc/exim.pl'
12029 .endd
12030 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12031 use from Exim. Exim can be configured either to start up a Perl interpreter as
12032 soon as it is entered, or to wait until the first time it is needed. Starting
12033 the interpreter at the beginning ensures that it is done while Exim still has
12034 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12035 fact used in a particular run. Also, note that this does not mean that Exim is
12036 necessarily running as root when Perl is called at a later time. By default,
12037 the interpreter is started only when it is needed, but this can be changed in
12038 two ways:
12039
12040 .ilist
12041 .oindex "&%perl_at_start%&"
12042 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12043 a startup when Exim is entered.
12044 .next
12045 The command line option &%-ps%& also requests a startup when Exim is entered,
12046 overriding the setting of &%perl_at_start%&.
12047 .endlist
12048
12049 There is also a command line option &%-pd%& (for delay) which suppresses the
12050 initial startup, even if &%perl_at_start%& is set.
12051
12052
12053 .section "Calling Perl subroutines" "SECID86"
12054 When the configuration file includes a &%perl_startup%& option you can make use
12055 of the string expansion item to call the Perl subroutines that are defined
12056 by the &%perl_startup%& code. The operator is used in any of the following
12057 forms:
12058 .code
12059 ${perl{foo}}
12060 ${perl{foo}{argument}}
12061 ${perl{foo}{argument1}{argument2} ... }
12062 .endd
12063 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12064 arguments may be passed. Passing more than this results in an expansion failure
12065 with an error message of the form
12066 .code
12067 Too many arguments passed to Perl subroutine "foo" (max is 8)
12068 .endd
12069 The return value of the Perl subroutine is evaluated in a scalar context before
12070 it is passed back to Exim to be inserted into the expanded string. If the
12071 return value is &'undef'&, the expansion is forced to fail in the same way as
12072 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12073 by obeying Perl's &%die%& function, the expansion fails with the error message
12074 that was passed to &%die%&.
12075
12076
12077 .section "Calling Exim functions from Perl" "SECID87"
12078 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12079 is available to call back into Exim's string expansion function. For example,
12080 the Perl code
12081 .code
12082 my $lp = Exim::expand_string('$local_part');
12083 .endd
12084 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12085 Note those are single quotes and not double quotes to protect against
12086 &$local_part$& being interpolated as a Perl variable.
12087
12088 If the string expansion is forced to fail by a &"fail"& item, the result of
12089 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12090 expansion string, the Perl call from the original expansion string fails with
12091 an appropriate error message, in the same way as if &%die%& were used.
12092
12093 .cindex "debugging" "from embedded Perl"
12094 .cindex "log" "writing from embedded Perl"
12095 Two other Exim functions are available for use from within Perl code.
12096 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12097 debugging is enabled. If you want a newline at the end, you must supply it.
12098 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12099 timestamp. In this case, you should not supply a terminating newline.
12100
12101
12102 .section "Use of standard output and error by Perl" "SECID88"
12103 .cindex "Perl" "standard output and error"
12104 You should not write to the standard error or output streams from within your
12105 Perl code, as it is not defined how these are set up. In versions of Exim
12106 before 4.50, it is possible for the standard output or error to refer to the
12107 SMTP connection during message reception via the daemon. Writing to this stream
12108 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12109 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12110 avoided, but the output is lost.
12111
12112 .cindex "Perl" "use of &%warn%&"
12113 The Perl &%warn%& statement writes to the standard error stream by default.
12114 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12115 you have no control. When Exim starts up the Perl interpreter, it arranges for
12116 output from the &%warn%& statement to be written to the Exim main log. You can
12117 change this by including appropriate Perl magic somewhere in your Perl code.
12118 For example, to discard &%warn%& output completely, you need this:
12119 .code
12120 $SIG{__WARN__} = sub { };
12121 .endd
12122 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12123 example, the code for the subroutine is empty, so it does nothing, but you can
12124 include any Perl code that you like. The text of the &%warn%& message is passed
12125 as the first subroutine argument.
12126 .ecindex IIDperl
12127
12128
12129 . ////////////////////////////////////////////////////////////////////////////
12130 . ////////////////////////////////////////////////////////////////////////////
12131
12132 .chapter "Starting the daemon and the use of network interfaces" &&&
12133          "CHAPinterfaces" &&&
12134          "Starting the daemon"
12135 .cindex "daemon" "starting"
12136 .cindex "interface" "listening"
12137 .cindex "network interface"
12138 .cindex "interface" "network"
12139 .cindex "IP address" "for listening"
12140 .cindex "daemon" "listening IP addresses"
12141 .cindex "TCP/IP" "setting listening interfaces"
12142 .cindex "TCP/IP" "setting listening ports"
12143 A host that is connected to a TCP/IP network may have one or more physical
12144 hardware network interfaces. Each of these interfaces may be configured as one
12145 or more &"logical"& interfaces, which are the entities that a program actually
12146 works with. Each of these logical interfaces is associated with an IP address.
12147 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12148 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12149 knowledge about the host's interfaces for use in three different circumstances:
12150
12151 .olist
12152 When a listening daemon is started, Exim needs to know which interfaces
12153 and ports to listen on.
12154 .next
12155 When Exim is routing an address, it needs to know which IP addresses
12156 are associated with local interfaces. This is required for the correct
12157 processing of MX lists by removing the local host and others with the
12158 same or higher priority values. Also, Exim needs to detect cases
12159 when an address is routed to an IP address that in fact belongs to the
12160 local host. Unless the &%self%& router option or the &%allow_localhost%&
12161 option of the smtp transport is set (as appropriate), this is treated
12162 as an error situation.
12163 .next
12164 When Exim connects to a remote host, it may need to know which interface to use
12165 for the outgoing connection.
12166 .endlist
12167
12168
12169 Exim's default behaviour is likely to be appropriate in the vast majority
12170 of cases. If your host has only one interface, and you want all its IP
12171 addresses to be treated in the same way, and you are using only the
12172 standard SMTP port, you should not need to take any special action. The
12173 rest of this chapter does not apply to you.
12174
12175 In a more complicated situation you may want to listen only on certain
12176 interfaces, or on different ports, and for this reason there are a number of
12177 options that can be used to influence Exim's behaviour. The rest of this
12178 chapter describes how they operate.
12179
12180 When a message is received over TCP/IP, the interface and port that were
12181 actually used are set in &$received_ip_address$& and &$received_port$&.
12182
12183
12184
12185 .section "Starting a listening daemon" "SECID89"
12186 When a listening daemon is started (by means of the &%-bd%& command line
12187 option), the interfaces and ports on which it listens are controlled by the
12188 following options:
12189
12190 .ilist
12191 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12192 compatibility, this option can also be specified in the singular.)
12193 .next
12194 &%local_interfaces%& contains list of interface IP addresses on which to
12195 listen. Each item may optionally also specify a port.
12196 .endlist
12197
12198 The default list separator in both cases is a colon, but this can be changed as
12199 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12200 it is usually best to change the separator to avoid having to double all the
12201 colons. For example:
12202 .code
12203 local_interfaces = <; 127.0.0.1 ; \
12204                       192.168.23.65 ; \
12205                       ::1 ; \
12206                       3ffe:ffff:836f::fe86:a061
12207 .endd
12208 There are two different formats for specifying a port along with an IP address
12209 in &%local_interfaces%&:
12210
12211 .olist
12212 The port is added onto the address with a dot separator. For example, to listen
12213 on port 1234 on two different IP addresses:
12214 .code
12215 local_interfaces = <; 192.168.23.65.1234 ; \
12216                       3ffe:ffff:836f::fe86:a061.1234
12217 .endd
12218 .next
12219 The IP address is enclosed in square brackets, and the port is added
12220 with a colon separator, for example:
12221 .code
12222 local_interfaces = <; [192.168.23.65]:1234 ; \
12223                       [3ffe:ffff:836f::fe86:a061]:1234
12224 .endd
12225 .endlist
12226
12227 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12228 default setting contains just one port:
12229 .code
12230 daemon_smtp_ports = smtp
12231 .endd
12232 If more than one port is listed, each interface that does not have its own port
12233 specified listens on all of them. Ports that are listed in
12234 &%daemon_smtp_ports%& can be identified either by name (defined in
12235 &_/etc/services_&) or by number. However, when ports are given with individual
12236 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12237
12238
12239
12240 .section "Special IP listening addresses" "SECID90"
12241 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12242 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12243 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12244 instead of setting up separate listening sockets for each interface. The
12245 default value of &%local_interfaces%& is
12246 .code
12247 local_interfaces = 0.0.0.0
12248 .endd
12249 when Exim is built without IPv6 support; otherwise it is:
12250 .code
12251 local_interfaces = <; ::0 ; 0.0.0.0
12252 .endd
12253 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12254
12255
12256
12257 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12258 The &%-oX%& command line option can be used to override the values of
12259 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12260 instance. Another way of doing this would be to use macros and the &%-D%&
12261 option. However, &%-oX%& can be used by any admin user, whereas modification of
12262 the runtime configuration by &%-D%& is allowed only when the caller is root or
12263 exim.
12264
12265 The value of &%-oX%& is a list of items. The default colon separator can be
12266 changed in the usual way if required. If there are any items that do not
12267 contain dots or colons (that is, are not IP addresses), the value of
12268 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12269 items that do contain dots or colons, the value of &%local_interfaces%& is
12270 replaced by those items. Thus, for example,
12271 .code
12272 -oX 1225
12273 .endd
12274 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12275 whereas
12276 .code
12277 -oX 192.168.34.5.1125
12278 .endd
12279 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12280 (However, since &%local_interfaces%& now contains no items without ports, the
12281 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12282
12283
12284
12285 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12286 .cindex "ssmtp protocol"
12287 .cindex "smtps protocol"
12288 .cindex "SMTP" "ssmtp protocol"
12289 .cindex "SMTP" "smtps protocol"
12290 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12291 before the STARTTLS command was standardized for SMTP. Some legacy clients
12292 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12293 list of port numbers, connections to those ports must use SSMTP. The most
12294 common use of this option is expected to be
12295 .code
12296 tls_on_connect_ports = 465
12297 .endd
12298 because 465 is the usual port number used by the legacy clients. There is also
12299 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12300 this way when a daemon is started.
12301
12302 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12303 daemon to listen on those ports. You must still specify them in
12304 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12305 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12306 connections via the daemon.)
12307
12308
12309
12310
12311 .section "IPv6 address scopes" "SECID92"
12312 .cindex "IPv6" "address scopes"
12313 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12314 can, in principle, have the same link-local IPv6 address on different
12315 interfaces. Thus, additional information is needed, over and above the IP
12316 address, to distinguish individual interfaces. A convention of using a
12317 percent sign followed by something (often the interface name) has been
12318 adopted in some cases, leading to addresses like this:
12319 .code
12320 fe80::202:b3ff:fe03:45c1%eth0
12321 .endd
12322 To accommodate this usage, a percent sign followed by an arbitrary string is
12323 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12324 to convert a textual IPv6 address for actual use. This function recognizes the
12325 percent convention in operating systems that support it, and it processes the
12326 address appropriately. Unfortunately, some older libraries have problems with
12327 &[getaddrinfo()]&. If
12328 .code
12329 IPV6_USE_INET_PTON=yes
12330 .endd
12331 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12332 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12333 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12334 function.) Of course, this means that the additional functionality of
12335 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12336
12337 .section "Disabling IPv6" "SECID93"
12338 .cindex "IPv6" "disabling"
12339 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12340 run on a host whose kernel does not support IPv6. The binary will fall back to
12341 using IPv4, but it may waste resources looking up AAAA records, and trying to
12342 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12343 .oindex "&%disable_ipv6%&"
12344 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12345 activities take place. AAAA records are never looked up, and any IPv6 addresses
12346 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12347 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12348 to handle IPv6 literal addresses.
12349
12350 On the other hand, when IPv6 is in use, there may be times when you want to
12351 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12352 option to globally suppress the lookup of AAAA records for specified domains,
12353 and you can use the &%ignore_target_hosts%& generic router option to ignore
12354 IPv6 addresses in an individual router.
12355
12356
12357
12358 .section "Examples of starting a listening daemon" "SECID94"
12359 The default case in an IPv6 environment is
12360 .code
12361 daemon_smtp_ports = smtp
12362 local_interfaces = <; ::0 ; 0.0.0.0
12363 .endd
12364 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12365 Either one or two sockets may be used, depending on the characteristics of
12366 the TCP/IP stack. (This is complicated and messy; for more information,
12367 read the comments in the &_daemon.c_& source file.)
12368
12369 To specify listening on ports 25 and 26 on all interfaces:
12370 .code
12371 daemon_smtp_ports = 25 : 26
12372 .endd
12373 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12374 .code
12375 local_interfaces = <; ::0.25     ; ::0.26 \
12376                       0.0.0.0.25 ; 0.0.0.0.26
12377 .endd
12378 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12379 IPv4 loopback address only:
12380 .code
12381 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12382 .endd
12383 To specify listening on the default port on specific interfaces only:
12384 .code
12385 local_interfaces = 192.168.34.67 : 192.168.34.67
12386 .endd
12387 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12388
12389
12390
12391 .section "Recognizing the local host" "SECTreclocipadd"
12392 The &%local_interfaces%& option is also used when Exim needs to determine
12393 whether or not an IP address refers to the local host. That is, the IP
12394 addresses of all the interfaces on which a daemon is listening are always
12395 treated as local.
12396
12397 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12398 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12399 available interfaces from the operating system, and extracts the relevant
12400 (that is, IPv4 or IPv6) addresses to use for checking.
12401
12402 Some systems set up large numbers of virtual interfaces in order to provide
12403 many virtual web servers. In this situation, you may want to listen for
12404 email on only a few of the available interfaces, but nevertheless treat all
12405 interfaces as local when routing. You can do this by setting
12406 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12407 &"all"& wildcard values. These addresses are recognized as local, but are not
12408 used for listening. Consider this example:
12409 .code
12410 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12411                       192.168.53.235 ; \
12412                       3ffe:2101:12:1:a00:20ff:fe86:a061
12413
12414 extra_local_interfaces = <; ::0 ; 0.0.0.0
12415 .endd
12416 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12417 address, but all available interface addresses are treated as local when
12418 Exim is routing.
12419
12420 In some environments the local host name may be in an MX list, but with an IP
12421 address that is not assigned to any local interface. In other cases it may be
12422 desirable to treat other host names as if they referred to the local host. Both
12423 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12424 This contains host names rather than IP addresses. When a host is referenced
12425 during routing, either via an MX record or directly, it is treated as the local
12426 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12427 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12428
12429
12430
12431 .section "Delivering to a remote host" "SECID95"
12432 Delivery to a remote host is handled by the smtp transport. By default, it
12433 allows the system's TCP/IP functions to choose which interface to use (if
12434 there is more than one) when connecting to a remote host. However, the
12435 &%interface%& option can be set to specify which interface is used. See the
12436 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12437 details.
12438
12439
12440
12441
12442 . ////////////////////////////////////////////////////////////////////////////
12443 . ////////////////////////////////////////////////////////////////////////////
12444
12445 .chapter "Main configuration" "CHAPmainconfig"
12446 .scindex IIDconfima "configuration file" "main section"
12447 .scindex IIDmaiconf "main configuration"
12448 The first part of the run time configuration file contains three types of item:
12449
12450 .ilist
12451 Macro definitions: These lines start with an upper case letter. See section
12452 &<<SECTmacrodefs>>& for details of macro processing.
12453 .next
12454 Named list definitions: These lines start with one of the words &"domainlist"&,
12455 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12456 section &<<SECTnamedlists>>&.
12457 .next
12458 Main configuration settings: Each setting occupies one line of the file
12459 (with possible continuations). If any setting is preceded by the word
12460 &"hide"&, the &%-bP%& command line option displays its value to admin users
12461 only. See section &<<SECTcos>>& for a description of the syntax of these option
12462 settings.
12463 .endlist
12464
12465 This chapter specifies all the main configuration options, along with their
12466 types and default values. For ease of finding a particular option, they appear
12467 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12468 are now so many options, they are first listed briefly in functional groups, as
12469 an aid to finding the name of the option you are looking for. Some options are
12470 listed in more than one group.
12471
12472 .section "Miscellaneous" "SECID96"
12473 .table2
12474 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12475 .row &%disable_ipv6%&                "do no IPv6 processing"
12476 .row &%keep_malformed%&              "for broken files &-- should not happen"
12477 .row &%localhost_number%&            "for unique message ids in clusters"
12478 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12479 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12480 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12481 .row &%print_topbitchars%&           "top-bit characters are printing"
12482 .row &%timezone%&                    "force time zone"
12483 .endtable
12484
12485
12486 .section "Exim parameters" "SECID97"
12487 .table2
12488 .row &%exim_group%&                  "override compiled-in value"
12489 .row &%exim_path%&                   "override compiled-in value"
12490 .row &%exim_user%&                   "override compiled-in value"
12491 .row &%primary_hostname%&            "default from &[uname()]&"
12492 .row &%split_spool_directory%&       "use multiple directories"
12493 .row &%spool_directory%&             "override compiled-in value"
12494 .endtable
12495
12496
12497
12498 .section "Privilege controls" "SECID98"
12499 .table2
12500 .row &%admin_groups%&                "groups that are Exim admin users"
12501 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12502 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12503 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12504 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12505 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12506 .row &%never_users%&                 "do not run deliveries as these"
12507 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12508 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12509 .row &%trusted_groups%&              "groups that are trusted"
12510 .row &%trusted_users%&               "users that are trusted"
12511 .endtable
12512
12513
12514
12515 .section "Logging" "SECID99"
12516 .table2
12517 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12518 .row &%log_file_path%&               "override compiled-in value"
12519 .row &%log_selector%&                "set/unset optional logging"
12520 .row &%log_timezone%&                "add timezone to log lines"
12521 .row &%message_logs%&                "create per-message logs"
12522 .row &%preserve_message_logs%&       "after message completion"
12523 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12524 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12525 .row &%syslog_facility%&             "set syslog &""facility""& field"
12526 .row &%syslog_processname%&          "set syslog &""ident""& field"
12527 .row &%syslog_timestamp%&            "timestamp syslog lines"
12528 .row &%write_rejectlog%&             "control use of message log"
12529 .endtable
12530
12531
12532
12533 .section "Frozen messages" "SECID100"
12534 .table2
12535 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12536 .row &%freeze_tell%&                 "send message when freezing"
12537 .row &%move_frozen_messages%&        "to another directory"
12538 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12539 .endtable
12540
12541
12542
12543 .section "Data lookups" "SECID101"
12544 .table2
12545 .row &%ibase_servers%&               "InterBase servers"
12546 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12547 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12548 .row &%ldap_cert_file%&              "client cert file for LDAP"
12549 .row &%ldap_cert_key%&               "client key file for LDAP"
12550 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12551 .row &%ldap_default_servers%&        "used if no server in query"
12552 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12553 .row &%ldap_start_tls%&              "require TLS within LDAP"
12554 .row &%ldap_version%&                "set protocol version"
12555 .row &%lookup_open_max%&             "lookup files held open"
12556 .row &%mysql_servers%&               "default MySQL servers"
12557 .row &%oracle_servers%&              "Oracle servers"
12558 .row &%pgsql_servers%&               "default PostgreSQL servers"
12559 .row &%sqlite_lock_timeout%&         "as it says"
12560 .endtable
12561
12562
12563
12564 .section "Message ids" "SECID102"
12565 .table2
12566 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12567 .row &%message_id_header_text%&      "ditto"
12568 .endtable
12569
12570
12571
12572 .section "Embedded Perl Startup" "SECID103"
12573 .table2
12574 .row &%perl_at_start%&               "always start the interpreter"
12575 .row &%perl_startup%&                "code to obey when starting Perl"
12576 .endtable
12577
12578
12579
12580 .section "Daemon" "SECID104"
12581 .table2
12582 .row &%daemon_smtp_ports%&           "default ports"
12583 .row &%daemon_startup_retries%&      "number of times to retry"
12584 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12585 .row &%extra_local_interfaces%&      "not necessarily listened on"
12586 .row &%local_interfaces%&            "on which to listen, with optional ports"
12587 .row &%pid_file_path%&               "override compiled-in value"
12588 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12589 .endtable
12590
12591
12592
12593 .section "Resource control" "SECID105"
12594 .table2
12595 .row &%check_log_inodes%&            "before accepting a message"
12596 .row &%check_log_space%&             "before accepting a message"
12597 .row &%check_spool_inodes%&          "before accepting a message"
12598 .row &%check_spool_space%&           "before accepting a message"
12599 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12600 .row &%queue_only_load%&             "queue incoming if load high"
12601 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12602 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12603 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12604 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12605 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12606 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12607 .row &%smtp_accept_max_per_connection%& "messages per connection"
12608 .row &%smtp_accept_max_per_host%&    "connections from one host"
12609 .row &%smtp_accept_queue%&           "queue mail if more connections"
12610 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12611                                            connection"
12612 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12613 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12614 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12615 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12616 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12617 .endtable
12618
12619
12620
12621 .section "Policy controls" "SECID106"
12622 .table2
12623 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12624 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12625 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12626 .row &%acl_smtp_auth%&               "ACL for AUTH"
12627 .row &%acl_smtp_connect%&            "ACL for connection"
12628 .row &%acl_smtp_data%&               "ACL for DATA"
12629 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12630 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12631 .row &%acl_smtp_expn%&               "ACL for EXPN"
12632 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12633 .row &%acl_smtp_mail%&               "ACL for MAIL"
12634 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12635 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12636 .row &%acl_smtp_predata%&            "ACL for start of data"
12637 .row &%acl_smtp_quit%&               "ACL for QUIT"
12638 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12639 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12640 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12641 .row &%av_scanner%&                  "specify virus scanner"
12642 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12643                                       words""&"
12644 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12645 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12646 .row &%header_maxsize%&              "total size of message header"
12647 .row &%header_line_maxsize%&         "individual header line limit"
12648 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12649 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12650 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12651 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12652 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12653 .row &%host_lookup%&                 "host name looked up for these hosts"
12654 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12655 .row &%host_reject_connection%&      "reject connection from these hosts"
12656 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12657 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12658 .row &%message_size_limit%&          "for all messages"
12659 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12660 .row &%spamd_address%&               "set interface to SpamAssassin"
12661 .row &%strict_acl_vars%&             "object to unset ACL variables"
12662 .endtable
12663
12664
12665
12666 .section "Callout cache" "SECID107"
12667 .table2
12668 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12669                                          item"
12670 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12671                                          item"
12672 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12673 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12674 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12675 .endtable
12676
12677
12678
12679 .section "TLS" "SECID108"
12680 .table2
12681 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12682 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12683 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12684 .row &%tls_certificate%&             "location of server certificate"
12685 .row &%tls_crl%&                     "certificate revocation list"
12686 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12687 .row &%tls_dhparam%&                 "DH parameters for server"
12688 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12689 .row &%tls_privatekey%&              "location of server private key"
12690 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12691 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12692 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12693 .row &%tls_verify_certificates%&     "expected client certificates"
12694 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12695 .endtable
12696
12697
12698
12699 .section "Local user handling" "SECID109"
12700 .table2
12701 .row &%finduser_retries%&            "useful in NIS environments"
12702 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12703 .row &%gecos_pattern%&               "ditto"
12704 .row &%max_username_length%&         "for systems that truncate"
12705 .row &%unknown_login%&               "used when no login name found"
12706 .row &%unknown_username%&            "ditto"
12707 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12708 .row &%uucp_from_sender%&            "ditto"
12709 .endtable
12710
12711
12712
12713 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12714 .table2
12715 .row &%header_maxsize%&              "total size of message header"
12716 .row &%header_line_maxsize%&         "individual header line limit"
12717 .row &%message_size_limit%&          "applies to all messages"
12718 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12719 .row &%received_header_text%&        "expanded to make &'Received:'&"
12720 .row &%received_headers_max%&        "for mail loop detection"
12721 .row &%recipients_max%&              "limit per message"
12722 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12723 .endtable
12724
12725
12726
12727
12728 .section "Non-SMTP incoming messages" "SECID111"
12729 .table2
12730 .row &%receive_timeout%&             "for non-SMTP messages"
12731 .endtable
12732
12733
12734
12735
12736
12737 .section "Incoming SMTP messages" "SECID112"
12738 See also the &'Policy controls'& section above.
12739
12740 .table2
12741 .row &%host_lookup%&                 "host name looked up for these hosts"
12742 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12743 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12744 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12745 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12746 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12747 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12748 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12749 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12750 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12751 .row &%smtp_accept_max_per_connection%& "messages per connection"
12752 .row &%smtp_accept_max_per_host%&    "connections from one host"
12753 .row &%smtp_accept_queue%&           "queue mail if more connections"
12754 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12755                                            connection"
12756 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12757 .row &%smtp_active_hostname%&        "host name to use in messages"
12758 .row &%smtp_banner%&                 "text for welcome banner"
12759 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12760 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12761 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12762 .row &%smtp_etrn_command%&           "what to run for ETRN"
12763 .row &%smtp_etrn_serialize%&         "only one at once"
12764 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12765 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12766 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12767 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12768 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12769 .row &%smtp_receive_timeout%&        "per command or data line"
12770 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12771 .row &%smtp_return_error_details%&   "give detail on rejections"
12772 .endtable
12773
12774
12775
12776 .section "SMTP extensions" "SECID113"
12777 .table2
12778 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12779 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12780 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12781 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12782 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12783 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12784 .endtable
12785
12786
12787
12788 .section "Processing messages" "SECID114"
12789 .table2
12790 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12791 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12792 .row &%allow_utf8_domains%&          "in addresses"
12793 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12794                                       words""&"
12795 .row &%delivery_date_remove%&        "from incoming messages"
12796 .row &%envelope_to_remove%&          "from incoming messages"
12797 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12798 .row &%headers_charset%&             "default for translations"
12799 .row &%qualify_domain%&              "default for senders"
12800 .row &%qualify_recipient%&           "default for recipients"
12801 .row &%return_path_remove%&          "from incoming messages"
12802 .row &%strip_excess_angle_brackets%& "in addresses"
12803 .row &%strip_trailing_dot%&          "at end of addresses"
12804 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12805 .endtable
12806
12807
12808
12809 .section "System filter" "SECID115"
12810 .table2
12811 .row &%system_filter%&               "locate system filter"
12812 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12813                                             directory"
12814 .row &%system_filter_file_transport%& "transport for delivery to a file"
12815 .row &%system_filter_group%&         "group for filter running"
12816 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12817 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12818 .row &%system_filter_user%&          "user for filter running"
12819 .endtable
12820
12821
12822
12823 .section "Routing and delivery" "SECID116"
12824 .table2
12825 .row &%disable_ipv6%&                "do no IPv6 processing"
12826 .row &%dns_again_means_nonexist%&    "for broken domains"
12827 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12828 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12829 .row &%dns_retrans%&                 "parameter for resolver"
12830 .row &%dns_retry%&                   "parameter for resolver"
12831 .row &%dns_use_edns0%&               "parameter for resolver"
12832 .row &%hold_domains%&                "hold delivery for these domains"
12833 .row &%local_interfaces%&            "for routing checks"
12834 .row &%queue_domains%&               "no immediate delivery for these"
12835 .row &%queue_only%&                  "no immediate delivery at all"
12836 .row &%queue_only_file%&             "no immediate delivery if file exists"
12837 .row &%queue_only_load%&             "no immediate delivery if load is high"
12838 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12839 .row &%queue_only_override%&         "allow command line to override"
12840 .row &%queue_run_in_order%&          "order of arrival"
12841 .row &%queue_run_max%&               "of simultaneous queue runners"
12842 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12843 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12844 .row &%remote_sort_domains%&         "order of remote deliveries"
12845 .row &%retry_data_expire%&           "timeout for retry data"
12846 .row &%retry_interval_max%&          "safety net for retry rules"
12847 .endtable
12848
12849
12850
12851 .section "Bounce and warning messages" "SECID117"
12852 .table2
12853 .row &%bounce_message_file%&         "content of bounce"
12854 .row &%bounce_message_text%&         "content of bounce"
12855 .row &%bounce_return_body%&          "include body if returning message"
12856 .row &%bounce_return_message%&       "include original message in bounce"
12857 .row &%bounce_return_size_limit%&    "limit on returned message"
12858 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12859 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12860 .row &%errors_copy%&                 "copy bounce messages"
12861 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12862 .row &%delay_warning%&               "time schedule"
12863 .row &%delay_warning_condition%&     "condition for warning messages"
12864 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12865 .row &%smtp_return_error_details%&   "give detail on rejections"
12866 .row &%warn_message_file%&           "content of warning message"
12867 .endtable
12868
12869
12870
12871 .section "Alphabetical list of main options" "SECTalomo"
12872 Those options that undergo string expansion before use are marked with
12873 &dagger;.
12874
12875 .option accept_8bitmime main boolean true
12876 .cindex "8BITMIME"
12877 .cindex "8-bit characters"
12878 This option causes Exim to send 8BITMIME in its response to an SMTP
12879 EHLO command, and to accept the BODY= parameter on MAIL commands.
12880 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12881 takes no steps to do anything special with messages received by this route.
12882
12883 Historically Exim kept this option off by default, but the maintainers
12884 feel that in today's Internet, this causes more problems than it solves.
12885 It now defaults to true.
12886 A more detailed analysis of the issues is provided by Dan Bernstein:
12887 .display
12888 &url(http://cr.yp.to/smtp/8bitmime.html)
12889 .endd
12890
12891 .option acl_not_smtp main string&!! unset
12892 .cindex "&ACL;" "for non-SMTP messages"
12893 .cindex "non-SMTP messages" "ACLs for"
12894 This option defines the ACL that is run when a non-SMTP message has been
12895 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12896 further details.
12897
12898 .option acl_not_smtp_mime main string&!! unset
12899 This option defines the ACL that is run for individual MIME parts of non-SMTP
12900 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12901 SMTP messages.
12902
12903 .option acl_not_smtp_start main string&!! unset
12904 .cindex "&ACL;" "at start of non-SMTP message"
12905 .cindex "non-SMTP messages" "ACLs for"
12906 This option defines the ACL that is run before Exim starts reading a
12907 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12908
12909 .option acl_smtp_auth main string&!! unset
12910 .cindex "&ACL;" "setting up for SMTP commands"
12911 .cindex "AUTH" "ACL for"
12912 This option defines the ACL that is run when an SMTP AUTH command is
12913 received. See chapter &<<CHAPACL>>& for further details.
12914
12915 .option acl_smtp_connect main string&!! unset
12916 .cindex "&ACL;" "on SMTP connection"
12917 This option defines the ACL that is run when an SMTP connection is received.
12918 See chapter &<<CHAPACL>>& for further details.
12919
12920 .option acl_smtp_data main string&!! unset
12921 .cindex "DATA" "ACL for"
12922 This option defines the ACL that is run after an SMTP DATA command has been
12923 processed and the message itself has been received, but before the final
12924 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12925
12926 .option acl_smtp_etrn main string&!! unset
12927 .cindex "ETRN" "ACL for"
12928 This option defines the ACL that is run when an SMTP ETRN command is
12929 received. See chapter &<<CHAPACL>>& for further details.
12930
12931 .option acl_smtp_expn main string&!! unset
12932 .cindex "EXPN" "ACL for"
12933 This option defines the ACL that is run when an SMTP EXPN command is
12934 received. See chapter &<<CHAPACL>>& for further details.
12935
12936 .option acl_smtp_helo main string&!! unset
12937 .cindex "EHLO" "ACL for"
12938 .cindex "HELO" "ACL for"
12939 This option defines the ACL that is run when an SMTP EHLO or HELO
12940 command is received. See chapter &<<CHAPACL>>& for further details.
12941
12942
12943 .option acl_smtp_mail main string&!! unset
12944 .cindex "MAIL" "ACL for"
12945 This option defines the ACL that is run when an SMTP MAIL command is
12946 received. See chapter &<<CHAPACL>>& for further details.
12947
12948 .option acl_smtp_mailauth main string&!! unset
12949 .cindex "AUTH" "on MAIL command"
12950 This option defines the ACL that is run when there is an AUTH parameter on
12951 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12952 &<<CHAPSMTPAUTH>>& for details of authentication.
12953
12954 .option acl_smtp_mime main string&!! unset
12955 .cindex "MIME content scanning" "ACL for"
12956 This option is available when Exim is built with the content-scanning
12957 extension. It defines the ACL that is run for each MIME part in a message. See
12958 section &<<SECTscanmimepart>>& for details.
12959
12960 .option acl_smtp_predata main string&!! unset
12961 This option defines the ACL that is run when an SMTP DATA command is
12962 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12963 further details.
12964
12965 .option acl_smtp_quit main string&!! unset
12966 .cindex "QUIT, ACL for"
12967 This option defines the ACL that is run when an SMTP QUIT command is
12968 received. See chapter &<<CHAPACL>>& for further details.
12969
12970 .option acl_smtp_rcpt main string&!! unset
12971 .cindex "RCPT" "ACL for"
12972 This option defines the ACL that is run when an SMTP RCPT command is
12973 received. See chapter &<<CHAPACL>>& for further details.
12974
12975 .option acl_smtp_starttls main string&!! unset
12976 .cindex "STARTTLS, ACL for"
12977 This option defines the ACL that is run when an SMTP STARTTLS command is
12978 received. See chapter &<<CHAPACL>>& for further details.
12979
12980 .option acl_smtp_vrfy main string&!! unset
12981 .cindex "VRFY" "ACL for"
12982 This option defines the ACL that is run when an SMTP VRFY command is
12983 received. See chapter &<<CHAPACL>>& for further details.
12984
12985 .option admin_groups main "string list&!!" unset
12986 .cindex "admin user"
12987 This option is expanded just once, at the start of Exim's processing. If the
12988 current group or any of the supplementary groups of an Exim caller is in this
12989 colon-separated list, the caller has admin privileges. If all your system
12990 programmers are in a specific group, for example, you can give them all Exim
12991 admin privileges by putting that group in &%admin_groups%&. However, this does
12992 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12993 To permit this, you have to add individuals to the Exim group.
12994
12995 .option allow_domain_literals main boolean false
12996 .cindex "domain literal"
12997 If this option is set, the RFC 2822 domain literal format is permitted in
12998 email addresses. The option is not set by default, because the domain literal
12999 format is not normally required these days, and few people know about it. It
13000 has, however, been exploited by mail abusers.
13001
13002 Unfortunately, it seems that some DNS black list maintainers are using this
13003 format to report black listing to postmasters. If you want to accept messages
13004 addressed to your hosts by IP address, you need to set
13005 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13006 domains (defined in the named domain list &%local_domains%& in the default
13007 configuration). This &"magic string"& matches the domain literal form of all
13008 the local host's IP addresses.
13009
13010
13011 .option allow_mx_to_ip main boolean false
13012 .cindex "MX record" "pointing to IP address"
13013 It appears that more and more DNS zone administrators are breaking the rules
13014 and putting domain names that look like IP addresses on the right hand side of
13015 MX records. Exim follows the rules and rejects this, giving an error message
13016 that explains the mis-configuration. However, some other MTAs support this
13017 practice, so to avoid &"Why can't Exim do this?"& complaints,
13018 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13019 recommended, except when you have no other choice.
13020
13021 .option allow_utf8_domains main boolean false
13022 .cindex "domain" "UTF-8 characters in"
13023 .cindex "UTF-8" "in domain name"
13024 Lots of discussion is going on about internationalized domain names. One
13025 camp is strongly in favour of just using UTF-8 characters, and it seems
13026 that at least two other MTAs permit this. This option allows Exim users to
13027 experiment if they wish.
13028
13029 If it is set true, Exim's domain parsing function allows valid
13030 UTF-8 multicharacters to appear in domain name components, in addition to
13031 letters, digits, and hyphens. However, just setting this option is not
13032 enough; if you want to look up these domain names in the DNS, you must also
13033 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13034 suitable setting is:
13035 .code
13036 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13037   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13038 .endd
13039 Alternatively, you can just disable this feature by setting
13040 .code
13041 dns_check_names_pattern =
13042 .endd
13043 That is, set the option to an empty string so that no check is done.
13044
13045
13046 .option auth_advertise_hosts main "host list&!!" *
13047 .cindex "authentication" "advertising"
13048 .cindex "AUTH" "advertising"
13049 If any server authentication mechanisms are configured, Exim advertises them in
13050 response to an EHLO command only if the calling host matches this list.
13051 Otherwise, Exim does not advertise AUTH.
13052 Exim does not accept AUTH commands from clients to which it has not
13053 advertised the availability of AUTH. The advertising of individual
13054 authentication mechanisms can be controlled by the use of the
13055 &%server_advertise_condition%& generic authenticator option on the individual
13056 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13057
13058 Certain mail clients (for example, Netscape) require the user to provide a name
13059 and password for authentication if AUTH is advertised, even though it may
13060 not be needed (the host may accept messages from hosts on its local LAN without
13061 authentication, for example). The &%auth_advertise_hosts%& option can be used
13062 to make these clients more friendly by excluding them from the set of hosts to
13063 which Exim advertises AUTH.
13064
13065 .cindex "AUTH" "advertising when encrypted"
13066 If you want to advertise the availability of AUTH only when the connection
13067 is encrypted using TLS, you can make use of the fact that the value of this
13068 option is expanded, with a setting like this:
13069 .code
13070 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
13071 .endd
13072 .vindex "&$tls_cipher$&"
13073 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
13074 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13075 expansion is *, which matches all hosts.
13076
13077
13078 .option auto_thaw main time 0s
13079 .cindex "thawing messages"
13080 .cindex "unfreezing messages"
13081 If this option is set to a time greater than zero, a queue runner will try a
13082 new delivery attempt on any frozen message, other than a bounce message, if
13083 this much time has passed since it was frozen. This may result in the message
13084 being re-frozen if nothing has changed since the last attempt. It is a way of
13085 saying &"keep on trying, even though there are big problems"&.
13086
13087 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13088 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13089 thought to be very useful any more, and its use should probably be avoided.
13090
13091
13092 .option av_scanner main string "see below"
13093 This option is available if Exim is built with the content-scanning extension.
13094 It specifies which anti-virus scanner to use. The default value is:
13095 .code
13096 sophie:/var/run/sophie
13097 .endd
13098 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13099 before use. See section &<<SECTscanvirus>>& for further details.
13100
13101
13102 .option bi_command main string unset
13103 .oindex "&%-bi%&"
13104 This option supplies the name of a command that is run when Exim is called with
13105 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13106 just the command name, it is not a complete command line. If an argument is
13107 required, it must come from the &%-oA%& command line option.
13108
13109
13110 .option bounce_message_file main string unset
13111 .cindex "bounce message" "customizing"
13112 .cindex "customizing" "bounce message"
13113 This option defines a template file containing paragraphs of text to be used
13114 for constructing bounce messages.  Details of the file's contents are given in
13115 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13116
13117
13118 .option bounce_message_text main string unset
13119 When this option is set, its contents are included in the default bounce
13120 message immediately after &"This message was created automatically by mail
13121 delivery software."& It is not used if &%bounce_message_file%& is set.
13122
13123 .option bounce_return_body main boolean true
13124 .cindex "bounce message" "including body"
13125 This option controls whether the body of an incoming message is included in a
13126 bounce message when &%bounce_return_message%& is true. The default setting
13127 causes the entire message, both header and body, to be returned (subject to the
13128 value of &%bounce_return_size_limit%&). If this option is false, only the
13129 message header is included. In the case of a non-SMTP message containing an
13130 error that is detected during reception, only those header lines preceding the
13131 point at which the error was detected are returned.
13132 .cindex "bounce message" "including original"
13133
13134 .option bounce_return_message main boolean true
13135 If this option is set false, none of the original message is included in
13136 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13137 &%bounce_return_body%&.
13138
13139
13140 .option bounce_return_size_limit main integer 100K
13141 .cindex "size" "of bounce, limit"
13142 .cindex "bounce message" "size limit"
13143 .cindex "limit" "bounce message size"
13144 This option sets a limit in bytes on the size of messages that are returned to
13145 senders as part of bounce messages when &%bounce_return_message%& is true. The
13146 limit should be less than the value of the global &%message_size_limit%& and of
13147 any &%message_size_limit%& settings on transports, to allow for the bounce text
13148 that Exim generates. If this option is set to zero there is no limit.
13149
13150 When the body of any message that is to be included in a bounce message is
13151 greater than the limit, it is truncated, and a comment pointing this out is
13152 added at the top. The actual cutoff may be greater than the value given, owing
13153 to the use of buffering for transferring the message in chunks (typically 8K in
13154 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13155 messages.
13156
13157 .option bounce_sender_authentication main string unset
13158 .cindex "bounce message" "sender authentication"
13159 .cindex "authentication" "bounce message"
13160 .cindex "AUTH" "on bounce message"
13161 This option provides an authenticated sender address that is sent with any
13162 bounce messages generated by Exim that are sent over an authenticated SMTP
13163 connection. A typical setting might be:
13164 .code
13165 bounce_sender_authentication = mailer-daemon@my.domain.example
13166 .endd
13167 which would cause bounce messages to be sent using the SMTP command:
13168 .code
13169 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13170 .endd
13171 The value of &%bounce_sender_authentication%& must always be a complete email
13172 address.
13173
13174 .option callout_domain_negative_expire main time 3h
13175 .cindex "caching" "callout timeouts"
13176 .cindex "callout" "caching timeouts"
13177 This option specifies the expiry time for negative callout cache data for a
13178 domain. See section &<<SECTcallver>>& for details of callout verification, and
13179 section &<<SECTcallvercache>>& for details of the caching.
13180
13181
13182 .option callout_domain_positive_expire main time 7d
13183 This option specifies the expiry time for positive callout cache data for a
13184 domain. See section &<<SECTcallver>>& for details of callout verification, and
13185 section &<<SECTcallvercache>>& for details of the caching.
13186
13187
13188 .option callout_negative_expire main time 2h
13189 This option specifies the expiry time for negative callout cache data for an
13190 address. See section &<<SECTcallver>>& for details of callout verification, and
13191 section &<<SECTcallvercache>>& for details of the caching.
13192
13193
13194 .option callout_positive_expire main time 24h
13195 This option specifies the expiry time for positive callout cache data for an
13196 address. See section &<<SECTcallver>>& for details of callout verification, and
13197 section &<<SECTcallvercache>>& for details of the caching.
13198
13199
13200 .option callout_random_local_part main string&!! "see below"
13201 This option defines the &"random"& local part that can be used as part of
13202 callout verification. The default value is
13203 .code
13204 $primary_hostname-$tod_epoch-testing
13205 .endd
13206 See section &<<CALLaddparcall>>& for details of how this value is used.
13207
13208
13209 .option check_log_inodes main integer 0
13210 See &%check_spool_space%& below.
13211
13212
13213 .option check_log_space main integer 0
13214 See &%check_spool_space%& below.
13215
13216 .oindex "&%check_rfc2047_length%&"
13217 .cindex "RFC 2047" "disabling length check"
13218 .option check_rfc2047_length main boolean true
13219 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13220 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13221 word; strings to be encoded that exceed this length are supposed to use
13222 multiple encoded words. By default, Exim does not recognize encoded words that
13223 exceed the maximum length. However, it seems that some software, in violation
13224 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13225 set false, Exim recognizes encoded words of any length.
13226
13227
13228 .option check_spool_inodes main integer 0
13229 See &%check_spool_space%& below.
13230
13231
13232 .option check_spool_space main integer 0
13233 .cindex "checking disk space"
13234 .cindex "disk space, checking"
13235 .cindex "spool directory" "checking space"
13236 The four &%check_...%& options allow for checking of disk resources before a
13237 message is accepted.
13238
13239 .vindex "&$log_inodes$&"
13240 .vindex "&$log_space$&"
13241 .vindex "&$spool_inodes$&"
13242 .vindex "&$spool_space$&"
13243 When any of these options are set, they apply to all incoming messages. If you
13244 want to apply different checks to different kinds of message, you can do so by
13245 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13246 &$spool_space$& in an ACL with appropriate additional conditions.
13247
13248
13249 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13250 either value is greater than zero, for example:
13251 .code
13252 check_spool_space = 10M
13253 check_spool_inodes = 100
13254 .endd
13255 The spool partition is the one that contains the directory defined by
13256 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13257 transit.
13258
13259 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13260 files are written if either is greater than zero. These should be set only if
13261 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13262
13263 If there is less space or fewer inodes than requested, Exim refuses to accept
13264 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13265 error response to the MAIL command. If ESMTP is in use and there was a
13266 SIZE parameter on the MAIL command, its value is added to the
13267 &%check_spool_space%& value, and the check is performed even if
13268 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13269
13270 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13271 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13272
13273 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13274 failure a message is written to stderr and Exim exits with a non-zero code, as
13275 it obviously cannot send an error message of any kind.
13276
13277 .option daemon_smtp_ports main string &`smtp`&
13278 .cindex "port" "for daemon"
13279 .cindex "TCP/IP" "setting listening ports"
13280 This option specifies one or more default SMTP ports on which the Exim daemon
13281 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13282 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13283
13284 .option daemon_startup_retries main integer 9
13285 .cindex "daemon startup, retrying"
13286 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13287 the daemon at startup when it cannot immediately bind a listening socket
13288 (typically because the socket is already in use): &%daemon_startup_retries%&
13289 defines the number of retries after the first failure, and
13290 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13291
13292 .option daemon_startup_sleep main time 30s
13293 See &%daemon_startup_retries%&.
13294
13295 .option delay_warning main "time list" 24h
13296 .cindex "warning of delay"
13297 .cindex "delay warning, specifying"
13298 When a message is delayed, Exim sends a warning message to the sender at
13299 intervals specified by this option. The data is a colon-separated list of times
13300 after which to send warning messages. If the value of the option is an empty
13301 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13302 message has been on the queue for longer than the last time, the last interval
13303 between the times is used to compute subsequent warning times. For example,
13304 with
13305 .code
13306 delay_warning = 4h:8h:24h
13307 .endd
13308 the first message is sent after 4 hours, the second after 8 hours, and
13309 the third one after 24 hours. After that, messages are sent every 16 hours,
13310 because that is the interval between the last two times on the list. If you set
13311 just one time, it specifies the repeat interval. For example, with:
13312 .code
13313 delay_warning = 6h
13314 .endd
13315 messages are repeated every six hours. To stop warnings after a given time, set
13316 a very large time at the end of the list. For example:
13317 .code
13318 delay_warning = 2h:12h:99d
13319 .endd
13320
13321 .option delay_warning_condition main string&!! "see below"
13322 .vindex "&$domain$&"
13323 The string is expanded at the time a warning message might be sent. If all the
13324 deferred addresses have the same domain, it is set in &$domain$& during the
13325 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13326 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13327 &"false"& (the comparison being done caselessly) then the warning message is
13328 not sent. The default is:
13329 .code
13330 delay_warning_condition = ${if or {\
13331   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13332   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13333   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13334   } {no}{yes}}
13335 .endd
13336 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13337 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13338 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13339 &"auto-replied"& in an &'Auto-Submitted:'& header.
13340
13341 .option deliver_drop_privilege main boolean false
13342 .cindex "unprivileged delivery"
13343 .cindex "delivery" "unprivileged"
13344 If this option is set true, Exim drops its root privilege at the start of a
13345 delivery process, and runs as the Exim user throughout. This severely restricts
13346 the kinds of local delivery that are possible, but is viable in certain types
13347 of configuration. There is a discussion about the use of root privilege in
13348 chapter &<<CHAPsecurity>>&.
13349
13350 .option deliver_queue_load_max main fixed-point unset
13351 .cindex "load average"
13352 .cindex "queue runner" "abandoning"
13353 When this option is set, a queue run is abandoned if the system load average
13354 becomes greater than the value of the option. The option has no effect on
13355 ancient operating systems on which Exim cannot determine the load average.
13356 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13357
13358
13359 .option delivery_date_remove main boolean true
13360 .cindex "&'Delivery-date:'& header line"
13361 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13362 message when it is delivered, in exactly the same way as &'Return-path:'& is
13363 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13364 should not be present in incoming messages, and this option causes them to be
13365 removed at the time the message is received, to avoid any problems that might
13366 occur when a delivered message is subsequently sent on to some other recipient.
13367
13368 .option disable_fsync main boolean false
13369 .cindex "&[fsync()]&, disabling"
13370 This option is available only if Exim was built with the compile-time option
13371 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13372 a runtime configuration generates an &"unknown option"& error. You should not
13373 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13374 really, really, really understand what you are doing. &'No pre-compiled
13375 distributions of Exim should ever make this option available.'&
13376
13377 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13378 updated files' data to be written to disc before continuing. Unexpected events
13379 such as crashes and power outages may cause data to be lost or scrambled.
13380 Here be Dragons. &*Beware.*&
13381
13382
13383 .option disable_ipv6 main boolean false
13384 .cindex "IPv6" "disabling"
13385 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13386 activities take place. AAAA records are never looked up, and any IPv6 addresses
13387 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13388 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13389 to handle IPv6 literal addresses.
13390
13391
13392 .option dns_again_means_nonexist main "domain list&!!" unset
13393 .cindex "DNS" "&""try again""& response; overriding"
13394 DNS lookups give a &"try again"& response for the DNS errors
13395 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13396 keep trying to deliver a message, or to give repeated temporary errors to
13397 incoming mail. Sometimes the effect is caused by a badly set up name server and
13398 may persist for a long time. If a domain which exhibits this problem matches
13399 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13400 This option should be used with care. You can make it apply to reverse lookups
13401 by a setting such as this:
13402 .code
13403 dns_again_means_nonexist = *.in-addr.arpa
13404 .endd
13405 This option applies to all DNS lookups that Exim does. It also applies when the
13406 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13407 since these are most likely to be caused by DNS lookup problems. The
13408 &(dnslookup)& router has some options of its own for controlling what happens
13409 when lookups for MX or SRV records give temporary errors. These more specific
13410 options are applied after this global option.
13411
13412 .option dns_check_names_pattern main string "see below"
13413 .cindex "DNS" "pre-check of name syntax"
13414 When this option is set to a non-empty string, it causes Exim to check domain
13415 names for characters that are not allowed in host names before handing them to
13416 the DNS resolver, because some resolvers give temporary errors for names that
13417 contain unusual characters. If a domain name contains any unwanted characters,
13418 a &"not found"& result is forced, and the resolver is not called. The check is
13419 done by matching the domain name against a regular expression, which is the
13420 value of this option. The default pattern is
13421 .code
13422 dns_check_names_pattern = \
13423   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13424 .endd
13425 which permits only letters, digits, slashes, and hyphens in components, but
13426 they must start and end with a letter or digit. Slashes are not, in fact,
13427 permitted in host names, but they are found in certain NS records (which can be
13428 accessed in Exim by using a &%dnsdb%& lookup). If you set
13429 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13430 empty string.
13431
13432 .option dns_csa_search_limit main integer 5
13433 This option controls the depth of parental searching for CSA SRV records in the
13434 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13435
13436 .option dns_csa_use_reverse main boolean true
13437 This option controls whether or not an IP address, given as a CSA domain, is
13438 reversed and looked up in the reverse DNS, as described in more detail in
13439 section &<<SECTverifyCSA>>&.
13440
13441 .option dns_ipv4_lookup main "domain list&!!" unset
13442 .cindex "IPv6" "DNS lookup for AAAA records"
13443 .cindex "DNS" "IPv6 lookup for AAAA records"
13444 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13445 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13446 (A records) when trying to find IP addresses for hosts, unless the host's
13447 domain matches this list.
13448
13449 This is a fudge to help with name servers that give big delays or otherwise do
13450 not work for the AAAA record type. In due course, when the world's name
13451 servers have all been upgraded, there should be no need for this option.
13452
13453
13454 .option dns_retrans main time 0s
13455 .cindex "DNS" "resolver options"
13456 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13457 retransmission and retry parameters for DNS lookups. Values of zero (the
13458 defaults) leave the system default settings unchanged. The first value is the
13459 time between retries, and the second is the number of retries. It isn't
13460 totally clear exactly how these settings affect the total time a DNS lookup may
13461 take. I haven't found any documentation about timeouts on DNS lookups; these
13462 parameter values are available in the external resolver interface structure,
13463 but nowhere does it seem to describe how they are used or what you might want
13464 to set in them.
13465
13466
13467 .option dns_retry main integer 0
13468 See &%dns_retrans%& above.
13469
13470
13471 .option dns_use_edns0 main integer -1
13472 .cindex "DNS" "resolver options"
13473 .cindex "DNS" "EDNS0"
13474 If this option is set to a non-negative number then Exim will initialise the
13475 DNS resolver library to either use or not use EDNS0 extensions, overriding
13476 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13477 on.
13478
13479 If the resolver library does not support EDNS0 then this option has no effect.
13480
13481
13482 .option drop_cr main boolean false
13483 This is an obsolete option that is now a no-op. It used to affect the way Exim
13484 handled CR and LF characters in incoming messages. What happens now is
13485 described in section &<<SECTlineendings>>&.
13486
13487 .option dsn_from main "string&!!" "see below"
13488 .cindex "&'From:'& header line" "in bounces"
13489 .cindex "bounce messages" "&'From:'& line, specifying"
13490 This option can be used to vary the contents of &'From:'& header lines in
13491 bounces and other automatically generated messages (&"Delivery Status
13492 Notifications"& &-- hence the name of the option). The default setting is:
13493 .code
13494 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13495 .endd
13496 The value is expanded every time it is needed. If the expansion fails, a
13497 panic is logged, and the default value is used.
13498
13499 .option envelope_to_remove main boolean true
13500 .cindex "&'Envelope-to:'& header line"
13501 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13502 message when it is delivered, in exactly the same way as &'Return-path:'& is
13503 handled. &'Envelope-to:'& records the original recipient address from the
13504 messages's envelope that caused the delivery to happen. Such headers should not
13505 be present in incoming messages, and this option causes them to be removed at
13506 the time the message is received, to avoid any problems that might occur when a
13507 delivered message is subsequently sent on to some other recipient.
13508
13509
13510 .option errors_copy main "string list&!!" unset
13511 .cindex "bounce message" "copy to other address"
13512 .cindex "copy of bounce message"
13513 Setting this option causes Exim to send bcc copies of bounce messages that it
13514 generates to other addresses. &*Note*&: This does not apply to bounce messages
13515 coming from elsewhere. The value of the option is a colon-separated list of
13516 items. Each item consists of a pattern, terminated by white space, followed by
13517 a comma-separated list of email addresses. If a pattern contains spaces, it
13518 must be enclosed in double quotes.
13519
13520 Each pattern is processed in the same way as a single item in an address list
13521 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13522 the bounce message, the message is copied to the addresses on the list. The
13523 items are scanned in order, and once a matching one is found, no further items
13524 are examined. For example:
13525 .code
13526 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13527               rqps@mydomain   hostmaster@mydomain.example,\
13528                               postmaster@mydomain.example
13529 .endd
13530 .vindex "&$domain$&"
13531 .vindex "&$local_part$&"
13532 The address list is expanded before use. The expansion variables &$local_part$&
13533 and &$domain$& are set from the original recipient of the error message, and if
13534 there was any wildcard matching in the pattern, the expansion
13535 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13536 variables &$0$&, &$1$&, etc. are set in the normal way.
13537
13538
13539 .option errors_reply_to main string unset
13540 .cindex "bounce message" "&'Reply-to:'& in"
13541 By default, Exim's bounce and delivery warning messages contain the header line
13542 .display
13543 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13544 .endd
13545 .oindex &%quota_warn_message%&
13546 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13547 A warning message that is generated by the &%quota_warn_message%& option in an
13548 &(appendfile)& transport may contain its own &'From:'& header line that
13549 overrides the default.
13550
13551 Experience shows that people reply to bounce messages. If the
13552 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13553 and warning messages. For example:
13554 .code
13555 errors_reply_to = postmaster@my.domain.example
13556 .endd
13557 The value of the option is not expanded. It must specify a valid RFC 2822
13558 address. However, if a warning message that is generated by the
13559 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13560 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13561 not used.
13562
13563
13564 .option exim_group main string "compile-time configured"
13565 .cindex "gid (group id)" "Exim's own"
13566 .cindex "Exim group"
13567 This option changes the gid under which Exim runs when it gives up root
13568 privilege. The default value is compiled into the binary. The value of this
13569 option is used only when &%exim_user%& is also set. Unless it consists entirely
13570 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13571 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13572 security issues.
13573
13574
13575 .option exim_path main string "see below"
13576 .cindex "Exim binary, path name"
13577 This option specifies the path name of the Exim binary, which is used when Exim
13578 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13579 the directory configured at compile time by the BIN_DIRECTORY setting. It
13580 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13581 other place.
13582 &*Warning*&: Do not use a macro to define the value of this option, because
13583 you will break those Exim utilities that scan the configuration file to find
13584 where the binary is. (They then use the &%-bP%& option to extract option
13585 settings such as the value of &%spool_directory%&.)
13586
13587
13588 .option exim_user main string "compile-time configured"
13589 .cindex "uid (user id)" "Exim's own"
13590 .cindex "Exim user"
13591 This option changes the uid under which Exim runs when it gives up root
13592 privilege. The default value is compiled into the binary. Ownership of the run
13593 time configuration file and the use of the &%-C%& and &%-D%& command line
13594 options is checked against the values in the binary, not what is set here.
13595
13596 Unless it consists entirely of digits, the string is looked up using
13597 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13598 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13599 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13600
13601
13602 .option extra_local_interfaces main "string list" unset
13603 This option defines network interfaces that are to be considered local when
13604 routing, but which are not used for listening by the daemon. See section
13605 &<<SECTreclocipadd>>& for details.
13606
13607
13608 . Allow this long option name to split; give it unsplit as a fifth argument
13609 . for the automatic .oindex that is generated by .option.
13610
13611 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13612          extract_addresses_remove_arguments
13613 .oindex "&%-t%&"
13614 .cindex "command line" "addresses with &%-t%&"
13615 .cindex "Sendmail compatibility" "&%-t%& option"
13616 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13617 are present on the command line when the &%-t%& option is used to build an
13618 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13619 line addresses are removed from the recipients list. This is also how Smail
13620 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13621 command line addresses are added to those obtained from the header lines. When
13622 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13623 argument headers. If it is set false, Exim adds rather than removes argument
13624 addresses.
13625
13626
13627 .option finduser_retries main integer 0
13628 .cindex "NIS, retrying user lookups"
13629 On systems running NIS or other schemes in which user and group information is
13630 distributed from a remote system, there can be times when &[getpwnam()]& and
13631 related functions fail, even when given valid data, because things time out.
13632 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13633 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13634 many extra times to find a user or a group, waiting for one second between
13635 retries.
13636
13637 .cindex "&_/etc/passwd_&" "multiple reading of"
13638 You should not set this option greater than zero if your user information is in
13639 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13640 search the file multiple times for non-existent users, and also cause delay.
13641
13642
13643
13644 .option freeze_tell main "string list, comma separated" unset
13645 .cindex "freezing messages" "sending a message when freezing"
13646 On encountering certain errors, or when configured to do so in a system filter,
13647 ACL, or special router, Exim freezes a message. This means that no further
13648 delivery attempts take place until an administrator thaws the message, or the
13649 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13650 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13651 warning message whenever it freezes something, unless the message it is
13652 freezing is a locally-generated bounce message. (Without this exception there
13653 is the possibility of looping.) The warning message is sent to the addresses
13654 supplied as the comma-separated value of this option. If several of the
13655 message's addresses cause freezing, only a single message is sent. If the
13656 freezing was automatic, the reason(s) for freezing can be found in the message
13657 log. If you configure freezing in a filter or ACL, you must arrange for any
13658 logging that you require.
13659
13660
13661 .option gecos_name main string&!! unset
13662 .cindex "HP-UX"
13663 .cindex "&""gecos""& field, parsing"
13664 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13665 password file to hold other information in addition to users' real names. Exim
13666 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13667 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13668 of the field are used unchanged, except that, if an ampersand is encountered,
13669 it is replaced by the user's login name with the first character forced to
13670 upper case, since this is a convention that is observed on many systems.
13671
13672 When these options are set, &%gecos_pattern%& is treated as a regular
13673 expression that is to be applied to the field (again with && replaced by the
13674 login name), and if it matches, &%gecos_name%& is expanded and used as the
13675 user's name.
13676
13677 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13678 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13679 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13680 name terminates at the first comma, the following can be used:
13681 .code
13682 gecos_pattern = ([^,]*)
13683 gecos_name = $1
13684 .endd
13685
13686 .option gecos_pattern main string unset
13687 See &%gecos_name%& above.
13688
13689
13690 .option gnutls_compat_mode main boolean unset
13691 This option controls whether GnuTLS is used in compatibility mode in an Exim
13692 server. This reduces security slightly, but improves interworking with older
13693 implementations of TLS.
13694
13695 .option headers_charset main string "see below"
13696 This option sets a default character set for translating from encoded MIME
13697 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13698 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13699 ultimate default is ISO-8859-1. For more details see the description of header
13700 insertions in section &<<SECTexpansionitems>>&.
13701
13702
13703
13704 .option header_maxsize main integer "see below"
13705 .cindex "header section" "maximum size of"
13706 .cindex "limit" "size of message header section"
13707 This option controls the overall maximum size of a message's header
13708 section. The default is the value of HEADER_MAXSIZE in
13709 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13710 sections are rejected.
13711
13712
13713 .option header_line_maxsize main integer 0
13714 .cindex "header lines" "maximum size of"
13715 .cindex "limit" "size of one header line"
13716 This option limits the length of any individual header line in a message, after
13717 all the continuations have been joined together. Messages with individual
13718 header lines that are longer than the limit are rejected. The default value of
13719 zero means &"no limit"&.
13720
13721
13722
13723
13724 .option helo_accept_junk_hosts main "host list&!!" unset
13725 .cindex "HELO" "accepting junk data"
13726 .cindex "EHLO" "accepting junk data"
13727 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13728 mail, and gives an error response for invalid data. Unfortunately, there are
13729 some SMTP clients that send syntactic junk. They can be accommodated by setting
13730 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13731 if you want to do semantic checking.
13732 See also &%helo_allow_chars%& for a way of extending the permitted character
13733 set.
13734
13735
13736 .option helo_allow_chars main string unset
13737 .cindex "HELO" "underscores in"
13738 .cindex "EHLO" "underscores in"
13739 .cindex "underscore in EHLO/HELO"
13740 This option can be set to a string of rogue characters that are permitted in
13741 all EHLO and HELO names in addition to the standard letters, digits,
13742 hyphens, and dots. If you really must allow underscores, you can set
13743 .code
13744 helo_allow_chars = _
13745 .endd
13746 Note that the value is one string, not a list.
13747
13748
13749 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13750 .cindex "HELO" "forcing reverse lookup"
13751 .cindex "EHLO" "forcing reverse lookup"
13752 If the domain given by a client in a HELO or EHLO command matches this
13753 list, a reverse lookup is done in order to establish the host's true name. The
13754 default forces a lookup if the client host gives the server's name or any of
13755 its IP addresses (in brackets), something that broken clients have been seen to
13756 do.
13757
13758
13759 .option helo_try_verify_hosts main "host list&!!" unset
13760 .cindex "HELO verifying" "optional"
13761 .cindex "EHLO" "verifying, optional"
13762 By default, Exim just checks the syntax of HELO and EHLO commands (see
13763 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13764 to do more extensive checking of the data supplied by these commands. The ACL
13765 condition &`verify = helo`& is provided to make this possible.
13766 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13767 to force the check to occur. From release 4.53 onwards, this is no longer
13768 necessary. If the check has not been done before &`verify = helo`& is
13769 encountered, it is done at that time. Consequently, this option is obsolete.
13770 Its specification is retained here for backwards compatibility.
13771
13772 When an EHLO or HELO command is received, if the calling host matches
13773 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13774 EHLO command either:
13775
13776 .ilist
13777 is an IP literal matching the calling address of the host, or
13778 .next
13779 .cindex "DNS" "reverse lookup"
13780 .cindex "reverse DNS lookup"
13781 matches the host name that Exim obtains by doing a reverse lookup of the
13782 calling host address, or
13783 .next
13784 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13785 available) yields the calling host address.
13786 .endlist
13787
13788 However, the EHLO or HELO command is not rejected if any of the checks
13789 fail. Processing continues, but the result of the check is remembered, and can
13790 be detected later in an ACL by the &`verify = helo`& condition.
13791
13792 .option helo_verify_hosts main "host list&!!" unset
13793 .cindex "HELO verifying" "mandatory"
13794 .cindex "EHLO" "verifying, mandatory"
13795 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13796 backwards compatibility. For hosts that match this option, Exim checks the host
13797 name given in the HELO or EHLO in the same way as for
13798 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13799 rejected with a 550 error, and entries are written to the main and reject logs.
13800 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13801 error.
13802
13803 .option hold_domains main "domain list&!!" unset
13804 .cindex "domain" "delaying delivery"
13805 .cindex "delivery" "delaying certain domains"
13806 This option allows mail for particular domains to be held on the queue
13807 manually. The option is overridden if a message delivery is forced with the
13808 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13809 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13810 item in &%hold_domains%&, no routing or delivery for that address is done, and
13811 it is deferred every time the message is looked at.
13812
13813 This option is intended as a temporary operational measure for delaying the
13814 delivery of mail while some problem is being sorted out, or some new
13815 configuration tested. If you just want to delay the processing of some
13816 domains until a queue run occurs, you should use &%queue_domains%& or
13817 &%queue_smtp_domains%&, not &%hold_domains%&.
13818
13819 A setting of &%hold_domains%& does not override Exim's code for removing
13820 messages from the queue if they have been there longer than the longest retry
13821 time in any retry rule. If you want to hold messages for longer than the normal
13822 retry times, insert a dummy retry rule with a long retry time.
13823
13824
13825 .option host_lookup main "host list&!!" unset
13826 .cindex "host name" "lookup, forcing"
13827 Exim does not look up the name of a calling host from its IP address unless it
13828 is required to compare against some host list, or the host matches
13829 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13830 option (which normally contains IP addresses rather than host names). The
13831 default configuration file contains
13832 .code
13833 host_lookup = *
13834 .endd
13835 which causes a lookup to happen for all hosts. If the expense of these lookups
13836 is felt to be too great, the setting can be changed or removed.
13837
13838 After a successful reverse lookup, Exim does a forward lookup on the name it
13839 has obtained, to verify that it yields the IP address that it started with. If
13840 this check fails, Exim behaves as if the name lookup failed.
13841
13842 .vindex "&$host_lookup_failed$&"
13843 .vindex "&$sender_host_name$&"
13844 After any kind of failure, the host name (in &$sender_host_name$&) remains
13845 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13846 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13847 &`verify = reverse_host_lookup`& in ACLs.
13848
13849
13850 .option host_lookup_order main "string list" &`bydns:byaddr`&
13851 This option specifies the order of different lookup methods when Exim is trying
13852 to find a host name from an IP address. The default is to do a DNS lookup
13853 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13854 if that fails. You can change the order of these lookups, or omit one entirely,
13855 if you want.
13856
13857 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13858 multiple PTR records in the DNS and the IP address is not listed in
13859 &_/etc/hosts_&. Different operating systems give different results in this
13860 case. That is why the default tries a DNS lookup first.
13861
13862
13863
13864 .option host_reject_connection main "host list&!!" unset
13865 .cindex "host" "rejecting connections from"
13866 If this option is set, incoming SMTP calls from the hosts listed are rejected
13867 as soon as the connection is made.
13868 This option is obsolete, and retained only for backward compatibility, because
13869 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13870 connections immediately.
13871
13872 The ability to give an immediate rejection (either by this option or using an
13873 ACL) is provided for use in unusual cases. Many hosts will just try again,
13874 sometimes without much delay. Normally, it is better to use an ACL to reject
13875 incoming messages at a later stage, such as after RCPT commands. See
13876 chapter &<<CHAPACL>>&.
13877
13878
13879 .option hosts_connection_nolog main "host list&!!" unset
13880 .cindex "host" "not logging connections from"
13881 This option defines a list of hosts for which connection logging does not
13882 happen, even though the &%smtp_connection%& log selector is set. For example,
13883 you might want not to log SMTP connections from local processes, or from
13884 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13885 the daemon; you should therefore strive to restrict its value to a short inline
13886 list of IP addresses and networks. To disable logging SMTP connections from
13887 local processes, you must create a host list with an empty item. For example:
13888 .code
13889 hosts_connection_nolog = :
13890 .endd
13891 If the &%smtp_connection%& log selector is not set, this option has no effect.
13892
13893
13894
13895 .option hosts_treat_as_local main "domain list&!!" unset
13896 .cindex "local host" "domains treated as"
13897 .cindex "host" "treated as local"
13898 If this option is set, any host names that match the domain list are treated as
13899 if they were the local host when Exim is scanning host lists obtained from MX
13900 records
13901 or other sources. Note that the value of this option is a domain list, not a
13902 host list, because it is always used to check host names, not IP addresses.
13903
13904 This option also applies when Exim is matching the special items
13905 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13906 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13907 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13908 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13909 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13910 interfaces and recognizing the local host.
13911
13912
13913 .option ibase_servers main "string list" unset
13914 .cindex "InterBase" "server list"
13915 This option provides a list of InterBase servers and associated connection data,
13916 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13917 The option is available only if Exim has been built with InterBase support.
13918
13919
13920
13921 .option ignore_bounce_errors_after main time 10w
13922 .cindex "bounce message" "discarding"
13923 .cindex "discarding bounce message"
13924 This option affects the processing of bounce messages that cannot be delivered,
13925 that is, those that suffer a permanent delivery failure. (Bounce messages that
13926 suffer temporary delivery failures are of course retried in the usual way.)
13927
13928 After a permanent delivery failure, bounce messages are frozen,
13929 because there is no sender to whom they can be returned. When a frozen bounce
13930 message has been on the queue for more than the given time, it is unfrozen at
13931 the next queue run, and a further delivery is attempted. If delivery fails
13932 again, the bounce message is discarded. This makes it possible to keep failed
13933 bounce messages around for a shorter time than the normal maximum retry time
13934 for frozen messages. For example,
13935 .code
13936 ignore_bounce_errors_after = 12h
13937 .endd
13938 retries failed bounce message deliveries after 12 hours, discarding any further
13939 failures. If the value of this option is set to a zero time period, bounce
13940 failures are discarded immediately. Setting a very long time (as in the default
13941 value) has the effect of disabling this option. For ways of automatically
13942 dealing with other kinds of frozen message, see &%auto_thaw%& and
13943 &%timeout_frozen_after%&.
13944
13945
13946 .option ignore_fromline_hosts main "host list&!!" unset
13947 .cindex "&""From""& line"
13948 .cindex "UUCP" "&""From""& line"
13949 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13950 the headers of a message. By default this is treated as the start of the
13951 message's body, which means that any following headers are not recognized as
13952 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13953 match those hosts that insist on sending it. If the sender is actually a local
13954 process rather than a remote host, and is using &%-bs%& to inject the messages,
13955 &%ignore_fromline_local%& must be set to achieve this effect.
13956
13957
13958 .option ignore_fromline_local main boolean false
13959 See &%ignore_fromline_hosts%& above.
13960
13961
13962 .option keep_malformed main time 4d
13963 This option specifies the length of time to keep messages whose spool files
13964 have been corrupted in some way. This should, of course, never happen. At the
13965 next attempt to deliver such a message, it gets removed. The incident is
13966 logged.
13967
13968
13969 .option ldap_ca_cert_dir main string unset
13970 .cindex "LDAP", "TLS CA certificate directory"
13971 This option indicates which directory contains CA certificates for verifying
13972 a TLS certificate presented by an LDAP server.
13973 While Exim does not provide a default value, your SSL library may.
13974 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13975 and constrained to be a directory.
13976
13977
13978 .option ldap_ca_cert_file main string unset
13979 .cindex "LDAP", "TLS CA certificate file"
13980 This option indicates which file contains CA certificates for verifying
13981 a TLS certificate presented by an LDAP server.
13982 While Exim does not provide a default value, your SSL library may.
13983 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13984 and constrained to be a file.
13985
13986
13987 .option ldap_cert_file main string unset
13988 .cindex "LDAP" "TLS client certificate file"
13989 This option indicates which file contains an TLS client certificate which
13990 Exim should present to the LDAP server during TLS negotiation.
13991 Should be used together with &%ldap_cert_key%&.
13992
13993
13994 .option ldap_cert_key main string unset
13995 .cindex "LDAP" "TLS client key file"
13996 This option indicates which file contains the secret/private key to use
13997 to prove identity to the LDAP server during TLS negotiation.
13998 Should be used together with &%ldap_cert_file%&, which contains the
13999 identity to be proven.
14000
14001
14002 .option ldap_cipher_suite main string unset
14003 .cindex "LDAP" "TLS cipher suite"
14004 This controls the TLS cipher-suite negotiation during TLS negotiation with
14005 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14006 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14007
14008
14009 .option ldap_default_servers main "string list" unset
14010 .cindex "LDAP" "default servers"
14011 This option provides a list of LDAP servers which are tried in turn when an
14012 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14013 details of LDAP queries. This option is available only when Exim has been built
14014 with LDAP support.
14015
14016
14017 .option ldap_require_cert main string unset.
14018 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14019 This should be one of the values "hard", "demand", "allow", "try" or "never".
14020 A value other than one of these is interpreted as "never".
14021 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14022 Although Exim does not set a default, the LDAP library probably defaults
14023 to hard/demand.
14024
14025
14026 .option ldap_start_tls main boolean false
14027 .cindex "LDAP" "whether or not to negotiate TLS"
14028 If set, Exim will attempt to negotiate TLS with the LDAP server when
14029 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14030 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14031 of SSL-on-connect.
14032 In the event of failure to negotiate TLS, the action taken is controlled
14033 by &%ldap_require_cert%&.
14034
14035
14036 .option ldap_version main integer unset
14037 .cindex "LDAP" "protocol version, forcing"
14038 This option can be used to force Exim to set a specific protocol version for
14039 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14040 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14041 the LDAP headers; otherwise it is 2. This option is available only when Exim
14042 has been built with LDAP support.
14043
14044
14045
14046 .option local_from_check main boolean true
14047 .cindex "&'Sender:'& header line" "disabling addition of"
14048 .cindex "&'From:'& header line" "disabling checking of"
14049 When a message is submitted locally (that is, not over a TCP/IP connection) by
14050 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14051 checks that the &'From:'& header line matches the login of the calling user and
14052 the domain specified by &%qualify_domain%&.
14053
14054 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14055 locally submitted message is automatically qualified by Exim, unless the
14056 &%-bnq%& command line option is used.
14057
14058 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14059 on the local part. If the &'From:'& header line does not match, Exim adds a
14060 &'Sender:'& header with an address constructed from the calling user's login
14061 and the default qualify domain.
14062
14063 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14064 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14065 &'Sender:'& header lines supplied by untrusted users, you must also set
14066 &%local_sender_retain%& to be true.
14067
14068 .cindex "envelope sender"
14069 These options affect only the header lines in the message. The envelope sender
14070 is still forced to be the login id at the qualify domain unless
14071 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14072
14073 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14074 request similar header line checking. See section &<<SECTthesenhea>>&, which
14075 has more details about &'Sender:'& processing.
14076
14077
14078
14079
14080 .option local_from_prefix main string unset
14081 When Exim checks the &'From:'& header line of locally submitted messages for
14082 matching the login id (see &%local_from_check%& above), it can be configured to
14083 ignore certain prefixes and suffixes in the local part of the address. This is
14084 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14085 appropriate lists, in the same form as the &%local_part_prefix%& and
14086 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14087 example, if
14088 .code
14089 local_from_prefix = *-
14090 .endd
14091 is set, a &'From:'& line containing
14092 .code
14093 From: anything-user@your.domain.example
14094 .endd
14095 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14096 matches the actual sender address that is constructed from the login name and
14097 qualify domain.
14098
14099
14100 .option local_from_suffix main string unset
14101 See &%local_from_prefix%& above.
14102
14103
14104 .option local_interfaces main "string list" "see below"
14105 This option controls which network interfaces are used by the daemon for
14106 listening; they are also used to identify the local host when routing. Chapter
14107 &<<CHAPinterfaces>>& contains a full description of this option and the related
14108 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14109 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14110 &%local_interfaces%& is
14111 .code
14112 local_interfaces = 0.0.0.0
14113 .endd
14114 when Exim is built without IPv6 support; otherwise it is
14115 .code
14116 local_interfaces = <; ::0 ; 0.0.0.0
14117 .endd
14118
14119 .option local_scan_timeout main time 5m
14120 .cindex "timeout" "for &[local_scan()]& function"
14121 .cindex "&[local_scan()]& function" "timeout"
14122 This timeout applies to the &[local_scan()]& function (see chapter
14123 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14124 the incoming message is rejected with a temporary error if it is an SMTP
14125 message. For a non-SMTP message, the message is dropped and Exim ends with a
14126 non-zero code. The incident is logged on the main and reject logs.
14127
14128
14129
14130 .option local_sender_retain main boolean false
14131 .cindex "&'Sender:'& header line" "retaining from local submission"
14132 When a message is submitted locally (that is, not over a TCP/IP connection) by
14133 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14134 do not want this to happen, you must set &%local_sender_retain%&, and you must
14135 also set &%local_from_check%& to be false (Exim will complain if you do not).
14136 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14137 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14138
14139
14140
14141
14142 .option localhost_number main string&!! unset
14143 .cindex "host" "locally unique number for"
14144 .cindex "message ids" "with multiple hosts"
14145 .vindex "&$localhost_number$&"
14146 Exim's message ids are normally unique only within the local host. If
14147 uniqueness among a set of hosts is required, each host must set a different
14148 value for the &%localhost_number%& option. The string is expanded immediately
14149 after reading the configuration file (so that a number can be computed from the
14150 host name, for example) and the result of the expansion must be a number in the
14151 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14152 systems). This is available in subsequent string expansions via the variable
14153 &$localhost_number$&. When &%localhost_number is set%&, the final two
14154 characters of the message id, instead of just being a fractional part of the
14155 time, are computed from the time and the local host number as described in
14156 section &<<SECTmessiden>>&.
14157
14158
14159
14160 .option log_file_path main "string list&!!" "set at compile time"
14161 .cindex "log" "file path for"
14162 This option sets the path which is used to determine the names of Exim's log
14163 files, or indicates that logging is to be to syslog, or both. It is expanded
14164 when Exim is entered, so it can, for example, contain a reference to the host
14165 name. If no specific path is set for the log files at compile or run time, they
14166 are written in a sub-directory called &_log_& in Exim's spool directory.
14167 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14168 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14169 used. If this string is fixed at your installation (contains no expansion
14170 variables) it is recommended that you do not set this option in the
14171 configuration file, but instead supply the path using LOG_FILE_PATH in
14172 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14173 early on &-- in particular, failure to read the configuration file.
14174
14175
14176 .option log_selector main string unset
14177 .cindex "log" "selectors"
14178 This option can be used to reduce or increase the number of things that Exim
14179 writes to its log files. Its argument is made up of names preceded by plus or
14180 minus characters. For example:
14181 .code
14182 log_selector = +arguments -retry_defer
14183 .endd
14184 A list of possible names and what they control is given in the chapter on
14185 logging, in section &<<SECTlogselector>>&.
14186
14187
14188 .option log_timezone main boolean false
14189 .cindex "log" "timezone for entries"
14190 .vindex "&$tod_log$&"
14191 .vindex "&$tod_zone$&"
14192 By default, the timestamps on log lines are in local time without the
14193 timezone. This means that if your timezone changes twice a year, the timestamps
14194 in log lines are ambiguous for an hour when the clocks go back. One way of
14195 avoiding this problem is to set the timezone to UTC. An alternative is to set
14196 &%log_timezone%& true. This turns on the addition of the timezone offset to
14197 timestamps in log lines. Turning on this option can add quite a lot to the size
14198 of log files because each line is extended by 6 characters. Note that the
14199 &$tod_log$& variable contains the log timestamp without the zone, but there is
14200 another variable called &$tod_zone$& that contains just the timezone offset.
14201
14202
14203 .option lookup_open_max main integer 25
14204 .cindex "too many open files"
14205 .cindex "open files, too many"
14206 .cindex "file" "too many open"
14207 .cindex "lookup" "maximum open files"
14208 .cindex "limit" "open files for lookups"
14209 This option limits the number of simultaneously open files for single-key
14210 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14211 Exim normally keeps these files open during routing, because often the same
14212 file is required several times. If the limit is reached, Exim closes the least
14213 recently used file. Note that if you are using the &'ndbm'& library, it
14214 actually opens two files for each logical DBM database, though it still counts
14215 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14216 open files"& errors with NDBM, you need to reduce the value of
14217 &%lookup_open_max%&.
14218
14219
14220 .option max_username_length main integer 0
14221 .cindex "length of login name"
14222 .cindex "user name" "maximum length"
14223 .cindex "limit" "user name length"
14224 Some operating systems are broken in that they truncate long arguments to
14225 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14226 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14227 an argument that is longer behaves as if &[getpwnam()]& failed.
14228
14229
14230 .option message_body_newlines main bool false
14231 .cindex "message body" "newlines in variables"
14232 .cindex "newline" "in message body variables"
14233 .vindex "&$message_body$&"
14234 .vindex "&$message_body_end$&"
14235 By default, newlines in the message body are replaced by spaces when setting
14236 the &$message_body$& and &$message_body_end$& expansion variables. If this
14237 option is set true, this no longer happens.
14238
14239
14240 .option message_body_visible main integer 500
14241 .cindex "body of message" "visible size"
14242 .cindex "message body" "visible size"
14243 .vindex "&$message_body$&"
14244 .vindex "&$message_body_end$&"
14245 This option specifies how much of a message's body is to be included in the
14246 &$message_body$& and &$message_body_end$& expansion variables.
14247
14248
14249 .option message_id_header_domain main string&!! unset
14250 .cindex "&'Message-ID:'& header line"
14251 If this option is set, the string is expanded and used as the right hand side
14252 (domain) of the &'Message-ID:'& header that Exim creates if a
14253 locally-originated incoming message does not have one. &"Locally-originated"&
14254 means &"not received over TCP/IP."&
14255 Otherwise, the primary host name is used.
14256 Only letters, digits, dot and hyphen are accepted; any other characters are
14257 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14258 empty string, the option is ignored.
14259
14260
14261 .option message_id_header_text main string&!! unset
14262 If this variable is set, the string is expanded and used to augment the text of
14263 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14264 message does not have one. The text of this header is required by RFC 2822 to
14265 take the form of an address. By default, Exim uses its internal message id as
14266 the local part, and the primary host name as the domain. If this option is set,
14267 it is expanded, and provided the expansion is not forced to fail, and does not
14268 yield an empty string, the result is inserted into the header immediately
14269 before the @, separated from the internal message id by a dot. Any characters
14270 that are illegal in an address are automatically converted into hyphens. This
14271 means that variables such as &$tod_log$& can be used, because the spaces and
14272 colons will become hyphens.
14273
14274
14275 .option message_logs main boolean true
14276 .cindex "message logs" "disabling"
14277 .cindex "log" "message log; disabling"
14278 If this option is turned off, per-message log files are not created in the
14279 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14280 Exim, by reducing the number of files involved in handling a message from a
14281 minimum of four (header spool file, body spool file, delivery journal, and
14282 per-message log) to three. The other major I/O activity is Exim's main log,
14283 which is not affected by this option.
14284
14285
14286 .option message_size_limit main string&!! 50M
14287 .cindex "message" "size limit"
14288 .cindex "limit" "message size"
14289 .cindex "size" "of message, limit"
14290 This option limits the maximum size of message that Exim will process. The
14291 value is expanded for each incoming connection so, for example, it can be made
14292 to depend on the IP address of the remote host for messages arriving via
14293 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14294 optionally followed by K or M.
14295
14296 &*Note*&: This limit cannot be made to depend on a message's sender or any
14297 other properties of an individual message, because it has to be advertised in
14298 the server's response to EHLO. String expansion failure causes a temporary
14299 error. A value of zero means no limit, but its use is not recommended. See also
14300 &%bounce_return_size_limit%&.
14301
14302 Incoming SMTP messages are failed with a 552 error if the limit is
14303 exceeded; locally-generated messages either get a stderr message or a delivery
14304 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14305 an oversized message is logged in both the main and the reject logs. See also
14306 the generic transport option &%message_size_limit%&, which limits the size of
14307 message that an individual transport can process.
14308
14309 If you use a virus-scanner and set this option to to a value larger than the
14310 maximum size that your virus-scanner is configured to support, you may get
14311 failures triggered by large mails.  The right size to configure for the
14312 virus-scanner depends upon what data is passed and the options in use but it's
14313 probably safest to just set it to a little larger than this value.  Eg, with a
14314 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14315 some problems may result.
14316
14317 A value of 0 will disable size limit checking; Exim will still advertise the
14318 SIZE extension in an EHLO response, but without a limit, so as to permit
14319 SMTP clients to still indicate the message size along with the MAIL verb.
14320
14321
14322 .option move_frozen_messages main boolean false
14323 .cindex "frozen messages" "moving"
14324 This option, which is available only if Exim has been built with the setting
14325 .code
14326 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14327 .endd
14328 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14329 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14330 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14331 standard utilities for handling such moved messages, and they do not show up in
14332 lists generated by &%-bp%& or by the Exim monitor.
14333
14334
14335 .option mua_wrapper main boolean false
14336 Setting this option true causes Exim to run in a very restrictive mode in which
14337 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14338 contains a full description of this facility.
14339
14340
14341
14342 .option mysql_servers main "string list" unset
14343 .cindex "MySQL" "server list"
14344 This option provides a list of MySQL servers and associated connection data, to
14345 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14346 option is available only if Exim has been built with MySQL support.
14347
14348
14349 .option never_users main "string list&!!" unset
14350 This option is expanded just once, at the start of Exim's processing. Local
14351 message deliveries are normally run in processes that are setuid to the
14352 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14353 It is usually desirable to prevent any deliveries from running as root, as a
14354 safety precaution.
14355
14356 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14357 list of users that must not be used for local deliveries. This list is fixed in
14358 the binary and cannot be overridden by the configuration file. By default, it
14359 contains just the single user name &"root"&. The &%never_users%& runtime option
14360 can be used to add more users to the fixed list.
14361
14362 If a message is to be delivered as one of the users on the fixed list or the
14363 &%never_users%& list, an error occurs, and delivery is deferred. A common
14364 example is
14365 .code
14366 never_users = root:daemon:bin
14367 .endd
14368 Including root is redundant if it is also on the fixed list, but it does no
14369 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14370 transport driver.
14371
14372
14373 .option openssl_options main "string list" "+no_sslv2"
14374 .cindex "OpenSSL "compatibility options"
14375 This option allows an administrator to adjust the SSL options applied
14376 by OpenSSL to connections.  It is given as a space-separated list of items,
14377 each one to be +added or -subtracted from the current value.
14378
14379 This option is only available if Exim is built against OpenSSL.  The values
14380 available for this option vary according to the age of your OpenSSL install.
14381 The &"all"& value controls a subset of flags which are available, typically
14382 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14383 list the values known on your system and Exim should support all the
14384 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14385 names lose the leading &"SSL_OP_"& and are lower-cased.
14386
14387 Note that adjusting the options can have severe impact upon the security of
14388 SSL as used by Exim.  It is possible to disable safety checks and shoot
14389 yourself in the foot in various unpleasant ways.  This option should not be
14390 adjusted lightly.  An unrecognised item will be detected at startup, by
14391 invoking Exim with the &%-bV%& flag.
14392
14393 Historical note: prior to release 4.80, Exim defaulted this value to
14394 "+dont_insert_empty_fragments", which may still be needed for compatibility
14395 with some clients, but which lowers security by increasing exposure to
14396 some now infamous attacks.
14397
14398 An example:
14399 .code
14400 # Make both old MS and old Eudora happy:
14401 openssl_options = -all +microsoft_big_sslv3_buffer \
14402                        +dont_insert_empty_fragments
14403 .endd
14404
14405 Possible options may include:
14406 .ilist
14407 &`all`&
14408 .next
14409 &`allow_unsafe_legacy_renegotiation`&
14410 .next
14411 &`cipher_server_preference`&
14412 .next
14413 &`dont_insert_empty_fragments`&
14414 .next
14415 &`ephemeral_rsa`&
14416 .next
14417 &`legacy_server_connect`&
14418 .next
14419 &`microsoft_big_sslv3_buffer`&
14420 .next
14421 &`microsoft_sess_id_bug`&
14422 .next
14423 &`msie_sslv2_rsa_padding`&
14424 .next
14425 &`netscape_challenge_bug`&
14426 .next
14427 &`netscape_reuse_cipher_change_bug`&
14428 .next
14429 &`no_compression`&
14430 .next
14431 &`no_session_resumption_on_renegotiation`&
14432 .next
14433 &`no_sslv2`&
14434 .next
14435 &`no_sslv3`&
14436 .next
14437 &`no_ticket`&
14438 .next
14439 &`no_tlsv1`&
14440 .next
14441 &`no_tlsv1_1`&
14442 .next
14443 &`no_tlsv1_2`&
14444 .next
14445 &`single_dh_use`&
14446 .next
14447 &`single_ecdh_use`&
14448 .next
14449 &`ssleay_080_client_dh_bug`&
14450 .next
14451 &`sslref2_reuse_cert_type_bug`&
14452 .next
14453 &`tls_block_padding_bug`&
14454 .next
14455 &`tls_d5_bug`&
14456 .next
14457 &`tls_rollback_bug`&
14458 .endlist
14459
14460
14461 .option oracle_servers main "string list" unset
14462 .cindex "Oracle" "server list"
14463 This option provides a list of Oracle servers and associated connection data,
14464 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14465 The option is available only if Exim has been built with Oracle support.
14466
14467
14468 .option percent_hack_domains main "domain list&!!" unset
14469 .cindex "&""percent hack""&"
14470 .cindex "source routing" "in email address"
14471 .cindex "address" "source-routed"
14472 The &"percent hack"& is the convention whereby a local part containing a
14473 percent sign is re-interpreted as a new email address, with the percent
14474 replaced by @. This is sometimes called &"source routing"&, though that term is
14475 also applied to RFC 2822 addresses that begin with an @ character. If this
14476 option is set, Exim implements the percent facility for those domains listed,
14477 but no others. This happens before an incoming SMTP address is tested against
14478 an ACL.
14479
14480 &*Warning*&: The &"percent hack"& has often been abused by people who are
14481 trying to get round relaying restrictions. For this reason, it is best avoided
14482 if at all possible. Unfortunately, a number of less security-conscious MTAs
14483 implement it unconditionally. If you are running Exim on a gateway host, and
14484 routing mail through to internal MTAs without processing the local parts, it is
14485 a good idea to reject recipient addresses with percent characters in their
14486 local parts. Exim's default configuration does this.
14487
14488
14489 .option perl_at_start main boolean false
14490 This option is available only when Exim is built with an embedded Perl
14491 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14492
14493
14494 .option perl_startup main string unset
14495 This option is available only when Exim is built with an embedded Perl
14496 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14497
14498
14499 .option pgsql_servers main "string list" unset
14500 .cindex "PostgreSQL lookup type" "server list"
14501 This option provides a list of PostgreSQL servers and associated connection
14502 data, to be used in conjunction with &(pgsql)& lookups (see section
14503 &<<SECID72>>&). The option is available only if Exim has been built with
14504 PostgreSQL support.
14505
14506
14507 .option pid_file_path main string&!! "set at compile time"
14508 .cindex "daemon" "pid file path"
14509 .cindex "pid file, path for"
14510 This option sets the name of the file to which the Exim daemon writes its
14511 process id. The string is expanded, so it can contain, for example, references
14512 to the host name:
14513 .code
14514 pid_file_path = /var/log/$primary_hostname/exim.pid
14515 .endd
14516 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14517 spool directory.
14518 The value set by the option can be overridden by the &%-oP%& command line
14519 option. A pid file is not written if a &"non-standard"& daemon is run by means
14520 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14521
14522
14523 .option pipelining_advertise_hosts main "host list&!!" *
14524 .cindex "PIPELINING" "suppressing advertising"
14525 This option can be used to suppress the advertisement of the SMTP
14526 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14527 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14528 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14529 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14530 that clients will use it; &"out of order"& commands that are &"expected"& do
14531 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14532
14533
14534 .option preserve_message_logs main boolean false
14535 .cindex "message logs" "preserving"
14536 If this option is set, message log files are not deleted when messages are
14537 completed. Instead, they are moved to a sub-directory of the spool directory
14538 called &_msglog.OLD_&, where they remain available for statistical or debugging
14539 purposes. This is a dangerous option to set on systems with any appreciable
14540 volume of mail. Use with care!
14541
14542
14543 .option primary_hostname main string "see below"
14544 .cindex "name" "of local host"
14545 .cindex "host" "name of local"
14546 .cindex "local host" "name of"
14547 .vindex "&$primary_hostname$&"
14548 This specifies the name of the current host. It is used in the default EHLO or
14549 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14550 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14551 The value is also used by default in some SMTP response messages from an Exim
14552 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14553
14554 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14555 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14556 contains only one component, Exim passes it to &[gethostbyname()]& (or
14557 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14558 version. The variable &$primary_hostname$& contains the host name, whether set
14559 explicitly by this option, or defaulted.
14560
14561
14562 .option print_topbitchars main boolean false
14563 .cindex "printing characters"
14564 .cindex "8-bit characters"
14565 By default, Exim considers only those characters whose codes lie in the range
14566 32&--126 to be printing characters. In a number of circumstances (for example,
14567 when writing log entries) non-printing characters are converted into escape
14568 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14569 is set, code values of 128 and above are also considered to be printing
14570 characters.
14571
14572 This option also affects the header syntax checks performed by the
14573 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14574 the user's full name when constructing From: and Sender: addresses (as
14575 described in section &<<SECTconstr>>&). Setting this option can cause
14576 Exim to generate eight bit message headers that do not conform to the
14577 standards.
14578
14579
14580 .option process_log_path main string unset
14581 .cindex "process log path"
14582 .cindex "log" "process log"
14583 .cindex "&'exiwhat'&"
14584 This option sets the name of the file to which an Exim process writes its
14585 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14586 utility script. If this option is unset, the file called &_exim-process.info_&
14587 in Exim's spool directory is used. The ability to specify the name explicitly
14588 can be useful in environments where two different Exims are running, using
14589 different spool directories.
14590
14591
14592 .option prod_requires_admin main boolean true
14593 .oindex "&%-M%&"
14594 .oindex "&%-R%&"
14595 .oindex "&%-q%&"
14596 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14597 admin user unless &%prod_requires_admin%& is set false. See also
14598 &%queue_list_requires_admin%&.
14599
14600
14601 .option qualify_domain main string "see below"
14602 .cindex "domain" "for qualifying addresses"
14603 .cindex "address" "qualification"
14604 This option specifies the domain name that is added to any envelope sender
14605 addresses that do not have a domain qualification. It also applies to
14606 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14607 are accepted by default only for locally-generated messages. Qualification is
14608 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14609 locally-generated messages, unless the &%-bnq%& command line option is used.
14610
14611 Messages from external sources must always contain fully qualified addresses,
14612 unless the sending host matches &%sender_unqualified_hosts%& or
14613 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14614 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14615 necessary. Internally, Exim always works with fully qualified envelope
14616 addresses. If &%qualify_domain%& is not set, it defaults to the
14617 &%primary_hostname%& value.
14618
14619
14620 .option qualify_recipient main string "see below"
14621 This option allows you to specify a different domain for qualifying recipient
14622 addresses to the one that is used for senders. See &%qualify_domain%& above.
14623
14624
14625
14626 .option queue_domains main "domain list&!!" unset
14627 .cindex "domain" "specifying non-immediate delivery"
14628 .cindex "queueing incoming messages"
14629 .cindex "message" "queueing certain domains"
14630 This option lists domains for which immediate delivery is not required.
14631 A delivery process is started whenever a message is received, but only those
14632 domains that do not match are processed. All other deliveries wait until the
14633 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14634
14635
14636 .option queue_list_requires_admin main boolean true
14637 .oindex "&%-bp%&"
14638 The &%-bp%& command-line option, which lists the messages that are on the
14639 queue, requires the caller to be an admin user unless
14640 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14641
14642
14643 .option queue_only main boolean false
14644 .cindex "queueing incoming messages"
14645 .cindex "message" "queueing unconditionally"
14646 If &%queue_only%& is set, a delivery process is not automatically started
14647 whenever a message is received. Instead, the message waits on the queue for the
14648 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14649 delivered immediately when certain conditions (such as heavy load) occur.
14650
14651 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14652 and &%-odi%& command line options override &%queue_only%& unless
14653 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14654 &%queue_only_load%&, and &%smtp_accept_queue%&.
14655
14656
14657 .option queue_only_file main string unset
14658 .cindex "queueing incoming messages"
14659 .cindex "message" "queueing by file existence"
14660 This option can be set to a colon-separated list of absolute path names, each
14661 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14662 it tests for the existence of each listed path using a call to &[stat()]&. For
14663 each path that exists, the corresponding queueing option is set.
14664 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14665 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14666 .code
14667 queue_only_file = smtp/some/file
14668 .endd
14669 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14670 &_/some/file_& exists.
14671
14672
14673 .option queue_only_load main fixed-point unset
14674 .cindex "load average"
14675 .cindex "queueing incoming messages"
14676 .cindex "message" "queueing by load"
14677 If the system load average is higher than this value, incoming messages from
14678 all sources are queued, and no automatic deliveries are started. If this
14679 happens during local or remote SMTP input, all subsequent messages received on
14680 the same SMTP connection are queued by default, whatever happens to the load in
14681 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14682 false.
14683
14684 Deliveries will subsequently be performed by queue runner processes. This
14685 option has no effect on ancient operating systems on which Exim cannot
14686 determine the load average. See also &%deliver_queue_load_max%& and
14687 &%smtp_load_reserve%&.
14688
14689
14690 .option queue_only_load_latch main boolean true
14691 .cindex "load average" "re-evaluating per message"
14692 When this option is true (the default), once one message has been queued
14693 because the load average is higher than the value set by &%queue_only_load%&,
14694 all subsequent messages received on the same SMTP connection are also queued.
14695 This is a deliberate choice; even though the load average may fall below the
14696 threshold, it doesn't seem right to deliver later messages on the same
14697 connection when not delivering earlier ones. However, there are special
14698 circumstances such as very long-lived connections from scanning appliances
14699 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14700 should be set false. This causes the value of the load average to be
14701 re-evaluated for each message.
14702
14703
14704 .option queue_only_override main boolean true
14705 .cindex "queueing incoming messages"
14706 When this option is true, the &%-od%&&'x'& command line options override the
14707 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14708 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14709 to override; they are accepted, but ignored.
14710
14711
14712 .option queue_run_in_order main boolean false
14713 .cindex "queue runner" "processing messages in order"
14714 If this option is set, queue runs happen in order of message arrival instead of
14715 in an arbitrary order. For this to happen, a complete list of the entire queue
14716 must be set up before the deliveries start. When the queue is all held in a
14717 single directory (the default), a single list is created for both the ordered
14718 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14719 single list is not created when &%queue_run_in_order%& is false. In this case,
14720 the sub-directories are processed one at a time (in a random order), and this
14721 avoids setting up one huge list for the whole queue. Thus, setting
14722 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14723 when the queue is large, because of the extra work in setting up the single,
14724 large list. In most situations, &%queue_run_in_order%& should not be set.
14725
14726
14727
14728 .option queue_run_max main integer 5
14729 .cindex "queue runner" "maximum number of"
14730 This controls the maximum number of queue runner processes that an Exim daemon
14731 can run simultaneously. This does not mean that it starts them all at once,
14732 but rather that if the maximum number are still running when the time comes to
14733 start another one, it refrains from starting another one. This can happen with
14734 very large queues and/or very sluggish deliveries. This option does not,
14735 however, interlock with other processes, so additional queue runners can be
14736 started by other means, or by killing and restarting the daemon.
14737
14738 Setting this option to zero does not suppress queue runs; rather, it disables
14739 the limit, allowing any number of simultaneous queue runner processes to be
14740 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14741 the daemon's command line.
14742
14743 .option queue_smtp_domains main "domain list&!!" unset
14744 .cindex "queueing incoming messages"
14745 .cindex "message" "queueing remote deliveries"
14746 When this option is set, a delivery process is started whenever a message is
14747 received, routing is performed, and local deliveries take place.
14748 However, if any SMTP deliveries are required for domains that match
14749 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14750 message waits on the queue for the next queue run. Since routing of the message
14751 has taken place, Exim knows to which remote hosts it must be delivered, and so
14752 when the queue run happens, multiple messages for the same host are delivered
14753 over a single SMTP connection. The &%-odqs%& command line option causes all
14754 SMTP deliveries to be queued in this way, and is equivalent to setting
14755 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14756 &%queue_domains%&.
14757
14758
14759 .option receive_timeout main time 0s
14760 .cindex "timeout" "for non-SMTP input"
14761 This option sets the timeout for accepting a non-SMTP message, that is, the
14762 maximum time that Exim waits when reading a message on the standard input. If
14763 the value is zero, it will wait for ever. This setting is overridden by the
14764 &%-or%& command line option. The timeout for incoming SMTP messages is
14765 controlled by &%smtp_receive_timeout%&.
14766
14767 .option received_header_text main string&!! "see below"
14768 .cindex "customizing" "&'Received:'& header"
14769 .cindex "&'Received:'& header line" "customizing"
14770 This string defines the contents of the &'Received:'& message header that is
14771 added to each message, except for the timestamp, which is automatically added
14772 on at the end (preceded by a semicolon). The string is expanded each time it is
14773 used. If the expansion yields an empty string, no &'Received:'& header line is
14774 added to the message. Otherwise, the string should start with the text
14775 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14776 header lines. The default setting is:
14777
14778 .code
14779 received_header_text = Received: \
14780   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14781   {${if def:sender_ident \
14782   {from ${quote_local_part:$sender_ident} }}\
14783   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14784   by $primary_hostname \
14785   ${if def:received_protocol {with $received_protocol}} \
14786   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14787   (Exim $version_number)\n\t\
14788   ${if def:sender_address \
14789   {(envelope-from <$sender_address>)\n\t}}\
14790   id $message_exim_id\
14791   ${if def:received_for {\n\tfor $received_for}}
14792 .endd
14793
14794 The reference to the TLS cipher is omitted when Exim is built without TLS
14795 support. The use of conditional expansions ensures that this works for both
14796 locally generated messages and messages received from remote hosts, giving
14797 header lines such as the following:
14798 .code
14799 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14800 by marley.carol.example with esmtp (Exim 4.00)
14801 (envelope-from <bob@carol.example>)
14802 id 16IOWa-00019l-00
14803 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14804 Received: by scrooge.carol.example with local (Exim 4.00)
14805 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14806 .endd
14807 Until the body of the message has been received, the timestamp is the time when
14808 the message started to be received. Once the body has arrived, and all policy
14809 checks have taken place, the timestamp is updated to the time at which the
14810 message was accepted.
14811
14812
14813 .option received_headers_max main integer 30
14814 .cindex "loop" "prevention"
14815 .cindex "mail loop prevention"
14816 .cindex "&'Received:'& header line" "counting"
14817 When a message is to be delivered, the number of &'Received:'& headers is
14818 counted, and if it is greater than this parameter, a mail loop is assumed to
14819 have occurred, the delivery is abandoned, and an error message is generated.
14820 This applies to both local and remote deliveries.
14821
14822
14823 .option recipient_unqualified_hosts main "host list&!!" unset
14824 .cindex "unqualified addresses"
14825 .cindex "host" "unqualified addresses from"
14826 This option lists those hosts from which Exim is prepared to accept unqualified
14827 recipient addresses in message envelopes. The addresses are made fully
14828 qualified by the addition of the &%qualify_recipient%& value. This option also
14829 affects message header lines. Exim does not reject unqualified recipient
14830 addresses in headers, but it qualifies them only if the message came from a
14831 host that matches &%recipient_unqualified_hosts%&,
14832 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14833 option was not set.
14834
14835
14836 .option recipients_max main integer 0
14837 .cindex "limit" "number of recipients"
14838 .cindex "recipient" "maximum number"
14839 If this option is set greater than zero, it specifies the maximum number of
14840 original recipients for any message. Additional recipients that are generated
14841 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14842 all recipients over the limit; earlier recipients are delivered as normal.
14843 Non-SMTP messages with too many recipients are failed, and no deliveries are
14844 done.
14845
14846 .cindex "RCPT" "maximum number of incoming"
14847 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14848 RCPT commands in a single message.
14849
14850
14851 .option recipients_max_reject main boolean false
14852 If this option is set true, Exim rejects SMTP messages containing too many
14853 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14854 error to the eventual DATA command. Otherwise (the default) it gives a 452
14855 error to the surplus RCPT commands and accepts the message on behalf of the
14856 initial set of recipients. The remote server should then re-send the message
14857 for the remaining recipients at a later time.
14858
14859
14860 .option remote_max_parallel main integer 2
14861 .cindex "delivery" "parallelism for remote"
14862 This option controls parallel delivery of one message to a number of remote
14863 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14864 does all the remote deliveries for a message one by one. Otherwise, if a single
14865 message has to be delivered to more than one remote host, or if several copies
14866 have to be sent to the same remote host, up to &%remote_max_parallel%&
14867 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14868 deliveries are required, the maximum number of processes are started, and as
14869 each one finishes, another is begun. The order of starting processes is the
14870 same as if sequential delivery were being done, and can be controlled by the
14871 &%remote_sort_domains%& option. If parallel delivery takes place while running
14872 with debugging turned on, the debugging output from each delivery process is
14873 tagged with its process id.
14874
14875 This option controls only the maximum number of parallel deliveries for one
14876 message in one Exim delivery process. Because Exim has no central queue
14877 manager, there is no way of controlling the total number of simultaneous
14878 deliveries if the configuration allows a delivery attempt as soon as a message
14879 is received.
14880
14881 .cindex "number of deliveries"
14882 .cindex "delivery" "maximum number of"
14883 If you want to control the total number of deliveries on the system, you
14884 need to set the &%queue_only%& option. This ensures that all incoming messages
14885 are added to the queue without starting a delivery process. Then set up an Exim
14886 daemon to start queue runner processes at appropriate intervals (probably
14887 fairly often, for example, every minute), and limit the total number of queue
14888 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14889 delivers only one message at a time, the maximum number of deliveries that can
14890 then take place at once is &%queue_run_max%& multiplied by
14891 &%remote_max_parallel%&.
14892
14893 If it is purely remote deliveries you want to control, use
14894 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14895 doing the SMTP routing before queueing, so that several messages for the same
14896 host will eventually get delivered down the same connection.
14897
14898
14899 .option remote_sort_domains main "domain list&!!" unset
14900 .cindex "sorting remote deliveries"
14901 .cindex "delivery" "sorting remote"
14902 When there are a number of remote deliveries for a message, they are sorted by
14903 domain into the order given by this list. For example,
14904 .code
14905 remote_sort_domains = *.cam.ac.uk:*.uk
14906 .endd
14907 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14908 then to those in the &%uk%& domain, then to any others.
14909
14910
14911 .option retry_data_expire main time 7d
14912 .cindex "hints database" "data expiry"
14913 This option sets a &"use before"& time on retry information in Exim's hints
14914 database. Any older retry data is ignored. This means that, for example, once a
14915 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14916 past failures.
14917
14918
14919 .option retry_interval_max main time 24h
14920 .cindex "retry" "limit on interval"
14921 .cindex "limit" "on retry interval"
14922 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14923 intervals between delivery attempts for messages that cannot be delivered
14924 straight away. This option sets an overall limit to the length of time between
14925 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14926 the default value.
14927
14928
14929 .option return_path_remove main boolean true
14930 .cindex "&'Return-path:'& header line" "removing"
14931 RFC 2821, section 4.4, states that an SMTP server must insert a
14932 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14933 The &'Return-path:'& header preserves the sender address as received in the
14934 MAIL command. This description implies that this header should not be present
14935 in an incoming message. If &%return_path_remove%& is true, any existing
14936 &'Return-path:'& headers are removed from messages at the time they are
14937 received. Exim's transports have options for adding &'Return-path:'& headers at
14938 the time of delivery. They are normally used only for final local deliveries.
14939
14940
14941 .option return_size_limit main integer 100K
14942 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14943
14944
14945 .option rfc1413_hosts main "host list&!!" *
14946 .cindex "RFC 1413"
14947 .cindex "host" "for RFC 1413 calls"
14948 RFC 1413 identification calls are made to any client host which matches an item
14949 in the list.
14950
14951 .option rfc1413_query_timeout main time 5s
14952 .cindex "RFC 1413" "query timeout"
14953 .cindex "timeout" "for RFC 1413 call"
14954 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14955 no RFC 1413 calls are ever made.
14956
14957
14958 .option sender_unqualified_hosts main "host list&!!" unset
14959 .cindex "unqualified addresses"
14960 .cindex "host" "unqualified addresses from"
14961 This option lists those hosts from which Exim is prepared to accept unqualified
14962 sender addresses. The addresses are made fully qualified by the addition of
14963 &%qualify_domain%&. This option also affects message header lines. Exim does
14964 not reject unqualified addresses in headers that contain sender addresses, but
14965 it qualifies them only if the message came from a host that matches
14966 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14967 using TCP/IP), and the &%-bnq%& option was not set.
14968
14969
14970 .option smtp_accept_keepalive main boolean true
14971 .cindex "keepalive" "on incoming connection"
14972 This option controls the setting of the SO_KEEPALIVE option on incoming
14973 TCP/IP socket connections. When set, it causes the kernel to probe idle
14974 connections periodically, by sending packets with &"old"& sequence numbers. The
14975 other end of the connection should send an acknowledgment if the connection is
14976 still okay or a reset if the connection has been aborted. The reason for doing
14977 this is that it has the beneficial effect of freeing up certain types of
14978 connection that can get stuck when the remote host is disconnected without
14979 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14980 hours to detect unreachable hosts.
14981
14982
14983
14984 .option smtp_accept_max main integer 20
14985 .cindex "limit" "incoming SMTP connections"
14986 .cindex "SMTP" "incoming connection count"
14987 .cindex "inetd"
14988 This option specifies the maximum number of simultaneous incoming SMTP calls
14989 that Exim will accept. It applies only to the listening daemon; there is no
14990 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14991 value is set to zero, no limit is applied. However, it is required to be
14992 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14993 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14994
14995 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14996 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14997 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14998 and &%smtp_load_reserve%& are then checked before accepting the connection.
14999
15000
15001 .option smtp_accept_max_nonmail main integer 10
15002 .cindex "limit" "non-mail SMTP commands"
15003 .cindex "SMTP" "limiting non-mail commands"
15004 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15005 the connection if there are too many. This option defines &"too many"&. The
15006 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15007 client looping sending EHLO, for example. The check is applied only if the
15008 client host matches &%smtp_accept_max_nonmail_hosts%&.
15009
15010 When a new message is expected, one occurrence of RSET is not counted. This
15011 allows a client to send one RSET between messages (this is not necessary,
15012 but some clients do it). Exim also allows one uncounted occurrence of HELO
15013 or EHLO, and one occurrence of STARTTLS between messages. After
15014 starting up a TLS session, another EHLO is expected, and so it too is not
15015 counted. The first occurrence of AUTH in a connection, or immediately
15016 following STARTTLS is not counted. Otherwise, all commands other than
15017 MAIL, RCPT, DATA, and QUIT are counted.
15018
15019
15020 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15021 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15022 check by setting this option. The default value makes it apply to all hosts. By
15023 changing the value, you can exclude any badly-behaved hosts that you have to
15024 live with.
15025
15026
15027 . Allow this long option name to split; give it unsplit as a fifth argument
15028 . for the automatic .oindex that is generated by .option.
15029
15030 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
15031          smtp_accept_max_per_connection
15032 .cindex "SMTP" "limiting incoming message count"
15033 .cindex "limit" "messages per SMTP connection"
15034 The value of this option limits the number of MAIL commands that Exim is
15035 prepared to accept over a single SMTP connection, whether or not each command
15036 results in the transfer of a message. After the limit is reached, a 421
15037 response is given to subsequent MAIL commands. This limit is a safety
15038 precaution against a client that goes mad (incidents of this type have been
15039 seen).
15040
15041
15042 .option smtp_accept_max_per_host main string&!! unset
15043 .cindex "limit" "SMTP connections from one host"
15044 .cindex "host" "limiting SMTP connections from"
15045 This option restricts the number of simultaneous IP connections from a single
15046 host (strictly, from a single IP address) to the Exim daemon. The option is
15047 expanded, to enable different limits to be applied to different hosts by
15048 reference to &$sender_host_address$&. Once the limit is reached, additional
15049 connection attempts from the same host are rejected with error code 421. This
15050 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15051 of zero imposes no limit. If this option is set greater than zero, it is
15052 required that &%smtp_accept_max%& be non-zero.
15053
15054 &*Warning*&: When setting this option you should not use any expansion
15055 constructions that take an appreciable amount of time. The expansion and test
15056 happen in the main daemon loop, in order to reject additional connections
15057 without forking additional processes (otherwise a denial-of-service attack
15058 could cause a vast number or processes to be created). While the daemon is
15059 doing this processing, it cannot accept any other incoming connections.
15060
15061
15062
15063 .option smtp_accept_queue main integer 0
15064 .cindex "SMTP" "incoming connection count"
15065 .cindex "queueing incoming messages"
15066 .cindex "message" "queueing by SMTP connection count"
15067 If the number of simultaneous incoming SMTP connections being handled via the
15068 listening daemon exceeds this value, messages received by SMTP are just placed
15069 on the queue; no delivery processes are started automatically. The count is
15070 fixed at the start of an SMTP connection. It cannot be updated in the
15071 subprocess that receives messages, and so the queueing or not queueing applies
15072 to all messages received in the same connection.
15073
15074 A value of zero implies no limit, and clearly any non-zero value is useful only
15075 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15076 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15077 various &%-od%&&'x'& command line options.
15078
15079
15080 . Allow this long option name to split; give it unsplit as a fifth argument
15081 . for the automatic .oindex that is generated by .option.
15082
15083 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15084          smtp_accept_queue_per_connection
15085 .cindex "queueing incoming messages"
15086 .cindex "message" "queueing by message count"
15087 This option limits the number of delivery processes that Exim starts
15088 automatically when receiving messages via SMTP, whether via the daemon or by
15089 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15090 and the number of messages received in a single SMTP session exceeds this
15091 number, subsequent messages are placed on the queue, but no delivery processes
15092 are started. This helps to limit the number of Exim processes when a server
15093 restarts after downtime and there is a lot of mail waiting for it on other
15094 systems. On large systems, the default should probably be increased, and on
15095 dial-in client systems it should probably be set to zero (that is, disabled).
15096
15097
15098 .option smtp_accept_reserve main integer 0
15099 .cindex "SMTP" "incoming call count"
15100 .cindex "host" "reserved"
15101 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15102 number of SMTP connections that are reserved for connections from the hosts
15103 that are specified in &%smtp_reserve_hosts%&. The value set in
15104 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15105 restricted to this number of connections; the option specifies a minimum number
15106 of connection slots for them, not a maximum. It is a guarantee that this group
15107 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15108 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15109 individual host.
15110
15111 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15112 set to 5, once there are 45 active connections (from any hosts), new
15113 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15114 provided the other criteria for acceptance are met.
15115
15116
15117 .option smtp_active_hostname main string&!! unset
15118 .cindex "host" "name in SMTP responses"
15119 .cindex "SMTP" "host name in responses"
15120 .vindex "&$primary_hostname$&"
15121 This option is provided for multi-homed servers that want to masquerade as
15122 several different hosts. At the start of an incoming SMTP connection, its value
15123 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15124 responses. For example, it is used as domain name in the response to an
15125 incoming HELO or EHLO command.
15126
15127 .vindex "&$smtp_active_hostname$&"
15128 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15129 is saved with any messages that are received. It is therefore available for use
15130 in routers and transports when the message is later delivered.
15131
15132 If this option is unset, or if its expansion is forced to fail, or if the
15133 expansion results in an empty string, the value of &$primary_hostname$& is
15134 used. Other expansion failures cause a message to be written to the main and
15135 panic logs, and the SMTP command receives a temporary error. Typically, the
15136 value of &%smtp_active_hostname%& depends on the incoming interface address.
15137 For example:
15138 .code
15139 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15140   {cox.mydomain}{box.mydomain}}
15141 .endd
15142
15143 Although &$smtp_active_hostname$& is primarily concerned with incoming
15144 messages, it is also used as the default for HELO commands in callout
15145 verification if there is no remote transport from which to obtain a
15146 &%helo_data%& value.
15147
15148 .option smtp_banner main string&!! "see below"
15149 .cindex "SMTP" "welcome banner"
15150 .cindex "banner for SMTP"
15151 .cindex "welcome banner for SMTP"
15152 .cindex "customizing" "SMTP banner"
15153 This string, which is expanded every time it is used, is output as the initial
15154 positive response to an SMTP connection. The default setting is:
15155 .code
15156 smtp_banner = $smtp_active_hostname ESMTP Exim \
15157   $version_number $tod_full
15158 .endd
15159 Failure to expand the string causes a panic error. If you want to create a
15160 multiline response to the initial SMTP connection, use &"\n"& in the string at
15161 appropriate points, but not at the end. Note that the 220 code is not included
15162 in this string. Exim adds it automatically (several times in the case of a
15163 multiline response).
15164
15165
15166 .option smtp_check_spool_space main boolean true
15167 .cindex "checking disk space"
15168 .cindex "disk space, checking"
15169 .cindex "spool directory" "checking space"
15170 When this option is set, if an incoming SMTP session encounters the SIZE
15171 option on a MAIL command, it checks that there is enough space in the
15172 spool directory's partition to accept a message of that size, while still
15173 leaving free the amount specified by &%check_spool_space%& (even if that value
15174 is zero). If there isn't enough space, a temporary error code is returned.
15175
15176
15177 .option smtp_connect_backlog main integer 20
15178 .cindex "connection backlog"
15179 .cindex "SMTP" "connection backlog"
15180 .cindex "backlog of connections"
15181 This option specifies a maximum number of waiting SMTP connections. Exim passes
15182 this value to the TCP/IP system when it sets up its listener. Once this number
15183 of connections are waiting for the daemon's attention, subsequent connection
15184 attempts are refused at the TCP/IP level. At least, that is what the manuals
15185 say; in some circumstances such connection attempts have been observed to time
15186 out instead. For large systems it is probably a good idea to increase the
15187 value (to 50, say). It also gives some protection against denial-of-service
15188 attacks by SYN flooding.
15189
15190
15191 .option smtp_enforce_sync main boolean true
15192 .cindex "SMTP" "synchronization checking"
15193 .cindex "synchronization checking in SMTP"
15194 The SMTP protocol specification requires the client to wait for a response from
15195 the server at certain points in the dialogue. Without PIPELINING these
15196 synchronization points are after every command; with PIPELINING they are
15197 fewer, but they still exist.
15198
15199 Some spamming sites send out a complete set of SMTP commands without waiting
15200 for any response. Exim protects against this by rejecting a message if the
15201 client has sent further input when it should not have. The error response &"554
15202 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15203 for this error cannot be perfect because of transmission delays (unexpected
15204 input may be on its way but not yet received when Exim checks). However, it
15205 does detect many instances.
15206
15207 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15208 If you want to disable the check selectively (for example, only for certain
15209 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15210 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15211
15212
15213
15214 .option smtp_etrn_command main string&!! unset
15215 .cindex "ETRN" "command to be run"
15216 .vindex "&$domain$&"
15217 If this option is set, the given command is run whenever an SMTP ETRN
15218 command is received from a host that is permitted to issue such commands (see
15219 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15220 are independently expanded. The expansion variable &$domain$& is set to the
15221 argument of the ETRN command, and no syntax checking is done on it. For
15222 example:
15223 .code
15224 smtp_etrn_command = /etc/etrn_command $domain \
15225                     $sender_host_address
15226 .endd
15227 A new process is created to run the command, but Exim does not wait for it to
15228 complete. Consequently, its status cannot be checked. If the command cannot be
15229 run, a line is written to the panic log, but the ETRN caller still receives
15230 a 250 success response. Exim is normally running under its own uid when
15231 receiving SMTP, so it is not possible for it to change the uid before running
15232 the command.
15233
15234
15235 .option smtp_etrn_serialize main boolean true
15236 .cindex "ETRN" "serializing"
15237 When this option is set, it prevents the simultaneous execution of more than
15238 one identical command as a result of ETRN in an SMTP connection. See
15239 section &<<SECTETRN>>& for details.
15240
15241
15242 .option smtp_load_reserve main fixed-point unset
15243 .cindex "load average"
15244 If the system load average ever gets higher than this, incoming SMTP calls are
15245 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15246 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15247 the load is over the limit. The option has no effect on ancient operating
15248 systems on which Exim cannot determine the load average. See also
15249 &%deliver_queue_load_max%& and &%queue_only_load%&.
15250
15251
15252
15253 .option smtp_max_synprot_errors main integer 3
15254 .cindex "SMTP" "limiting syntax and protocol errors"
15255 .cindex "limit" "SMTP syntax and protocol errors"
15256 Exim rejects SMTP commands that contain syntax or protocol errors. In
15257 particular, a syntactically invalid email address, as in this command:
15258 .code
15259 RCPT TO:<abc xyz@a.b.c>
15260 .endd
15261 causes immediate rejection of the command, before any other tests are done.
15262 (The ACL cannot be run if there is no valid address to set up for it.) An
15263 example of a protocol error is receiving RCPT before MAIL. If there are
15264 too many syntax or protocol errors in one SMTP session, the connection is
15265 dropped. The limit is set by this option.
15266
15267 .cindex "PIPELINING" "expected errors"
15268 When the PIPELINING extension to SMTP is in use, some protocol errors are
15269 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15270 Exim assumes that PIPELINING will be used if it advertises it (see
15271 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15272 not count towards the limit.
15273
15274
15275
15276 .option smtp_max_unknown_commands main integer 3
15277 .cindex "SMTP" "limiting unknown commands"
15278 .cindex "limit" "unknown SMTP commands"
15279 If there are too many unrecognized commands in an incoming SMTP session, an
15280 Exim server drops the connection. This is a defence against some kinds of abuse
15281 that subvert web
15282 clients
15283 into making connections to SMTP ports; in these circumstances, a number of
15284 non-SMTP command lines are sent first.
15285
15286
15287
15288 .option smtp_ratelimit_hosts main "host list&!!" unset
15289 .cindex "SMTP" "rate limiting"
15290 .cindex "limit" "rate of message arrival"
15291 .cindex "RCPT" "rate limiting"
15292 Some sites find it helpful to be able to limit the rate at which certain hosts
15293 can send them messages, and the rate at which an individual message can specify
15294 recipients.
15295
15296 Exim has two rate-limiting facilities. This section describes the older
15297 facility, which can limit rates within a single connection. The newer
15298 &%ratelimit%& ACL condition can limit rates across all connections. See section
15299 &<<SECTratelimiting>>& for details of the newer facility.
15300
15301 When a host matches &%smtp_ratelimit_hosts%&, the values of
15302 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15303 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15304 respectively. Each option, if set, must contain a set of four comma-separated
15305 values:
15306
15307 .ilist
15308 A threshold, before which there is no rate limiting.
15309 .next
15310 An initial time delay. Unlike other times in Exim, numbers with decimal
15311 fractional parts are allowed here.
15312 .next
15313 A factor by which to increase the delay each time.
15314 .next
15315 A maximum value for the delay. This should normally be less than 5 minutes,
15316 because after that time, the client is liable to timeout the SMTP command.
15317 .endlist
15318
15319 For example, these settings have been used successfully at the site which
15320 first suggested this feature, for controlling mail from their customers:
15321 .code
15322 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15323 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15324 .endd
15325 The first setting specifies delays that are applied to MAIL commands after
15326 two have been received over a single connection. The initial delay is 0.5
15327 seconds, increasing by a factor of 1.05 each time. The second setting applies
15328 delays to RCPT commands when more than four occur in a single message.
15329
15330
15331 .option smtp_ratelimit_mail main string unset
15332 See &%smtp_ratelimit_hosts%& above.
15333
15334
15335 .option smtp_ratelimit_rcpt main string unset
15336 See &%smtp_ratelimit_hosts%& above.
15337
15338
15339 .option smtp_receive_timeout main time 5m
15340 .cindex "timeout" "for SMTP input"
15341 .cindex "SMTP" "input timeout"
15342 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15343 input, including batch SMTP. If a line of input (either an SMTP command or a
15344 data line) is not received within this time, the SMTP connection is dropped and
15345 the message is abandoned.
15346 A line is written to the log containing one of the following messages:
15347 .code
15348 SMTP command timeout on connection from...
15349 SMTP data timeout on connection from...
15350 .endd
15351 The former means that Exim was expecting to read an SMTP command; the latter
15352 means that it was in the DATA phase, reading the contents of a message.
15353
15354
15355 .oindex "&%-os%&"
15356 The value set by this option can be overridden by the
15357 &%-os%& command-line option. A setting of zero time disables the timeout, but
15358 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15359 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15360 timeout is controlled by &%receive_timeout%& and &%-or%&.
15361
15362
15363 .option smtp_reserve_hosts main "host list&!!" unset
15364 This option defines hosts for which SMTP connections are reserved; see
15365 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15366
15367
15368 .option smtp_return_error_details main boolean false
15369 .cindex "SMTP" "details policy failures"
15370 .cindex "policy control" "rejection, returning details"
15371 In the default state, Exim uses bland messages such as
15372 &"Administrative prohibition"& when it rejects SMTP commands for policy
15373 reasons. Many sysadmins like this because it gives away little information
15374 to spammers. However, some other sysadmins who are applying strict checking
15375 policies want to give out much fuller information about failures. Setting
15376 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15377 example, instead of &"Administrative prohibition"&, it might give:
15378 .code
15379 550-Rejected after DATA: '>' missing at end of address:
15380 550 failing address in "From" header is: <user@dom.ain
15381 .endd
15382
15383 .option spamd_address main string "see below"
15384 This option is available when Exim is compiled with the content-scanning
15385 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15386 The default value is
15387 .code
15388 127.0.0.1 783
15389 .endd
15390 See section &<<SECTscanspamass>>& for more details.
15391
15392
15393
15394 .option split_spool_directory main boolean false
15395 .cindex "multiple spool directories"
15396 .cindex "spool directory" "split"
15397 .cindex "directories, multiple"
15398 If this option is set, it causes Exim to split its input directory into 62
15399 subdirectories, each with a single alphanumeric character as its name. The
15400 sixth character of the message id is used to allocate messages to
15401 subdirectories; this is the least significant base-62 digit of the time of
15402 arrival of the message.
15403
15404 Splitting up the spool in this way may provide better performance on systems
15405 where there are long mail queues, by reducing the number of files in any one
15406 directory. The msglog directory is also split up in a similar way to the input
15407 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15408 are still placed in the single directory &_msglog.OLD_&.
15409
15410 It is not necessary to take any special action for existing messages when
15411 changing &%split_spool_directory%&. Exim notices messages that are in the
15412 &"wrong"& place, and continues to process them. If the option is turned off
15413 after a period of being on, the subdirectories will eventually empty and be
15414 automatically deleted.
15415
15416 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15417 changes. Instead of creating a list of all messages in the queue, and then
15418 trying to deliver each one in turn, it constructs a list of those in one
15419 sub-directory and tries to deliver them, before moving on to the next
15420 sub-directory. The sub-directories are processed in a random order. This
15421 spreads out the scanning of the input directories, and uses less memory. It is
15422 particularly beneficial when there are lots of messages on the queue. However,
15423 if &%queue_run_in_order%& is set, none of this new processing happens. The
15424 entire queue has to be scanned and sorted before any deliveries can start.
15425
15426
15427 .option spool_directory main string&!! "set at compile time"
15428 .cindex "spool directory" "path to"
15429 This defines the directory in which Exim keeps its spool, that is, the messages
15430 it is waiting to deliver. The default value is taken from the compile-time
15431 configuration setting, if there is one. If not, this option must be set. The
15432 string is expanded, so it can contain, for example, a reference to
15433 &$primary_hostname$&.
15434
15435 If the spool directory name is fixed on your installation, it is recommended
15436 that you set it at build time rather than from this option, particularly if the
15437 log files are being written to the spool directory (see &%log_file_path%&).
15438 Otherwise log files cannot be used for errors that are detected early on, such
15439 as failures in the configuration file.
15440
15441 By using this option to override the compiled-in path, it is possible to run
15442 tests of Exim without using the standard spool.
15443
15444 .option sqlite_lock_timeout main time 5s
15445 .cindex "sqlite lookup type" "lock timeout"
15446 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15447 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15448
15449 .option strict_acl_vars main boolean false
15450 .cindex "&ACL;" "variables, handling unset"
15451 This option controls what happens if a syntactically valid but undefined ACL
15452 variable is referenced. If it is false (the default), an empty string
15453 is substituted; if it is true, an error is generated. See section
15454 &<<SECTaclvariables>>& for details of ACL variables.
15455
15456 .option strip_excess_angle_brackets main boolean false
15457 .cindex "angle brackets, excess"
15458 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15459 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15460 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15461 passed on to another MTA, the excess angle brackets are not passed on. If this
15462 option is not set, multiple pairs of angle brackets cause a syntax error.
15463
15464
15465 .option strip_trailing_dot main boolean false
15466 .cindex "trailing dot on domain"
15467 .cindex "dot" "trailing on domain"
15468 If this option is set, a trailing dot at the end of a domain in an address is
15469 ignored. If this is in the envelope and the message is passed on to another
15470 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15471 domain causes a syntax error.
15472 However, addresses in header lines are checked only when an ACL requests header
15473 syntax checking.
15474
15475
15476 .option syslog_duplication main boolean true
15477 .cindex "syslog" "duplicate log lines; suppressing"
15478 When Exim is logging to syslog, it writes the log lines for its three
15479 separate logs at different syslog priorities so that they can in principle
15480 be separated on the logging hosts. Some installations do not require this
15481 separation, and in those cases, the duplication of certain log lines is a
15482 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15483 particular log line is written to syslog. For lines that normally go to
15484 both the main log and the reject log, the reject log version (possibly
15485 containing message header lines) is written, at LOG_NOTICE priority.
15486 Lines that normally go to both the main and the panic log are written at
15487 the LOG_ALERT priority.
15488
15489
15490 .option syslog_facility main string unset
15491 .cindex "syslog" "facility; setting"
15492 This option sets the syslog &"facility"& name, used when Exim is logging to
15493 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15494 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15495 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15496 details of Exim's logging.
15497
15498
15499
15500 .option syslog_processname main string &`exim`&
15501 .cindex "syslog" "process name; setting"
15502 This option sets the syslog &"ident"& name, used when Exim is logging to
15503 syslog. The value must be no longer than 32 characters. See chapter
15504 &<<CHAPlog>>& for details of Exim's logging.
15505
15506
15507
15508 .option syslog_timestamp main boolean true
15509 .cindex "syslog" "timestamps"
15510 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15511 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15512 details of Exim's logging.
15513
15514
15515 .option system_filter main string&!! unset
15516 .cindex "filter" "system filter"
15517 .cindex "system filter" "specifying"
15518 .cindex "Sieve filter" "not available for system filter"
15519 This option specifies an Exim filter file that is applied to all messages at
15520 the start of each delivery attempt, before any routing is done. System filters
15521 must be Exim filters; they cannot be Sieve filters. If the system filter
15522 generates any deliveries to files or pipes, or any new mail messages, the
15523 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15524 which transports are to be used. Details of this facility are given in chapter
15525 &<<CHAPsystemfilter>>&.
15526
15527
15528 .option system_filter_directory_transport main string&!! unset
15529 .vindex "&$address_file$&"
15530 This sets the name of the transport driver that is to be used when the
15531 &%save%& command in a system message filter specifies a path ending in &"/"&,
15532 implying delivery of each message into a separate file in some directory.
15533 During the delivery, the variable &$address_file$& contains the path name.
15534
15535
15536 .option system_filter_file_transport main string&!! unset
15537 .cindex "file" "transport for system filter"
15538 This sets the name of the transport driver that is to be used when the &%save%&
15539 command in a system message filter specifies a path not ending in &"/"&. During
15540 the delivery, the variable &$address_file$& contains the path name.
15541
15542 .option system_filter_group main string unset
15543 .cindex "gid (group id)" "system filter"
15544 This option is used only when &%system_filter_user%& is also set. It sets the
15545 gid under which the system filter is run, overriding any gid that is associated
15546 with the user. The value may be numerical or symbolic.
15547
15548 .option system_filter_pipe_transport main string&!! unset
15549 .cindex "&(pipe)& transport" "for system filter"
15550 .vindex "&$address_pipe$&"
15551 This specifies the transport driver that is to be used when a &%pipe%& command
15552 is used in a system filter. During the delivery, the variable &$address_pipe$&
15553 contains the pipe command.
15554
15555
15556 .option system_filter_reply_transport main string&!! unset
15557 .cindex "&(autoreply)& transport" "for system filter"
15558 This specifies the transport driver that is to be used when a &%mail%& command
15559 is used in a system filter.
15560
15561
15562 .option system_filter_user main string unset
15563 .cindex "uid (user id)" "system filter"
15564 If this option is set to root, the system filter is run in the main Exim
15565 delivery process, as root.  Otherwise, the system filter runs in a separate
15566 process, as the given user, defaulting to the Exim run-time user.
15567 Unless the string consists entirely of digits, it
15568 is looked up in the password data. Failure to find the named user causes a
15569 configuration error. The gid is either taken from the password data, or
15570 specified by &%system_filter_group%&. When the uid is specified numerically,
15571 &%system_filter_group%& is required to be set.
15572
15573 If the system filter generates any pipe, file, or reply deliveries, the uid
15574 under which the filter is run is used when transporting them, unless a
15575 transport option overrides.
15576
15577
15578 .option tcp_nodelay main boolean true
15579 .cindex "daemon" "TCP_NODELAY on sockets"
15580 .cindex "Nagle algorithm"
15581 .cindex "TCP_NODELAY on listening sockets"
15582 If this option is set false, it stops the Exim daemon setting the
15583 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15584 turns off the &"Nagle algorithm"&, which is a way of improving network
15585 performance in interactive (character-by-character) situations. Turning it off
15586 should improve Exim's performance a bit, so that is what happens by default.
15587 However, it appears that some broken clients cannot cope, and time out. Hence
15588 this option. It affects only those sockets that are set up for listening by the
15589 daemon. Sockets created by the smtp transport for delivering mail always set
15590 TCP_NODELAY.
15591
15592
15593 .option timeout_frozen_after main time 0s
15594 .cindex "frozen messages" "timing out"
15595 .cindex "timeout" "frozen messages"
15596 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15597 message of any kind that has been on the queue for longer than the given time
15598 is automatically cancelled at the next queue run. If the frozen message is a
15599 bounce message, it is just discarded; otherwise, a bounce is sent to the
15600 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15601 If you want to timeout frozen bounce messages earlier than other kinds of
15602 frozen message, see &%ignore_bounce_errors_after%&.
15603
15604 &*Note:*& the default value of zero means no timeouts; with this setting,
15605 frozen messages remain on the queue forever (except for any frozen bounce
15606 messages that are released by &%ignore_bounce_errors_after%&).
15607
15608
15609 .option timezone main string unset
15610 .cindex "timezone, setting"
15611 The value of &%timezone%& is used to set the environment variable TZ while
15612 running Exim (if it is different on entry). This ensures that all timestamps
15613 created by Exim are in the required timezone. If you want all your timestamps
15614 to be in UTC (aka GMT) you should set
15615 .code
15616 timezone = UTC
15617 .endd
15618 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15619 or, if that is not set, from the value of the TZ environment variable when Exim
15620 is built. If &%timezone%& is set to the empty string, either at build or run
15621 time, any existing TZ variable is removed from the environment when Exim
15622 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15623 unfortunately not all, operating systems.
15624
15625
15626 .option tls_advertise_hosts main "host list&!!" unset
15627 .cindex "TLS" "advertising"
15628 .cindex "encryption" "on SMTP connection"
15629 .cindex "SMTP" "encrypted connection"
15630 When Exim is built with support for TLS encrypted connections, the availability
15631 of the STARTTLS command to set up an encrypted session is advertised in
15632 response to EHLO only to those client hosts that match this option. See
15633 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15634
15635
15636 .option tls_certificate main string&!! unset
15637 .cindex "TLS" "server certificate; location of"
15638 .cindex "certificate" "server, location of"
15639 The value of this option is expanded, and must then be the absolute path to a
15640 file which contains the server's certificates. The server's private key is also
15641 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15642 &<<CHAPTLS>>& for further details.
15643
15644 &*Note*&: The certificates defined by this option are used only when Exim is
15645 receiving incoming messages as a server. If you want to supply certificates for
15646 use when sending messages as a client, you must set the &%tls_certificate%&
15647 option in the relevant &(smtp)& transport.
15648
15649 If the option contains &$tls_sni$& and Exim is built against OpenSSL, then
15650 if the OpenSSL build supports TLS extensions and the TLS client sends the
15651 Server Name Indication extension, then this option and others documented in
15652 &<<SECTtlssni>>& will be re-expanded.
15653
15654 .option tls_crl main string&!! unset
15655 .cindex "TLS" "server certificate revocation list"
15656 .cindex "certificate" "revocation list for server"
15657 This option specifies a certificate revocation list. The expanded value must
15658 be the name of a file that contains a CRL in PEM format.
15659
15660 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15661
15662
15663 .option tls_dh_max_bits main integer 2236
15664 .cindex "TLS" "D-H bit count"
15665 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15666 the chosen TLS library.  That value might prove to be too high for
15667 interoperability.  This option provides a maximum clamp on the value
15668 suggested, trading off security for interoperability.
15669
15670 The value must be at least 1024.
15671
15672 The value 2236 was chosen because, at time of adding the option, it was the
15673 hard-coded maximum value supported by the NSS cryptographic library, as used
15674 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15675
15676 If you prefer more security and are willing to break some clients, raise this
15677 number.
15678
15679 Note that the value passed to GnuTLS for *generating* a new prime may be a
15680 little less than this figure, because GnuTLS is inexact and may produce a
15681 larger prime than requested.
15682
15683
15684 .option tls_dhparam main string&!! unset
15685 .cindex "TLS" "D-H parameters for server"
15686 The value of this option is expanded and indicates the source of DH parameters
15687 to be used by Exim.
15688
15689 If it is a filename starting with a &`/`&, then it names a file from which DH
15690 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
15691 PKCS#3 representation of the DH prime.  If the file does not exist, for
15692 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
15693 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
15694 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
15695 and treated as though the &%tls_dhparam%& were set to "none".
15696
15697 If this option expands to the string "none", then no DH parameters will be
15698 loaded by Exim.
15699
15700 If this option expands to the string "historic" and Exim is using GnuTLS, then
15701 Exim will attempt to load a file from inside the spool directory.  If the file
15702 does not exist, Exim will attempt to create it.
15703 See section &<<SECTgnutlsparam>>& for further details.
15704
15705 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
15706 a default DH prime; the default is the 2048 bit prime described in section
15707 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
15708 in IKE is assigned number 23.
15709
15710 Otherwise, the option must expand to the name used by Exim for any of a number
15711 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
15712 "ike" followed by the number used by IKE, of "default" which corresponds to
15713 "ike23".
15714
15715 The available primes are:
15716 &`ike1`&, &`ike2`&, &`ike5`&,
15717 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
15718 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
15719
15720 Some of these will be too small to be accepted by clients.
15721 Some may be too large to be accepted by clients.
15722
15723
15724 .option tls_on_connect_ports main "string list" unset
15725 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15726 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15727 set up without waiting for the client to issue a STARTTLS command. For
15728 further details, see section &<<SECTsupobssmt>>&.
15729
15730
15731
15732 .option tls_privatekey main string&!! unset
15733 .cindex "TLS" "server private key; location of"
15734 The value of this option is expanded, and must then be the absolute path to a
15735 file which contains the server's private key. If this option is unset, or if
15736 the expansion is forced to fail, or the result is an empty string, the private
15737 key is assumed to be in the same file as the server's certificates. See chapter
15738 &<<CHAPTLS>>& for further details.
15739
15740 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15741
15742
15743 .option tls_remember_esmtp main boolean false
15744 .cindex "TLS" "esmtp state; remembering"
15745 .cindex "TLS" "broken clients"
15746 If this option is set true, Exim violates the RFCs by remembering that it is in
15747 &"esmtp"& state after successfully negotiating a TLS session. This provides
15748 support for broken clients that fail to send a new EHLO after starting a
15749 TLS session.
15750
15751
15752 .option tls_require_ciphers main string&!! unset
15753 .cindex "TLS" "requiring specific ciphers"
15754 .cindex "cipher" "requiring specific"
15755 This option controls which ciphers can be used for incoming TLS connections.
15756 The &(smtp)& transport has an option of the same name for controlling outgoing
15757 connections. This option is expanded for each connection, so can be varied for
15758 different clients if required. The value of this option must be a list of
15759 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15760 in somewhat different ways. If GnuTLS is being used, the client controls the
15761 preference order of the available ciphers. Details are given in sections
15762 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15763
15764
15765 .option tls_try_verify_hosts main "host list&!!" unset
15766 .cindex "TLS" "client certificate verification"
15767 .cindex "certificate" "verification of client"
15768 See &%tls_verify_hosts%& below.
15769
15770
15771 .option tls_verify_certificates main string&!! unset
15772 .cindex "TLS" "client certificate verification"
15773 .cindex "certificate" "verification of client"
15774 The value of this option is expanded, and must then be the absolute path to
15775 a file containing permitted certificates for clients that
15776 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15777 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15778 directory containing certificate files. This does not work with GnuTLS; the
15779 option must be set to the name of a single file if you are using GnuTLS.
15780
15781 These certificates should be for the certificate authorities trusted, rather
15782 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15783 the value is a file then the certificates are sent by Exim as a server to
15784 connecting clients, defining the list of accepted certificate authorities.
15785 Thus the values defined should be considered public data.  To avoid this,
15786 use OpenSSL with a directory.
15787
15788 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15789
15790
15791 .option tls_verify_hosts main "host list&!!" unset
15792 .cindex "TLS" "client certificate verification"
15793 .cindex "certificate" "verification of client"
15794 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15795 certificates from clients. The expected certificates are defined by
15796 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15797 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15798 &%tls_verify_certificates%& is not set.
15799
15800 Any client that matches &%tls_verify_hosts%& is constrained by
15801 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15802 present one of the listed certificates. If it does not, the connection is
15803 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15804 the host to use TLS. It can still send SMTP commands through unencrypted
15805 connections. Forcing a client to use TLS has to be done separately using an
15806 ACL to reject inappropriate commands when the connection is not encrypted.
15807
15808 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15809 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15810 certificate and checks it against &%tls_verify_certificates%&, but does not
15811 abort the connection if there is no certificate or if it does not match. This
15812 state can be detected in an ACL, which makes it possible to implement policies
15813 such as &"accept for relay only if a verified certificate has been received,
15814 but accept for local delivery if encrypted, even without a verified
15815 certificate"&.
15816
15817 Client hosts that match neither of these lists are not asked to present
15818 certificates.
15819
15820
15821 .option trusted_groups main "string list&!!" unset
15822 .cindex "trusted groups"
15823 .cindex "groups" "trusted"
15824 This option is expanded just once, at the start of Exim's processing. If this
15825 option is set, any process that is running in one of the listed groups, or
15826 which has one of them as a supplementary group, is trusted. The groups can be
15827 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15828 details of what trusted callers are permitted to do. If neither
15829 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15830 are trusted.
15831
15832 .option trusted_users main "string list&!!" unset
15833 .cindex "trusted users"
15834 .cindex "user" "trusted"
15835 This option is expanded just once, at the start of Exim's processing. If this
15836 option is set, any process that is running as one of the listed users is
15837 trusted. The users can be specified numerically or by name. See section
15838 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15839 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15840 Exim user are trusted.
15841
15842 .option unknown_login main string&!! unset
15843 .cindex "uid (user id)" "unknown caller"
15844 .vindex "&$caller_uid$&"
15845 This is a specialized feature for use in unusual configurations. By default, if
15846 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15847 gives up. The &%unknown_login%& option can be used to set a login name to be
15848 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15849 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15850 is used for the user's real name (gecos field), unless this has been set by the
15851 &%-F%& option.
15852
15853 .option unknown_username main string unset
15854 See &%unknown_login%&.
15855
15856 .option untrusted_set_sender main "address list&!!" unset
15857 .cindex "trusted users"
15858 .cindex "sender" "setting by untrusted user"
15859 .cindex "untrusted user setting sender"
15860 .cindex "user" "untrusted setting sender"
15861 .cindex "envelope sender"
15862 When an untrusted user submits a message to Exim using the standard input, Exim
15863 normally creates an envelope sender address from the user's login and the
15864 default qualification domain. Data from the &%-f%& option (for setting envelope
15865 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15866 is used) is ignored.
15867
15868 However, untrusted users are permitted to set an empty envelope sender address,
15869 to declare that a message should never generate any bounces. For example:
15870 .code
15871 exim -f '<>' user@domain.example
15872 .endd
15873 .vindex "&$sender_ident$&"
15874 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15875 other envelope sender addresses in a controlled way. When it is set, untrusted
15876 users are allowed to set envelope sender addresses that match any of the
15877 patterns in the list. Like all address lists, the string is expanded. The
15878 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15879 users to setting senders that start with their login ids
15880 followed by a hyphen
15881 by a setting like this:
15882 .code
15883 untrusted_set_sender = ^$sender_ident-
15884 .endd
15885 If you want to allow untrusted users to set envelope sender addresses without
15886 restriction, you can use
15887 .code
15888 untrusted_set_sender = *
15889 .endd
15890 The &%untrusted_set_sender%& option applies to all forms of local input, but
15891 only to the setting of the envelope sender. It does not permit untrusted users
15892 to use the other options which trusted user can use to override message
15893 parameters. Furthermore, it does not stop Exim from removing an existing
15894 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15895 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15896 overriding these actions. The handling of the &'Sender:'& header is also
15897 described in section &<<SECTthesenhea>>&.
15898
15899 The log line for a message's arrival shows the envelope sender following
15900 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15901 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15902 envelope sender address, the user's login is shown in parentheses after the
15903 sender address.
15904
15905
15906 .option uucp_from_pattern main string "see below"
15907 .cindex "&""From""& line"
15908 .cindex "UUCP" "&""From""& line"
15909 Some applications that pass messages to an MTA via a command line interface use
15910 an initial line starting with &"From&~"& to pass the envelope sender. In
15911 particular, this is used by UUCP software. Exim recognizes such a line by means
15912 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15913 matches, the sender address is constructed by expanding the contents of
15914 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15915 default pattern recognizes lines in the following two forms:
15916 .code
15917 From ph10 Fri Jan  5 12:35 GMT 1996
15918 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15919 .endd
15920 The pattern can be seen by running
15921 .code
15922 exim -bP uucp_from_pattern
15923 .endd
15924 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15925 year in the second case. The first word after &"From&~"& is matched in the
15926 regular expression by a parenthesized subpattern. The default value for
15927 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15928 (&"ph10"& in the example above) as the message's sender. See also
15929 &%ignore_fromline_hosts%&.
15930
15931
15932 .option uucp_from_sender main string&!! &`$1`&
15933 See &%uucp_from_pattern%& above.
15934
15935
15936 .option warn_message_file main string unset
15937 .cindex "warning of delay" "customizing the message"
15938 .cindex "customizing" "warning message"
15939 This option defines a template file containing paragraphs of text to be used
15940 for constructing the warning message which is sent by Exim when a message has
15941 been on the queue for a specified amount of time, as specified by
15942 &%delay_warning%&. Details of the file's contents are given in chapter
15943 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15944
15945
15946 .option write_rejectlog main boolean true
15947 .cindex "reject log" "disabling"
15948 If this option is set false, Exim no longer writes anything to the reject log.
15949 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15950 .ecindex IIDconfima
15951 .ecindex IIDmaiconf
15952
15953
15954
15955
15956 . ////////////////////////////////////////////////////////////////////////////
15957 . ////////////////////////////////////////////////////////////////////////////
15958
15959 .chapter "Generic options for routers" "CHAProutergeneric"
15960 .scindex IIDgenoprou1 "options" "generic; for routers"
15961 .scindex IIDgenoprou2 "generic options" "router"
15962 This chapter describes the generic options that apply to all routers.
15963 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15964
15965 For a general description of how a router operates, see sections
15966 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15967 which the preconditions are tested. The order of expansion of the options that
15968 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15969 &%headers_remove%&, &%transport%&.
15970
15971
15972
15973 .option address_data routers string&!! unset
15974 .cindex "router" "data attached to address"
15975 The string is expanded just before the router is run, that is, after all the
15976 precondition tests have succeeded. If the expansion is forced to fail, the
15977 router declines, the value of &%address_data%& remains unchanged, and the
15978 &%more%& option controls what happens next. Other expansion failures cause
15979 delivery of the address to be deferred.
15980
15981 .vindex "&$address_data$&"
15982 When the expansion succeeds, the value is retained with the address, and can be
15983 accessed using the variable &$address_data$& in the current router, subsequent
15984 routers, and the eventual transport.
15985
15986 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15987 that runs a user's filter file, the contents of &$address_data$& are accessible
15988 in the filter. This is not normally a problem, because such data is usually
15989 either not confidential or it &"belongs"& to the current user, but if you do
15990 put confidential data into &$address_data$& you need to remember this point.
15991
15992 Even if the router declines or passes, the value of &$address_data$& remains
15993 with the address, though it can be changed by another &%address_data%& setting
15994 on a subsequent router. If a router generates child addresses, the value of
15995 &$address_data$& propagates to them. This also applies to the special kind of
15996 &"child"& that is generated by a router with the &%unseen%& option.
15997
15998 The idea of &%address_data%& is that you can use it to look up a lot of data
15999 for the address once, and then pick out parts of the data later. For example,
16000 you could use a single LDAP lookup to return a string of the form
16001 .code
16002 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16003 .endd
16004 In the transport you could pick out the mailbox by a setting such as
16005 .code
16006 file = ${extract{mailbox}{$address_data}}
16007 .endd
16008 This makes the configuration file less messy, and also reduces the number of
16009 lookups (though Exim does cache lookups).
16010
16011 .vindex "&$sender_address_data$&"
16012 .vindex "&$address_data$&"
16013 The &%address_data%& facility is also useful as a means of passing information
16014 from one router to another, and from a router to a transport. In addition, if
16015 &$address_data$& is set by a router when verifying a recipient address from an
16016 ACL, it remains available for use in the rest of the ACL statement. After
16017 verifying a sender, the value is transferred to &$sender_address_data$&.
16018
16019
16020
16021 .option address_test routers&!? boolean true
16022 .oindex "&%-bt%&"
16023 .cindex "router" "skipping when address testing"
16024 If this option is set false, the router is skipped when routing is being tested
16025 by means of the &%-bt%& command line option. This can be a convenience when
16026 your first router sends messages to an external scanner, because it saves you
16027 having to set the &"already scanned"& indicator when testing real address
16028 routing.
16029
16030
16031
16032 .option cannot_route_message routers string&!! unset
16033 .cindex "router" "customizing &""cannot route""& message"
16034 .cindex "customizing" "&""cannot route""& message"
16035 This option specifies a text message that is used when an address cannot be
16036 routed because Exim has run out of routers. The default message is
16037 &"Unrouteable address"&. This option is useful only on routers that have
16038 &%more%& set false, or on the very last router in a configuration, because the
16039 value that is used is taken from the last router that is considered. This
16040 includes a router that is skipped because its preconditions are not met, as
16041 well as a router that declines. For example, using the default configuration,
16042 you could put:
16043 .code
16044 cannot_route_message = Remote domain not found in DNS
16045 .endd
16046 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16047 and
16048 .code
16049 cannot_route_message = Unknown local user
16050 .endd
16051 on the final router that checks for local users. If string expansion fails for
16052 this option, the default message is used. Unless the expansion failure was
16053 explicitly forced, a message about the failure is written to the main and panic
16054 logs, in addition to the normal message about the routing failure.
16055
16056
16057 .option caseful_local_part routers boolean false
16058 .cindex "case of local parts"
16059 .cindex "router" "case of local parts"
16060 By default, routers handle the local parts of addresses in a case-insensitive
16061 manner, though the actual case is preserved for transmission with the message.
16062 If you want the case of letters to be significant in a router, you must set
16063 this option true. For individual router options that contain address or local
16064 part lists (for example, &%local_parts%&), case-sensitive matching can be
16065 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16066 more details.
16067
16068 .vindex "&$local_part$&"
16069 .vindex "&$original_local_part$&"
16070 .vindex "&$parent_local_part$&"
16071 The value of the &$local_part$& variable is forced to lower case while a
16072 router is running unless &%caseful_local_part%& is set. When a router assigns
16073 an address to a transport, the value of &$local_part$& when the transport runs
16074 is the same as it was in the router. Similarly, when a router generates child
16075 addresses by aliasing or forwarding, the values of &$original_local_part$&
16076 and &$parent_local_part$& are those that were used by the redirecting router.
16077
16078 This option applies to the processing of an address by a router. When a
16079 recipient address is being processed in an ACL, there is a separate &%control%&
16080 modifier that can be used to specify case-sensitive processing within the ACL
16081 (see section &<<SECTcontrols>>&).
16082
16083
16084
16085 .option check_local_user routers&!? boolean false
16086 .cindex "local user, checking in router"
16087 .cindex "router" "checking for local user"
16088 .cindex "&_/etc/passwd_&"
16089 .vindex "&$home$&"
16090 When this option is true, Exim checks that the local part of the recipient
16091 address (with affixes removed if relevant) is the name of an account on the
16092 local system. The check is done by calling the &[getpwnam()]& function rather
16093 than trying to read &_/etc/passwd_& directly. This means that other methods of
16094 holding password data (such as NIS) are supported. If the local part is a local
16095 user, &$home$& is set from the password data, and can be tested in other
16096 preconditions that are evaluated after this one (the order of evaluation is
16097 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16098 overridden by &%router_home_directory%&. If the local part is not a local user,
16099 the router is skipped.
16100
16101 If you want to check that the local part is either the name of a local user
16102 or matches something else, you cannot combine &%check_local_user%& with a
16103 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16104 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16105 setting to achieve this. For example:
16106 .code
16107 local_parts = passwd;$local_part : lsearch;/etc/other/users
16108 .endd
16109 Note, however, that the side effects of &%check_local_user%& (such as setting
16110 up a home directory) do not occur when a &(passwd)& lookup is used in a
16111 &%local_parts%& (or any other) precondition.
16112
16113
16114
16115 .option condition routers&!? string&!! unset
16116 .cindex "router" "customized precondition"
16117 This option specifies a general precondition test that has to succeed for the
16118 router to be called. The &%condition%& option is the last precondition to be
16119 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16120 result is a forced failure, or an empty string, or one of the strings &"0"& or
16121 &"no"& or &"false"& (checked without regard to the case of the letters), the
16122 router is skipped, and the address is offered to the next one.
16123
16124 If the result is any other value, the router is run (as this is the last
16125 precondition to be evaluated, all the other preconditions must be true).
16126
16127 This option is unique in that multiple &%condition%& options may be present.
16128 All &%condition%& options must succeed.
16129
16130 The &%condition%& option provides a means of applying custom conditions to the
16131 running of routers. Note that in the case of a simple conditional expansion,
16132 the default expansion values are exactly what is wanted. For example:
16133 .code
16134 condition = ${if >{$message_age}{600}}
16135 .endd
16136 Because of the default behaviour of the string expansion, this is equivalent to
16137 .code
16138 condition = ${if >{$message_age}{600}{true}{}}
16139 .endd
16140
16141 A multiple condition example, which succeeds:
16142 .code
16143 condition = ${if >{$message_age}{600}}
16144 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16145 condition = foobar
16146 .endd
16147
16148 If the expansion fails (other than forced failure) delivery is deferred. Some
16149 of the other precondition options are common special cases that could in fact
16150 be specified using &%condition%&.
16151
16152
16153 .option debug_print routers string&!! unset
16154 .cindex "testing" "variables in drivers"
16155 If this option is set and debugging is enabled (see the &%-d%& command line
16156 option), the string is expanded and included in the debugging output.
16157 If expansion of the string fails, the error message is written to the debugging
16158 output, and Exim carries on processing.
16159 This option is provided to help with checking out the values of variables and
16160 so on when debugging router configurations. For example, if a &%condition%&
16161 option appears not to be working, &%debug_print%& can be used to output the
16162 variables it references. The output happens after checks for &%domains%&,
16163 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16164 are tested. A newline is added to the text if it does not end with one.
16165
16166
16167
16168 .option disable_logging routers boolean false
16169 If this option is set true, nothing is logged for any routing errors
16170 or for any deliveries caused by this router. You should not set this option
16171 unless you really, really know what you are doing. See also the generic
16172 transport option of the same name.
16173
16174
16175 .option domains routers&!? "domain list&!!" unset
16176 .cindex "router" "restricting to specific domains"
16177 .vindex "&$domain_data$&"
16178 If this option is set, the router is skipped unless the current domain matches
16179 the list. If the match is achieved by means of a file lookup, the data that the
16180 lookup returned for the domain is placed in &$domain_data$& for use in string
16181 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16182 a list of the order in which preconditions are evaluated.
16183
16184
16185
16186 .option driver routers string unset
16187 This option must always be set. It specifies which of the available routers is
16188 to be used.
16189
16190
16191
16192 .option errors_to routers string&!! unset
16193 .cindex "envelope sender"
16194 .cindex "router" "changing address for errors"
16195 If a router successfully handles an address, it may assign the address to a
16196 transport for delivery or it may generate child addresses. In both cases, if
16197 there is a delivery problem during later processing, the resulting bounce
16198 message is sent to the address that results from expanding this string,
16199 provided that the address verifies successfully. The &%errors_to%& option is
16200 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16201
16202 The &%errors_to%& setting associated with an address can be overridden if it
16203 subsequently passes through other routers that have their own &%errors_to%&
16204 settings, or if the message is delivered by a transport with a &%return_path%&
16205 setting.
16206
16207 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16208 the expansion fails to verify, the errors address associated with the incoming
16209 address is used. At top level, this is the envelope sender. A non-forced
16210 expansion failure causes delivery to be deferred.
16211
16212 If an address for which &%errors_to%& has been set ends up being delivered over
16213 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16214 any bounces that are generated by other MTAs on the delivery route are also
16215 sent there. You can set &%errors_to%& to the empty string by either of these
16216 settings:
16217 .code
16218 errors_to =
16219 errors_to = ""
16220 .endd
16221 An expansion item that yields an empty string has the same effect. If you do
16222 this, a locally detected delivery error for addresses processed by this router
16223 no longer gives rise to a bounce message; the error is discarded. If the
16224 address is delivered to a remote host, the return path is set to &`<>`&, unless
16225 overridden by the &%return_path%& option on the transport.
16226
16227 .vindex "&$address_data$&"
16228 If for some reason you want to discard local errors, but use a non-empty
16229 MAIL command for remote delivery, you can preserve the original return
16230 path in &$address_data$& in the router, and reinstate it in the transport by
16231 setting &%return_path%&.
16232
16233 The most common use of &%errors_to%& is to direct mailing list bounces to the
16234 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16235 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16236
16237
16238
16239 .option expn routers&!? boolean true
16240 .cindex "address" "testing"
16241 .cindex "testing" "addresses"
16242 .cindex "EXPN" "router skipping"
16243 .cindex "router" "skipping for EXPN"
16244 If this option is turned off, the router is skipped when testing an address
16245 as a result of processing an SMTP EXPN command. You might, for example,
16246 want to turn it off on a router for users' &_.forward_& files, while leaving it
16247 on for the system alias file.
16248 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16249 are evaluated.
16250
16251 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16252 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16253 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16254
16255
16256
16257 .option fail_verify routers boolean false
16258 .cindex "router" "forcing verification failure"
16259 Setting this option has the effect of setting both &%fail_verify_sender%& and
16260 &%fail_verify_recipient%& to the same value.
16261
16262
16263
16264 .option fail_verify_recipient routers boolean false
16265 If this option is true and an address is accepted by this router when
16266 verifying a recipient, verification fails.
16267
16268
16269
16270 .option fail_verify_sender routers boolean false
16271 If this option is true and an address is accepted by this router when
16272 verifying a sender, verification fails.
16273
16274
16275
16276 .option fallback_hosts routers "string list" unset
16277 .cindex "router" "fallback hosts"
16278 .cindex "fallback" "hosts specified on router"
16279 String expansion is not applied to this option. The argument must be a
16280 colon-separated list of host names or IP addresses. The list separator can be
16281 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16282 each name or address. In fact, the format of each item is exactly the same as
16283 defined for the list of hosts in a &(manualroute)& router (see section
16284 &<<SECTformatonehostitem>>&).
16285
16286 If a router queues an address for a remote transport, this host list is
16287 associated with the address, and used instead of the transport's fallback host
16288 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16289 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16290 transport for further details.
16291
16292
16293 .option group routers string&!! "see below"
16294 .cindex "gid (group id)" "local delivery"
16295 .cindex "local transports" "uid and gid"
16296 .cindex "transport" "local"
16297 .cindex "router" "setting group"
16298 When a router queues an address for a transport, and the transport does not
16299 specify a group, the group given here is used when running the delivery
16300 process.
16301 The group may be specified numerically or by name. If expansion fails, the
16302 error is logged and delivery is deferred.
16303 The default is unset, unless &%check_local_user%& is set, when the default
16304 is taken from the password information. See also &%initgroups%& and &%user%&
16305 and the discussion in chapter &<<CHAPenvironment>>&.
16306
16307
16308
16309 .option headers_add routers string&!! unset
16310 .cindex "header lines" "adding"
16311 .cindex "router" "adding header lines"
16312 This option specifies a string of text that is expanded at routing time, and
16313 associated with any addresses that are accepted by the router. However, this
16314 option has no effect when an address is just being verified. The way in which
16315 the text is used to add header lines at transport time is described in section
16316 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16317 message is in the process of being transported. This means that references to
16318 header lines in string expansions in the transport's configuration do not
16319 &"see"& the added header lines.
16320
16321 The &%headers_add%& option is expanded after &%errors_to%&, but before
16322 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16323 the expansion is forced to fail, the option has no effect. Other expansion
16324 failures are treated as configuration errors.
16325
16326 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16327 router that has the &%one_time%& option set.
16328
16329 .cindex "duplicate addresses"
16330 .oindex "&%unseen%&"
16331 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16332 additions are deleted when the address is passed on to subsequent routers.
16333 For a &%redirect%& router, if a generated address is the same as the incoming
16334 address, this can lead to duplicate addresses with different header
16335 modifications. Exim does not do duplicate deliveries (except, in certain
16336 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16337 which of the duplicates is discarded, so this ambiguous situation should be
16338 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16339
16340
16341
16342 .option headers_remove routers string&!! unset
16343 .cindex "header lines" "removing"
16344 .cindex "router" "removing header lines"
16345 This option specifies a string of text that is expanded at routing time, and
16346 associated with any addresses that are accepted by the router. However, this
16347 option has no effect when an address is just being verified. The way in which
16348 the text is used to remove header lines at transport time is described in
16349 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16350 the message is in the process of being transported. This means that references
16351 to header lines in string expansions in the transport's configuration still
16352 &"see"& the original header lines.
16353
16354 The &%headers_remove%& option is expanded after &%errors_to%& and
16355 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16356 the option has no effect. Other expansion failures are treated as configuration
16357 errors.
16358
16359 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16360 router that has the &%one_time%& option set.
16361
16362 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16363 removal requests are deleted when the address is passed on to subsequent
16364 routers, and this can lead to problems with duplicates -- see the similar
16365 warning for &%headers_add%& above.
16366
16367
16368 .option ignore_target_hosts routers "host list&!!" unset
16369 .cindex "IP address" "discarding"
16370 .cindex "router" "discarding IP addresses"
16371 Although this option is a host list, it should normally contain IP address
16372 entries rather than names. If any host that is looked up by the router has an
16373 IP address that matches an item in this list, Exim behaves as if that IP
16374 address did not exist. This option allows you to cope with rogue DNS entries
16375 like
16376 .code
16377 remote.domain.example.  A  127.0.0.1
16378 .endd
16379 by setting
16380 .code
16381 ignore_target_hosts = 127.0.0.1
16382 .endd
16383 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16384 discarded in this way, the router declines. In a conventional configuration, an
16385 attempt to mail to such a domain would normally provoke the &"unrouteable
16386 domain"& error, and an attempt to verify an address in the domain would fail.
16387 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16388 router declines if presented with one of the listed addresses.
16389
16390 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16391 means of the first or the second of the following settings, respectively:
16392 .code
16393 ignore_target_hosts = 0.0.0.0/0
16394 ignore_target_hosts = <; 0::0/0
16395 .endd
16396 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16397 in the second line matches all IPv6 addresses.
16398
16399 This option may also be useful for ignoring link-local and site-local IPv6
16400 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16401 is expanded before use as a list, it is possible to make it dependent on the
16402 domain that is being routed.
16403
16404 .vindex "&$host_address$&"
16405 During its expansion, &$host_address$& is set to the IP address that is being
16406 checked.
16407
16408 .option initgroups routers boolean false
16409 .cindex "additional groups"
16410 .cindex "groups" "additional"
16411 .cindex "local transports" "uid and gid"
16412 .cindex "transport" "local"
16413 If the router queues an address for a transport, and this option is true, and
16414 the uid supplied by the router is not overridden by the transport, the
16415 &[initgroups()]& function is called when running the transport to ensure that
16416 any additional groups associated with the uid are set up. See also &%group%&
16417 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16418
16419
16420
16421 .option local_part_prefix routers&!? "string list" unset
16422 .cindex "router" "prefix for local part"
16423 .cindex "prefix" "for local part, used in router"
16424 If this option is set, the router is skipped unless the local part starts with
16425 one of the given strings, or &%local_part_prefix_optional%& is true. See
16426 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16427 evaluated.
16428
16429 The list is scanned from left to right, and the first prefix that matches is
16430 used. A limited form of wildcard is available; if the prefix begins with an
16431 asterisk, it matches the longest possible sequence of arbitrary characters at
16432 the start of the local part. An asterisk should therefore always be followed by
16433 some character that does not occur in normal local parts.
16434 .cindex "multiple mailboxes"
16435 .cindex "mailbox" "multiple"
16436 Wildcarding can be used to set up multiple user mailboxes, as described in
16437 section &<<SECTmulbox>>&.
16438
16439 .vindex "&$local_part$&"
16440 .vindex "&$local_part_prefix$&"
16441 During the testing of the &%local_parts%& option, and while the router is
16442 running, the prefix is removed from the local part, and is available in the
16443 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16444 the router accepts the address, this remains true during subsequent delivery by
16445 a transport. In particular, the local part that is transmitted in the RCPT
16446 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16447 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16448 the relevant transport.
16449
16450 When an address is being verified, &%local_part_prefix%& affects only the
16451 behaviour of the router. If the callout feature of verification is in use, this
16452 means that the full address, including the prefix, will be used during the
16453 callout.
16454
16455 The prefix facility is commonly used to handle local parts of the form
16456 &%owner-something%&. Another common use is to support local parts of the form
16457 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16458 to tell a user their forwarding is broken &-- by placing a router like this one
16459 immediately before the router that handles &_.forward_& files:
16460 .code
16461 real_localuser:
16462   driver = accept
16463   local_part_prefix = real-
16464   check_local_user
16465   transport = local_delivery
16466 .endd
16467 For security, it would probably be a good idea to restrict the use of this
16468 router to locally-generated messages, using a condition such as this:
16469 .code
16470   condition = ${if match {$sender_host_address}\
16471                          {\N^(|127\.0\.0\.1)$\N}}
16472 .endd
16473
16474 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16475 both conditions must be met if not optional. Care must be taken if wildcards
16476 are used in both a prefix and a suffix on the same router. Different
16477 separator characters must be used to avoid ambiguity.
16478
16479
16480 .option local_part_prefix_optional routers boolean false
16481 See &%local_part_prefix%& above.
16482
16483
16484
16485 .option local_part_suffix routers&!? "string list" unset
16486 .cindex "router" "suffix for local part"
16487 .cindex "suffix for local part" "used in router"
16488 This option operates in the same way as &%local_part_prefix%&, except that the
16489 local part must end (rather than start) with the given string, the
16490 &%local_part_suffix_optional%& option determines whether the suffix is
16491 mandatory, and the wildcard * character, if present, must be the last
16492 character of the suffix. This option facility is commonly used to handle local
16493 parts of the form &%something-request%& and multiple user mailboxes of the form
16494 &%username-foo%&.
16495
16496
16497 .option local_part_suffix_optional routers boolean false
16498 See &%local_part_suffix%& above.
16499
16500
16501
16502 .option local_parts routers&!? "local part list&!!" unset
16503 .cindex "router" "restricting to specific local parts"
16504 .cindex "local part" "checking in router"
16505 The router is run only if the local part of the address matches the list.
16506 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16507 are evaluated, and
16508 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16509 string is expanded, it is possible to make it depend on the domain, for
16510 example:
16511 .code
16512 local_parts = dbm;/usr/local/specials/$domain
16513 .endd
16514 .vindex "&$local_part_data$&"
16515 If the match is achieved by a lookup, the data that the lookup returned
16516 for the local part is placed in the variable &$local_part_data$& for use in
16517 expansions of the router's private options. You might use this option, for
16518 example, if you have a large number of local virtual domains, and you want to
16519 send all postmaster mail to the same place without having to set up an alias in
16520 each virtual domain:
16521 .code
16522 postmaster:
16523   driver = redirect
16524   local_parts = postmaster
16525   data = postmaster@real.domain.example
16526 .endd
16527
16528
16529 .option log_as_local routers boolean "see below"
16530 .cindex "log" "delivery line"
16531 .cindex "delivery" "log line format"
16532 Exim has two logging styles for delivery, the idea being to make local
16533 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16534 recipient address is given just as the local part, without a domain. The use of
16535 this style is controlled by this option. It defaults to true for the &(accept)&
16536 router, and false for all the others. This option applies only when a
16537 router assigns an address to a transport. It has no effect on routers that
16538 redirect addresses.
16539
16540
16541
16542 .option more routers boolean&!! true
16543 The result of string expansion for this option must be a valid boolean value,
16544 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16545 result causes an error, and delivery is deferred. If the expansion is forced to
16546 fail, the default value for the option (true) is used. Other failures cause
16547 delivery to be deferred.
16548
16549 If this option is set false, and the router declines to handle the address, no
16550 further routers are tried, routing fails, and the address is bounced.
16551 .oindex "&%self%&"
16552 However, if the router explicitly passes an address to the following router by
16553 means of the setting
16554 .code
16555 self = pass
16556 .endd
16557 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16558 does not affect the behaviour if one of the precondition tests fails. In that
16559 case, the address is always passed to the next router.
16560
16561 Note that &%address_data%& is not considered to be a precondition. If its
16562 expansion is forced to fail, the router declines, and the value of &%more%&
16563 controls what happens next.
16564
16565
16566 .option pass_on_timeout routers boolean false
16567 .cindex "timeout" "of router"
16568 .cindex "router" "timeout"
16569 If a router times out during a host lookup, it normally causes deferral of the
16570 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16571 router, overriding &%no_more%&. This may be helpful for systems that are
16572 intermittently connected to the Internet, or those that want to pass to a smart
16573 host any messages that cannot immediately be delivered.
16574
16575 There are occasional other temporary errors that can occur while doing DNS
16576 lookups. They are treated in the same way as a timeout, and this option
16577 applies to all of them.
16578
16579
16580
16581 .option pass_router routers string unset
16582 .cindex "router" "go to after &""pass""&"
16583 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16584 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16585 routing to continue, and overriding a false setting of &%more%&. When one of
16586 these routers returns &"pass"&, the address is normally handed on to the next
16587 router in sequence. This can be changed by setting &%pass_router%& to the name
16588 of another router. However (unlike &%redirect_router%&) the named router must
16589 be below the current router, to avoid loops. Note that this option applies only
16590 to the special case of &"pass"&. It does not apply when a router returns
16591 &"decline"& because it cannot handle an address.
16592
16593
16594
16595 .option redirect_router routers string unset
16596 .cindex "router" "start at after redirection"
16597 Sometimes an administrator knows that it is pointless to reprocess addresses
16598 generated from alias or forward files with the same router again. For
16599 example, if an alias file translates real names into login ids there is no
16600 point searching the alias file a second time, especially if it is a large file.
16601
16602 The &%redirect_router%& option can be set to the name of any router instance.
16603 It causes the routing of any generated addresses to start at the named router
16604 instead of at the first router. This option has no effect if the router in
16605 which it is set does not generate new addresses.
16606
16607
16608
16609 .option require_files routers&!? "string list&!!" unset
16610 .cindex "file" "requiring for router"
16611 .cindex "router" "requiring file existence"
16612 This option provides a general mechanism for predicating the running of a
16613 router on the existence or non-existence of certain files or directories.
16614 Before running a router, as one of its precondition tests, Exim works its way
16615 through the &%require_files%& list, expanding each item separately.
16616
16617 Because the list is split before expansion, any colons in expansion items must
16618 be doubled, or the facility for using a different list separator must be used.
16619 If any expansion is forced to fail, the item is ignored. Other expansion
16620 failures cause routing of the address to be deferred.
16621
16622 If any expanded string is empty, it is ignored. Otherwise, except as described
16623 below, each string must be a fully qualified file path, optionally preceded by
16624 &"!"&. The paths are passed to the &[stat()]& function to test for the
16625 existence of the files or directories. The router is skipped if any paths not
16626 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16627
16628 .cindex "NFS"
16629 If &[stat()]& cannot determine whether a file exists or not, delivery of
16630 the message is deferred. This can happen when NFS-mounted filesystems are
16631 unavailable.
16632
16633 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16634 options, so you cannot use it to check for the existence of a file in which to
16635 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16636 full list of the order in which preconditions are evaluated.) However, as
16637 these options are all expanded, you can use the &%exists%& expansion condition
16638 to make such tests. The &%require_files%& option is intended for checking files
16639 that the router may be going to use internally, or which are needed by a
16640 transport (for example &_.procmailrc_&).
16641
16642 During delivery, the &[stat()]& function is run as root, but there is a
16643 facility for some checking of the accessibility of a file by another user.
16644 This is not a proper permissions check, but just a &"rough"& check that
16645 operates as follows:
16646
16647 If an item in a &%require_files%& list does not contain any forward slash
16648 characters, it is taken to be the user (and optional group, separated by a
16649 comma) to be checked for subsequent files in the list. If no group is specified
16650 but the user is specified symbolically, the gid associated with the uid is
16651 used. For example:
16652 .code
16653 require_files = mail:/some/file
16654 require_files = $local_part:$home/.procmailrc
16655 .endd
16656 If a user or group name in a &%require_files%& list does not exist, the
16657 &%require_files%& condition fails.
16658
16659 Exim performs the check by scanning along the components of the file path, and
16660 checking the access for the given uid and gid. It checks for &"x"& access on
16661 directories, and &"r"& access on the final file. Note that this means that file
16662 access control lists, if the operating system has them, are ignored.
16663
16664 &*Warning 1*&: When the router is being run to verify addresses for an
16665 incoming SMTP message, Exim is not running as root, but under its own uid. This
16666 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16667 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16668 user is not permitted to read one of the directories on the file's path.
16669
16670 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16671 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16672 without root access. In this case, if a check for access by a particular user
16673 is requested, Exim creates a subprocess that runs as that user, and tries the
16674 check again in that process.
16675
16676 The default action for handling an unresolved EACCES is to consider it to
16677 be caused by a configuration error, and routing is deferred because the
16678 existence or non-existence of the file cannot be determined. However, in some
16679 circumstances it may be desirable to treat this condition as if the file did
16680 not exist. If the file name (or the exclamation mark that precedes the file
16681 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16682 as if the file did not exist. For example:
16683 .code
16684 require_files = +/some/file
16685 .endd
16686 If the router is not an essential part of verification (for example, it
16687 handles users' &_.forward_& files), another solution is to set the &%verify%&
16688 option false so that the router is skipped when verifying.
16689
16690
16691
16692 .option retry_use_local_part routers boolean "see below"
16693 .cindex "hints database" "retry keys"
16694 .cindex "local part" "in retry keys"
16695 When a delivery suffers a temporary routing failure, a retry record is created
16696 in Exim's hints database. For addresses whose routing depends only on the
16697 domain, the key for the retry record should not involve the local part, but for
16698 other addresses, both the domain and the local part should be included.
16699 Usually, remote routing is of the former kind, and local routing is of the
16700 latter kind.
16701
16702 This option controls whether the local part is used to form the key for retry
16703 hints for addresses that suffer temporary errors while being handled by this
16704 router. The default value is true for any router that has &%check_local_user%&
16705 set, and false otherwise. Note that this option does not apply to hints keys
16706 for transport delays; they are controlled by a generic transport option of the
16707 same name.
16708
16709 The setting of &%retry_use_local_part%& applies only to the router on which it
16710 appears. If the router generates child addresses, they are routed
16711 independently; this setting does not become attached to them.
16712
16713
16714
16715 .option router_home_directory routers string&!! unset
16716 .cindex "router" "home directory for"
16717 .cindex "home directory" "for router"
16718 .vindex "&$home$&"
16719 This option sets a home directory for use while the router is running. (Compare
16720 &%transport_home_directory%&, which sets a home directory for later
16721 transporting.) In particular, if used on a &(redirect)& router, this option
16722 sets a value for &$home$& while a filter is running. The value is expanded;
16723 forced expansion failure causes the option to be ignored &-- other failures
16724 cause the router to defer.
16725
16726 Expansion of &%router_home_directory%& happens immediately after the
16727 &%check_local_user%& test (if configured), before any further expansions take
16728 place.
16729 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16730 are evaluated.)
16731 While the router is running, &%router_home_directory%& overrides the value of
16732 &$home$& that came from &%check_local_user%&.
16733
16734 When a router accepts an address and assigns it to a local transport (including
16735 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16736 delivery), the home directory setting for the transport is taken from the first
16737 of these values that is set:
16738
16739 .ilist
16740 The &%home_directory%& option on the transport;
16741 .next
16742 The &%transport_home_directory%& option on the router;
16743 .next
16744 The password data if &%check_local_user%& is set on the router;
16745 .next
16746 The &%router_home_directory%& option on the router.
16747 .endlist
16748
16749 In other words, &%router_home_directory%& overrides the password data for the
16750 router, but not for the transport.
16751
16752
16753
16754 .option self routers string freeze
16755 .cindex "MX record" "pointing to local host"
16756 .cindex "local host" "MX pointing to"
16757 This option applies to those routers that use a recipient address to find a
16758 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16759 and &(manualroute)& routers.
16760 Certain configurations of the &(queryprogram)& router can also specify a list
16761 of remote hosts.
16762 Usually such routers are configured to send the message to a remote host via an
16763 &(smtp)& transport. The &%self%& option specifies what happens when the first
16764 host on the list turns out to be the local host.
16765 The way in which Exim checks for the local host is described in section
16766 &<<SECTreclocipadd>>&.
16767
16768 Normally this situation indicates either an error in Exim's configuration (for
16769 example, the router should be configured not to process this domain), or an
16770 error in the DNS (for example, the MX should not point to this host). For this
16771 reason, the default action is to log the incident, defer the address, and
16772 freeze the message. The following alternatives are provided for use in special
16773 cases:
16774
16775 .vlist
16776 .vitem &%defer%&
16777 Delivery of the message is tried again later, but the message is not frozen.
16778
16779 .vitem "&%reroute%&: <&'domain'&>"
16780 The domain is changed to the given domain, and the address is passed back to
16781 be reprocessed by the routers. No rewriting of headers takes place. This
16782 behaviour is essentially a redirection.
16783
16784 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16785 The domain is changed to the given domain, and the address is passed back to be
16786 reprocessed by the routers. Any headers that contain the original domain are
16787 rewritten.
16788
16789 .vitem &%pass%&
16790 .oindex "&%more%&"
16791 .vindex "&$self_hostname$&"
16792 The router passes the address to the next router, or to the router named in the
16793 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16794 subsequent routing and delivery, the variable &$self_hostname$& contains the
16795 name of the local host that the router encountered. This can be used to
16796 distinguish between different cases for hosts with multiple names. The
16797 combination
16798 .code
16799 self = pass
16800 no_more
16801 .endd
16802 ensures that only those addresses that routed to the local host are passed on.
16803 Without &%no_more%&, addresses that were declined for other reasons would also
16804 be passed to the next router.
16805
16806 .vitem &%fail%&
16807 Delivery fails and an error report is generated.
16808
16809 .vitem &%send%&
16810 .cindex "local host" "sending to"
16811 The anomaly is ignored and the address is queued for the transport. This
16812 setting should be used with extreme caution. For an &(smtp)& transport, it
16813 makes sense only in cases where the program that is listening on the SMTP port
16814 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16815 different configuration file that handles the domain in another way.
16816 .endlist
16817
16818
16819
16820 .option senders routers&!? "address list&!!" unset
16821 .cindex "router" "checking senders"
16822 If this option is set, the router is skipped unless the message's sender
16823 address matches something on the list.
16824 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16825 are evaluated.
16826
16827 There are issues concerning verification when the running of routers is
16828 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16829 setting, it sets the sender to the null string. When using the &%-bt%& option
16830 to check a configuration file, it is necessary also to use the &%-f%& option to
16831 set an appropriate sender. For incoming mail, the sender is unset when
16832 verifying the sender, but is available when verifying any recipients. If the
16833 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16834 matters.
16835
16836
16837 .option translate_ip_address routers string&!! unset
16838 .cindex "IP address" "translating"
16839 .cindex "packet radio"
16840 .cindex "router" "IP address translation"
16841 There exist some rare networking situations (for example, packet radio) where
16842 it is helpful to be able to translate IP addresses generated by normal routing
16843 mechanisms into other IP addresses, thus performing a kind of manual IP
16844 routing. This should be done only if the normal IP routing of the TCP/IP stack
16845 is inadequate or broken. Because this is an extremely uncommon requirement, the
16846 code to support this option is not included in the Exim binary unless
16847 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16848
16849 .vindex "&$host_address$&"
16850 The &%translate_ip_address%& string is expanded for every IP address generated
16851 by the router, with the generated address set in &$host_address$&. If the
16852 expansion is forced to fail, no action is taken.
16853 For any other expansion error, delivery of the message is deferred.
16854 If the result of the expansion is an IP address, that replaces the original
16855 address; otherwise the result is assumed to be a host name &-- this is looked
16856 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16857 produce one or more replacement IP addresses. For example, to subvert all IP
16858 addresses in some specific networks, this could be added to a router:
16859 .code
16860 translate_ip_address = \
16861   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16862     {$value}fail}}
16863 .endd
16864 The file would contain lines like
16865 .code
16866 10.2.3.128/26    some.host
16867 10.8.4.34/26     10.44.8.15
16868 .endd
16869 You should not make use of this facility unless you really understand what you
16870 are doing.
16871
16872
16873
16874 .option transport routers string&!! unset
16875 This option specifies the transport to be used when a router accepts an address
16876 and sets it up for delivery. A transport is never needed if a router is used
16877 only for verification. The value of the option is expanded at routing time,
16878 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16879 and result must be the name of one of the configured transports. If it is not,
16880 delivery is deferred.
16881
16882 The &%transport%& option is not used by the &(redirect)& router, but it does
16883 have some private options that set up transports for pipe and file deliveries
16884 (see chapter &<<CHAPredirect>>&).
16885
16886
16887
16888 .option transport_current_directory routers string&!! unset
16889 .cindex "current directory for local transport"
16890 This option associates a current directory with any address that is routed
16891 to a local transport. This can happen either because a transport is
16892 explicitly configured for the router, or because it generates a delivery to a
16893 file or a pipe. During the delivery process (that is, at transport time), this
16894 option string is expanded and is set as the current directory, unless
16895 overridden by a setting on the transport.
16896 If the expansion fails for any reason, including forced failure, an error is
16897 logged, and delivery is deferred.
16898 See chapter &<<CHAPenvironment>>& for details of the local delivery
16899 environment.
16900
16901
16902
16903
16904 .option transport_home_directory routers string&!! "see below"
16905 .cindex "home directory" "for local transport"
16906 This option associates a home directory with any address that is routed to a
16907 local transport. This can happen either because a transport is explicitly
16908 configured for the router, or because it generates a delivery to a file or a
16909 pipe. During the delivery process (that is, at transport time), the option
16910 string is expanded and is set as the home directory, unless overridden by a
16911 setting of &%home_directory%& on the transport.
16912 If the expansion fails for any reason, including forced failure, an error is
16913 logged, and delivery is deferred.
16914
16915 If the transport does not specify a home directory, and
16916 &%transport_home_directory%& is not set for the router, the home directory for
16917 the transport is taken from the password data if &%check_local_user%& is set for
16918 the router. Otherwise it is taken from &%router_home_directory%& if that option
16919 is set; if not, no home directory is set for the transport.
16920
16921 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16922 environment.
16923
16924
16925
16926
16927 .option unseen routers boolean&!! false
16928 .cindex "router" "carrying on after success"
16929 The result of string expansion for this option must be a valid boolean value,
16930 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16931 result causes an error, and delivery is deferred. If the expansion is forced to
16932 fail, the default value for the option (false) is used. Other failures cause
16933 delivery to be deferred.
16934
16935 When this option is set true, routing does not cease if the router accepts the
16936 address. Instead, a copy of the incoming address is passed to the next router,
16937 overriding a false setting of &%more%&. There is little point in setting
16938 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16939 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16940 sometimes true and sometimes false).
16941
16942 .cindex "copy of message (&%unseen%& option)"
16943 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16944 qualifier in filter files. It can be used to cause copies of messages to be
16945 delivered to some other destination, while also carrying out a normal delivery.
16946 In effect, the current address is made into a &"parent"& that has two children
16947 &-- one that is delivered as specified by this router, and a clone that goes on
16948 to be routed further. For this reason, &%unseen%& may not be combined with the
16949 &%one_time%& option in a &(redirect)& router.
16950
16951 &*Warning*&: Header lines added to the address (or specified for removal) by
16952 this router or by previous routers affect the &"unseen"& copy of the message
16953 only. The clone that continues to be processed by further routers starts with
16954 no added headers and none specified for removal. For a &%redirect%& router, if
16955 a generated address is the same as the incoming address, this can lead to
16956 duplicate addresses with different header modifications. Exim does not do
16957 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16958 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16959 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16960 &%redirect%& router may be of help.
16961
16962 Unlike the handling of header modifications, any data that was set by the
16963 &%address_data%& option in the current or previous routers &'is'& passed on to
16964 subsequent routers.
16965
16966
16967 .option user routers string&!! "see below"
16968 .cindex "uid (user id)" "local delivery"
16969 .cindex "local transports" "uid and gid"
16970 .cindex "transport" "local"
16971 .cindex "router" "user for filter processing"
16972 .cindex "filter" "user for processing"
16973 When a router queues an address for a transport, and the transport does not
16974 specify a user, the user given here is used when running the delivery process.
16975 The user may be specified numerically or by name. If expansion fails, the
16976 error is logged and delivery is deferred.
16977 This user is also used by the &(redirect)& router when running a filter file.
16978 The default is unset, except when &%check_local_user%& is set. In this case,
16979 the default is taken from the password information. If the user is specified as
16980 a name, and &%group%& is not set, the group associated with the user is used.
16981 See also &%initgroups%& and &%group%& and the discussion in chapter
16982 &<<CHAPenvironment>>&.
16983
16984
16985
16986 .option verify routers&!? boolean true
16987 Setting this option has the effect of setting &%verify_sender%& and
16988 &%verify_recipient%& to the same value.
16989
16990
16991 .option verify_only routers&!? boolean false
16992 .cindex "EXPN" "with &%verify_only%&"
16993 .oindex "&%-bv%&"
16994 .cindex "router" "used only when verifying"
16995 If this option is set, the router is used only when verifying an address or
16996 testing with the &%-bv%& option, not when actually doing a delivery, testing
16997 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16998 restricted to verifying only senders or recipients by means of
16999 &%verify_sender%& and &%verify_recipient%&.
17000
17001 &*Warning*&: When the router is being run to verify addresses for an incoming
17002 SMTP message, Exim is not running as root, but under its own uid. If the router
17003 accesses any files, you need to make sure that they are accessible to the Exim
17004 user or group.
17005
17006
17007 .option verify_recipient routers&!? boolean true
17008 If this option is false, the router is skipped when verifying recipient
17009 addresses
17010 or testing recipient verification using &%-bv%&.
17011 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17012 are evaluated.
17013
17014
17015 .option verify_sender routers&!? boolean true
17016 If this option is false, the router is skipped when verifying sender addresses
17017 or testing sender verification using &%-bvs%&.
17018 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17019 are evaluated.
17020 .ecindex IIDgenoprou1
17021 .ecindex IIDgenoprou2
17022
17023
17024
17025
17026
17027
17028 . ////////////////////////////////////////////////////////////////////////////
17029 . ////////////////////////////////////////////////////////////////////////////
17030
17031 .chapter "The accept router" "CHID4"
17032 .cindex "&(accept)& router"
17033 .cindex "routers" "&(accept)&"
17034 The &(accept)& router has no private options of its own. Unless it is being
17035 used purely for verification (see &%verify_only%&) a transport is required to
17036 be defined by the generic &%transport%& option. If the preconditions that are
17037 specified by generic options are met, the router accepts the address and queues
17038 it for the given transport. The most common use of this router is for setting
17039 up deliveries to local mailboxes. For example:
17040 .code
17041 localusers:
17042   driver = accept
17043   domains = mydomain.example
17044   check_local_user
17045   transport = local_delivery
17046 .endd
17047 The &%domains%& condition in this example checks the domain of the address, and
17048 &%check_local_user%& checks that the local part is the login of a local user.
17049 When both preconditions are met, the &(accept)& router runs, and queues the
17050 address for the &(local_delivery)& transport.
17051
17052
17053
17054
17055
17056
17057 . ////////////////////////////////////////////////////////////////////////////
17058 . ////////////////////////////////////////////////////////////////////////////
17059
17060 .chapter "The dnslookup router" "CHAPdnslookup"
17061 .scindex IIDdnsrou1 "&(dnslookup)& router"
17062 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17063 The &(dnslookup)& router looks up the hosts that handle mail for the
17064 recipient's domain in the DNS. A transport must always be set for this router,
17065 unless &%verify_only%& is set.
17066
17067 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17068 SRV records. If none are found, or if SRV support is not configured,
17069 MX records are looked up. If no MX records exist, address records are sought.
17070 However, &%mx_domains%& can be set to disable the direct use of address
17071 records.
17072
17073 MX records of equal priority are sorted by Exim into a random order. Exim then
17074 looks for address records for the host names obtained from MX or SRV records.
17075 When a host has more than one IP address, they are sorted into a random order,
17076 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17077 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17078 generic option, the router declines.
17079
17080 Unless they have the highest priority (lowest MX value), MX records that point
17081 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17082 are discarded, together with any other MX records of equal or lower priority.
17083
17084 .cindex "MX record" "pointing to local host"
17085 .cindex "local host" "MX pointing to"
17086 .oindex "&%self%&" "in &(dnslookup)& router"
17087 If the host pointed to by the highest priority MX record, or looked up as an
17088 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17089 happens is controlled by the generic &%self%& option.
17090
17091
17092 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17093 There have been problems with DNS servers when SRV records are looked up.
17094 Some mis-behaving servers return a DNS error or timeout when a non-existent
17095 SRV record is sought. Similar problems have in the past been reported for
17096 MX records. The global &%dns_again_means_nonexist%& option can help with this
17097 problem, but it is heavy-handed because it is a global option.
17098
17099 For this reason, there are two options, &%srv_fail_domains%& and
17100 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17101 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17102 an attempt to look up an SRV or MX record causes one of these results, and the
17103 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17104 such record"&. In the case of an SRV lookup, this means that the router
17105 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17106 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17107 case routing fails.
17108
17109
17110 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17111 .cindex "&(dnslookup)& router" "declines"
17112 There are a few cases where a &(dnslookup)& router will decline to accept
17113 an address; if such a router is expected to handle "all remaining non-local
17114 domains", then it is important to set &%no_more%&.
17115
17116 Reasons for a &(dnslookup)& router to decline currently include:
17117 .ilist
17118 The domain does not exist in DNS
17119 .next
17120 The domain exists but the MX record's host part is just "."; this is a common
17121 convention (borrowed from SRV) used to indicate that there is no such service
17122 for this domain and to not fall back to trying A/AAAA records.
17123 .next
17124 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17125 .next
17126 MX record points to a non-existent host.
17127 .next
17128 MX record points to an IP address and the main section option
17129 &%allow_mx_to_ip%& is not set.
17130 .next
17131 MX records exist and point to valid hosts, but all hosts resolve only to
17132 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17133 .next
17134 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17135 &%dns_check_names_pattern%& for handling one variant of this)
17136 .next
17137 &%check_secondary_mx%& is set on this router but the local host can
17138 not be found in the MX records (see below)
17139 .endlist
17140
17141
17142
17143
17144 .section "Private options for dnslookup" "SECID118"
17145 .cindex "options" "&(dnslookup)& router"
17146 The private options for the &(dnslookup)& router are as follows:
17147
17148 .option check_secondary_mx dnslookup boolean false
17149 .cindex "MX record" "checking for secondary"
17150 If this option is set, the router declines unless the local host is found in
17151 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17152 process domains for which the local host is a secondary mail exchanger
17153 differently to other domains. The way in which Exim decides whether a host is
17154 the local host is described in section &<<SECTreclocipadd>>&.
17155
17156
17157 .option check_srv dnslookup string&!! unset
17158 .cindex "SRV record" "enabling use of"
17159 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17160 addition to MX and address records. The support is disabled by default. To
17161 enable SRV support, set the &%check_srv%& option to the name of the service
17162 required. For example,
17163 .code
17164 check_srv = smtp
17165 .endd
17166 looks for SRV records that refer to the normal smtp service. The option is
17167 expanded, so the service name can vary from message to message or address
17168 to address. This might be helpful if SRV records are being used for a
17169 submission service. If the expansion is forced to fail, the &%check_srv%&
17170 option is ignored, and the router proceeds to look for MX records in the
17171 normal way.
17172
17173 When the expansion succeeds, the router searches first for SRV records for
17174 the given service (it assumes TCP protocol). A single SRV record with a
17175 host name that consists of just a single dot indicates &"no such service for
17176 this domain"&; if this is encountered, the router declines. If other kinds of
17177 SRV record are found, they are used to construct a host list for delivery
17178 according to the rules of RFC 2782. MX records are not sought in this case.
17179
17180 When no SRV records are found, MX records (and address records) are sought in
17181 the traditional way. In other words, SRV records take precedence over MX
17182 records, just as MX records take precedence over address records. Note that
17183 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17184 defined it. It is apparently believed that MX records are sufficient for email
17185 and that SRV records should not be used for this purpose. However, SRV records
17186 have an additional &"weight"& feature which some people might find useful when
17187 trying to split an SMTP load between hosts of different power.
17188
17189 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17190 when there is a DNS lookup error.
17191
17192
17193
17194 .option mx_domains dnslookup "domain list&!!" unset
17195 .cindex "MX record" "required to exist"
17196 .cindex "SRV record" "required to exist"
17197 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17198 record in order to be recognized. (The name of this option could be improved.)
17199 For example, if all the mail hosts in &'fict.example'& are known to have MX
17200 records, except for those in &'discworld.fict.example'&, you could use this
17201 setting:
17202 .code
17203 mx_domains = ! *.discworld.fict.example : *.fict.example
17204 .endd
17205 This specifies that messages addressed to a domain that matches the list but
17206 has no MX record should be bounced immediately instead of being routed using
17207 the address record.
17208
17209
17210 .option mx_fail_domains dnslookup "domain list&!!" unset
17211 If the DNS lookup for MX records for one of the domains in this list causes a
17212 DNS lookup error, Exim behaves as if no MX records were found. See section
17213 &<<SECTprowitdnsloo>>& for more discussion.
17214
17215
17216
17217
17218 .option qualify_single dnslookup boolean true
17219 .cindex "DNS" "resolver options"
17220 .cindex "DNS" "qualifying single-component names"
17221 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17222 lookups. Typically, but not standardly, this causes the resolver to qualify
17223 single-component names with the default domain. For example, on a machine
17224 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17225 &'thesaurus.ref.example'& inside the resolver. For details of what your
17226 resolver actually does, consult your man pages for &'resolver'& and
17227 &'resolv.conf'&.
17228
17229
17230
17231 .option rewrite_headers dnslookup boolean true
17232 .cindex "rewriting" "header lines"
17233 .cindex "header lines" "rewriting"
17234 If the domain name in the address that is being processed is not fully
17235 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17236 an address is specified as &'dormouse@teaparty'&, the domain might be
17237 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17238 occur as a result of setting the &%widen_domains%& option. If
17239 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17240 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17241 header lines of the message are rewritten with the full domain name.
17242
17243 This option should be turned off only when it is known that no message is
17244 ever going to be sent outside an environment where the abbreviation makes
17245 sense.
17246
17247 When an MX record is looked up in the DNS and matches a wildcard record, name
17248 servers normally return a record containing the name that has been looked up,
17249 making it impossible to detect whether a wildcard was present or not. However,
17250 some name servers have recently been seen to return the wildcard entry. If the
17251 name returned by a DNS lookup begins with an asterisk, it is not used for
17252 header rewriting.
17253
17254
17255 .option same_domain_copy_routing dnslookup boolean false
17256 .cindex "address" "copying routing"
17257 Addresses with the same domain are normally routed by the &(dnslookup)& router
17258 to the same list of hosts. However, this cannot be presumed, because the router
17259 options and preconditions may refer to the local part of the address. By
17260 default, therefore, Exim routes each address in a message independently. DNS
17261 servers run caches, so repeated DNS lookups are not normally expensive, and in
17262 any case, personal messages rarely have more than a few recipients.
17263
17264 If you are running mailing lists with large numbers of subscribers at the same
17265 domain, and you are using a &(dnslookup)& router which is independent of the
17266 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17267 lookups for identical domains in one message. In this case, when &(dnslookup)&
17268 routes an address to a remote transport, any other unrouted addresses in the
17269 message that have the same domain are automatically given the same routing
17270 without processing them independently,
17271 provided the following conditions are met:
17272
17273 .ilist
17274 No router that processed the address specified &%headers_add%& or
17275 &%headers_remove%&.
17276 .next
17277 The router did not change the address in any way, for example, by &"widening"&
17278 the domain.
17279 .endlist
17280
17281
17282
17283
17284 .option search_parents dnslookup boolean false
17285 .cindex "DNS" "resolver options"
17286 When this option is true, the resolver option RES_DNSRCH is set for DNS
17287 lookups. This is different from the &%qualify_single%& option in that it
17288 applies to domains containing dots. Typically, but not standardly, it causes
17289 the resolver to search for the name in the current domain and in parent
17290 domains. For example, on a machine in the &'fict.example'& domain, if looking
17291 up &'teaparty.wonderland'& failed, the resolver would try
17292 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17293 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17294
17295 Setting this option true can cause problems in domains that have a wildcard MX
17296 record, because any domain that does not have its own MX record matches the
17297 local wildcard.
17298
17299
17300
17301 .option srv_fail_domains dnslookup "domain list&!!" unset
17302 If the DNS lookup for SRV records for one of the domains in this list causes a
17303 DNS lookup error, Exim behaves as if no SRV records were found. See section
17304 &<<SECTprowitdnsloo>>& for more discussion.
17305
17306
17307
17308
17309 .option widen_domains dnslookup "string list" unset
17310 .cindex "domain" "partial; widening"
17311 If a DNS lookup fails and this option is set, each of its strings in turn is
17312 added onto the end of the domain, and the lookup is tried again. For example,
17313 if
17314 .code
17315 widen_domains = fict.example:ref.example
17316 .endd
17317 is set and a lookup of &'klingon.dictionary'& fails,
17318 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17319 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17320 and &%search_parents%& options can cause some widening to be undertaken inside
17321 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17322 when verifying, unless &%rewrite_headers%& is false (not the default).
17323
17324
17325 .section "Effect of qualify_single and search_parents" "SECID119"
17326 When a domain from an envelope recipient is changed by the resolver as a result
17327 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17328 corresponding address in the message's header lines unless &%rewrite_headers%&
17329 is set false. Exim then re-routes the address, using the full domain.
17330
17331 These two options affect only the DNS lookup that takes place inside the router
17332 for the domain of the address that is being routed. They do not affect lookups
17333 such as that implied by
17334 .code
17335 domains = @mx_any
17336 .endd
17337 that may happen while processing a router precondition before the router is
17338 entered. No widening ever takes place for these lookups.
17339 .ecindex IIDdnsrou1
17340 .ecindex IIDdnsrou2
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350 . ////////////////////////////////////////////////////////////////////////////
17351 . ////////////////////////////////////////////////////////////////////////////
17352
17353 .chapter "The ipliteral router" "CHID5"
17354 .cindex "&(ipliteral)& router"
17355 .cindex "domain literal" "routing"
17356 .cindex "routers" "&(ipliteral)&"
17357 This router has no private options. Unless it is being used purely for
17358 verification (see &%verify_only%&) a transport is required to be defined by the
17359 generic &%transport%& option. The router accepts the address if its domain part
17360 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17361 router handles the address
17362 .code
17363 root@[192.168.1.1]
17364 .endd
17365 by setting up delivery to the host with that IP address. IPv4 domain literals
17366 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17367 are similar, but the address is preceded by &`ipv6:`&. For example:
17368 .code
17369 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17370 .endd
17371 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17372 grounds that sooner or later somebody will try it.
17373
17374 .oindex "&%self%&" "in &(ipliteral)& router"
17375 If the IP address matches something in &%ignore_target_hosts%&, the router
17376 declines. If an IP literal turns out to refer to the local host, the generic
17377 &%self%& option determines what happens.
17378
17379 The RFCs require support for domain literals; however, their use is
17380 controversial in today's Internet. If you want to use this router, you must
17381 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17382 Exim will not recognize the domain literal syntax in addresses.
17383
17384
17385
17386 . ////////////////////////////////////////////////////////////////////////////
17387 . ////////////////////////////////////////////////////////////////////////////
17388
17389 .chapter "The iplookup router" "CHID6"
17390 .cindex "&(iplookup)& router"
17391 .cindex "routers" "&(iplookup)&"
17392 The &(iplookup)& router was written to fulfil a specific requirement in
17393 Cambridge University (which in fact no longer exists). For this reason, it is
17394 not included in the binary of Exim by default. If you want to include it, you
17395 must set
17396 .code
17397 ROUTER_IPLOOKUP=yes
17398 .endd
17399 in your &_Local/Makefile_& configuration file.
17400
17401 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17402 connection to one or more specific hosts. The host can then return the same or
17403 a different address &-- in effect rewriting the recipient address in the
17404 message's envelope. The new address is then passed on to subsequent routers. If
17405 this process fails, the address can be passed on to other routers, or delivery
17406 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17407 must not be specified for it.
17408
17409 .cindex "options" "&(iplookup)& router"
17410 .option hosts iplookup string unset
17411 This option must be supplied. Its value is a colon-separated list of host
17412 names. The hosts are looked up using &[gethostbyname()]&
17413 (or &[getipnodebyname()]& when available)
17414 and are tried in order until one responds to the query. If none respond, what
17415 happens is controlled by &%optional%&.
17416
17417
17418 .option optional iplookup boolean false
17419 If &%optional%& is true, if no response is obtained from any host, the address
17420 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17421 delivery to the address is deferred.
17422
17423
17424 .option port iplookup integer 0
17425 .cindex "port" "&(iplookup)& router"
17426 This option must be supplied. It specifies the port number for the TCP or UDP
17427 call.
17428
17429
17430 .option protocol iplookup string udp
17431 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17432 protocols is to be used.
17433
17434
17435 .option query iplookup string&!! "see below"
17436 This defines the content of the query that is sent to the remote hosts. The
17437 default value is:
17438 .code
17439 $local_part@$domain $local_part@$domain
17440 .endd
17441 The repetition serves as a way of checking that a response is to the correct
17442 query in the default case (see &%response_pattern%& below).
17443
17444
17445 .option reroute iplookup string&!! unset
17446 If this option is not set, the rerouted address is precisely the byte string
17447 returned by the remote host, up to the first white space, if any. If set, the
17448 string is expanded to form the rerouted address. It can include parts matched
17449 in the response by &%response_pattern%& by means of numeric variables such as
17450 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17451 whether or not a pattern is in use. In all cases, the rerouted address must end
17452 up in the form &'local_part@domain'&.
17453
17454
17455 .option response_pattern iplookup string unset
17456 This option can be set to a regular expression that is applied to the string
17457 returned from the remote host. If the pattern does not match the response, the
17458 router declines. If &%response_pattern%& is not set, no checking of the
17459 response is done, unless the query was defaulted, in which case there is a
17460 check that the text returned after the first white space is the original
17461 address. This checks that the answer that has been received is in response to
17462 the correct question. For example, if the response is just a new domain, the
17463 following could be used:
17464 .code
17465 response_pattern = ^([^@]+)$
17466 reroute = $local_part@$1
17467 .endd
17468
17469 .option timeout iplookup time 5s
17470 This specifies the amount of time to wait for a response from the remote
17471 machine. The same timeout is used for the &[connect()]& function for a TCP
17472 call. It does not apply to UDP.
17473
17474
17475
17476
17477 . ////////////////////////////////////////////////////////////////////////////
17478 . ////////////////////////////////////////////////////////////////////////////
17479
17480 .chapter "The manualroute router" "CHID7"
17481 .scindex IIDmanrou1 "&(manualroute)& router"
17482 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17483 .cindex "domain" "manually routing"
17484 The &(manualroute)& router is so-called because it provides a way of manually
17485 routing an address according to its domain. It is mainly used when you want to
17486 route addresses to remote hosts according to your own rules, bypassing the
17487 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17488 route to local transports, a facility that may be useful if you want to save
17489 messages for dial-in hosts in local files.
17490
17491 The &(manualroute)& router compares a list of domain patterns with the domain
17492 it is trying to route. If there is no match, the router declines. Each pattern
17493 has associated with it a list of hosts and some other optional data, which may
17494 include a transport. The combination of a pattern and its data is called a
17495 &"routing rule"&. For patterns that do not have an associated transport, the
17496 generic &%transport%& option must specify a transport, unless the router is
17497 being used purely for verification (see &%verify_only%&).
17498
17499 .vindex "&$host$&"
17500 In the case of verification, matching the domain pattern is sufficient for the
17501 router to accept the address. When actually routing an address for delivery,
17502 an address that matches a domain pattern is queued for the associated
17503 transport. If the transport is not a local one, a host list must be associated
17504 with the pattern; IP addresses are looked up for the hosts, and these are
17505 passed to the transport along with the mail address. For local transports, a
17506 host list is optional. If it is present, it is passed in &$host$& as a single
17507 text string.
17508
17509 The list of routing rules can be provided as an inline string in
17510 &%route_list%&, or the data can be obtained by looking up the domain in a file
17511 or database by setting &%route_data%&. Only one of these settings may appear in
17512 any one instance of &(manualroute)&. The format of routing rules is described
17513 below, following the list of private options.
17514
17515
17516 .section "Private options for manualroute" "SECTprioptman"
17517
17518 .cindex "options" "&(manualroute)& router"
17519 The private options for the &(manualroute)& router are as follows:
17520
17521 .option host_all_ignored manualroute string defer
17522 See &%host_find_failed%&.
17523
17524 .option host_find_failed manualroute string freeze
17525 This option controls what happens when &(manualroute)& tries to find an IP
17526 address for a host, and the host does not exist. The option can be set to one
17527 of the following values:
17528 .code
17529 decline
17530 defer
17531 fail
17532 freeze
17533 ignore
17534 pass
17535 .endd
17536 The default (&"freeze"&) assumes that this state is a serious configuration
17537 error. The difference between &"pass"& and &"decline"& is that the former
17538 forces the address to be passed to the next router (or the router defined by
17539 &%pass_router%&),
17540 .oindex "&%more%&"
17541 overriding &%no_more%&, whereas the latter passes the address to the next
17542 router only if &%more%& is true.
17543
17544 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17545 cannot be found. If all the hosts in the list are ignored, the behaviour is
17546 controlled by the &%host_all_ignored%& option. This takes the same values
17547 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17548
17549 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17550 state; if a host lookup gets a temporary error, delivery is deferred unless the
17551 generic &%pass_on_timeout%& option is set.
17552
17553
17554 .option hosts_randomize manualroute boolean false
17555 .cindex "randomized host list"
17556 .cindex "host" "list of; randomized"
17557 If this option is set, the order of the items in a host list in a routing rule
17558 is randomized each time the list is used, unless an option in the routing rule
17559 overrides (see below). Randomizing the order of a host list can be used to do
17560 crude load sharing. However, if more than one mail address is routed by the
17561 same router to the same host list, the host lists are considered to be the same
17562 (even though they may be randomized into different orders) for the purpose of
17563 deciding whether to batch the deliveries into a single SMTP transaction.
17564
17565 When &%hosts_randomize%& is true, a host list may be split
17566 into groups whose order is separately randomized. This makes it possible to
17567 set up MX-like behaviour. The boundaries between groups are indicated by an
17568 item that is just &`+`& in the host list. For example:
17569 .code
17570 route_list = * host1:host2:host3:+:host4:host5
17571 .endd
17572 The order of the first three hosts and the order of the last two hosts is
17573 randomized for each use, but the first three always end up before the last two.
17574 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17575 randomized host list is passed to an &(smtp)& transport that also has
17576 &%hosts_randomize set%&, the list is not re-randomized.
17577
17578
17579 .option route_data manualroute string&!! unset
17580 If this option is set, it must expand to yield the data part of a routing rule.
17581 Typically, the expansion string includes a lookup based on the domain. For
17582 example:
17583 .code
17584 route_data = ${lookup{$domain}dbm{/etc/routes}}
17585 .endd
17586 If the expansion is forced to fail, or the result is an empty string, the
17587 router declines. Other kinds of expansion failure cause delivery to be
17588 deferred.
17589
17590
17591 .option route_list manualroute "string list" unset
17592 This string is a list of routing rules, in the form defined below. Note that,
17593 unlike most string lists, the items are separated by semicolons. This is so
17594 that they may contain colon-separated host lists.
17595
17596
17597 .option same_domain_copy_routing manualroute boolean false
17598 .cindex "address" "copying routing"
17599 Addresses with the same domain are normally routed by the &(manualroute)&
17600 router to the same list of hosts. However, this cannot be presumed, because the
17601 router options and preconditions may refer to the local part of the address. By
17602 default, therefore, Exim routes each address in a message independently. DNS
17603 servers run caches, so repeated DNS lookups are not normally expensive, and in
17604 any case, personal messages rarely have more than a few recipients.
17605
17606 If you are running mailing lists with large numbers of subscribers at the same
17607 domain, and you are using a &(manualroute)& router which is independent of the
17608 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17609 lookups for identical domains in one message. In this case, when
17610 &(manualroute)& routes an address to a remote transport, any other unrouted
17611 addresses in the message that have the same domain are automatically given the
17612 same routing without processing them independently. However, this is only done
17613 if &%headers_add%& and &%headers_remove%& are unset.
17614
17615
17616
17617
17618 .section "Routing rules in route_list" "SECID120"
17619 The value of &%route_list%& is a string consisting of a sequence of routing
17620 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17621 entered as two semicolons. Alternatively, the list separator can be changed as
17622 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17623 Empty rules are ignored. The format of each rule is
17624 .display
17625 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17626 .endd
17627 The following example contains two rules, each with a simple domain pattern and
17628 no options:
17629 .code
17630 route_list = \
17631   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17632   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17633 .endd
17634 The three parts of a rule are separated by white space. The pattern and the
17635 list of hosts can be enclosed in quotes if necessary, and if they are, the
17636 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17637 single domain pattern, which is the only mandatory item in the rule. The
17638 pattern is in the same format as one item in a domain list (see section
17639 &<<SECTdomainlist>>&),
17640 except that it may not be the name of an interpolated file.
17641 That is, it may be wildcarded, or a regular expression, or a file or database
17642 lookup (with semicolons doubled, because of the use of semicolon as a separator
17643 in a &%route_list%&).
17644
17645 The rules in &%route_list%& are searched in order until one of the patterns
17646 matches the domain that is being routed. The list of hosts and then options are
17647 then used as described below. If there is no match, the router declines. When
17648 &%route_list%& is set, &%route_data%& must not be set.
17649
17650
17651
17652 .section "Routing rules in route_data" "SECID121"
17653 The use of &%route_list%& is convenient when there are only a small number of
17654 routing rules. For larger numbers, it is easier to use a file or database to
17655 hold the routing information, and use the &%route_data%& option instead.
17656 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17657 Most commonly, &%route_data%& is set as a string that contains an
17658 expansion lookup. For example, suppose we place two routing rules in a file
17659 like this:
17660 .code
17661 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17662 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17663 .endd
17664 This data can be accessed by setting
17665 .code
17666 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17667 .endd
17668 Failure of the lookup results in an empty string, causing the router to
17669 decline. However, you do not have to use a lookup in &%route_data%&. The only
17670 requirement is that the result of expanding the string is a list of hosts,
17671 possibly followed by options, separated by white space. The list of hosts must
17672 be enclosed in quotes if it contains white space.
17673
17674
17675
17676
17677 .section "Format of the list of hosts" "SECID122"
17678 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17679 always separately expanded before use. If the expansion fails, the router
17680 declines. The result of the expansion must be a colon-separated list of names
17681 and/or IP addresses, optionally also including ports. The format of each item
17682 in the list is described in the next section. The list separator can be changed
17683 as described in section &<<SECTlistconstruct>>&.
17684
17685 If the list of hosts was obtained from a &%route_list%& item, the following
17686 variables are set during its expansion:
17687
17688 .ilist
17689 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17690 If the domain was matched against a regular expression, the numeric variables
17691 &$1$&, &$2$&, etc. may be set. For example:
17692 .code
17693 route_list = ^domain(\d+)   host-$1.text.example
17694 .endd
17695 .next
17696 &$0$& is always set to the entire domain.
17697 .next
17698 &$1$& is also set when partial matching is done in a file lookup.
17699
17700 .next
17701 .vindex "&$value$&"
17702 If the pattern that matched the domain was a lookup item, the data that was
17703 looked up is available in the expansion variable &$value$&. For example:
17704 .code
17705 route_list = lsearch;;/some/file.routes  $value
17706 .endd
17707 .endlist
17708
17709 Note the doubling of the semicolon in the pattern that is necessary because
17710 semicolon is the default route list separator.
17711
17712
17713
17714 .section "Format of one host item" "SECTformatonehostitem"
17715 Each item in the list of hosts is either a host name or an IP address,
17716 optionally with an attached port number. When no port is given, an IP address
17717 is not enclosed in brackets. When a port is specified, it overrides the port
17718 specification on the transport. The port is separated from the name or address
17719 by a colon. This leads to some complications:
17720
17721 .ilist
17722 Because colon is the default separator for the list of hosts, either
17723 the colon that specifies a port must be doubled, or the list separator must
17724 be changed. The following two examples have the same effect:
17725 .code
17726 route_list = * "host1.tld::1225 : host2.tld::1226"
17727 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17728 .endd
17729 .next
17730 When IPv6 addresses are involved, it gets worse, because they contain
17731 colons of their own. To make this case easier, it is permitted to
17732 enclose an IP address (either v4 or v6) in square brackets if a port
17733 number follows. For example:
17734 .code
17735 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17736 .endd
17737 .endlist
17738
17739 .section "How the list of hosts is used" "SECThostshowused"
17740 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17741 the hosts is tried, in the order specified, when carrying out the SMTP
17742 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17743 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17744 transport.
17745
17746 Hosts may be listed by name or by IP address. An unadorned name in the list of
17747 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17748 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17749 records in the DNS. For example:
17750 .code
17751 route_list = *  x.y.z:p.q.r/MX:e.f.g
17752 .endd
17753 If this feature is used with a port specifier, the port must come last. For
17754 example:
17755 .code
17756 route_list = *  dom1.tld/mx::1225
17757 .endd
17758 If the &%hosts_randomize%& option is set, the order of the items in the list is
17759 randomized before any lookups are done. Exim then scans the list; for any name
17760 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17761 be an interface on the local host and the item is not the first in the list,
17762 Exim discards it and any subsequent items. If it is the first item, what
17763 happens is controlled by the
17764 .oindex "&%self%&" "in &(manualroute)& router"
17765 &%self%& option of the router.
17766
17767 A name on the list that is followed by &`/MX`& is replaced with the list of
17768 hosts obtained by looking up MX records for the name. This is always a DNS
17769 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17770 below) are not relevant here. The order of these hosts is determined by the
17771 preference values in the MX records, according to the usual rules. Because
17772 randomizing happens before the MX lookup, it does not affect the order that is
17773 defined by MX preferences.
17774
17775 If the local host is present in the sublist obtained from MX records, but is
17776 not the most preferred host in that list, it and any equally or less
17777 preferred hosts are removed before the sublist is inserted into the main list.
17778
17779 If the local host is the most preferred host in the MX list, what happens
17780 depends on where in the original list of hosts the &`/MX`& item appears. If it
17781 is not the first item (that is, there are previous hosts in the main list),
17782 Exim discards this name and any subsequent items in the main list.
17783
17784 If the MX item is first in the list of hosts, and the local host is the
17785 most preferred host, what happens is controlled by the &%self%& option of the
17786 router.
17787
17788 DNS failures when lookup up the MX records are treated in the same way as DNS
17789 failures when looking up IP addresses: &%pass_on_timeout%& and
17790 &%host_find_failed%& are used when relevant.
17791
17792 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17793 whether obtained from an MX lookup or not.
17794
17795
17796
17797 .section "How the options are used" "SECThowoptused"
17798 The options are a sequence of words; in practice no more than three are ever
17799 present. One of the words can be the name of a transport; this overrides the
17800 &%transport%& option on the router for this particular routing rule only. The
17801 other words (if present) control randomization of the list of hosts on a
17802 per-rule basis, and how the IP addresses of the hosts are to be found when
17803 routing to a remote transport. These options are as follows:
17804
17805 .ilist
17806 &%randomize%&: randomize the order of the hosts in this list, overriding the
17807 setting of &%hosts_randomize%& for this routing rule only.
17808 .next
17809 &%no_randomize%&: do not randomize the order of the hosts in this list,
17810 overriding the setting of &%hosts_randomize%& for this routing rule only.
17811 .next
17812 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17813 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17814 also look in &_/etc/hosts_& or other sources of information.
17815 .next
17816 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17817 no address records are found. If there is a temporary DNS error (such as a
17818 timeout), delivery is deferred.
17819 .endlist
17820
17821 For example:
17822 .code
17823 route_list = domain1  host1:host2:host3  randomize bydns;\
17824              domain2  host4:host5
17825 .endd
17826 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17827 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17828 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17829 or &[gethostbyname()]&, and the result of the lookup is the result of that
17830 call.
17831
17832 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17833 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17834 instead of TRY_AGAIN. That is why the default action is to try a DNS
17835 lookup first. Only if that gives a definite &"no such host"& is the local
17836 function called.
17837
17838
17839
17840 If no IP address for a host can be found, what happens is controlled by the
17841 &%host_find_failed%& option.
17842
17843 .vindex "&$host$&"
17844 When an address is routed to a local transport, IP addresses are not looked up.
17845 The host list is passed to the transport in the &$host$& variable.
17846
17847
17848
17849 .section "Manualroute examples" "SECID123"
17850 In some of the examples that follow, the presence of the &%remote_smtp%&
17851 transport, as defined in the default configuration file, is assumed:
17852
17853 .ilist
17854 .cindex "smart host" "example router"
17855 The &(manualroute)& router can be used to forward all external mail to a
17856 &'smart host'&. If you have set up, in the main part of the configuration, a
17857 named domain list that contains your local domains, for example:
17858 .code
17859 domainlist local_domains = my.domain.example
17860 .endd
17861 You can arrange for all other domains to be routed to a smart host by making
17862 your first router something like this:
17863 .code
17864 smart_route:
17865   driver = manualroute
17866   domains = !+local_domains
17867   transport = remote_smtp
17868   route_list = * smarthost.ref.example
17869 .endd
17870 This causes all non-local addresses to be sent to the single host
17871 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17872 they are tried in order
17873 (but you can use &%hosts_randomize%& to vary the order each time).
17874 Another way of configuring the same thing is this:
17875 .code
17876 smart_route:
17877   driver = manualroute
17878   transport = remote_smtp
17879   route_list = !+local_domains  smarthost.ref.example
17880 .endd
17881 There is no difference in behaviour between these two routers as they stand.
17882 However, they behave differently if &%no_more%& is added to them. In the first
17883 example, the router is skipped if the domain does not match the &%domains%&
17884 precondition; the following router is always tried. If the router runs, it
17885 always matches the domain and so can never decline. Therefore, &%no_more%&
17886 would have no effect. In the second case, the router is never skipped; it
17887 always runs. However, if it doesn't match the domain, it declines. In this case
17888 &%no_more%& would prevent subsequent routers from running.
17889
17890 .next
17891 .cindex "mail hub example"
17892 A &'mail hub'& is a host which receives mail for a number of domains via MX
17893 records in the DNS and delivers it via its own private routing mechanism. Often
17894 the final destinations are behind a firewall, with the mail hub being the one
17895 machine that can connect to machines both inside and outside the firewall. The
17896 &(manualroute)& router is usually used on a mail hub to route incoming messages
17897 to the correct hosts. For a small number of domains, the routing can be inline,
17898 using the &%route_list%& option, but for a larger number a file or database
17899 lookup is easier to manage.
17900
17901 If the domain names are in fact the names of the machines to which the mail is
17902 to be sent by the mail hub, the configuration can be quite simple. For
17903 example:
17904 .code
17905 hub_route:
17906   driver = manualroute
17907   transport = remote_smtp
17908   route_list = *.rhodes.tvs.example  $domain
17909 .endd
17910 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17911 whose names are the same as the mail domains. A similar approach can be taken
17912 if the host name can be obtained from the domain name by a string manipulation
17913 that the expansion facilities can handle. Otherwise, a lookup based on the
17914 domain can be used to find the host:
17915 .code
17916 through_firewall:
17917   driver = manualroute
17918   transport = remote_smtp
17919   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17920 .endd
17921 The result of the lookup must be the name or IP address of the host (or
17922 hosts) to which the address is to be routed. If the lookup fails, the route
17923 data is empty, causing the router to decline. The address then passes to the
17924 next router.
17925
17926 .next
17927 .cindex "batched SMTP output example"
17928 .cindex "SMTP" "batched outgoing; example"
17929 You can use &(manualroute)& to deliver messages to pipes or files in batched
17930 SMTP format for onward transportation by some other means. This is one way of
17931 storing mail for a dial-up host when it is not connected. The route list entry
17932 can be as simple as a single domain name in a configuration like this:
17933 .code
17934 save_in_file:
17935   driver = manualroute
17936   transport = batchsmtp_appendfile
17937   route_list = saved.domain.example
17938 .endd
17939 though often a pattern is used to pick up more than one domain. If there are
17940 several domains or groups of domains with different transport requirements,
17941 different transports can be listed in the routing information:
17942 .code
17943 save_in_file:
17944   driver = manualroute
17945   route_list = \
17946     *.saved.domain1.example  $domain  batch_appendfile; \
17947     *.saved.domain2.example  \
17948       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17949       batch_pipe
17950 .endd
17951 .vindex "&$domain$&"
17952 .vindex "&$host$&"
17953 The first of these just passes the domain in the &$host$& variable, which
17954 doesn't achieve much (since it is also in &$domain$&), but the second does a
17955 file lookup to find a value to pass, causing the router to decline to handle
17956 the address if the lookup fails.
17957
17958 .next
17959 .cindex "UUCP" "example of router for"
17960 Routing mail directly to UUCP software is a specific case of the use of
17961 &(manualroute)& in a gateway to another mail environment. This is an example of
17962 one way it can be done:
17963 .code
17964 # Transport
17965 uucp:
17966   driver = pipe
17967   user = nobody
17968   command = /usr/local/bin/uux -r - \
17969     ${substr_-5:$host}!rmail ${local_part}
17970   return_fail_output = true
17971
17972 # Router
17973 uucphost:
17974   transport = uucp
17975   driver = manualroute
17976   route_data = \
17977     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17978 .endd
17979 The file &_/usr/local/exim/uucphosts_& contains entries like
17980 .code
17981 darksite.ethereal.example:           darksite.UUCP
17982 .endd
17983 It can be set up more simply without adding and removing &".UUCP"& but this way
17984 makes clear the distinction between the domain name
17985 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17986 .endlist
17987 .ecindex IIDmanrou1
17988 .ecindex IIDmanrou2
17989
17990
17991
17992
17993
17994
17995
17996
17997 . ////////////////////////////////////////////////////////////////////////////
17998 . ////////////////////////////////////////////////////////////////////////////
17999
18000 .chapter "The queryprogram router" "CHAPdriverlast"
18001 .scindex IIDquerou1 "&(queryprogram)& router"
18002 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18003 .cindex "routing" "by external program"
18004 The &(queryprogram)& router routes an address by running an external command
18005 and acting on its output. This is an expensive way to route, and is intended
18006 mainly for use in lightly-loaded systems, or for performing experiments.
18007 However, if it is possible to use the precondition options (&%domains%&,
18008 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18009 be used in special cases, even on a busy host. There are the following private
18010 options:
18011 .cindex "options" "&(queryprogram)& router"
18012
18013 .option command queryprogram string&!! unset
18014 This option must be set. It specifies the command that is to be run. The
18015 command is split up into a command name and arguments, and then each is
18016 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18017 &<<CHAPpipetransport>>&).
18018
18019
18020 .option command_group queryprogram string unset
18021 .cindex "gid (group id)" "in &(queryprogram)& router"
18022 This option specifies a gid to be set when running the command while routing an
18023 address for deliver. It must be set if &%command_user%& specifies a numerical
18024 uid. If it begins with a digit, it is interpreted as the numerical value of the
18025 gid. Otherwise it is looked up using &[getgrnam()]&.
18026
18027
18028 .option command_user queryprogram string unset
18029 .cindex "uid (user id)" "for &(queryprogram)&"
18030 This option must be set. It specifies the uid which is set when running the
18031 command while routing an address for delivery. If the value begins with a digit,
18032 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18033 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18034 not set, a value for the gid also.
18035
18036 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18037 root, which it does during a normal delivery in a conventional configuration.
18038 However, when an address is being verified during message reception, Exim is
18039 usually running as the Exim user, not as root. If the &(queryprogram)& router
18040 is called from a non-root process, Exim cannot change uid or gid before running
18041 the command. In this circumstance the command runs under the current uid and
18042 gid.
18043
18044
18045 .option current_directory queryprogram string /
18046 This option specifies an absolute path which is made the current directory
18047 before running the command.
18048
18049
18050 .option timeout queryprogram time 1h
18051 If the command does not complete within the timeout period, its process group
18052 is killed and the message is frozen. A value of zero time specifies no
18053 timeout.
18054
18055
18056 The standard output of the command is connected to a pipe, which is read when
18057 the command terminates. It should consist of a single line of output,
18058 containing up to five fields, separated by white space. The maximum length of
18059 the line is 1023 characters. Longer lines are silently truncated. The first
18060 field is one of the following words (case-insensitive):
18061
18062 .ilist
18063 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18064 below).
18065 .next
18066 &'Decline'&: the router declines; pass the address to the next router, unless
18067 &%no_more%& is set.
18068 .next
18069 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18070 subsequent text on the line is an error message. If the router is run as part
18071 of address verification during an incoming SMTP message, the message is
18072 included in the SMTP response.
18073 .next
18074 &'Defer'&: routing could not be completed at this time; try again later. Any
18075 subsequent text on the line is an error message which is logged. It is not
18076 included in any SMTP response.
18077 .next
18078 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18079 .next
18080 &'Pass'&: pass the address to the next router (or the router specified by
18081 &%pass_router%&), overriding &%no_more%&.
18082 .next
18083 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18084 new addresses, which are routed independently, starting with the first router,
18085 or the router specified by &%redirect_router%&, if set.
18086 .endlist
18087
18088 When the first word is &'accept'&, the remainder of the line consists of a
18089 number of keyed data values, as follows (split into two lines here, to fit on
18090 the page):
18091 .code
18092 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18093 LOOKUP=byname|bydns DATA=<text>
18094 .endd
18095 The data items can be given in any order, and all are optional. If no transport
18096 is included, the transport specified by the generic &%transport%& option is
18097 used. The list of hosts and the lookup type are needed only if the transport is
18098 an &(smtp)& transport that does not itself supply a list of hosts.
18099
18100 The format of the list of hosts is the same as for the &(manualroute)& router.
18101 As well as host names and IP addresses with optional port numbers, as described
18102 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18103 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18104 (see section &<<SECThostshowused>>&).
18105
18106 If the lookup type is not specified, Exim behaves as follows when trying to
18107 find an IP address for each host: First, a DNS lookup is done. If this yields
18108 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18109 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18110 result of the lookup is the result of that call.
18111
18112 .vindex "&$address_data$&"
18113 If the DATA field is set, its value is placed in the &$address_data$&
18114 variable. For example, this return line
18115 .code
18116 accept hosts=x1.y.example:x2.y.example data="rule1"
18117 .endd
18118 routes the address to the default transport, passing a list of two hosts. When
18119 the transport runs, the string &"rule1"& is in &$address_data$&.
18120 .ecindex IIDquerou1
18121 .ecindex IIDquerou2
18122
18123
18124
18125
18126 . ////////////////////////////////////////////////////////////////////////////
18127 . ////////////////////////////////////////////////////////////////////////////
18128
18129 .chapter "The redirect router" "CHAPredirect"
18130 .scindex IIDredrou1 "&(redirect)& router"
18131 .scindex IIDredrou2 "routers" "&(redirect)&"
18132 .cindex "alias file" "in a &(redirect)& router"
18133 .cindex "address redirection" "&(redirect)& router"
18134 The &(redirect)& router handles several kinds of address redirection. Its most
18135 common uses are for resolving local part aliases from a central alias file
18136 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18137 files, but it has many other potential uses. The incoming address can be
18138 redirected in several different ways:
18139
18140 .ilist
18141 It can be replaced by one or more new addresses which are themselves routed
18142 independently.
18143 .next
18144 It can be routed to be delivered to a given file or directory.
18145 .next
18146 It can be routed to be delivered to a specified pipe command.
18147 .next
18148 It can cause an automatic reply to be generated.
18149 .next
18150 It can be forced to fail, optionally with a custom error message.
18151 .next
18152 It can be temporarily deferred, optionally with a custom message.
18153 .next
18154 It can be discarded.
18155 .endlist
18156
18157 The generic &%transport%& option must not be set for &(redirect)& routers.
18158 However, there are some private options which define transports for delivery to
18159 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18160 &%pipe_transport%& and &%reply_transport%& descriptions below.
18161
18162
18163
18164 .section "Redirection data" "SECID124"
18165 The router operates by interpreting a text string which it obtains either by
18166 expanding the contents of the &%data%& option, or by reading the entire
18167 contents of a file whose name is given in the &%file%& option. These two
18168 options are mutually exclusive. The first is commonly used for handling system
18169 aliases, in a configuration like this:
18170 .code
18171 system_aliases:
18172   driver = redirect
18173   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18174 .endd
18175 If the lookup fails, the expanded string in this example is empty. When the
18176 expansion of &%data%& results in an empty string, the router declines. A forced
18177 expansion failure also causes the router to decline; other expansion failures
18178 cause delivery to be deferred.
18179
18180 A configuration using &%file%& is commonly used for handling users'
18181 &_.forward_& files, like this:
18182 .code
18183 userforward:
18184   driver = redirect
18185   check_local_user
18186   file = $home/.forward
18187   no_verify
18188 .endd
18189 If the file does not exist, or causes no action to be taken (for example, it is
18190 empty or consists only of comments), the router declines. &*Warning*&: This
18191 is not the case when the file contains syntactically valid items that happen to
18192 yield empty addresses, for example, items containing only RFC 2822 address
18193 comments.
18194
18195
18196
18197 .section "Forward files and address verification" "SECID125"
18198 .cindex "address redirection" "while verifying"
18199 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18200 &_.forward_& files, as in the example above. There are two reasons for this:
18201
18202 .ilist
18203 When Exim is receiving an incoming SMTP message from a remote host, it is
18204 running under the Exim uid, not as root. Exim is unable to change uid to read
18205 the file as the user, and it may not be able to read it as the Exim user. So in
18206 practice the router may not be able to operate.
18207 .next
18208 However, even when the router can operate, the existence of a &_.forward_& file
18209 is unimportant when verifying an address. What should be checked is whether the
18210 local part is a valid user name or not. Cutting out the redirection processing
18211 saves some resources.
18212 .endlist
18213
18214
18215
18216
18217
18218
18219 .section "Interpreting redirection data" "SECID126"
18220 .cindex "Sieve filter" "specifying in redirection data"
18221 .cindex "filter" "specifying in redirection data"
18222 The contents of the data string, whether obtained from &%data%& or &%file%&,
18223 can be interpreted in two different ways:
18224
18225 .ilist
18226 If the &%allow_filter%& option is set true, and the data begins with the text
18227 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18228 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18229 respectively. Details of the syntax and semantics of filter files are described
18230 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18231 document is intended for use by end users.
18232 .next
18233 Otherwise, the data must be a comma-separated list of redirection items, as
18234 described in the next section.
18235 .endlist
18236
18237 When a message is redirected to a file (a &"mail folder"&), the file name given
18238 in a non-filter redirection list must always be an absolute path. A filter may
18239 generate a relative path &-- how this is handled depends on the transport's
18240 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18241 for the &(appendfile)& transport.
18242
18243
18244
18245 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18246 .cindex "address redirection" "non-filter list items"
18247 When the redirection data is not an Exim or Sieve filter, for example, if it
18248 comes from a conventional alias or forward file, it consists of a list of
18249 addresses, file names, pipe commands, or certain special items (see section
18250 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18251 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18252 depending on their default values. The items in the list are separated by
18253 commas or newlines.
18254 If a comma is required in an item, the entire item must be enclosed in double
18255 quotes.
18256
18257 Lines starting with a # character are comments, and are ignored, and # may
18258 also appear following a comma, in which case everything between the # and the
18259 next newline character is ignored.
18260
18261 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18262 double quotes are retained because some forms of mail address require their use
18263 (but never to enclose the entire address). In the following description,
18264 &"item"& refers to what remains after any surrounding double quotes have been
18265 removed.
18266
18267 .vindex "&$local_part$&"
18268 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18269 and the expansion contains a reference to &$local_part$&, you should make use
18270 of the &%quote_local_part%& expansion operator, in case the local part contains
18271 special characters. For example, to redirect all mail for the domain
18272 &'obsolete.example'&, retaining the existing local part, you could use this
18273 setting:
18274 .code
18275 data = ${quote_local_part:$local_part}@newdomain.example
18276 .endd
18277
18278
18279 .section "Redirecting to a local mailbox" "SECTredlocmai"
18280 .cindex "routing" "loops in"
18281 .cindex "loop" "while routing, avoidance of"
18282 .cindex "address redirection" "to local mailbox"
18283 A redirection item may safely be the same as the address currently under
18284 consideration. This does not cause a routing loop, because a router is
18285 automatically skipped if any ancestor of the address that is being processed
18286 is the same as the current address and was processed by the current router.
18287 Such an address is therefore passed to the following routers, so it is handled
18288 as if there were no redirection. When making this loop-avoidance test, the
18289 complete local part, including any prefix or suffix, is used.
18290
18291 .cindex "address redirection" "local part without domain"
18292 Specifying the same local part without a domain is a common usage in personal
18293 filter files when the user wants to have messages delivered to the local
18294 mailbox and also forwarded elsewhere. For example, the user whose login is
18295 &'cleo'& might have a &_.forward_& file containing this:
18296 .code
18297 cleo, cleopatra@egypt.example
18298 .endd
18299 .cindex "backslash in alias file"
18300 .cindex "alias file" "backslash in"
18301 For compatibility with other MTAs, such unqualified local parts may be
18302 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18303 it does make a difference if more than one domain is being handled
18304 synonymously.
18305
18306 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18307 2822 address that does not include a domain, the item is qualified using the
18308 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18309 addresses are qualified using the value in &%qualify_recipient%&, but you can
18310 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18311
18312 Care must be taken if there are alias names for local users.
18313 Consider an MTA handling a single local domain where the system alias file
18314 contains:
18315 .code
18316 Sam.Reman: spqr
18317 .endd
18318 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18319 messages in the local mailbox, and also forward copies elsewhere. He creates
18320 this forward file:
18321 .code
18322 Sam.Reman, spqr@reme.elsewhere.example
18323 .endd
18324 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18325 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18326 second time round, because it has previously routed it,
18327 and the following routers presumably cannot handle the alias. The forward file
18328 should really contain
18329 .code
18330 spqr, spqr@reme.elsewhere.example
18331 .endd
18332 but because this is such a common error, the &%check_ancestor%& option (see
18333 below) exists to provide a way to get round it. This is normally set on a
18334 &(redirect)& router that is handling users' &_.forward_& files.
18335
18336
18337
18338 .section "Special items in redirection lists" "SECTspecitredli"
18339 In addition to addresses, the following types of item may appear in redirection
18340 lists (that is, in non-filter redirection data):
18341
18342 .ilist
18343 .cindex "pipe" "in redirection list"
18344 .cindex "address redirection" "to pipe"
18345 An item is treated as a pipe command if it begins with &"|"& and does not parse
18346 as a valid RFC 2822 address that includes a domain. A transport for running the
18347 command must be specified by the &%pipe_transport%& option.
18348 Normally, either the router or the transport specifies a user and a group under
18349 which to run the delivery. The default is to use the Exim user and group.
18350
18351 Single or double quotes can be used for enclosing the individual arguments of
18352 the pipe command; no interpretation of escapes is done for single quotes. If
18353 the command contains a comma character, it is necessary to put the whole item
18354 in double quotes, for example:
18355 .code
18356 "|/some/command ready,steady,go"
18357 .endd
18358 since items in redirection lists are terminated by commas. Do not, however,
18359 quote just the command. An item such as
18360 .code
18361 |"/some/command ready,steady,go"
18362 .endd
18363 is interpreted as a pipe with a rather strange command name, and no arguments.
18364
18365 .next
18366 .cindex "file" "in redirection list"
18367 .cindex "address redirection" "to file"
18368 An item is interpreted as a path name if it begins with &"/"& and does not
18369 parse as a valid RFC 2822 address that includes a domain. For example,
18370 .code
18371 /home/world/minbari
18372 .endd
18373 is treated as a file name, but
18374 .code
18375 /s=molari/o=babylon/@x400gate.way
18376 .endd
18377 is treated as an address. For a file name, a transport must be specified using
18378 the &%file_transport%& option. However, if the generated path name ends with a
18379 forward slash character, it is interpreted as a directory name rather than a
18380 file name, and &%directory_transport%& is used instead.
18381
18382 Normally, either the router or the transport specifies a user and a group under
18383 which to run the delivery. The default is to use the Exim user and group.
18384
18385 .cindex "&_/dev/null_&"
18386 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18387 bypassed at a high level, and the log entry shows &"**bypassed**"&
18388 instead of a transport name. In this case the user and group are not used.
18389
18390 .next
18391 .cindex "included address list"
18392 .cindex "address redirection" "included external list"
18393 If an item is of the form
18394 .code
18395 :include:<path name>
18396 .endd
18397 a list of further items is taken from the given file and included at that
18398 point. &*Note*&: Such a file can not be a filter file; it is just an
18399 out-of-line addition to the list. The items in the included list are separated
18400 by commas or newlines and are not subject to expansion. If this is the first
18401 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18402 the alias name. This example is incorrect:
18403 .code
18404 list1    :include:/opt/lists/list1
18405 .endd
18406 It must be given as
18407 .code
18408 list1:   :include:/opt/lists/list1
18409 .endd
18410 .next
18411 .cindex "address redirection" "to black hole"
18412 Sometimes you want to throw away mail to a particular local part. Making the
18413 &%data%& option expand to an empty string does not work, because that causes
18414 the router to decline. Instead, the alias item
18415 .cindex "black hole"
18416 .cindex "abandoning mail"
18417 &':blackhole:'& can be used. It does what its name implies. No delivery is
18418 done, and no error message is generated. This has the same effect as specifing
18419 &_/dev/null_& as a destination, but it can be independently disabled.
18420
18421 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18422 delivery is done for the original local part, even if other redirection items
18423 are present. If you are generating a multi-item list (for example, by reading a
18424 database) and need the ability to provide a no-op item, you must use
18425 &_/dev/null_&.
18426
18427 .next
18428 .cindex "delivery" "forcing failure"
18429 .cindex "delivery" "forcing deferral"
18430 .cindex "failing delivery" "forcing"
18431 .cindex "deferred delivery, forcing"
18432 .cindex "customizing" "failure message"
18433 An attempt to deliver a particular address can be deferred or forced to fail by
18434 redirection items of the form
18435 .code
18436 :defer:
18437 :fail:
18438 .endd
18439 respectively. When a redirection list contains such an item, it applies
18440 to the entire redirection; any other items in the list are ignored. Any
18441 text following &':fail:'& or &':defer:'& is placed in the error text
18442 associated with the failure. For example, an alias file might contain:
18443 .code
18444 X.Employee:  :fail: Gone away, no forwarding address
18445 .endd
18446 In the case of an address that is being verified from an ACL or as the subject
18447 of a
18448 .cindex "VRFY" "error text, display of"
18449 VRFY command, the text is included in the SMTP error response by
18450 default.
18451 .cindex "EXPN" "error text, display of"
18452 The text is not included in the response to an EXPN command. In non-SMTP cases
18453 the text is included in the error message that Exim generates.
18454
18455 .cindex "SMTP" "error codes"
18456 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18457 &':fail:'&. However, if the message starts with three digits followed by a
18458 space, optionally followed by an extended code of the form &'n.n.n'&, also
18459 followed by a space, and the very first digit is the same as the default error
18460 code, the code from the message is used instead. If the very first digit is
18461 incorrect, a panic error is logged, and the default code is used. You can
18462 suppress the use of the supplied code in a redirect router by setting the
18463 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18464 ignored.
18465
18466 .vindex "&$acl_verify_message$&"
18467 In an ACL, an explicitly provided message overrides the default, but the
18468 default message is available in the variable &$acl_verify_message$& and can
18469 therefore be included in a custom message if this is desired.
18470
18471 Normally the error text is the rest of the redirection list &-- a comma does
18472 not terminate it &-- but a newline does act as a terminator. Newlines are not
18473 normally present in alias expansions. In &(lsearch)& lookups they are removed
18474 as part of the continuation process, but they may exist in other kinds of
18475 lookup and in &':include:'& files.
18476
18477 During routing for message delivery (as opposed to verification), a redirection
18478 containing &':fail:'& causes an immediate failure of the incoming address,
18479 whereas &':defer:'& causes the message to remain on the queue so that a
18480 subsequent delivery attempt can happen at a later time. If an address is
18481 deferred for too long, it will ultimately fail, because the normal retry
18482 rules still apply.
18483
18484 .next
18485 .cindex "alias file" "exception to default"
18486 Sometimes it is useful to use a single-key search type with a default (see
18487 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18488 for exceptions to the default. These can be handled by aliasing them to
18489 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18490 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18491 results in an empty redirection list has the same effect.
18492 .endlist
18493
18494
18495 .section "Duplicate addresses" "SECTdupaddr"
18496 .cindex "duplicate addresses"
18497 .cindex "address duplicate, discarding"
18498 .cindex "pipe" "duplicated"
18499 Exim removes duplicate addresses from the list to which it is delivering, so as
18500 to deliver just one copy to each address. This does not apply to deliveries
18501 routed to pipes by different immediate parent addresses, but an indirect
18502 aliasing scheme of the type
18503 .code
18504 pipe:       |/some/command $local_part
18505 localpart1: pipe
18506 localpart2: pipe
18507 .endd
18508 does not work with a message that is addressed to both local parts, because
18509 when the second is aliased to the intermediate local part &"pipe"& it gets
18510 discarded as being the same as a previously handled address. However, a scheme
18511 such as
18512 .code
18513 localpart1: |/some/command $local_part
18514 localpart2: |/some/command $local_part
18515 .endd
18516 does result in two different pipe deliveries, because the immediate parents of
18517 the pipes are distinct.
18518
18519
18520
18521 .section "Repeated redirection expansion" "SECID128"
18522 .cindex "repeated redirection expansion"
18523 .cindex "address redirection" "repeated for each delivery attempt"
18524 When a message cannot be delivered to all of its recipients immediately,
18525 leading to two or more delivery attempts, redirection expansion is carried out
18526 afresh each time for those addresses whose children were not all previously
18527 delivered. If redirection is being used as a mailing list, this can lead to new
18528 members of the list receiving copies of old messages. The &%one_time%& option
18529 can be used to avoid this.
18530
18531
18532 .section "Errors in redirection lists" "SECID129"
18533 .cindex "address redirection" "errors"
18534 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18535 error is skipped, and an entry is written to the main log. This may be useful
18536 for mailing lists that are automatically managed. Otherwise, if an error is
18537 detected while generating the list of new addresses, the original address is
18538 deferred. See also &%syntax_errors_to%&.
18539
18540
18541
18542 .section "Private options for the redirect router" "SECID130"
18543
18544 .cindex "options" "&(redirect)& router"
18545 The private options for the &(redirect)& router are as follows:
18546
18547
18548 .option allow_defer redirect boolean false
18549 Setting this option allows the use of &':defer:'& in non-filter redirection
18550 data, or the &%defer%& command in an Exim filter file.
18551
18552
18553 .option allow_fail redirect boolean false
18554 .cindex "failing delivery" "from filter"
18555 If this option is true, the &':fail:'& item can be used in a redirection list,
18556 and the &%fail%& command may be used in an Exim filter file.
18557
18558
18559 .option allow_filter redirect boolean false
18560 .cindex "filter" "enabling use of"
18561 .cindex "Sieve filter" "enabling use of"
18562 Setting this option allows Exim to interpret redirection data that starts with
18563 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18564 are some features of Exim filter files that some administrators may wish to
18565 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18566
18567 It is also possible to lock out Exim filters or Sieve filters while allowing
18568 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18569
18570
18571 The filter is run using the uid and gid set by the generic &%user%& and
18572 &%group%& options. These take their defaults from the password data if
18573 &%check_local_user%& is set, so in the normal case of users' personal filter
18574 files, the filter is run as the relevant user. When &%allow_filter%& is set
18575 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18576
18577
18578
18579 .option allow_freeze redirect boolean false
18580 .cindex "freezing messages" "allowing in filter"
18581 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18582 This command is more normally encountered in system filters, and is disabled by
18583 default for redirection filters because it isn't something you usually want to
18584 let ordinary users do.
18585
18586
18587
18588 .option check_ancestor redirect boolean false
18589 This option is concerned with handling generated addresses that are the same
18590 as some address in the list of redirection ancestors of the current address.
18591 Although it is turned off by default in the code, it is set in the default
18592 configuration file for handling users' &_.forward_& files. It is recommended
18593 for this use of the &(redirect)& router.
18594
18595 When &%check_ancestor%& is set, if a generated address (including the domain)
18596 is the same as any ancestor of the current address, it is replaced by a copy of
18597 the current address. This helps in the case where local part A is aliased to B,
18598 and B has a &_.forward_& file pointing back to A. For example, within a single
18599 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18600 &_&~jb/.forward_& contains:
18601 .code
18602 \Joe.Bloggs, <other item(s)>
18603 .endd
18604 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18605 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18606 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18607 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18608 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18609 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18610 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18611 original address. See also the &%repeat_use%& option below.
18612
18613
18614 .option check_group redirect boolean "see below"
18615 When the &%file%& option is used, the group owner of the file is checked only
18616 when this option is set. The permitted groups are those listed in the
18617 &%owngroups%& option, together with the user's default group if
18618 &%check_local_user%& is set. If the file has the wrong group, routing is
18619 deferred. The default setting for this option is true if &%check_local_user%&
18620 is set and the &%modemask%& option permits the group write bit, or if the
18621 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18622
18623
18624
18625 .option check_owner redirect boolean "see below"
18626 When the &%file%& option is used, the owner of the file is checked only when
18627 this option is set. If &%check_local_user%& is set, the local user is
18628 permitted; otherwise the owner must be one of those listed in the &%owners%&
18629 option. The default value for this option is true if &%check_local_user%& or
18630 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18631
18632
18633 .option data redirect string&!! unset
18634 This option is mutually exclusive with &%file%&. One or other of them must be
18635 set, but not both. The contents of &%data%& are expanded, and then used as the
18636 list of forwarding items, or as a set of filtering instructions. If the
18637 expansion is forced to fail, or the result is an empty string or a string that
18638 has no effect (consists entirely of comments), the router declines.
18639
18640 When filtering instructions are used, the string must begin with &"#Exim
18641 filter"&, and all comments in the string, including this initial one, must be
18642 terminated with newline characters. For example:
18643 .code
18644 data = #Exim filter\n\
18645        if $h_to: contains Exim then save $home/mail/exim endif
18646 .endd
18647 If you are reading the data from a database where newlines cannot be included,
18648 you can use the &${sg}$& expansion item to turn the escape string of your
18649 choice into a newline.
18650
18651
18652 .option directory_transport redirect string&!! unset
18653 A &(redirect)& router sets up a direct delivery to a directory when a path name
18654 ending with a slash is specified as a new &"address"&. The transport used is
18655 specified by this option, which, after expansion, must be the name of a
18656 configured transport. This should normally be an &(appendfile)& transport.
18657
18658
18659 .option file redirect string&!! unset
18660 This option specifies the name of a file that contains the redirection data. It
18661 is mutually exclusive with the &%data%& option. The string is expanded before
18662 use; if the expansion is forced to fail, the router declines. Other expansion
18663 failures cause delivery to be deferred. The result of a successful expansion
18664 must be an absolute path. The entire file is read and used as the redirection
18665 data. If the data is an empty string or a string that has no effect (consists
18666 entirely of comments), the router declines.
18667
18668 .cindex "NFS" "checking for file existence"
18669 If the attempt to open the file fails with a &"does not exist"& error, Exim
18670 runs a check on the containing directory,
18671 unless &%ignore_enotdir%& is true (see below).
18672 If the directory does not appear to exist, delivery is deferred. This can
18673 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18674 is a mount problem. If the containing directory does exist, but the file does
18675 not, the router declines.
18676
18677
18678 .option file_transport redirect string&!! unset
18679 .vindex "&$address_file$&"
18680 A &(redirect)& router sets up a direct delivery to a file when a path name not
18681 ending in a slash is specified as a new &"address"&. The transport used is
18682 specified by this option, which, after expansion, must be the name of a
18683 configured transport. This should normally be an &(appendfile)& transport. When
18684 it is running, the file name is in &$address_file$&.
18685
18686
18687 .option filter_prepend_home redirect boolean true
18688 When this option is true, if a &(save)& command in an Exim filter specifies a
18689 relative path, and &$home$& is defined, it is automatically prepended to the
18690 relative path. If this option is set false, this action does not happen. The
18691 relative path is then passed to the transport unmodified.
18692
18693
18694 .option forbid_blackhole redirect boolean false
18695 If this option is true, the &':blackhole:'& item may not appear in a
18696 redirection list.
18697
18698
18699 .option forbid_exim_filter redirect boolean false
18700 If this option is set true, only Sieve filters are permitted when
18701 &%allow_filter%& is true.
18702
18703
18704
18705
18706 .option forbid_file redirect boolean false
18707 .cindex "delivery" "to file; forbidding"
18708 .cindex "Sieve filter" "forbidding delivery to a file"
18709 .cindex "Sieve filter" "&""keep""& facility; disabling"
18710 If this option is true, this router may not generate a new address that
18711 specifies delivery to a local file or directory, either from a filter or from a
18712 conventional forward file. This option is forced to be true if &%one_time%& is
18713 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18714 locks out the Sieve's &"keep"& facility.
18715
18716
18717 .option forbid_filter_dlfunc redirect boolean false
18718 .cindex "filter" "locking out certain features"
18719 If this option is true, string expansions in Exim filters are not allowed to
18720 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18721 functions.
18722
18723 .option forbid_filter_existstest redirect boolean false
18724 .cindex "expansion" "statting a file"
18725 If this option is true, string expansions in Exim filters are not allowed to
18726 make use of the &%exists%& condition or the &%stat%& expansion item.
18727
18728 .option forbid_filter_logwrite redirect boolean false
18729 If this option is true, use of the logging facility in Exim filters is not
18730 permitted. Logging is in any case available only if the filter is being run
18731 under some unprivileged uid (which is normally the case for ordinary users'
18732 &_.forward_& files).
18733
18734
18735 .option forbid_filter_lookup redirect boolean false
18736 If this option is true, string expansions in Exim filter files are not allowed
18737 to make use of &%lookup%& items.
18738
18739
18740 .option forbid_filter_perl redirect boolean false
18741 This option has an effect only if Exim is built with embedded Perl support. If
18742 it is true, string expansions in Exim filter files are not allowed to make use
18743 of the embedded Perl support.
18744
18745
18746 .option forbid_filter_readfile redirect boolean false
18747 If this option is true, string expansions in Exim filter files are not allowed
18748 to make use of &%readfile%& items.
18749
18750
18751 .option forbid_filter_readsocket redirect boolean false
18752 If this option is true, string expansions in Exim filter files are not allowed
18753 to make use of &%readsocket%& items.
18754
18755
18756 .option forbid_filter_reply redirect boolean false
18757 If this option is true, this router may not generate an automatic reply
18758 message. Automatic replies can be generated only from Exim or Sieve filter
18759 files, not from traditional forward files. This option is forced to be true if
18760 &%one_time%& is set.
18761
18762
18763 .option forbid_filter_run redirect boolean false
18764 If this option is true, string expansions in Exim filter files are not allowed
18765 to make use of &%run%& items.
18766
18767
18768 .option forbid_include redirect boolean false
18769 If this option is true, items of the form
18770 .code
18771 :include:<path name>
18772 .endd
18773 are not permitted in non-filter redirection lists.
18774
18775
18776 .option forbid_pipe redirect boolean false
18777 .cindex "delivery" "to pipe; forbidding"
18778 If this option is true, this router may not generate a new address which
18779 specifies delivery to a pipe, either from an Exim filter or from a conventional
18780 forward file. This option is forced to be true if &%one_time%& is set.
18781
18782
18783 .option forbid_sieve_filter redirect boolean false
18784 If this option is set true, only Exim filters are permitted when
18785 &%allow_filter%& is true.
18786
18787
18788 .cindex "SMTP" "error codes"
18789 .option forbid_smtp_code redirect boolean false
18790 If this option is set true, any SMTP error codes that are present at the start
18791 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18792 the default codes (451 and 550, respectively) are always used.
18793
18794
18795
18796
18797 .option hide_child_in_errmsg redirect boolean false
18798 .cindex "bounce message" "redirection details; suppressing"
18799 If this option is true, it prevents Exim from quoting a child address if it
18800 generates a bounce or delay message for it. Instead it says &"an address
18801 generated from <&'the top level address'&>"&. Of course, this applies only to
18802 bounces generated locally. If a message is forwarded to another host, &'its'&
18803 bounce may well quote the generated address.
18804
18805
18806 .option ignore_eacces redirect boolean false
18807 .cindex "EACCES"
18808 If this option is set and an attempt to open a redirection file yields the
18809 EACCES error (permission denied), the &(redirect)& router behaves as if the
18810 file did not exist.
18811
18812
18813 .option ignore_enotdir redirect boolean false
18814 .cindex "ENOTDIR"
18815 If this option is set and an attempt to open a redirection file yields the
18816 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18817 router behaves as if the file did not exist.
18818
18819 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18820 router that has the &%file%& option set discovers that the file does not exist
18821 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18822 against unmounted NFS directories. If the parent can not be statted, delivery
18823 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18824 is set, because that option tells Exim to ignore &"something on the path is not
18825 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18826 that some operating systems give ENOENT where others give ENOTDIR.
18827
18828
18829
18830 .option include_directory redirect string unset
18831 If this option is set, the path names of any &':include:'& items in a
18832 redirection list must start with this directory.
18833
18834
18835 .option modemask redirect "octal integer" 022
18836 This specifies mode bits which must not be set for a file specified by the
18837 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18838
18839
18840 .option one_time redirect boolean false
18841 .cindex "one-time aliasing/forwarding expansion"
18842 .cindex "alias file" "one-time expansion"
18843 .cindex "forward file" "one-time expansion"
18844 .cindex "mailing lists" "one-time expansion"
18845 .cindex "address redirection" "one-time expansion"
18846 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18847 files each time it tries to deliver a message causes a problem when one or more
18848 of the generated addresses fails be delivered at the first attempt. The problem
18849 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18850 but of what happens when the redirection list changes during the time that the
18851 message is on Exim's queue. This is particularly true in the case of mailing
18852 lists, where new subscribers might receive copies of messages that were posted
18853 before they subscribed.
18854
18855 If &%one_time%& is set and any addresses generated by the router fail to
18856 deliver at the first attempt, the failing addresses are added to the message as
18857 &"top level"& addresses, and the parent address that generated them is marked
18858 &"delivered"&. Thus, redirection does not happen again at the next delivery
18859 attempt.
18860
18861 &*Warning 1*&: Any header line addition or removal that is specified by this
18862 router would be lost if delivery did not succeed at the first attempt. For this
18863 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18864 permitted when &%one_time%& is set.
18865
18866 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18867 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18868 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18869
18870 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18871 &%one_time%&.
18872
18873 The original top-level address is remembered with each of the generated
18874 addresses, and is output in any log messages. However, any intermediate parent
18875 addresses are not recorded. This makes a difference to the log only if
18876 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18877 typically be used for mailing lists, where there is normally just one level of
18878 expansion.
18879
18880
18881 .option owners redirect "string list" unset
18882 .cindex "ownership" "alias file"
18883 .cindex "ownership" "forward file"
18884 .cindex "alias file" "ownership"
18885 .cindex "forward file" "ownership"
18886 This specifies a list of permitted owners for the file specified by &%file%&.
18887 This list is in addition to the local user when &%check_local_user%& is set.
18888 See &%check_owner%& above.
18889
18890
18891 .option owngroups redirect "string list" unset
18892 This specifies a list of permitted groups for the file specified by &%file%&.
18893 The list is in addition to the local user's primary group when
18894 &%check_local_user%& is set. See &%check_group%& above.
18895
18896
18897 .option pipe_transport redirect string&!! unset
18898 .vindex "&$address_pipe$&"
18899 A &(redirect)& router sets up a direct delivery to a pipe when a string
18900 starting with a vertical bar character is specified as a new &"address"&. The
18901 transport used is specified by this option, which, after expansion, must be the
18902 name of a configured transport. This should normally be a &(pipe)& transport.
18903 When the transport is run, the pipe command is in &$address_pipe$&.
18904
18905
18906 .option qualify_domain redirect string&!! unset
18907 .vindex "&$qualify_recipient$&"
18908 If this option is set, and an unqualified address (one without a domain) is
18909 generated, and that address would normally be qualified by the global setting
18910 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18911 expanding this string. If the expansion fails, the router declines. If you want
18912 to revert to the default, you can have the expansion generate
18913 &$qualify_recipient$&.
18914
18915 This option applies to all unqualified addresses generated by Exim filters,
18916 but for traditional &_.forward_& files, it applies only to addresses that are
18917 not preceded by a backslash. Sieve filters cannot generate unqualified
18918 addresses.
18919
18920 .option qualify_preserve_domain redirect boolean false
18921 .cindex "domain" "in redirection; preserving"
18922 .cindex "preserving domain in redirection"
18923 .cindex "address redirection" "domain; preserving"
18924 If this option is set, the router's local &%qualify_domain%& option must not be
18925 set (a configuration error occurs if it is). If an unqualified address (one
18926 without a domain) is generated, it is qualified with the domain of the parent
18927 address (the immediately preceding ancestor) instead of the global
18928 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18929 this applies whether or not the address is preceded by a backslash.
18930
18931
18932 .option repeat_use redirect boolean true
18933 If this option is set false, the router is skipped for a child address that has
18934 any ancestor that was routed by this router. This test happens before any of
18935 the other preconditions are tested. Exim's default anti-looping rules skip
18936 only when the ancestor is the same as the current address. See also
18937 &%check_ancestor%& above and the generic &%redirect_router%& option.
18938
18939
18940 .option reply_transport redirect string&!! unset
18941 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18942 &%vacation%& command is used in a filter file. The transport used is specified
18943 by this option, which, after expansion, must be the name of a configured
18944 transport. This should normally be an &(autoreply)& transport. Other transports
18945 are unlikely to do anything sensible or useful.
18946
18947
18948 .option rewrite redirect boolean true
18949 .cindex "address redirection" "disabling rewriting"
18950 If this option is set false, addresses generated by the router are not
18951 subject to address rewriting. Otherwise, they are treated like new addresses
18952 and are rewritten according to the global rewriting rules.
18953
18954
18955 .option sieve_subaddress redirect string&!! unset
18956 The value of this option is passed to a Sieve filter to specify the
18957 :subaddress part of an address.
18958
18959 .option sieve_useraddress redirect string&!! unset
18960 The value of this option is passed to a Sieve filter to specify the :user part
18961 of an address. However, if it is unset, the entire original local part
18962 (including any prefix or suffix) is used for :user.
18963
18964
18965 .option sieve_vacation_directory redirect string&!! unset
18966 .cindex "Sieve filter" "vacation directory"
18967 To enable the &"vacation"& extension for Sieve filters, you must set
18968 &%sieve_vacation_directory%& to the directory where vacation databases are held
18969 (do not put anything else in that directory), and ensure that the
18970 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18971 needs their own directory; Exim will create it if necessary.
18972
18973
18974
18975 .option skip_syntax_errors redirect boolean false
18976 .cindex "forward file" "broken"
18977 .cindex "address redirection" "broken files"
18978 .cindex "alias file" "broken"
18979 .cindex "broken alias or forward files"
18980 .cindex "ignoring faulty addresses"
18981 .cindex "skipping faulty addresses"
18982 .cindex "error" "skipping bad syntax"
18983 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18984 non-filter redirection data are skipped, and each failing address is logged. If
18985 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18986 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18987 are expanded and placed at the head of the error message generated by
18988 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18989 be the same address as the generic &%errors_to%& option. The
18990 &%skip_syntax_errors%& option is often used when handling mailing lists.
18991
18992 If all the addresses in a redirection list are skipped because of syntax
18993 errors, the router declines to handle the original address, and it is passed to
18994 the following routers.
18995
18996 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18997 error in the filter causes filtering to be abandoned without any action being
18998 taken. The incident is logged, and the router declines to handle the address,
18999 so it is passed to the following routers.
19000
19001 .cindex "Sieve filter" "syntax errors in"
19002 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19003 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19004 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19005
19006 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19007 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19008 option, used with an address that does not get redirected, can be used to
19009 notify users of these errors, by means of a router like this:
19010 .code
19011 userforward:
19012   driver = redirect
19013   allow_filter
19014   check_local_user
19015   file = $home/.forward
19016   file_transport = address_file
19017   pipe_transport = address_pipe
19018   reply_transport = address_reply
19019   no_verify
19020   skip_syntax_errors
19021   syntax_errors_to = real-$local_part@$domain
19022   syntax_errors_text = \
19023    This is an automatically generated message. An error has\n\
19024    been found in your .forward file. Details of the error are\n\
19025    reported below. While this error persists, you will receive\n\
19026    a copy of this message for every message that is addressed\n\
19027    to you. If your .forward file is a filter file, or if it is\n\
19028    a non-filter file containing no valid forwarding addresses,\n\
19029    a copy of each incoming message will be put in your normal\n\
19030    mailbox. If a non-filter file contains at least one valid\n\
19031    forwarding address, forwarding to the valid addresses will\n\
19032    happen, and those will be the only deliveries that occur.
19033 .endd
19034 You also need a router to ensure that local addresses that are prefixed by
19035 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19036 put this immediately before the &(userforward)& router:
19037 .code
19038 real_localuser:
19039   driver = accept
19040   check_local_user
19041   local_part_prefix = real-
19042   transport = local_delivery
19043 .endd
19044 For security, it would probably be a good idea to restrict the use of this
19045 router to locally-generated messages, using a condition such as this:
19046 .code
19047   condition = ${if match {$sender_host_address}\
19048                          {\N^(|127\.0\.0\.1)$\N}}
19049 .endd
19050
19051
19052 .option syntax_errors_text redirect string&!! unset
19053 See &%skip_syntax_errors%& above.
19054
19055
19056 .option syntax_errors_to redirect string unset
19057 See &%skip_syntax_errors%& above.
19058 .ecindex IIDredrou1
19059 .ecindex IIDredrou2
19060
19061
19062
19063
19064
19065
19066 . ////////////////////////////////////////////////////////////////////////////
19067 . ////////////////////////////////////////////////////////////////////////////
19068
19069 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19070          "Environment for local transports"
19071 .scindex IIDenvlotra1 "local transports" "environment for"
19072 .scindex IIDenvlotra2 "environment for local transports"
19073 .scindex IIDenvlotra3 "transport" "local; environment for"
19074 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19075 transport can be thought of as similar to a pipe.) Exim always runs transports
19076 in subprocesses, under specified uids and gids. Typical deliveries to local
19077 mailboxes run under the uid and gid of the local user.
19078
19079 Exim also sets a specific current directory while running the transport; for
19080 some transports a home directory setting is also relevant. The &(pipe)&
19081 transport is the only one that sets up environment variables; see section
19082 &<<SECTpipeenv>>& for details.
19083
19084 The values used for the uid, gid, and the directories may come from several
19085 different places. In many cases, the router that handles the address associates
19086 settings with that address as a result of its &%check_local_user%&, &%group%&,
19087 or &%user%& options. However, values may also be given in the transport's own
19088 configuration, and these override anything that comes from the router.
19089
19090
19091
19092 .section "Concurrent deliveries" "SECID131"
19093 .cindex "concurrent deliveries"
19094 .cindex "simultaneous deliveries"
19095 If two different messages for the same local recipient arrive more or less
19096 simultaneously, the two delivery processes are likely to run concurrently. When
19097 the &(appendfile)& transport is used to write to a file, Exim applies locking
19098 rules to stop concurrent processes from writing to the same file at the same
19099 time.
19100
19101 However, when you use a &(pipe)& transport, it is up to you to arrange any
19102 locking that is needed. Here is a silly example:
19103 .code
19104 my_transport:
19105   driver = pipe
19106   command = /bin/sh -c 'cat >>/some/file'
19107 .endd
19108 This is supposed to write the message at the end of the file. However, if two
19109 messages arrive at the same time, the file will be scrambled. You can use the
19110 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19111 file using the same algorithm that Exim itself uses.
19112
19113
19114
19115
19116 .section "Uids and gids" "SECTenvuidgid"
19117 .cindex "local transports" "uid and gid"
19118 .cindex "transport" "local; uid and gid"
19119 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19120 overrides any group that the router set in the address, even if &%user%& is not
19121 set for the transport. This makes it possible, for example, to run local mail
19122 delivery under the uid of the recipient (set by the router), but in a special
19123 group (set by the transport). For example:
19124 .code
19125 # Routers ...
19126 # User/group are set by check_local_user in this router
19127 local_users:
19128   driver = accept
19129   check_local_user
19130   transport = group_delivery
19131
19132 # Transports ...
19133 # This transport overrides the group
19134 group_delivery:
19135   driver = appendfile
19136   file = /var/spool/mail/$local_part
19137   group = mail
19138 .endd
19139 If &%user%& is set for a transport, its value overrides what is set in the
19140 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19141 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19142 set.
19143
19144 .oindex "&%initgroups%&"
19145 When the uid is taken from the transport's configuration, the &[initgroups()]&
19146 function is called for the groups associated with that uid if the
19147 &%initgroups%& option is set for the transport. When the uid is not specified
19148 by the transport, but is associated with the address by a router, the option
19149 for calling &[initgroups()]& is taken from the router configuration.
19150
19151 .cindex "&(pipe)& transport" "uid for"
19152 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19153 is set and &%user%& is not set, the uid of the process that called Exim to
19154 receive the message is used, and if &%group%& is not set, the corresponding
19155 original gid is also used.
19156
19157 This is the detailed preference order for obtaining a gid; the first of the
19158 following that is set is used:
19159
19160 .ilist
19161 A &%group%& setting of the transport;
19162 .next
19163 A &%group%& setting of the router;
19164 .next
19165 A gid associated with a user setting of the router, either as a result of
19166 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19167 .next
19168 The group associated with a non-numeric &%user%& setting of the transport;
19169 .next
19170 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19171 the uid is the creator's uid;
19172 .next
19173 The Exim gid if the Exim uid is being used as a default.
19174 .endlist
19175
19176 If, for example, the user is specified numerically on the router and there are
19177 no group settings, no gid is available. In this situation, an error occurs.
19178 This is different for the uid, for which there always is an ultimate default.
19179 The first of the following that is set is used:
19180
19181 .ilist
19182 A &%user%& setting of the transport;
19183 .next
19184 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19185 .next
19186 A &%user%& setting of the router;
19187 .next
19188 A &%check_local_user%& setting of the router;
19189 .next
19190 The Exim uid.
19191 .endlist
19192
19193 Of course, an error will still occur if the uid that is chosen is on the
19194 &%never_users%& list.
19195
19196
19197
19198
19199
19200 .section "Current and home directories" "SECID132"
19201 .cindex "current directory for local transport"
19202 .cindex "home directory" "for local transport"
19203 .cindex "transport" "local; home directory for"
19204 .cindex "transport" "local; current directory for"
19205 Routers may set current and home directories for local transports by means of
19206 the &%transport_current_directory%& and &%transport_home_directory%& options.
19207 However, if the transport's &%current_directory%& or &%home_directory%& options
19208 are set, they override the router's values. In detail, the home directory
19209 for a local transport is taken from the first of these values that is set:
19210
19211 .ilist
19212 The &%home_directory%& option on the transport;
19213 .next
19214 The &%transport_home_directory%& option on the router;
19215 .next
19216 The password data if &%check_local_user%& is set on the router;
19217 .next
19218 The &%router_home_directory%& option on the router.
19219 .endlist
19220
19221 The current directory is taken from the first of these values that is set:
19222
19223 .ilist
19224 The &%current_directory%& option on the transport;
19225 .next
19226 The &%transport_current_directory%& option on the router.
19227 .endlist
19228
19229
19230 If neither the router nor the transport sets a current directory, Exim uses the
19231 value of the home directory, if it is set. Otherwise it sets the current
19232 directory to &_/_& before running a local transport.
19233
19234
19235
19236 .section "Expansion variables derived from the address" "SECID133"
19237 .vindex "&$domain$&"
19238 .vindex "&$local_part$&"
19239 .vindex "&$original_domain$&"
19240 Normally a local delivery is handling a single address, and in that case the
19241 variables such as &$domain$& and &$local_part$& are set during local
19242 deliveries. However, in some circumstances more than one address may be handled
19243 at once (for example, while writing batch SMTP for onward transmission by some
19244 other means). In this case, the variables associated with the local part are
19245 never set, &$domain$& is set only if all the addresses have the same domain,
19246 and &$original_domain$& is never set.
19247 .ecindex IIDenvlotra1
19248 .ecindex IIDenvlotra2
19249 .ecindex IIDenvlotra3
19250
19251
19252
19253
19254
19255
19256
19257 . ////////////////////////////////////////////////////////////////////////////
19258 . ////////////////////////////////////////////////////////////////////////////
19259
19260 .chapter "Generic options for transports" "CHAPtransportgeneric"
19261 .scindex IIDgenoptra1 "generic options" "transport"
19262 .scindex IIDgenoptra2 "options" "generic; for transports"
19263 .scindex IIDgenoptra3 "transport" "generic options for"
19264 The following generic options apply to all transports:
19265
19266
19267 .option body_only transports boolean false
19268 .cindex "transport" "body only"
19269 .cindex "message" "transporting body only"
19270 .cindex "body of message" "transporting"
19271 If this option is set, the message's headers are not transported. It is
19272 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19273 or &(pipe)& transports, the settings of &%message_prefix%& and
19274 &%message_suffix%& should be checked, because this option does not
19275 automatically suppress them.
19276
19277
19278 .option current_directory transports string&!! unset
19279 .cindex "transport" "current directory for"
19280 This specifies the current directory that is to be set while running the
19281 transport, overriding any value that may have been set by the router.
19282 If the expansion fails for any reason, including forced failure, an error is
19283 logged, and delivery is deferred.
19284
19285
19286 .option disable_logging transports boolean false
19287 If this option is set true, nothing is logged for any
19288 deliveries by the transport or for any
19289 transport errors. You should not set this option unless you really, really know
19290 what you are doing.
19291
19292
19293 .option debug_print transports string&!! unset
19294 .cindex "testing" "variables in drivers"
19295 If this option is set and debugging is enabled (see the &%-d%& command line
19296 option), the string is expanded and included in the debugging output when the
19297 transport is run.
19298 If expansion of the string fails, the error message is written to the debugging
19299 output, and Exim carries on processing.
19300 This facility is provided to help with checking out the values of variables and
19301 so on when debugging driver configurations. For example, if a &%headers_add%&
19302 option is not working properly, &%debug_print%& could be used to output the
19303 variables it references. A newline is added to the text if it does not end with
19304 one.
19305
19306
19307 .option delivery_date_add transports boolean false
19308 .cindex "&'Delivery-date:'& header line"
19309 If this option is true, a &'Delivery-date:'& header is added to the message.
19310 This gives the actual time the delivery was made. As this is not a standard
19311 header, Exim has a configuration option (&%delivery_date_remove%&) which
19312 requests its removal from incoming messages, so that delivered messages can
19313 safely be resent to other recipients.
19314
19315
19316 .option driver transports string unset
19317 This specifies which of the available transport drivers is to be used.
19318 There is no default, and this option must be set for every transport.
19319
19320
19321 .option envelope_to_add transports boolean false
19322 .cindex "&'Envelope-to:'& header line"
19323 If this option is true, an &'Envelope-to:'& header is added to the message.
19324 This gives the original address(es) in the incoming envelope that caused this
19325 delivery to happen. More than one address may be present if the transport is
19326 configured to handle several addresses at once, or if more than one original
19327 address was redirected to the same final address. As this is not a standard
19328 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19329 its removal from incoming messages, so that delivered messages can safely be
19330 resent to other recipients.
19331
19332
19333 .option group transports string&!! "Exim group"
19334 .cindex "transport" "group; specifying"
19335 This option specifies a gid for running the transport process, overriding any
19336 value that the router supplies, and also overriding any value associated with
19337 &%user%& (see below).
19338
19339
19340 .option headers_add transports string&!! unset
19341 .cindex "header lines" "adding in transport"
19342 .cindex "transport" "header lines; adding"
19343 This option specifies a string of text that is expanded and added to the header
19344 portion of a message as it is transported, as described in section
19345 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19346 routers. If the result of the expansion is an empty string, or if the expansion
19347 is forced to fail, no action is taken. Other expansion failures are treated as
19348 errors and cause the delivery to be deferred.
19349
19350
19351
19352 .option headers_only transports boolean false
19353 .cindex "transport" "header lines only"
19354 .cindex "message" "transporting headers only"
19355 .cindex "header lines" "transporting"
19356 If this option is set, the message's body is not transported. It is mutually
19357 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19358 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19359 checked, since this option does not automatically suppress them.
19360
19361
19362 .option headers_remove transports string&!! unset
19363 .cindex "header lines" "removing"
19364 .cindex "transport" "header lines; removing"
19365 This option specifies a string that is expanded into a list of header names;
19366 these headers are omitted from the message as it is transported, as described
19367 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19368 routers. If the result of the expansion is an empty string, or if the expansion
19369 is forced to fail, no action is taken. Other expansion failures are treated as
19370 errors and cause the delivery to be deferred.
19371
19372
19373
19374 .option headers_rewrite transports string unset
19375 .cindex "transport" "header lines; rewriting"
19376 .cindex "rewriting" "at transport time"
19377 This option allows addresses in header lines to be rewritten at transport time,
19378 that is, as the message is being copied to its destination. The contents of the
19379 option are a colon-separated list of rewriting rules. Each rule is in exactly
19380 the same form as one of the general rewriting rules that are applied when a
19381 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19382 example,
19383 .code
19384 headers_rewrite = a@b c@d f : \
19385                   x@y w@z
19386 .endd
19387 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19388 &'w@z'& in all address-bearing header lines. The rules are applied to the
19389 header lines just before they are written out at transport time, so they affect
19390 only those copies of the message that pass through the transport. However, only
19391 the message's original header lines, and any that were added by a system
19392 filter, are rewritten. If a router or transport adds header lines, they are not
19393 affected by this option. These rewriting rules are &'not'& applied to the
19394 envelope. You can change the return path using &%return_path%&, but you cannot
19395 change envelope recipients at this time.
19396
19397
19398 .option home_directory transports string&!! unset
19399 .cindex "transport" "home directory for"
19400 .vindex "&$home$&"
19401 This option specifies a home directory setting for a local transport,
19402 overriding any value that may be set by the router. The home directory is
19403 placed in &$home$& while expanding the transport's private options. It is also
19404 used as the current directory if no current directory is set by the
19405 &%current_directory%& option on the transport or the
19406 &%transport_current_directory%& option on the router. If the expansion fails
19407 for any reason, including forced failure, an error is logged, and delivery is
19408 deferred.
19409
19410
19411 .option initgroups transports boolean false
19412 .cindex "additional groups"
19413 .cindex "groups" "additional"
19414 .cindex "transport" "group; additional"
19415 If this option is true and the uid for the delivery process is provided by the
19416 transport, the &[initgroups()]& function is called when running the transport
19417 to ensure that any additional groups associated with the uid are set up.
19418
19419
19420 .option message_size_limit transports string&!! 0
19421 .cindex "limit" "message size per transport"
19422 .cindex "size" "of message, limit"
19423 .cindex "transport" "message size; limiting"
19424 This option controls the size of messages passed through the transport. It is
19425 expanded before use; the result of the expansion must be a sequence of decimal
19426 digits, optionally followed by K or M. If the expansion fails for any reason,
19427 including forced failure, or if the result is not of the required form,
19428 delivery is deferred. If the value is greater than zero and the size of a
19429 message exceeds this limit, the address is failed. If there is any chance that
19430 the resulting bounce message could be routed to the same transport, you should
19431 ensure that &%return_size_limit%& is less than the transport's
19432 &%message_size_limit%&, as otherwise the bounce message will fail to get
19433 delivered.
19434
19435
19436
19437 .option rcpt_include_affixes transports boolean false
19438 .cindex "prefix" "for local part, including in envelope"
19439 .cindex "suffix for local part" "including in envelope"
19440 .cindex "local part" "prefix"
19441 .cindex "local part" "suffix"
19442 When this option is false (the default), and an address that has had any
19443 affixes (prefixes or suffixes) removed from the local part is delivered by any
19444 form of SMTP or LMTP, the affixes are not included. For example, if a router
19445 that contains
19446 .code
19447 local_part_prefix = *-
19448 .endd
19449 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19450 is delivered with
19451 .code
19452 RCPT TO:<xyz@some.domain>
19453 .endd
19454 This is also the case when an ACL-time callout is being used to verify a
19455 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19456 whole local part is included in the RCPT command. This option applies to BSMTP
19457 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19458 &(lmtp)& and &(smtp)& transports.
19459
19460
19461 .option retry_use_local_part transports boolean "see below"
19462 .cindex "hints database" "retry keys"
19463 When a delivery suffers a temporary failure, a retry record is created
19464 in Exim's hints database. For remote deliveries, the key for the retry record
19465 is based on the name and/or IP address of the failing remote host. For local
19466 deliveries, the key is normally the entire address, including both the local
19467 part and the domain. This is suitable for most common cases of local delivery
19468 temporary failure &-- for example, exceeding a mailbox quota should delay only
19469 deliveries to that mailbox, not to the whole domain.
19470
19471 However, in some special cases you may want to treat a temporary local delivery
19472 as a failure associated with the domain, and not with a particular local part.
19473 (For example, if you are storing all mail for some domain in files.) You can do
19474 this by setting &%retry_use_local_part%& false.
19475
19476 For all the local transports, its default value is true. For remote transports,
19477 the default value is false for tidiness, but changing the value has no effect
19478 on a remote transport in the current implementation.
19479
19480
19481 .option return_path transports string&!! unset
19482 .cindex "envelope sender"
19483 .cindex "transport" "return path; changing"
19484 .cindex "return path" "changing in transport"
19485 If this option is set, the string is expanded at transport time and replaces
19486 the existing return path (envelope sender) value in the copy of the message
19487 that is being delivered. An empty return path is permitted. This feature is
19488 designed for remote deliveries, where the value of this option is used in the
19489 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19490 only effect is to change the address that is placed in the &'Return-path:'&
19491 header line, if one is added to the message (see the next option).
19492
19493 &*Note:*& A changed return path is not logged unless you add
19494 &%return_path_on_delivery%& to the log selector.
19495
19496 .vindex "&$return_path$&"
19497 The expansion can refer to the existing value via &$return_path$&. This is
19498 either the message's envelope sender, or an address set by the
19499 &%errors_to%& option on a router. If the expansion is forced to fail, no
19500 replacement occurs; if it fails for another reason, delivery is deferred. This
19501 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19502 section &<<SECTverp>>&.
19503
19504 &*Note*&: If a delivery error is detected locally, including the case when a
19505 remote server rejects a message at SMTP time, the bounce message is not sent to
19506 the value of this option. It is sent to the previously set errors address.
19507 This defaults to the incoming sender address, but can be changed by setting
19508 &%errors_to%& in a router.
19509
19510
19511
19512 .option return_path_add transports boolean false
19513 .cindex "&'Return-path:'& header line"
19514 If this option is true, a &'Return-path:'& header is added to the message.
19515 Although the return path is normally available in the prefix line of BSD
19516 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19517 have easy access to it.
19518
19519 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19520 the delivery SMTP server makes the final delivery"&. This implies that this
19521 header should not be present in incoming messages. Exim has a configuration
19522 option, &%return_path_remove%&, which requests removal of this header from
19523 incoming messages, so that delivered messages can safely be resent to other
19524 recipients.
19525
19526
19527 .option shadow_condition transports string&!! unset
19528 See &%shadow_transport%& below.
19529
19530
19531 .option shadow_transport transports string unset
19532 .cindex "shadow transport"
19533 .cindex "transport" "shadow"
19534 A local transport may set the &%shadow_transport%& option to the name of
19535 another local transport. Shadow remote transports are not supported.
19536
19537 Whenever a delivery to the main transport succeeds, and either
19538 &%shadow_condition%& is unset, or its expansion does not result in the empty
19539 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19540 passed to the shadow transport, with the same delivery address or addresses. If
19541 expansion fails, no action is taken except that non-forced expansion failures
19542 cause a log line to be written.
19543
19544 The result of the shadow transport is discarded and does not affect the
19545 subsequent processing of the message. Only a single level of shadowing is
19546 provided; the &%shadow_transport%& option is ignored on any transport when it
19547 is running as a shadow. Options concerned with output from pipes are also
19548 ignored. The log line for the successful delivery has an item added on the end,
19549 of the form
19550 .code
19551 ST=<shadow transport name>
19552 .endd
19553 If the shadow transport did not succeed, the error message is put in
19554 parentheses afterwards. Shadow transports can be used for a number of different
19555 purposes, including keeping more detailed log information than Exim normally
19556 provides, and implementing automatic acknowledgment policies based on message
19557 headers that some sites insist on.
19558
19559
19560 .option transport_filter transports string&!! unset
19561 .cindex "transport" "filter"
19562 .cindex "filter" "transport filter"
19563 This option sets up a filtering (in the Unix shell sense) process for messages
19564 at transport time. It should not be confused with mail filtering as set up by
19565 individual users or via a system filter.
19566
19567 When the message is about to be written out, the command specified by
19568 &%transport_filter%& is started up in a separate, parallel process, and
19569 the entire message, including the header lines, is passed to it on its standard
19570 input (this in fact is done from a third process, to avoid deadlock). The
19571 command must be specified as an absolute path.
19572
19573 The lines of the message that are written to the transport filter are
19574 terminated by newline (&"\n"&). The message is passed to the filter before any
19575 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19576 lines beginning with a dot, and also before any processing implied by the
19577 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19578 &(pipe)& transports.
19579
19580 The standard error for the filter process is set to the same destination as its
19581 standard output; this is read and written to the message's ultimate
19582 destination. The process that writes the message to the filter, the
19583 filter itself, and the original process that reads the result and delivers it
19584 are all run in parallel, like a shell pipeline.
19585
19586 The filter can perform any transformations it likes, but of course should take
19587 care not to break RFC 2822 syntax. Exim does not check the result, except to
19588 test for a final newline when SMTP is in use. All messages transmitted over
19589 SMTP must end with a newline, so Exim supplies one if it is missing.
19590
19591 .cindex "content scanning" "per user"
19592 A transport filter can be used to provide content-scanning on a per-user basis
19593 at delivery time if the only required effect of the scan is to modify the
19594 message. For example, a content scan could insert a new header line containing
19595 a spam score. This could be interpreted by a filter in the user's MUA. It is
19596 not possible to discard a message at this stage.
19597
19598 .cindex "SMTP" "SIZE"
19599 A problem might arise if the filter increases the size of a message that is
19600 being sent down an SMTP connection. If the receiving SMTP server has indicated
19601 support for the SIZE parameter, Exim will have sent the size of the message
19602 at the start of the SMTP session. If what is actually sent is substantially
19603 more, the server might reject the message. This can be worked round by setting
19604 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19605 additions to the message, or to disable the use of SIZE altogether.
19606
19607 .vindex "&$pipe_addresses$&"
19608 The value of the &%transport_filter%& option is the command string for starting
19609 the filter, which is run directly from Exim, not under a shell. The string is
19610 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19611 Exim breaks it up into arguments and then expands each argument separately (see
19612 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19613 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19614 of arguments, one for each address that applies to this delivery. (This isn't
19615 an ideal name for this feature here, but as it was already implemented for the
19616 &(pipe)& transport, it seemed sensible not to change it.)
19617
19618 .vindex "&$host$&"
19619 .vindex "&$host_address$&"
19620 The expansion variables &$host$& and &$host_address$& are available when the
19621 transport is a remote one. They contain the name and IP address of the host to
19622 which the message is being sent. For example:
19623 .code
19624 transport_filter = /some/directory/transport-filter.pl \
19625   $host $host_address $sender_address $pipe_addresses
19626 .endd
19627
19628 Two problems arise if you want to use more complicated expansion items to
19629 generate transport filter commands, both of which due to the fact that the
19630 command is split up &'before'& expansion.
19631 .ilist
19632 If an expansion item contains white space, you must quote it, so that it is all
19633 part of the same command item. If the entire option setting is one such
19634 expansion item, you have to take care what kind of quoting you use. For
19635 example:
19636 .code
19637 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19638 .endd
19639 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19640 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19641 stripped by Exim when it read the option's value. When the value is used, if
19642 the single quotes were missing, the line would be split into two items,
19643 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19644 Exim tried to expand the first one.
19645 .next
19646 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19647 expansion cannot generate multiple arguments, or a command name followed by
19648 arguments. Consider this example:
19649 .code
19650 transport_filter = ${lookup{$host}lsearch{/a/file}\
19651                     {$value}{/bin/cat}}
19652 .endd
19653 The result of the lookup is interpreted as the name of the command, even
19654 if it contains white space. The simplest way round this is to use a shell:
19655 .code
19656 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19657                                {$value}{/bin/cat}}
19658 .endd
19659 .endlist
19660
19661 The filter process is run under the same uid and gid as the normal delivery.
19662 For remote deliveries this is the Exim uid/gid by default. The command should
19663 normally yield a zero return code. Transport filters are not supposed to fail.
19664 A non-zero code is taken to mean that the transport filter encountered some
19665 serious problem. Delivery of the message is deferred; the message remains on
19666 the queue and is tried again later. It is not possible to cause a message to be
19667 bounced from a transport filter.
19668
19669 If a transport filter is set on an autoreply transport, the original message is
19670 passed through the filter as it is being copied into the newly generated
19671 message, which happens if the &%return_message%& option is set.
19672
19673
19674 .option transport_filter_timeout transports time 5m
19675 .cindex "transport" "filter, timeout"
19676 When Exim is reading the output of a transport filter, it a applies a timeout
19677 that can be set by this option. Exceeding the timeout is normally treated as a
19678 temporary delivery failure. However, if a transport filter is used with a
19679 &(pipe)& transport, a timeout in the transport filter is treated in the same
19680 way as a timeout in the pipe command itself. By default, a timeout is a hard
19681 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19682 becomes a temporary error.
19683
19684
19685 .option user transports string&!! "Exim user"
19686 .cindex "uid (user id)" "local delivery"
19687 .cindex "transport" "user, specifying"
19688 This option specifies the user under whose uid the delivery process is to be
19689 run, overriding any uid that may have been set by the router. If the user is
19690 given as a name, the uid is looked up from the password data, and the
19691 associated group is taken as the value of the gid to be used if the &%group%&
19692 option is not set.
19693
19694 For deliveries that use local transports, a user and group are normally
19695 specified explicitly or implicitly (for example, as a result of
19696 &%check_local_user%&) by the router or transport.
19697
19698 .cindex "hints database" "access by remote transport"
19699 For remote transports, you should leave this option unset unless you really are
19700 sure you know what you are doing. When a remote transport is running, it needs
19701 to be able to access Exim's hints databases, because each host may have its own
19702 retry data.
19703 .ecindex IIDgenoptra1
19704 .ecindex IIDgenoptra2
19705 .ecindex IIDgenoptra3
19706
19707
19708
19709
19710
19711
19712 . ////////////////////////////////////////////////////////////////////////////
19713 . ////////////////////////////////////////////////////////////////////////////
19714
19715 .chapter "Address batching in local transports" "CHAPbatching" &&&
19716          "Address batching"
19717 .cindex "transport" "local; address batching in"
19718 The only remote transport (&(smtp)&) is normally configured to handle more than
19719 one address at a time, so that when several addresses are routed to the same
19720 remote host, just one copy of the message is sent. Local transports, however,
19721 normally handle one address at a time. That is, a separate instance of the
19722 transport is run for each address that is routed to the transport. A separate
19723 copy of the message is delivered each time.
19724
19725 .cindex "batched local delivery"
19726 .oindex "&%batch_max%&"
19727 .oindex "&%batch_id%&"
19728 In special cases, it may be desirable to handle several addresses at once in a
19729 local transport, for example:
19730
19731 .ilist
19732 In an &(appendfile)& transport, when storing messages in files for later
19733 delivery by some other means, a single copy of the message with multiple
19734 recipients saves space.
19735 .next
19736 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19737 a single copy saves time, and is the normal way LMTP is expected to work.
19738 .next
19739 In a &(pipe)& transport, when passing the message
19740 to a scanner program or
19741 to some other delivery mechanism such as UUCP, multiple recipients may be
19742 acceptable.
19743 .endlist
19744
19745 These three local transports all have the same options for controlling multiple
19746 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19747 repeating the information for each transport, these options are described here.
19748
19749 The &%batch_max%& option specifies the maximum number of addresses that can be
19750 delivered together in a single run of the transport. Its default value is one
19751 (no batching). When more than one address is routed to a transport that has a
19752 &%batch_max%& value greater than one, the addresses are delivered in a batch
19753 (that is, in a single run of the transport with multiple recipients), subject
19754 to certain conditions:
19755
19756 .ilist
19757 .vindex "&$local_part$&"
19758 If any of the transport's options contain a reference to &$local_part$&, no
19759 batching is possible.
19760 .next
19761 .vindex "&$domain$&"
19762 If any of the transport's options contain a reference to &$domain$&, only
19763 addresses with the same domain are batched.
19764 .next
19765 .cindex "customizing" "batching condition"
19766 If &%batch_id%& is set, it is expanded for each address, and only those
19767 addresses with the same expanded value are batched. This allows you to specify
19768 customized batching conditions. Failure of the expansion for any reason,
19769 including forced failure, disables batching, but it does not stop the delivery
19770 from taking place.
19771 .next
19772 Batched addresses must also have the same errors address (where to send
19773 delivery errors), the same header additions and removals, the same user and
19774 group for the transport, and if a host list is present, the first host must
19775 be the same.
19776 .endlist
19777
19778 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19779 both when the file or pipe command is specified in the transport, and when it
19780 is specified by a &(redirect)& router, but all the batched addresses must of
19781 course be routed to the same file or pipe command. These two transports have an
19782 option called &%use_bsmtp%&, which causes them to deliver the message in
19783 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19784 &%check_string%& and &%escape_string%& options are forced to the values
19785 .code
19786 check_string = "."
19787 escape_string = ".."
19788 .endd
19789 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19790 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19791 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19792
19793 .cindex "&'Envelope-to:'& header line"
19794 If the generic &%envelope_to_add%& option is set for a batching transport, the
19795 &'Envelope-to:'& header that is added to the message contains all the addresses
19796 that are being processed together. If you are using a batching &(appendfile)&
19797 transport without &%use_bsmtp%&, the only way to preserve the recipient
19798 addresses is to set the &%envelope_to_add%& option.
19799
19800 .cindex "&(pipe)& transport" "with multiple addresses"
19801 .vindex "&$pipe_addresses$&"
19802 If you are using a &(pipe)& transport without BSMTP, and setting the
19803 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19804 the command. This is not a true variable; it is a bit of magic that causes each
19805 of the recipient addresses to be inserted into the command as a separate
19806 argument. This provides a way of accessing all the addresses that are being
19807 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19808 are specified by a &(redirect)& router.
19809
19810
19811
19812
19813 . ////////////////////////////////////////////////////////////////////////////
19814 . ////////////////////////////////////////////////////////////////////////////
19815
19816 .chapter "The appendfile transport" "CHAPappendfile"
19817 .scindex IIDapptra1 "&(appendfile)& transport"
19818 .scindex IIDapptra2 "transports" "&(appendfile)&"
19819 .cindex "directory creation"
19820 .cindex "creating directories"
19821 The &(appendfile)& transport delivers a message by appending it to an existing
19822 file, or by creating an entirely new file in a specified directory. Single
19823 files to which messages are appended can be in the traditional Unix mailbox
19824 format, or optionally in the MBX format supported by the Pine MUA and
19825 University of Washington IMAP daemon, &'inter alia'&. When each message is
19826 being delivered as a separate file, &"maildir"& format can optionally be used
19827 to give added protection against failures that happen part-way through the
19828 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19829 supported. For all file formats, Exim attempts to create as many levels of
19830 directory as necessary, provided that &%create_directory%& is set.
19831
19832 The code for the optional formats is not included in the Exim binary by
19833 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19834 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19835 included.
19836
19837 .cindex "quota" "system"
19838 Exim recognizes system quota errors, and generates an appropriate message. Exim
19839 also supports its own quota control within the transport, for use when the
19840 system facility is unavailable or cannot be used for some reason.
19841
19842 If there is an error while appending to a file (for example, quota exceeded or
19843 partition filled), Exim attempts to reset the file's length and last
19844 modification time back to what they were before. If there is an error while
19845 creating an entirely new file, the new file is removed.
19846
19847 Before appending to a file, a number of security checks are made, and the
19848 file is locked. A detailed description is given below, after the list of
19849 private options.
19850
19851 The &(appendfile)& transport is most commonly used for local deliveries to
19852 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19853 putting messages into files for remote delivery by some means other than Exim.
19854 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19855 option).
19856
19857
19858
19859 .section "The file and directory options" "SECTfildiropt"
19860 The &%file%& option specifies a single file, to which the message is appended;
19861 the &%directory%& option specifies a directory, in which a new file containing
19862 the message is created. Only one of these two options can be set, and for
19863 normal deliveries to mailboxes, one of them &'must'& be set.
19864
19865 .vindex "&$address_file$&"
19866 .vindex "&$local_part$&"
19867 However, &(appendfile)& is also used for delivering messages to files or
19868 directories whose names (or parts of names) are obtained from alias,
19869 forwarding, or filtering operations (for example, a &%save%& command in a
19870 user's Exim filter). When such a transport is running, &$local_part$& contains
19871 the local part that was aliased or forwarded, and &$address_file$& contains the
19872 name (or partial name) of the file or directory generated by the redirection
19873 operation. There are two cases:
19874
19875 .ilist
19876 If neither &%file%& nor &%directory%& is set, the redirection operation
19877 must specify an absolute path (one that begins with &`/`&). This is the most
19878 common case when users with local accounts use filtering to sort mail into
19879 different folders. See for example, the &(address_file)& transport in the
19880 default configuration. If the path ends with a slash, it is assumed to be the
19881 name of a directory. A delivery to a directory can also be forced by setting
19882 &%maildir_format%& or &%mailstore_format%&.
19883 .next
19884 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19885 used to determine the file or directory name for the delivery. Normally, the
19886 contents of &$address_file$& are used in some way in the string expansion.
19887 .endlist
19888
19889
19890 .cindex "Sieve filter" "configuring &(appendfile)&"
19891 .cindex "Sieve filter" "relative mailbox path handling"
19892 As an example of the second case, consider an environment where users do not
19893 have home directories. They may be permitted to use Exim filter commands of the
19894 form:
19895 .code
19896 save folder23
19897 .endd
19898 or Sieve filter commands of the form:
19899 .code
19900 require "fileinto";
19901 fileinto "folder23";
19902 .endd
19903 In this situation, the expansion of &%file%& or &%directory%& in the transport
19904 must transform the relative path into an appropriate absolute file name. In the
19905 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19906 is used as a result of a &"keep"& action in the filter. This example shows one
19907 way of handling this requirement:
19908 .code
19909 file = ${if eq{$address_file}{inbox} \
19910             {/var/mail/$local_part} \
19911             {${if eq{${substr_0_1:$address_file}}{/} \
19912                   {$address_file} \
19913                   {$home/mail/$address_file} \
19914             }} \
19915        }
19916 .endd
19917 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19918 location, absolute paths are used without change, and other folders are in the
19919 &_mail_& directory within the home directory.
19920
19921 &*Note 1*&: While processing an Exim filter, a relative path such as
19922 &_folder23_& is turned into an absolute path if a home directory is known to
19923 the router. In particular, this is the case if &%check_local_user%& is set. If
19924 you want to prevent this happening at routing time, you can set
19925 &%router_home_directory%& empty. This forces the router to pass the relative
19926 path to the transport.
19927
19928 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19929 the &%file%& or &%directory%& option is still used if it is set.
19930
19931
19932
19933
19934 .section "Private options for appendfile" "SECID134"
19935 .cindex "options" "&(appendfile)& transport"
19936
19937
19938
19939 .option allow_fifo appendfile boolean false
19940 .cindex "fifo (named pipe)"
19941 .cindex "named pipe (fifo)"
19942 .cindex "pipe" "named (fifo)"
19943 Setting this option permits delivery to named pipes (FIFOs) as well as to
19944 regular files. If no process is reading the named pipe at delivery time, the
19945 delivery is deferred.
19946
19947
19948 .option allow_symlink appendfile boolean false
19949 .cindex "symbolic link" "to mailbox"
19950 .cindex "mailbox" "symbolic link"
19951 By default, &(appendfile)& will not deliver if the path name for the file is
19952 that of a symbolic link. Setting this option relaxes that constraint, but there
19953 are security issues involved in the use of symbolic links. Be sure you know
19954 what you are doing if you set this. Details of exactly what this option affects
19955 are included in the discussion which follows this list of options.
19956
19957
19958 .option batch_id appendfile string&!! unset
19959 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19960 However, batching is automatically disabled for &(appendfile)& deliveries that
19961 happen as a result of forwarding or aliasing or other redirection directly to a
19962 file.
19963
19964
19965 .option batch_max appendfile integer 1
19966 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19967
19968
19969 .option check_group appendfile boolean false
19970 When this option is set, the group owner of the file defined by the &%file%&
19971 option is checked to see that it is the same as the group under which the
19972 delivery process is running. The default setting is false because the default
19973 file mode is 0600, which means that the group is irrelevant.
19974
19975
19976 .option check_owner appendfile boolean true
19977 When this option is set, the owner of the file defined by the &%file%& option
19978 is checked to ensure that it is the same as the user under which the delivery
19979 process is running.
19980
19981
19982 .option check_string appendfile string "see below"
19983 .cindex "&""From""& line"
19984 As &(appendfile)& writes the message, the start of each line is tested for
19985 matching &%check_string%&, and if it does, the initial matching characters are
19986 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19987 a literal string, not a regular expression, and the case of any letters it
19988 contains is significant.
19989
19990 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19991 are forced to &"."& and &".."& respectively, and any settings in the
19992 configuration are ignored. Otherwise, they default to &"From&~"& and
19993 &">From&~"& when the &%file%& option is set, and unset when any of the
19994 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19995
19996 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19997 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19998 &"From&~"& indicates the start of a new message. All four options need changing
19999 if another format is used. For example, to deliver to mailboxes in MMDF format:
20000 .cindex "MMDF format mailbox"
20001 .cindex "mailbox" "MMDF format"
20002 .code
20003 check_string = "\1\1\1\1\n"
20004 escape_string = "\1\1\1\1 \n"
20005 message_prefix = "\1\1\1\1\n"
20006 message_suffix = "\1\1\1\1\n"
20007 .endd
20008 .option create_directory appendfile boolean true
20009 .cindex "directory creation"
20010 When this option is true, Exim attempts to create any missing superior
20011 directories for the file that it is about to write. A created directory's mode
20012 is given by the &%directory_mode%& option.
20013
20014 The group ownership of a newly created directory is highly dependent on the
20015 operating system (and possibly the file system) that is being used. For
20016 example, in Solaris, if the parent directory has the setgid bit set, its group
20017 is propagated to the child; if not, the currently set group is used. However,
20018 in FreeBSD, the parent's group is always used.
20019
20020
20021
20022 .option create_file appendfile string anywhere
20023 This option constrains the location of files and directories that are created
20024 by this transport. It applies to files defined by the &%file%& option and
20025 directories defined by the &%directory%& option. In the case of maildir
20026 delivery, it applies to the top level directory, not the maildir directories
20027 beneath.
20028
20029 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20030 &"belowhome"&. In the second and third cases, a home directory must have been
20031 set for the transport. This option is not useful when an explicit file name is
20032 given for normal mailbox deliveries. It is intended for the case when file
20033 names are generated from users' &_.forward_& files. These are usually handled
20034 by an &(appendfile)& transport called &%address_file%&. See also
20035 &%file_must_exist%&.
20036
20037
20038 .option directory appendfile string&!! unset
20039 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20040 or &%directory%& must be set, unless the delivery is the direct result of a
20041 redirection (see section &<<SECTfildiropt>>&).
20042
20043 When &%directory%& is set, the string is expanded, and the message is delivered
20044 into a new file or files in or below the given directory, instead of being
20045 appended to a single mailbox file. A number of different formats are provided
20046 (see &%maildir_format%& and &%mailstore_format%&), and see section
20047 &<<SECTopdir>>& for further details of this form of delivery.
20048
20049
20050 .option directory_file appendfile string&!! "see below"
20051 .cindex "base62"
20052 .vindex "&$inode$&"
20053 When &%directory%& is set, but neither &%maildir_format%& nor
20054 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20055 whose name is obtained by expanding this string. The default value is:
20056 .code
20057 q${base62:$tod_epoch}-$inode
20058 .endd
20059 This generates a unique name from the current time, in base 62 form, and the
20060 inode of the file. The variable &$inode$& is available only when expanding this
20061 option.
20062
20063
20064 .option directory_mode appendfile "octal integer" 0700
20065 If &(appendfile)& creates any directories as a result of the
20066 &%create_directory%& option, their mode is specified by this option.
20067
20068
20069 .option escape_string appendfile string "see description"
20070 See &%check_string%& above.
20071
20072
20073 .option file appendfile string&!! unset
20074 This option is mutually exclusive with the &%directory%& option, but one of
20075 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20076 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20077 specifies a single file, to which the message is appended. One or more of
20078 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20079 &%file%&.
20080
20081 .cindex "NFS" "lock file"
20082 .cindex "locking files"
20083 .cindex "lock files"
20084 If you are using more than one host to deliver over NFS into the same
20085 mailboxes, you should always use lock files.
20086
20087 The string value is expanded for each delivery, and must yield an absolute
20088 path. The most common settings of this option are variations on one of these
20089 examples:
20090 .code
20091 file = /var/spool/mail/$local_part
20092 file = /home/$local_part/inbox
20093 file = $home/inbox
20094 .endd
20095 .cindex "&""sticky""& bit"
20096 In the first example, all deliveries are done into the same directory. If Exim
20097 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20098 create a file in the directory, so the &"sticky"& bit must be turned on for
20099 deliveries to be possible, or alternatively the &%group%& option can be used to
20100 run the delivery under a group id which has write access to the directory.
20101
20102
20103
20104 .option file_format appendfile string unset
20105 .cindex "file" "mailbox; checking existing format"
20106 This option requests the transport to check the format of an existing file
20107 before adding to it. The check consists of matching a specific string at the
20108 start of the file. The value of the option consists of an even number of
20109 colon-separated strings. The first of each pair is the test string, and the
20110 second is the name of a transport. If the transport associated with a matched
20111 string is not the current transport, control is passed over to the other
20112 transport. For example, suppose the standard &(local_delivery)& transport has
20113 this added to it:
20114 .code
20115 file_format = "From       : local_delivery :\
20116                \1\1\1\1\n : local_mmdf_delivery"
20117 .endd
20118 Mailboxes that begin with &"From"& are still handled by this transport, but if
20119 a mailbox begins with four binary ones followed by a newline, control is passed
20120 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20121 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20122 is assumed to match the current transport. If the start of a mailbox doesn't
20123 match any string, or if the transport named for a given string is not defined,
20124 delivery is deferred.
20125
20126
20127 .option file_must_exist appendfile boolean false
20128 If this option is true, the file specified by the &%file%& option must exist.
20129 A temporary error occurs if it does not, causing delivery to be deferred.
20130 If this option is false, the file is created if it does not exist.
20131
20132
20133 .option lock_fcntl_timeout appendfile time 0s
20134 .cindex "timeout" "mailbox locking"
20135 .cindex "mailbox" "locking, blocking and non-blocking"
20136 .cindex "locking files"
20137 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20138 when locking an open mailbox file. If the call fails, the delivery process
20139 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20140 Non-blocking calls are used so that the file is not kept open during the wait
20141 for the lock; the reason for this is to make it as safe as possible for
20142 deliveries over NFS in the case when processes might be accessing an NFS
20143 mailbox without using a lock file. This should not be done, but
20144 misunderstandings and hence misconfigurations are not unknown.
20145
20146 On a busy system, however, the performance of a non-blocking lock approach is
20147 not as good as using a blocking lock with a timeout. In this case, the waiting
20148 is done inside the system call, and Exim's delivery process acquires the lock
20149 and can proceed as soon as the previous lock holder releases it.
20150
20151 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20152 timeout, are used. There may still be some retrying: the maximum number of
20153 retries is
20154 .code
20155 (lock_retries * lock_interval) / lock_fcntl_timeout
20156 .endd
20157 rounded up to the next whole number. In other words, the total time during
20158 which &(appendfile)& is trying to get a lock is roughly the same, unless
20159 &%lock_fcntl_timeout%& is set very large.
20160
20161 You should consider setting this option if you are getting a lot of delayed
20162 local deliveries because of errors of the form
20163 .code
20164 failed to lock mailbox /some/file (fcntl)
20165 .endd
20166
20167 .option lock_flock_timeout appendfile time 0s
20168 This timeout applies to file locking when using &[flock()]& (see
20169 &%use_flock%&); the timeout operates in a similar manner to
20170 &%lock_fcntl_timeout%&.
20171
20172
20173 .option lock_interval appendfile time 3s
20174 This specifies the time to wait between attempts to lock the file. See below
20175 for details of locking.
20176
20177
20178 .option lock_retries appendfile integer 10
20179 This specifies the maximum number of attempts to lock the file. A value of zero
20180 is treated as 1. See below for details of locking.
20181
20182
20183 .option lockfile_mode appendfile "octal integer" 0600
20184 This specifies the mode of the created lock file, when a lock file is being
20185 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20186
20187
20188 .option lockfile_timeout appendfile time 30m
20189 .cindex "timeout" "mailbox locking"
20190 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20191 exists and is older than this value, it is assumed to have been left behind by
20192 accident, and Exim attempts to remove it.
20193
20194
20195 .option mailbox_filecount appendfile string&!! unset
20196 .cindex "mailbox" "specifying size of"
20197 .cindex "size" "of mailbox"
20198 If this option is set, it is expanded, and the result is taken as the current
20199 number of files in the mailbox. It must be a decimal number, optionally
20200 followed by K or M. This provides a way of obtaining this information from an
20201 external source that maintains the data.
20202
20203
20204 .option mailbox_size appendfile string&!! unset
20205 .cindex "mailbox" "specifying size of"
20206 .cindex "size" "of mailbox"
20207 If this option is set, it is expanded, and the result is taken as the current
20208 size the mailbox. It must be a decimal number, optionally followed by K or M.
20209 This provides a way of obtaining this information from an external source that
20210 maintains the data. This is likely to be helpful for maildir deliveries where
20211 it is computationally expensive to compute the size of a mailbox.
20212
20213
20214
20215 .option maildir_format appendfile boolean false
20216 .cindex "maildir format" "specifying"
20217 If this option is set with the &%directory%& option, the delivery is into a new
20218 file, in the &"maildir"& format that is used by other mail software. When the
20219 transport is activated directly from a &(redirect)& router (for example, the
20220 &(address_file)& transport in the default configuration), setting
20221 &%maildir_format%& causes the path received from the router to be treated as a
20222 directory, whether or not it ends with &`/`&. This option is available only if
20223 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20224 &<<SECTmaildirdelivery>>& below for further details.
20225
20226
20227 .option maildir_quota_directory_regex appendfile string "See below"
20228 .cindex "maildir format" "quota; directories included in"
20229 .cindex "quota" "maildir; directories included in"
20230 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20231 a regular expression for specifying directories, relative to the quota
20232 directory (see &%quota_directory%&), that should be included in the quota
20233 calculation. The default value is:
20234 .code
20235 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20236 .endd
20237 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20238 (directories whose names begin with a dot). If you want to exclude the
20239 &_Trash_&
20240 folder from the count (as some sites do), you need to change this setting to
20241 .code
20242 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20243 .endd
20244 This uses a negative lookahead in the regular expression to exclude the
20245 directory whose name is &_.Trash_&. When a directory is excluded from quota
20246 calculations, quota processing is bypassed for any messages that are delivered
20247 directly into that directory.
20248
20249
20250 .option maildir_retries appendfile integer 10
20251 This option specifies the number of times to retry when writing a file in
20252 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20253
20254
20255 .option maildir_tag appendfile string&!! unset
20256 This option applies only to deliveries in maildir format, and is described in
20257 section &<<SECTmaildirdelivery>>& below.
20258
20259
20260 .option maildir_use_size_file appendfile&!! boolean false
20261 .cindex "maildir format" "&_maildirsize_& file"
20262 The result of string expansion for this option must be a valid boolean value.
20263 If it is true, it enables support for &_maildirsize_& files. Exim
20264 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20265 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20266 value is zero. See &%maildir_quota_directory_regex%& above and section
20267 &<<SECTmaildirdelivery>>& below for further details.
20268
20269 .option maildirfolder_create_regex appendfile string unset
20270 .cindex "maildir format" "&_maildirfolder_& file"
20271 .cindex "&_maildirfolder_&, creating"
20272 The value of this option is a regular expression. If it is unset, it has no
20273 effect. Otherwise, before a maildir delivery takes place, the pattern is
20274 matched against the name of the maildir directory, that is, the directory
20275 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20276 delivery. If there is a match, Exim checks for the existence of a file called
20277 &_maildirfolder_& in the directory, and creates it if it does not exist.
20278 See section &<<SECTmaildirdelivery>>& for more details.
20279
20280
20281 .option mailstore_format appendfile boolean false
20282 .cindex "mailstore format" "specifying"
20283 If this option is set with the &%directory%& option, the delivery is into two
20284 new files in  &"mailstore"& format. The option is available only if
20285 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20286 below for further details.
20287
20288
20289 .option mailstore_prefix appendfile string&!! unset
20290 This option applies only to deliveries in mailstore format, and is described in
20291 section &<<SECTopdir>>& below.
20292
20293
20294 .option mailstore_suffix appendfile string&!! unset
20295 This option applies only to deliveries in mailstore format, and is described in
20296 section &<<SECTopdir>>& below.
20297
20298
20299 .option mbx_format appendfile boolean false
20300 .cindex "locking files"
20301 .cindex "file" "locking"
20302 .cindex "file" "MBX format"
20303 .cindex "MBX format, specifying"
20304 This option is available only if Exim has been compiled with SUPPORT_MBX
20305 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20306 the message is appended to the mailbox file in MBX format instead of
20307 traditional Unix format. This format is supported by Pine4 and its associated
20308 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20309
20310 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20311 automatically changed by the use of &%mbx_format%&. They should normally be set
20312 empty when using MBX format, so this option almost always appears in this
20313 combination:
20314 .code
20315 mbx_format = true
20316 message_prefix =
20317 message_suffix =
20318 .endd
20319 If none of the locking options are mentioned in the configuration,
20320 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20321 is possible to specify the other kinds of locking with &%mbx_format%&, but
20322 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20323 interworks with &'c-client'&, providing for shared access to the mailbox. It
20324 should not be used if any program that does not use this form of locking is
20325 going to access the mailbox, nor should it be used if the mailbox file is NFS
20326 mounted, because it works only when the mailbox is accessed from a single host.
20327
20328 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20329 the standard version of &'c-client'&, because as long as it has a mailbox open
20330 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20331 append messages to it.
20332
20333
20334 .option message_prefix appendfile string&!! "see below"
20335 .cindex "&""From""& line"
20336 The string specified here is expanded and output at the start of every message.
20337 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20338 in which case it is:
20339 .code
20340 message_prefix = "From ${if def:return_path{$return_path}\
20341   {MAILER-DAEMON}} $tod_bsdinbox\n"
20342 .endd
20343 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20344 &`\n`& to &`\r\n`& in &%message_prefix%&.
20345
20346 .option message_suffix appendfile string&!! "see below"
20347 The string specified here is expanded and output at the end of every message.
20348 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20349 in which case it is a single newline character. The suffix can be suppressed by
20350 setting
20351 .code
20352 message_suffix =
20353 .endd
20354 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20355 &`\n`& to &`\r\n`& in &%message_suffix%&.
20356
20357 .option mode appendfile "octal integer" 0600
20358 If the output file is created, it is given this mode. If it already exists and
20359 has wider permissions, they are reduced to this mode. If it has narrower
20360 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20361 if the delivery is the result of a &%save%& command in a filter file specifying
20362 a particular mode, the mode of the output file is always forced to take that
20363 value, and this option is ignored.
20364
20365
20366 .option mode_fail_narrower appendfile boolean true
20367 This option applies in the case when an existing mailbox file has a narrower
20368 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20369 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20370 continues with the delivery attempt, using the existing mode of the file.
20371
20372
20373 .option notify_comsat appendfile boolean false
20374 If this option is true, the &'comsat'& daemon is notified after every
20375 successful delivery to a user mailbox. This is the daemon that notifies logged
20376 on users about incoming mail.
20377
20378
20379 .option quota appendfile string&!! unset
20380 .cindex "quota" "imposed by Exim"
20381 This option imposes a limit on the size of the file to which Exim is appending,
20382 or to the total space used in the directory tree when the &%directory%& option
20383 is set. In the latter case, computation of the space used is expensive, because
20384 all the files in the directory (and any sub-directories) have to be
20385 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20386 &%maildir_use_size_file%& for ways to avoid this in environments where users
20387 have no shell access to their mailboxes).
20388
20389 As there is no interlock against two simultaneous deliveries into a
20390 multi-file mailbox, it is possible for the quota to be overrun in this case.
20391 For single-file mailboxes, of course, an interlock is a necessity.
20392
20393 A file's size is taken as its &'used'& value. Because of blocking effects, this
20394 may be a lot less than the actual amount of disk space allocated to the file.
20395 If the sizes of a number of files are being added up, the rounding effect can
20396 become quite noticeable, especially on systems that have large block sizes.
20397 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20398 the obvious value which users understand most easily.
20399
20400 The value of the option is expanded, and must then be a numerical value
20401 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20402 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20403 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20404 be handled.
20405
20406 &*Note*&: A value of zero is interpreted as &"no quota"&.
20407
20408 The expansion happens while Exim is running as root, before it changes uid for
20409 the delivery. This means that files that are inaccessible to the end user can
20410 be used to hold quota values that are looked up in the expansion. When delivery
20411 fails because this quota is exceeded, the handling of the error is as for
20412 system quota failures.
20413
20414 By default, Exim's quota checking mimics system quotas, and restricts the
20415 mailbox to the specified maximum size, though the value is not accurate to the
20416 last byte, owing to separator lines and additional headers that may get added
20417 during message delivery. When a mailbox is nearly full, large messages may get
20418 refused even though small ones are accepted, because the size of the current
20419 message is added to the quota when the check is made. This behaviour can be
20420 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20421 for exceeding the quota does not include the current message. Thus, deliveries
20422 continue until the quota has been exceeded; thereafter, no further messages are
20423 delivered. See also &%quota_warn_threshold%&.
20424
20425
20426 .option quota_directory appendfile string&!! unset
20427 This option defines the directory to check for quota purposes when delivering
20428 into individual files. The default is the delivery directory, or, if a file
20429 called &_maildirfolder_& exists in a maildir directory, the parent of the
20430 delivery directory.
20431
20432
20433 .option quota_filecount appendfile string&!! 0
20434 This option applies when the &%directory%& option is set. It limits the total
20435 number of files in the directory (compare the inode limit in system quotas). It
20436 can only be used if &%quota%& is also set. The value is expanded; an expansion
20437 failure causes delivery to be deferred. A value of zero is interpreted as
20438 &"no quota"&.
20439
20440
20441 .option quota_is_inclusive appendfile boolean true
20442 See &%quota%& above.
20443
20444
20445 .option quota_size_regex appendfile string unset
20446 This option applies when one of the delivery modes that writes a separate file
20447 for each message is being used. When Exim wants to find the size of one of
20448 these files in order to test the quota, it first checks &%quota_size_regex%&.
20449 If this is set to a regular expression that matches the file name, and it
20450 captures one string, that string is interpreted as a representation of the
20451 file's size. The value of &%quota_size_regex%& is not expanded.
20452
20453 This feature is useful only when users have no shell access to their mailboxes
20454 &-- otherwise they could defeat the quota simply by renaming the files. This
20455 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20456 the file length to the file name. For example:
20457 .code
20458 maildir_tag = ,S=$message_size
20459 quota_size_regex = ,S=(\d+)
20460 .endd
20461 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20462 number of lines in the message.
20463
20464 The regular expression should not assume that the length is at the end of the
20465 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20466 sometimes add other information onto the ends of message file names.
20467
20468 Section &<<SECID136>>& contains further information.
20469
20470
20471 .option quota_warn_message appendfile string&!! "see below"
20472 See below for the use of this option. If it is not set when
20473 &%quota_warn_threshold%& is set, it defaults to
20474 .code
20475 quota_warn_message = "\
20476   To: $local_part@$domain\n\
20477   Subject: Your mailbox\n\n\
20478   This message is automatically created \
20479   by mail delivery software.\n\n\
20480   The size of your mailbox has exceeded \
20481   a warning threshold that is\n\
20482   set by the system administrator.\n"
20483 .endd
20484
20485
20486 .option quota_warn_threshold appendfile string&!! 0
20487 .cindex "quota" "warning threshold"
20488 .cindex "mailbox" "size warning"
20489 .cindex "size" "of mailbox"
20490 This option is expanded in the same way as &%quota%& (see above). If the
20491 resulting value is greater than zero, and delivery of the message causes the
20492 size of the file or total space in the directory tree to cross the given
20493 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20494 may be specified as a percentage of it by following the value with a percent
20495 sign. For example:
20496 .code
20497 quota = 10M
20498 quota_warn_threshold = 75%
20499 .endd
20500 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20501 percent sign is ignored.
20502
20503 The warning message itself is specified by the &%quota_warn_message%& option,
20504 and it must start with a &'To:'& header line containing the recipient(s) of the
20505 warning message. These do not necessarily have to include the recipient(s) of
20506 the original message. A &'Subject:'& line should also normally be supplied. You
20507 can include any other header lines that you want. If you do not include a
20508 &'From:'& line, the default is:
20509 .code
20510 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20511 .endd
20512 .oindex &%errors_reply_to%&
20513 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20514 option.
20515
20516 The &%quota%& option does not have to be set in order to use this option; they
20517 are independent of one another except when the threshold is specified as a
20518 percentage.
20519
20520
20521 .option use_bsmtp appendfile boolean false
20522 .cindex "envelope sender"
20523 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20524 format, with the envelope sender and recipient(s) included as SMTP commands. If
20525 you want to include a leading HELO command with such messages, you can do
20526 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20527 for details of batch SMTP.
20528
20529
20530 .option use_crlf appendfile boolean false
20531 .cindex "carriage return"
20532 .cindex "linefeed"
20533 This option causes lines to be terminated with the two-character CRLF sequence
20534 (carriage return, linefeed) instead of just a linefeed character. In the case
20535 of batched SMTP, the byte sequence written to the file is then an exact image
20536 of what would be sent down a real SMTP connection.
20537
20538 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20539 (which are used to supply the traditional &"From&~"& and blank line separators
20540 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20541 carriage return characters if these are needed. In cases where these options
20542 have non-empty defaults, the values end with a single linefeed, so they must be
20543 changed to end with &`\r\n`& if &%use_crlf%& is set.
20544
20545
20546 .option use_fcntl_lock appendfile boolean "see below"
20547 This option controls the use of the &[fcntl()]& function to lock a file for
20548 exclusive use when a message is being appended. It is set by default unless
20549 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20550 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20551 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20552
20553
20554 .option use_flock_lock appendfile boolean false
20555 This option is provided to support the use of &[flock()]& for file locking, for
20556 the few situations where it is needed. Most modern operating systems support
20557 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20558 each other. Exim uses &[fcntl()]& locking by default.
20559
20560 This option is required only if you are using an operating system where
20561 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20562 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20563 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20564
20565 .cindex "Solaris" "&[flock()]& support"
20566 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20567 have it (and some, I think, provide a not quite right version built on top of
20568 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20569 the ability to use it, and any attempt to do so will cause a configuration
20570 error.
20571
20572 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20573 is just being mapped onto &[fcntl()]& by the OS).
20574
20575
20576 .option use_lockfile appendfile boolean "see below"
20577 If this option is turned off, Exim does not attempt to create a lock file when
20578 appending to a mailbox file. In this situation, the only locking is by
20579 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20580 sure that every MUA that is ever going to look at your users' mailboxes uses
20581 &[fcntl()]& rather than a lock file, and even then only when you are not
20582 delivering over NFS from more than one host.
20583
20584 .cindex "NFS" "lock file"
20585 In order to append to an NFS file safely from more than one host, it is
20586 necessary to take out a lock &'before'& opening the file, and the lock file
20587 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20588 file corruption.
20589
20590 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20591 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20592 except when &%mbx_format%& is set.
20593
20594
20595 .option use_mbx_lock appendfile boolean "see below"
20596 This option is available only if Exim has been compiled with SUPPORT_MBX
20597 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20598 locking rules be used. It is set by default if &%mbx_format%& is set and none
20599 of the locking options are mentioned in the configuration. The locking rules
20600 are the same as are used by the &'c-client'& library that underlies Pine and
20601 the IMAP4 and POP daemons that come with it (see the discussion below). The
20602 rules allow for shared access to the mailbox. However, this kind of locking
20603 does not work when the mailbox is NFS mounted.
20604
20605 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20606 &%use_flock_lock%& to control what kind of locking is used in implementing the
20607 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20608 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20609
20610
20611
20612
20613 .section "Operational details for appending" "SECTopappend"
20614 .cindex "appending to a file"
20615 .cindex "file" "appending"
20616 Before appending to a file, the following preparations are made:
20617
20618 .ilist
20619 If the name of the file is &_/dev/null_&, no action is taken, and a success
20620 return is given.
20621
20622 .next
20623 .cindex "directory creation"
20624 If any directories on the file's path are missing, Exim creates them if the
20625 &%create_directory%& option is set. A created directory's mode is given by the
20626 &%directory_mode%& option.
20627
20628 .next
20629 If &%file_format%& is set, the format of an existing file is checked. If this
20630 indicates that a different transport should be used, control is passed to that
20631 transport.
20632
20633 .next
20634 .cindex "file" "locking"
20635 .cindex "locking files"
20636 .cindex "NFS" "lock file"
20637 If &%use_lockfile%& is set, a lock file is built in a way that will work
20638 reliably over NFS, as follows:
20639
20640 .olist
20641 Create a &"hitching post"& file whose name is that of the lock file with the
20642 current time, primary host name, and process id added, by opening for writing
20643 as a new file. If this fails with an access error, delivery is deferred.
20644 .next
20645 Close the hitching post file, and hard link it to the lock file name.
20646 .next
20647 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20648 Unlink the hitching post name.
20649 .next
20650 Otherwise, use &[stat()]& to get information about the hitching post file, and
20651 then unlink hitching post name. If the number of links is exactly two, creation
20652 of the lock file succeeded but something (for example, an NFS server crash and
20653 restart) caused this fact not to be communicated to the &[link()]& call.
20654 .next
20655 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20656 up to &%lock_retries%& times. However, since any program that writes to a
20657 mailbox should complete its task very quickly, it is reasonable to time out old
20658 lock files that are normally the result of user agent and system crashes. If an
20659 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20660 it before trying again.
20661 .endlist olist
20662
20663 .next
20664 A call is made to &[lstat()]& to discover whether the main file exists, and if
20665 so, what its characteristics are. If &[lstat()]& fails for any reason other
20666 than non-existence, delivery is deferred.
20667
20668 .next
20669 .cindex "symbolic link" "to mailbox"
20670 .cindex "mailbox" "symbolic link"
20671 If the file does exist and is a symbolic link, delivery is deferred, unless the
20672 &%allow_symlink%& option is set, in which case the ownership of the link is
20673 checked, and then &[stat()]& is called to find out about the real file, which
20674 is then subjected to the checks below. The check on the top-level link
20675 ownership prevents one user creating a link for another's mailbox in a sticky
20676 directory, though allowing symbolic links in this case is definitely not a good
20677 idea. If there is a chain of symbolic links, the intermediate ones are not
20678 checked.
20679
20680 .next
20681 If the file already exists but is not a regular file, or if the file's owner
20682 and group (if the group is being checked &-- see &%check_group%& above) are
20683 different from the user and group under which the delivery is running,
20684 delivery is deferred.
20685
20686 .next
20687 If the file's permissions are more generous than specified, they are reduced.
20688 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20689 is set false, in which case the delivery is tried using the existing
20690 permissions.
20691
20692 .next
20693 The file's inode number is saved, and the file is then opened for appending.
20694 If this fails because the file has vanished, &(appendfile)& behaves as if it
20695 hadn't existed (see below). For any other failures, delivery is deferred.
20696
20697 .next
20698 If the file is opened successfully, check that the inode number hasn't
20699 changed, that it is still a regular file, and that the owner and permissions
20700 have not changed. If anything is wrong, defer delivery and freeze the message.
20701
20702 .next
20703 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20704 option is set. Otherwise, check that the file is being created in a permitted
20705 directory if the &%create_file%& option is set (deferring on failure), and then
20706 open for writing as a new file, with the O_EXCL and O_CREAT options,
20707 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20708 set). In this case, which can happen if the link points to a non-existent file,
20709 the file is opened for writing using O_CREAT but not O_EXCL, because
20710 that prevents link following.
20711
20712 .next
20713 .cindex "loop" "while file testing"
20714 If opening fails because the file exists, obey the tests given above for
20715 existing files. However, to avoid looping in a situation where the file is
20716 being continuously created and destroyed, the exists/not-exists loop is broken
20717 after 10 repetitions, and the message is then frozen.
20718
20719 .next
20720 If opening fails with any other error, defer delivery.
20721
20722 .next
20723 .cindex "file" "locking"
20724 .cindex "locking files"
20725 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20726 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20727 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20728 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20729 file, and an exclusive lock on the file whose name is
20730 .code
20731 /tmp/.<device-number>.<inode-number>
20732 .endd
20733 using the device and inode numbers of the open mailbox file, in accordance with
20734 the MBX locking rules. This file is created with a mode that is specified by
20735 the &%lockfile_mode%& option.
20736
20737 If Exim fails to lock the file, there are two possible courses of action,
20738 depending on the value of the locking timeout. This is obtained from
20739 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20740
20741 If the timeout value is zero, the file is closed, Exim waits for
20742 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20743 to lock it again. This happens up to &%lock_retries%& times, after which the
20744 delivery is deferred.
20745
20746 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20747 &[flock()]& are used (with the given timeout), so there has already been some
20748 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20749 immediately. It retries up to
20750 .code
20751 (lock_retries * lock_interval) / <timeout>
20752 .endd
20753 times (rounded up).
20754 .endlist
20755
20756 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20757 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20758
20759
20760 .section "Operational details for delivery to a new file" "SECTopdir"
20761 .cindex "delivery" "to single file"
20762 .cindex "&""From""& line"
20763 When the &%directory%& option is set instead of &%file%&, each message is
20764 delivered into a newly-created file or set of files. When &(appendfile)& is
20765 activated directly from a &(redirect)& router, neither &%file%& nor
20766 &%directory%& is normally set, because the path for delivery is supplied by the
20767 router. (See for example, the &(address_file)& transport in the default
20768 configuration.) In this case, delivery is to a new file if either the path name
20769 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20770
20771 No locking is required while writing the message to a new file, so the various
20772 locking options of the transport are ignored. The &"From"& line that by default
20773 separates messages in a single file is not normally needed, nor is the escaping
20774 of message lines that start with &"From"&, and there is no need to ensure a
20775 newline at the end of each message. Consequently, the default values for
20776 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20777 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20778
20779 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20780 the files in the delivery directory by default. However, you can specify a
20781 different directory by setting &%quota_directory%&. Also, for maildir
20782 deliveries (see below) the &_maildirfolder_& convention is honoured.
20783
20784
20785 .cindex "maildir format"
20786 .cindex "mailstore format"
20787 There are three different ways in which delivery to individual files can be
20788 done, controlled by the settings of the &%maildir_format%& and
20789 &%mailstore_format%& options. Note that code to support maildir or mailstore
20790 formats is not included in the binary unless SUPPORT_MAILDIR or
20791 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20792
20793 .cindex "directory creation"
20794 In all three cases an attempt is made to create the directory and any necessary
20795 sub-directories if they do not exist, provided that the &%create_directory%&
20796 option is set (the default). The location of a created directory can be
20797 constrained by setting &%create_file%&. A created directory's mode is given by
20798 the &%directory_mode%& option. If creation fails, or if the
20799 &%create_directory%& option is not set when creation is required, delivery is
20800 deferred.
20801
20802
20803
20804 .section "Maildir delivery" "SECTmaildirdelivery"
20805 .cindex "maildir format" "description of"
20806 If the &%maildir_format%& option is true, Exim delivers each message by writing
20807 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20808 directory that is defined by the &%directory%& option (the &"delivery
20809 directory"&). If the delivery is successful, the file is renamed into the
20810 &_new_& subdirectory.
20811
20812 In the file name, <&'stime'&> is the current time of day in seconds, and
20813 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20814 Exim checks that the time-of-day clock has moved on by at least one microsecond
20815 before terminating the delivery process. This guarantees uniqueness for the
20816 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20817 opening it. If any response other than ENOENT (does not exist) is given,
20818 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20819
20820 Before Exim carries out a maildir delivery, it ensures that subdirectories
20821 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20822 do not exist, Exim tries to create them and any superior directories in their
20823 path, subject to the &%create_directory%& and &%create_file%& options. If the
20824 &%maildirfolder_create_regex%& option is set, and the regular expression it
20825 contains matches the delivery directory, Exim also ensures that a file called
20826 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20827 &_maildirfolder_& file cannot be created, delivery is deferred.
20828
20829 These features make it possible to use Exim to create all the necessary files
20830 and directories in a maildir mailbox, including subdirectories for maildir++
20831 folders. Consider this example:
20832 .code
20833 maildir_format = true
20834 directory = /var/mail/$local_part\
20835            ${if eq{$local_part_suffix}{}{}\
20836            {/.${substr_1:$local_part_suffix}}}
20837 maildirfolder_create_regex = /\.[^/]+$
20838 .endd
20839 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20840 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20841 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20842 not match this name, so Exim will not look for or create the file
20843 &_/var/mail/pimbo/maildirfolder_&, though it will create
20844 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20845
20846 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20847 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20848 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20849 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20850 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20851
20852 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20853 not inadvertently match the toplevel maildir directory, because a
20854 &_maildirfolder_& file at top level would completely break quota calculations.
20855
20856 .cindex "quota" "in maildir delivery"
20857 .cindex "maildir++"
20858 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20859 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20860 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20861 Exim assumes the directory is a maildir++ folder directory, which is one level
20862 down from the user's top level mailbox directory. This causes it to start at
20863 the parent directory instead of the current directory when calculating the
20864 amount of space used.
20865
20866 One problem with delivering into a multi-file mailbox is that it is
20867 computationally expensive to compute the size of the mailbox for quota
20868 checking. Various approaches have been taken to reduce the amount of work
20869 needed. The next two sections describe two of them. A third alternative is to
20870 use some external process for maintaining the size data, and use the expansion
20871 of the &%mailbox_size%& option as a way of importing it into Exim.
20872
20873
20874
20875
20876 .section "Using tags to record message sizes" "SECID135"
20877 If &%maildir_tag%& is set, the string is expanded for each delivery.
20878 When the maildir file is renamed into the &_new_& sub-directory, the
20879 tag is added to its name. However, if adding the tag takes the length of the
20880 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20881 the tag is dropped and the maildir file is created with no tag.
20882
20883
20884 .vindex "&$message_size$&"
20885 Tags can be used to encode the size of files in their names; see
20886 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20887 happens after the message has been written. The value of the &$message_size$&
20888 variable is set to the number of bytes actually written. If the expansion is
20889 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20890 be deferred. The expanded tag may contain any printing characters except &"/"&.
20891 Non-printing characters in the string are ignored; if the resulting string is
20892 empty, it is ignored. If it starts with an alphanumeric character, a leading
20893 colon is inserted; this default has not proven to be the path that popular
20894 maildir implementations have chosen (but changing it in Exim would break
20895 backwards compatibility).
20896
20897 For one common implementation, you might set:
20898 .code
20899 maildir_tag = ,S=${message_size}
20900 .endd
20901 but you should check the documentation of the other software to be sure.
20902
20903 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
20904 as this allows Exim to extract the size from your tag, instead of having to
20905 &[stat()]& each message file.
20906
20907
20908 .section "Using a maildirsize file" "SECID136"
20909 .cindex "quota" "in maildir delivery"
20910 .cindex "maildir format" "&_maildirsize_& file"
20911 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20912 storing quota and message size information in a file called &_maildirsize_&
20913 within the toplevel maildir directory. If this file does not exist, Exim
20914 creates it, setting the quota from the &%quota%& option of the transport. If
20915 the maildir directory itself does not exist, it is created before any attempt
20916 to write a &_maildirsize_& file.
20917
20918 The &_maildirsize_& file is used to hold information about the sizes of
20919 messages in the maildir, thus speeding up quota calculations. The quota value
20920 in the file is just a cache; if the quota is changed in the transport, the new
20921 value overrides the cached value when the next message is delivered. The cache
20922 is maintained for the benefit of other programs that access the maildir and
20923 need to know the quota.
20924
20925 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20926 file is maintained (with a zero quota setting), but no quota is imposed.
20927
20928 A regular expression is available for controlling which directories in the
20929 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20930 See the description of the &%maildir_quota_directory_regex%& option above for
20931 details.
20932
20933
20934 .section "Mailstore delivery" "SECID137"
20935 .cindex "mailstore format" "description of"
20936 If the &%mailstore_format%& option is true, each message is written as two
20937 files in the given directory. A unique base name is constructed from the
20938 message id and the current delivery process, and the files that are written use
20939 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20940 contains the message's envelope, and the &_.msg_& file contains the message
20941 itself. The base name is placed in the variable &$mailstore_basename$&.
20942
20943 During delivery, the envelope is first written to a file with the suffix
20944 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20945 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20946 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20947 file before accessing either of them. An alternative approach is to wait for
20948 the absence of a &_.tmp_& file.
20949
20950 The envelope file starts with any text defined by the &%mailstore_prefix%&
20951 option, expanded and terminated by a newline if there isn't one. Then follows
20952 the sender address on one line, then all the recipient addresses, one per line.
20953 There can be more than one recipient only if the &%batch_max%& option is set
20954 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20955 appended to the file, followed by a newline if it does not end with one.
20956
20957 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20958 failure, it is ignored. Other expansion errors are treated as serious
20959 configuration errors, and delivery is deferred. The variable
20960 &$mailstore_basename$& is available for use during these expansions.
20961
20962
20963 .section "Non-special new file delivery" "SECID138"
20964 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20965 file is created directly in the named directory. For example, when delivering
20966 messages into files in batched SMTP format for later delivery to some host (see
20967 section &<<SECTbatchSMTP>>&), a setting such as
20968 .code
20969 directory = /var/bsmtp/$host
20970 .endd
20971 might be used. A message is written to a file with a temporary name, which is
20972 then renamed when the delivery is complete. The final name is obtained by
20973 expanding the contents of the &%directory_file%& option.
20974 .ecindex IIDapptra1
20975 .ecindex IIDapptra2
20976
20977
20978
20979
20980
20981
20982 . ////////////////////////////////////////////////////////////////////////////
20983 . ////////////////////////////////////////////////////////////////////////////
20984
20985 .chapter "The autoreply transport" "CHID8"
20986 .scindex IIDauttra1 "transports" "&(autoreply)&"
20987 .scindex IIDauttra2 "&(autoreply)& transport"
20988 The &(autoreply)& transport is not a true transport in that it does not cause
20989 the message to be transmitted. Instead, it generates a new mail message as an
20990 automatic reply to the incoming message. &'References:'& and
20991 &'Auto-Submitted:'& header lines are included. These are constructed according
20992 to the rules in RFCs 2822 and 3834, respectively.
20993
20994 If the router that passes the message to this transport does not have the
20995 &%unseen%& option set, the original message (for the current recipient) is not
20996 delivered anywhere. However, when the &%unseen%& option is set on the router
20997 that passes the message to this transport, routing of the address continues, so
20998 another router can set up a normal message delivery.
20999
21000
21001 The &(autoreply)& transport is usually run as the result of mail filtering, a
21002 &"vacation"& message being the standard example. However, it can also be run
21003 directly from a router like any other transport. To reduce the possibility of
21004 message cascades, messages created by the &(autoreply)& transport always have
21005 empty envelope sender addresses, like bounce messages.
21006
21007 The parameters of the message to be sent can be specified in the configuration
21008 by options described below. However, these are used only when the address
21009 passed to the transport does not contain its own reply information. When the
21010 transport is run as a consequence of a
21011 &%mail%&
21012 or &%vacation%& command in a filter file, the parameters of the message are
21013 supplied by the filter, and passed with the address. The transport's options
21014 that define the message are then ignored (so they are not usually set in this
21015 case). The message is specified entirely by the filter or by the transport; it
21016 is never built from a mixture of options. However, the &%file_optional%&,
21017 &%mode%&, and &%return_message%& options apply in all cases.
21018
21019 &(Autoreply)& is implemented as a local transport. When used as a result of a
21020 command in a user's filter file, &(autoreply)& normally runs under the uid and
21021 gid of the user, and with appropriate current and home directories (see chapter
21022 &<<CHAPenvironment>>&).
21023
21024 There is a subtle difference between routing a message to a &(pipe)& transport
21025 that generates some text to be returned to the sender, and routing it to an
21026 &(autoreply)& transport. This difference is noticeable only if more than one
21027 address from the same message is so handled. In the case of a pipe, the
21028 separate outputs from the different addresses are gathered up and returned to
21029 the sender in a single message, whereas if &(autoreply)& is used, a separate
21030 message is generated for each address that is passed to it.
21031
21032 Non-printing characters are not permitted in the header lines generated for the
21033 message that &(autoreply)& creates, with the exception of newlines that are
21034 immediately followed by white space. If any non-printing characters are found,
21035 the transport defers.
21036 Whether characters with the top bit set count as printing characters or not is
21037 controlled by the &%print_topbitchars%& global option.
21038
21039 If any of the generic options for manipulating headers (for example,
21040 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21041 of the original message that is included in the generated message when
21042 &%return_message%& is set. They do not apply to the generated message itself.
21043
21044 .vindex "&$sender_address$&"
21045 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21046 the message, indicating that there were no recipients, it does not treat this
21047 as an error. This means that autoreplies sent to &$sender_address$& when this
21048 is empty (because the incoming message is a bounce message) do not cause
21049 problems. They are just discarded.
21050
21051
21052
21053 .section "Private options for autoreply" "SECID139"
21054 .cindex "options" "&(autoreply)& transport"
21055
21056 .option bcc autoreply string&!! unset
21057 This specifies the addresses that are to receive &"blind carbon copies"& of the
21058 message when the message is specified by the transport.
21059
21060
21061 .option cc autoreply string&!! unset
21062 This specifies recipients of the message and the contents of the &'Cc:'& header
21063 when the message is specified by the transport.
21064
21065
21066 .option file autoreply string&!! unset
21067 The contents of the file are sent as the body of the message when the message
21068 is specified by the transport. If both &%file%& and &%text%& are set, the text
21069 string comes first.
21070
21071
21072 .option file_expand autoreply boolean false
21073 If this is set, the contents of the file named by the &%file%& option are
21074 subjected to string expansion as they are added to the message.
21075
21076
21077 .option file_optional autoreply boolean false
21078 If this option is true, no error is generated if the file named by the &%file%&
21079 option or passed with the address does not exist or cannot be read.
21080
21081
21082 .option from autoreply string&!! unset
21083 This specifies the contents of the &'From:'& header when the message is
21084 specified by the transport.
21085
21086
21087 .option headers autoreply string&!! unset
21088 This specifies additional RFC 2822 headers that are to be added to the message
21089 when the message is specified by the transport. Several can be given by using
21090 &"\n"& to separate them. There is no check on the format.
21091
21092
21093 .option log autoreply string&!! unset
21094 This option names a file in which a record of every message sent is logged when
21095 the message is specified by the transport.
21096
21097
21098 .option mode autoreply "octal integer" 0600
21099 If either the log file or the &"once"& file has to be created, this mode is
21100 used.
21101
21102
21103 .option never_mail autoreply "address list&!!" unset
21104 If any run of the transport creates a message with a recipient that matches any
21105 item in the list, that recipient is quietly discarded. If all recipients are
21106 discarded, no message is created. This applies both when the recipients are
21107 generated by a filter and when they are specified in the transport.
21108
21109
21110
21111 .option once autoreply string&!! unset
21112 This option names a file or DBM database in which a record of each &'To:'&
21113 recipient is kept when the message is specified by the transport. &*Note*&:
21114 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21115
21116 If &%once%& is unset, or is set to an empty string, the message is always sent.
21117 By default, if &%once%& is set to a non-empty file name, the message
21118 is not sent if a potential recipient is already listed in the database.
21119 However, if the &%once_repeat%& option specifies a time greater than zero, the
21120 message is sent if that much time has elapsed since a message was last sent to
21121 this recipient. A setting of zero time for &%once_repeat%& (the default)
21122 prevents a message from being sent a second time &-- in this case, zero means
21123 infinity.
21124
21125 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21126 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21127 greater than zero, it changes the way Exim implements the &%once%& option.
21128 Instead of using a DBM file to record every recipient it sends to, it uses a
21129 regular file, whose size will never get larger than the given value.
21130
21131 In the file, Exim keeps a linear list of recipient addresses and the times at
21132 which they were sent messages. If the file is full when a new address needs to
21133 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21134 means that a given recipient may receive multiple messages, but at
21135 unpredictable intervals that depend on the rate of turnover of addresses in the
21136 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21137
21138
21139 .option once_file_size autoreply integer 0
21140 See &%once%& above.
21141
21142
21143 .option once_repeat autoreply time&!! 0s
21144 See &%once%& above.
21145 After expansion, the value of this option must be a valid time value.
21146
21147
21148 .option reply_to autoreply string&!! unset
21149 This specifies the contents of the &'Reply-To:'& header when the message is
21150 specified by the transport.
21151
21152
21153 .option return_message autoreply boolean false
21154 If this is set, a copy of the original message is returned with the new
21155 message, subject to the maximum size set in the &%return_size_limit%& global
21156 configuration option.
21157
21158
21159 .option subject autoreply string&!! unset
21160 This specifies the contents of the &'Subject:'& header when the message is
21161 specified by the transport. It is tempting to quote the original subject in
21162 automatic responses. For example:
21163 .code
21164 subject = Re: $h_subject:
21165 .endd
21166 There is a danger in doing this, however. It may allow a third party to
21167 subscribe your users to an opt-in mailing list, provided that the list accepts
21168 bounce messages as subscription confirmations. Well-managed lists require a
21169 non-bounce message to confirm a subscription, so the danger is relatively
21170 small.
21171
21172
21173
21174 .option text autoreply string&!! unset
21175 This specifies a single string to be used as the body of the message when the
21176 message is specified by the transport. If both &%text%& and &%file%& are set,
21177 the text comes first.
21178
21179
21180 .option to autoreply string&!! unset
21181 This specifies recipients of the message and the contents of the &'To:'& header
21182 when the message is specified by the transport.
21183 .ecindex IIDauttra1
21184 .ecindex IIDauttra2
21185
21186
21187
21188
21189 . ////////////////////////////////////////////////////////////////////////////
21190 . ////////////////////////////////////////////////////////////////////////////
21191
21192 .chapter "The lmtp transport" "CHAPLMTP"
21193 .cindex "transports" "&(lmtp)&"
21194 .cindex "&(lmtp)& transport"
21195 .cindex "LMTP" "over a pipe"
21196 .cindex "LMTP" "over a socket"
21197 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21198 specified command
21199 or by interacting with a Unix domain socket.
21200 This transport is something of a cross between the &(pipe)& and &(smtp)&
21201 transports. Exim also has support for using LMTP over TCP/IP; this is
21202 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21203 to be of minority interest, the default build-time configure in &_src/EDITME_&
21204 has it commented out. You need to ensure that
21205 .code
21206 TRANSPORT_LMTP=yes
21207 .endd
21208 .cindex "options" "&(lmtp)& transport"
21209 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21210 included in the Exim binary. The private options of the &(lmtp)& transport are
21211 as follows:
21212
21213 .option batch_id lmtp string&!! unset
21214 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21215
21216
21217 .option batch_max lmtp integer 1
21218 This limits the number of addresses that can be handled in a single delivery.
21219 Most LMTP servers can handle several addresses at once, so it is normally a
21220 good idea to increase this value. See the description of local delivery
21221 batching in chapter &<<CHAPbatching>>&.
21222
21223
21224 .option command lmtp string&!! unset
21225 This option must be set if &%socket%& is not set. The string is a command which
21226 is run in a separate process. It is split up into a command name and list of
21227 arguments, each of which is separately expanded (so expansion cannot change the
21228 number of arguments). The command is run directly, not via a shell. The message
21229 is passed to the new process using the standard input and output to operate the
21230 LMTP protocol.
21231
21232 .option ignore_quota lmtp boolean false
21233 .cindex "LMTP" "ignoring quota errors"
21234 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21235 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21236 in its response to the LHLO command.
21237
21238 .option socket lmtp string&!! unset
21239 This option must be set if &%command%& is not set. The result of expansion must
21240 be the name of a Unix domain socket. The transport connects to the socket and
21241 delivers the message to it using the LMTP protocol.
21242
21243
21244 .option timeout lmtp time 5m
21245 The transport is aborted if the created process or Unix domain socket does not
21246 respond to LMTP commands or message input within this timeout. Delivery
21247 is deferred, and will be tried again later. Here is an example of a typical
21248 LMTP transport:
21249 .code
21250 lmtp:
21251   driver = lmtp
21252   command = /some/local/lmtp/delivery/program
21253   batch_max = 20
21254   user = exim
21255 .endd
21256 This delivers up to 20 addresses at a time, in a mixture of domains if
21257 necessary, running as the user &'exim'&.
21258
21259
21260
21261 . ////////////////////////////////////////////////////////////////////////////
21262 . ////////////////////////////////////////////////////////////////////////////
21263
21264 .chapter "The pipe transport" "CHAPpipetransport"
21265 .scindex IIDpiptra1 "transports" "&(pipe)&"
21266 .scindex IIDpiptra2 "&(pipe)& transport"
21267 The &(pipe)& transport is used to deliver messages via a pipe to a command
21268 running in another process. One example is the use of &(pipe)& as a
21269 pseudo-remote transport for passing messages to some other delivery mechanism
21270 (such as UUCP). Another is the use by individual users to automatically process
21271 their incoming messages. The &(pipe)& transport can be used in one of the
21272 following ways:
21273
21274 .ilist
21275 .vindex "&$local_part$&"
21276 A router routes one address to a transport in the normal way, and the
21277 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21278 contains the local part of the address (as usual), and the command that is run
21279 is specified by the &%command%& option on the transport.
21280 .next
21281 .vindex "&$pipe_addresses$&"
21282 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21283 transport can handle more than one address in a single run. In this case, when
21284 more than one address is routed to the transport, &$local_part$& is not set
21285 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21286 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21287 that are routed to the transport.
21288 .next
21289 .vindex "&$address_pipe$&"
21290 A router redirects an address directly to a pipe command (for example, from an
21291 alias or forward file). In this case, &$address_pipe$& contains the text of the
21292 pipe command, and the &%command%& option on the transport is ignored. If only
21293 one address is being transported (&%batch_max%& is not greater than one, or
21294 only one address was redirected to this pipe command), &$local_part$& contains
21295 the local part that was redirected.
21296 .endlist
21297
21298
21299 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21300 deliver messages over pipes using the LMTP interactive protocol. This is
21301 implemented by the &(lmtp)& transport.
21302
21303 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21304 &_.forward_& file, the command runs under the uid and gid of that user. In
21305 other cases, the uid and gid have to be specified explicitly, either on the
21306 transport or on the router that handles the address. Current and &"home"&
21307 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21308 details of the local delivery environment and chapter &<<CHAPbatching>>&
21309 for a discussion of local delivery batching.
21310
21311
21312 .section "Concurrent delivery" "SECID140"
21313 If two messages arrive at almost the same time, and both are routed to a pipe
21314 delivery, the two pipe transports may be run concurrently. You must ensure that
21315 any pipe commands you set up are robust against this happening. If the commands
21316 write to a file, the &%exim_lock%& utility might be of use.
21317
21318
21319
21320
21321 .section "Returned status and data" "SECID141"
21322 .cindex "&(pipe)& transport" "returned data"
21323 If the command exits with a non-zero return code, the delivery is deemed to
21324 have failed, unless either the &%ignore_status%& option is set (in which case
21325 the return code is treated as zero), or the return code is one of those listed
21326 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21327 later"&. In this case, delivery is deferred. Details of a permanent failure are
21328 logged, but are not included in the bounce message, which merely contains
21329 &"local delivery failed"&.
21330
21331 If the command exits on a signal and the &%freeze_signal%& option is set then
21332 the message will be frozen in the queue. If that option is not set, a bounce
21333 will be sent as normal.
21334
21335 If the return code is greater than 128 and the command being run is a shell
21336 script, it normally means that the script was terminated by a signal whose
21337 value is the return code minus 128. The &%freeze_signal%& option does not
21338 apply in this case.
21339
21340 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21341 return code is set to 127. This is the value that a shell returns if it is
21342 asked to run a non-existent command. The wording for the log line suggests that
21343 a non-existent command may be the problem.
21344
21345 The &%return_output%& option can affect the result of a pipe delivery. If it is
21346 set and the command produces any output on its standard output or standard
21347 error streams, the command is considered to have failed, even if it gave a zero
21348 return code or if &%ignore_status%& is set. The output from the command is
21349 included as part of the bounce message. The &%return_fail_output%& option is
21350 similar, except that output is returned only when the command exits with a
21351 failure return code, that is, a value other than zero or a code that matches
21352 &%temp_errors%&.
21353
21354
21355
21356 .section "How the command is run" "SECThowcommandrun"
21357 .cindex "&(pipe)& transport" "path for command"
21358 The command line is (by default) broken down into a command name and arguments
21359 by the &(pipe)& transport itself. The &%allow_commands%& and
21360 &%restrict_to_path%& options can be used to restrict the commands that may be
21361 run.
21362
21363 .cindex "quoting" "in pipe command"
21364 Unquoted arguments are delimited by white space. If an argument appears in
21365 double quotes, backslash is interpreted as an escape character in the usual
21366 way. If an argument appears in single quotes, no escaping is done.
21367
21368 String expansion is applied to the command line except when it comes from a
21369 traditional &_.forward_& file (commands from a filter file are expanded). The
21370 expansion is applied to each argument in turn rather than to the whole line.
21371 For this reason, any string expansion item that contains white space must be
21372 quoted so as to be contained within a single argument. A setting such as
21373 .code
21374 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21375 .endd
21376 will not work, because the expansion item gets split between several
21377 arguments. You have to write
21378 .code
21379 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21380 .endd
21381 to ensure that it is all in one argument. The expansion is done in this way,
21382 argument by argument, so that the number of arguments cannot be changed as a
21383 result of expansion, and quotes or backslashes in inserted variables do not
21384 interact with external quoting. However, this leads to problems if you want to
21385 generate multiple arguments (or the command name plus arguments) from a single
21386 expansion. In this situation, the simplest solution is to use a shell. For
21387 example:
21388 .code
21389 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21390 .endd
21391
21392 .cindex "transport" "filter"
21393 .cindex "filter" "transport filter"
21394 .vindex "&$pipe_addresses$&"
21395 Special handling takes place when an argument consists of precisely the text
21396 &`$pipe_addresses`&. This is not a general expansion variable; the only
21397 place this string is recognized is when it appears as an argument for a pipe or
21398 transport filter command. It causes each address that is being handled to be
21399 inserted in the argument list at that point &'as a separate argument'&. This
21400 avoids any problems with spaces or shell metacharacters, and is of use when a
21401 &(pipe)& transport is handling groups of addresses in a batch.
21402
21403 After splitting up into arguments and expansion, the resulting command is run
21404 in a subprocess directly from the transport, &'not'& under a shell. The
21405 message that is being delivered is supplied on the standard input, and the
21406 standard output and standard error are both connected to a single pipe that is
21407 read by Exim. The &%max_output%& option controls how much output the command
21408 may produce, and the &%return_output%& and &%return_fail_output%& options
21409 control what is done with it.
21410
21411 Not running the command under a shell (by default) lessens the security risks
21412 in cases when a command from a user's filter file is built out of data that was
21413 taken from an incoming message. If a shell is required, it can of course be
21414 explicitly specified as the command to be run. However, there are circumstances
21415 where existing commands (for example, in &_.forward_& files) expect to be run
21416 under a shell and cannot easily be modified. To allow for these cases, there is
21417 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21418 works. Instead of breaking up the command line as just described, it expands it
21419 as a single string and passes the result to &_/bin/sh_&. The
21420 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21421 with &%use_shell%&, and the whole mechanism is inherently less secure.
21422
21423
21424
21425 .section "Environment variables" "SECTpipeenv"
21426 .cindex "&(pipe)& transport" "environment for command"
21427 .cindex "environment for pipe transport"
21428 The environment variables listed below are set up when the command is invoked.
21429 This list is a compromise for maximum compatibility with other MTAs. Note that
21430 the &%environment%& option can be used to add additional variables to this
21431 environment.
21432 .display
21433 &`DOMAIN            `&   the domain of the address
21434 &`HOME              `&   the home directory, if set
21435 &`HOST              `&   the host name when called from a router (see below)
21436 &`LOCAL_PART        `&   see below
21437 &`LOCAL_PART_PREFIX `&   see below
21438 &`LOCAL_PART_SUFFIX `&   see below
21439 &`LOGNAME           `&   see below
21440 &`MESSAGE_ID        `&   Exim's local ID for the message
21441 &`PATH              `&   as specified by the &%path%& option below
21442 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21443 &`RECIPIENT         `&   the complete recipient address
21444 &`SENDER            `&   the sender of the message (empty if a bounce)
21445 &`SHELL             `&   &`/bin/sh`&
21446 &`TZ                `&   the value of the &%timezone%& option, if set
21447 &`USER              `&   see below
21448 .endd
21449 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21450 router, LOCAL_PART is set to the local part of the address. When it is
21451 called as a result of a forward or alias expansion, LOCAL_PART is set to
21452 the local part of the address that was expanded. In both cases, any affixes are
21453 removed from the local part, and made available in LOCAL_PART_PREFIX and
21454 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21455 same value as LOCAL_PART for compatibility with other MTAs.
21456
21457 .cindex "HOST"
21458 HOST is set only when a &(pipe)& transport is called from a router that
21459 associates hosts with an address, typically when using &(pipe)& as a
21460 pseudo-remote transport. HOST is set to the first host name specified by
21461 the router.
21462
21463 .cindex "HOME"
21464 If the transport's generic &%home_directory%& option is set, its value is used
21465 for the HOME environment variable. Otherwise, a home directory may be set
21466 by the router's &%transport_home_directory%& option, which defaults to the
21467 user's home directory if &%check_local_user%& is set.
21468
21469
21470 .section "Private options for pipe" "SECID142"
21471 .cindex "options" "&(pipe)& transport"
21472
21473
21474
21475 .option allow_commands pipe "string list&!!" unset
21476 .cindex "&(pipe)& transport" "permitted commands"
21477 The string is expanded, and is then interpreted as a colon-separated list of
21478 permitted commands. If &%restrict_to_path%& is not set, the only commands
21479 permitted are those in the &%allow_commands%& list. They need not be absolute
21480 paths; the &%path%& option is still used for relative paths. If
21481 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21482 in the &%allow_commands%& list, or a name without any slashes that is found on
21483 the path. In other words, if neither &%allow_commands%& nor
21484 &%restrict_to_path%& is set, there is no restriction on the command, but
21485 otherwise only commands that are permitted by one or the other are allowed. For
21486 example, if
21487 .code
21488 allow_commands = /usr/bin/vacation
21489 .endd
21490 and &%restrict_to_path%& is not set, the only permitted command is
21491 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21492 &%use_shell%& is set.
21493
21494
21495 .option batch_id pipe string&!! unset
21496 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21497
21498
21499 .option batch_max pipe integer 1
21500 This limits the number of addresses that can be handled in a single delivery.
21501 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21502
21503
21504 .option check_string pipe string unset
21505 As &(pipe)& writes the message, the start of each line is tested for matching
21506 &%check_string%&, and if it does, the initial matching characters are replaced
21507 by the contents of &%escape_string%&, provided both are set. The value of
21508 &%check_string%& is a literal string, not a regular expression, and the case of
21509 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21510 of &%check_string%& and &%escape_string%& are forced to values that implement
21511 the SMTP escaping protocol. Any settings made in the configuration file are
21512 ignored.
21513
21514
21515 .option command pipe string&!! unset
21516 This option need not be set when &(pipe)& is being used to deliver to pipes
21517 obtained directly from address redirections. In other cases, the option must be
21518 set, to provide a command to be run. It need not yield an absolute path (see
21519 the &%path%& option below). The command is split up into separate arguments by
21520 Exim, and each argument is separately expanded, as described in section
21521 &<<SECThowcommandrun>>& above.
21522
21523
21524 .option environment pipe string&!! unset
21525 .cindex "&(pipe)& transport" "environment for command"
21526 .cindex "environment for &(pipe)& transport"
21527 This option is used to add additional variables to the environment in which the
21528 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21529 a string which is expanded, and then interpreted as a colon-separated list of
21530 environment settings of the form <&'name'&>=<&'value'&>.
21531
21532
21533 .option escape_string pipe string unset
21534 See &%check_string%& above.
21535
21536
21537 .option freeze_exec_fail pipe boolean false
21538 .cindex "exec failure"
21539 .cindex "failure of exec"
21540 .cindex "&(pipe)& transport" "failure of exec"
21541 Failure to exec the command in a pipe transport is by default treated like
21542 any other failure while running the command. However, if &%freeze_exec_fail%&
21543 is set, failure to exec is treated specially, and causes the message to be
21544 frozen, whatever the setting of &%ignore_status%&.
21545
21546
21547 .option freeze_signal pipe boolean false
21548 .cindex "signal exit"
21549 .cindex "&(pipe)& transport", "signal exit"
21550 Normally if the process run by a command in a pipe transport exits on a signal,
21551 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21552 frozen in Exim's queue instead.
21553
21554
21555 .option ignore_status pipe boolean false
21556 If this option is true, the status returned by the subprocess that is set up to
21557 run the command is ignored, and Exim behaves as if zero had been returned.
21558 Otherwise, a non-zero status or termination by signal causes an error return
21559 from the transport unless the status value is one of those listed in
21560 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21561
21562 &*Note*&: This option does not apply to timeouts, which do not return a status.
21563 See the &%timeout_defer%& option for how timeouts are handled.
21564
21565 .option log_defer_output pipe boolean false
21566 .cindex "&(pipe)& transport" "logging output"
21567 If this option is set, and the status returned by the command is
21568 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21569 and any output was produced, the first line of it is written to the main log.
21570
21571
21572 .option log_fail_output pipe boolean false
21573 If this option is set, and the command returns any output, and also ends with a
21574 return code that is neither zero nor one of the return codes listed in
21575 &%temp_errors%& (that is, the delivery failed), the first line of output is
21576 written to the main log. This option and &%log_output%& are mutually exclusive.
21577 Only one of them may be set.
21578
21579
21580
21581 .option log_output pipe boolean false
21582 If this option is set and the command returns any output, the first line of
21583 output is written to the main log, whatever the return code. This option and
21584 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21585
21586
21587
21588 .option max_output pipe integer 20K
21589 This specifies the maximum amount of output that the command may produce on its
21590 standard output and standard error file combined. If the limit is exceeded, the
21591 process running the command is killed. This is intended as a safety measure to
21592 catch runaway processes. The limit is applied independently of the settings of
21593 the options that control what is done with such output (for example,
21594 &%return_output%&). Because of buffering effects, the amount of output may
21595 exceed the limit by a small amount before Exim notices.
21596
21597
21598 .option message_prefix pipe string&!! "see below"
21599 The string specified here is expanded and output at the start of every message.
21600 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21601 .code
21602 message_prefix = \
21603   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21604   ${tod_bsdinbox}\n
21605 .endd
21606 .cindex "Cyrus"
21607 .cindex "&%tmail%&"
21608 .cindex "&""From""& line"
21609 This is required by the commonly used &_/usr/bin/vacation_& program.
21610 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21611 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21612 setting
21613 .code
21614 message_prefix =
21615 .endd
21616 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21617 &`\n`& to &`\r\n`& in &%message_prefix%&.
21618
21619
21620 .option message_suffix pipe string&!! "see below"
21621 The string specified here is expanded and output at the end of every message.
21622 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21623 The suffix can be suppressed by setting
21624 .code
21625 message_suffix =
21626 .endd
21627 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21628 &`\n`& to &`\r\n`& in &%message_suffix%&.
21629
21630
21631 .option path pipe string "see below"
21632 This option specifies the string that is set up in the PATH environment
21633 variable of the subprocess. The default is:
21634 .code
21635 /bin:/usr/bin
21636 .endd
21637 If the &%command%& option does not yield an absolute path name, the command is
21638 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21639 apply to a command specified as a transport filter.
21640
21641
21642 .option permit_coredump pipe boolean false
21643 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21644 a core-dump of a pipe command, enable this command.  This enables core-dumps
21645 during delivery and affects both the Exim binary and the pipe command run.
21646 It is recommended that this option remain off unless and until you have a need
21647 for it and that this only be enabled when needed, as the risk of excessive
21648 resource consumption can be quite high.  Note also that Exim is typically
21649 installed as a setuid binary and most operating systems will inhibit coredumps
21650 of these by default, so further OS-specific action may be required.
21651
21652
21653 .option pipe_as_creator pipe boolean false
21654 .cindex "uid (user id)" "local delivery"
21655 If the generic &%user%& option is not set and this option is true, the delivery
21656 process is run under the uid that was in force when Exim was originally called
21657 to accept the message. If the group id is not otherwise set (via the generic
21658 &%group%& option), the gid that was in force when Exim was originally called to
21659 accept the message is used.
21660
21661
21662 .option restrict_to_path pipe boolean false
21663 When this option is set, any command name not listed in &%allow_commands%& must
21664 contain no slashes. The command is searched for only in the directories listed
21665 in the &%path%& option. This option is intended for use in the case when a pipe
21666 command has been generated from a user's &_.forward_& file. This is usually
21667 handled by a &(pipe)& transport called &%address_pipe%&.
21668
21669
21670 .option return_fail_output pipe boolean false
21671 If this option is true, and the command produced any output and ended with a
21672 return code other than zero or one of the codes listed in &%temp_errors%& (that
21673 is, the delivery failed), the output is returned in the bounce message.
21674 However, if the message has a null sender (that is, it is itself a bounce
21675 message), output from the command is discarded. This option and
21676 &%return_output%& are mutually exclusive. Only one of them may be set.
21677
21678
21679
21680 .option return_output pipe boolean false
21681 If this option is true, and the command produced any output, the delivery is
21682 deemed to have failed whatever the return code from the command, and the output
21683 is returned in the bounce message. Otherwise, the output is just discarded.
21684 However, if the message has a null sender (that is, it is a bounce message),
21685 output from the command is always discarded, whatever the setting of this
21686 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21687 of them may be set.
21688
21689
21690
21691 .option temp_errors pipe "string list" "see below"
21692 .cindex "&(pipe)& transport" "temporary failure"
21693 This option contains either a colon-separated list of numbers, or a single
21694 asterisk. If &%ignore_status%& is false
21695 and &%return_output%& is not set,
21696 and the command exits with a non-zero return code, the failure is treated as
21697 temporary and the delivery is deferred if the return code matches one of the
21698 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21699 codes are treated as permanent errors. The default setting contains the codes
21700 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21701 compiled on a system that does not define these macros, it assumes values of 75
21702 and 73, respectively.
21703
21704
21705 .option timeout pipe time 1h
21706 If the command fails to complete within this time, it is killed. This normally
21707 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21708 specifies no timeout. In order to ensure that any subprocesses created by the
21709 command are also killed, Exim makes the initial process a process group leader,
21710 and kills the whole process group on a timeout. However, this can be defeated
21711 if one of the processes starts a new process group.
21712
21713 .option timeout_defer pipe boolean false
21714 A timeout in a &(pipe)& transport, either in the command that the transport
21715 runs, or in a transport filter that is associated with it, is by default
21716 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21717 is set true, both kinds of timeout become temporary errors, causing the
21718 delivery to be deferred.
21719
21720 .option umask pipe "octal integer" 022
21721 This specifies the umask setting for the subprocess that runs the command.
21722
21723
21724 .option use_bsmtp pipe boolean false
21725 .cindex "envelope sender"
21726 If this option is set true, the &(pipe)& transport writes messages in &"batch
21727 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21728 commands. If you want to include a leading HELO command with such messages,
21729 you can do so by setting the &%message_prefix%& option. See section
21730 &<<SECTbatchSMTP>>& for details of batch SMTP.
21731
21732 .option use_classresources pipe boolean false
21733 .cindex "class resources (BSD)"
21734 This option is available only when Exim is running on FreeBSD, NetBSD, or
21735 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21736 resource limits when a &(pipe)& transport is run to perform a delivery. The
21737 limits for the uid under which the pipe is to run are obtained from the login
21738 class database.
21739
21740
21741 .option use_crlf pipe boolean false
21742 .cindex "carriage return"
21743 .cindex "linefeed"
21744 This option causes lines to be terminated with the two-character CRLF sequence
21745 (carriage return, linefeed) instead of just a linefeed character. In the case
21746 of batched SMTP, the byte sequence written to the pipe is then an exact image
21747 of what would be sent down a real SMTP connection.
21748
21749 The contents of the &%message_prefix%& and &%message_suffix%& options are
21750 written verbatim, so must contain their own carriage return characters if these
21751 are needed. When &%use_bsmtp%& is not set, the default values for both
21752 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21753 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21754
21755
21756 .option use_shell pipe boolean false
21757 .vindex "&$pipe_addresses$&"
21758 If this option is set, it causes the command to be passed to &_/bin/sh_&
21759 instead of being run directly from the transport, as described in section
21760 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21761 where the command is expected to be run under a shell and cannot easily be
21762 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21763 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21764 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21765 its &%-c%& option.
21766
21767
21768
21769 .section "Using an external local delivery agent" "SECID143"
21770 .cindex "local delivery" "using an external agent"
21771 .cindex "&'procmail'&"
21772 .cindex "external local delivery"
21773 .cindex "delivery" "&'procmail'&"
21774 .cindex "delivery" "by external agent"
21775 The &(pipe)& transport can be used to pass all messages that require local
21776 delivery to a separate local delivery agent such as &%procmail%&. When doing
21777 this, care must be taken to ensure that the pipe is run under an appropriate
21778 uid and gid. In some configurations one wants this to be a uid that is trusted
21779 by the delivery agent to supply the correct sender of the message. It may be
21780 necessary to recompile or reconfigure the delivery agent so that it trusts an
21781 appropriate user. The following is an example transport and router
21782 configuration for &%procmail%&:
21783 .code
21784 # transport
21785 procmail_pipe:
21786   driver = pipe
21787   command = /usr/local/bin/procmail -d $local_part
21788   return_path_add
21789   delivery_date_add
21790   envelope_to_add
21791   check_string = "From "
21792   escape_string = ">From "
21793   umask = 077
21794   user = $local_part
21795   group = mail
21796
21797 # router
21798 procmail:
21799   driver = accept
21800   check_local_user
21801   transport = procmail_pipe
21802 .endd
21803 In this example, the pipe is run as the local user, but with the group set to
21804 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21805 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21806 user to supply a correct sender address. If you do not specify either a
21807 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21808 home directory is the user's home directory by default.
21809
21810 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21811 .code
21812 IFS=" "
21813 .endd
21814 as shown in some &%procmail%& documentation, because Exim does not by default
21815 use a shell to run pipe commands.
21816
21817 .cindex "Cyrus"
21818 The next example shows a transport and a router for a system where local
21819 deliveries are handled by the Cyrus IMAP server.
21820 .code
21821 # transport
21822 local_delivery_cyrus:
21823   driver = pipe
21824   command = /usr/cyrus/bin/deliver \
21825             -m ${substr_1:$local_part_suffix} -- $local_part
21826   user = cyrus
21827   group = mail
21828   return_output
21829   log_output
21830   message_prefix =
21831   message_suffix =
21832
21833 # router
21834 local_user_cyrus:
21835   driver = accept
21836   check_local_user
21837   local_part_suffix = .*
21838   transport = local_delivery_cyrus
21839 .endd
21840 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21841 &%return_output%& to cause any text written by Cyrus to be returned to the
21842 sender.
21843 .ecindex IIDpiptra1
21844 .ecindex IIDpiptra2
21845
21846
21847 . ////////////////////////////////////////////////////////////////////////////
21848 . ////////////////////////////////////////////////////////////////////////////
21849
21850 .chapter "The smtp transport" "CHAPsmtptrans"
21851 .scindex IIDsmttra1 "transports" "&(smtp)&"
21852 .scindex IIDsmttra2 "&(smtp)& transport"
21853 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21854 or LMTP protocol. The list of hosts to try can either be taken from the address
21855 that is being processed (having been set up by the router), or specified
21856 explicitly for the transport. Timeout and retry processing (see chapter
21857 &<<CHAPretry>>&) is applied to each IP address independently.
21858
21859
21860 .section "Multiple messages on a single connection" "SECID144"
21861 The sending of multiple messages over a single TCP/IP connection can arise in
21862 two ways:
21863
21864 .ilist
21865 If a message contains more than &%max_rcpt%& (see below) addresses that are
21866 routed to the same host, more than one copy of the message has to be sent to
21867 that host. In this situation, multiple copies may be sent in a single run of
21868 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21869 does when it has too many addresses to send in one message also depends on the
21870 value of the global &%remote_max_parallel%& option. Details are given in
21871 section &<<SECToutSMTPTCP>>&.)
21872 .next
21873 .cindex "hints database" "remembering routing"
21874 When a message has been successfully delivered over a TCP/IP connection, Exim
21875 looks in its hints database to see if there are any other messages awaiting a
21876 connection to the same host. If there are, a new delivery process is started
21877 for one of them, and the current TCP/IP connection is passed on to it. The new
21878 process may in turn send multiple copies and possibly create yet another
21879 process.
21880 .endlist
21881
21882
21883 For each copy sent over the same TCP/IP connection, a sequence counter is
21884 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21885 no further messages are sent over that connection.
21886
21887
21888
21889 .section "Use of the $host and $host_address variables" "SECID145"
21890 .vindex "&$host$&"
21891 .vindex "&$host_address$&"
21892 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21893 &$host_address$& are the name and IP address of the first host on the host list
21894 passed by the router. However, when the transport is about to connect to a
21895 specific host, and while it is connected to that host, &$host$& and
21896 &$host_address$& are set to the values for that host. These are the values
21897 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21898 &%serialize_hosts%&, and the various TLS options are expanded.
21899
21900
21901 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21902 .vindex &$tls_bits$&
21903 .vindex &$tls_cipher$&
21904 .vindex &$tls_peerdn$&
21905 .vindex &$tls_sni$&
21906 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
21907 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
21908 are the values that were set when the message was received.
21909 These are the values that are used for options that are expanded before any
21910 SMTP connections are made. Just before each connection is made, these four
21911 variables are emptied. If TLS is subsequently started, they are set to the
21912 appropriate values for the outgoing connection, and these are the values that
21913 are in force when any authenticators are run and when the
21914 &%authenticated_sender%& option is expanded.
21915
21916
21917 .section "Private options for smtp" "SECID146"
21918 .cindex "options" "&(smtp)& transport"
21919 The private options of the &(smtp)& transport are as follows:
21920
21921
21922 .option address_retry_include_sender smtp boolean true
21923 .cindex "4&'xx'& responses" "retrying after"
21924 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21925 is the combination of sender and recipient that is delayed in subsequent queue
21926 runs until the retry time is reached. You can delay the recipient without
21927 reference to the sender (which is what earlier versions of Exim did), by
21928 setting &%address_retry_include_sender%& false. However, this can lead to
21929 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21930
21931 .option allow_localhost smtp boolean false
21932 .cindex "local host" "sending to"
21933 .cindex "fallback" "hosts specified on transport"
21934 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21935 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21936 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21937 the delivery anyway. This should be used only in special cases when the
21938 configuration ensures that no looping will result (for example, a differently
21939 configured Exim is listening on the port to which the message is sent).
21940
21941
21942 .option authenticated_sender smtp string&!! unset
21943 .cindex "Cyrus"
21944 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21945 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21946 overriding any existing authenticated sender value. If the string expansion is
21947 forced to fail, the option is ignored. Other expansion failures cause delivery
21948 to be deferred. If the result of expansion is an empty string, that is also
21949 ignored.
21950
21951 The expansion happens after the outgoing connection has been made and TLS
21952 started, if required. This means that the &$host$&, &$host_address$&,
21953 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21954 particular connection.
21955
21956 If the SMTP session is not authenticated, the expansion of
21957 &%authenticated_sender%& still happens (and can cause the delivery to be
21958 deferred if it fails), but no AUTH= item is added to MAIL commands
21959 unless &%authenticated_sender_force%& is true.
21960
21961 This option allows you to use the &(smtp)& transport in LMTP mode to
21962 deliver mail to Cyrus IMAP and provide the proper local part as the
21963 &"authenticated sender"&, via a setting such as:
21964 .code
21965 authenticated_sender = $local_part
21966 .endd
21967 This removes the need for IMAP subfolders to be assigned special ACLs to
21968 allow direct delivery to those subfolders.
21969
21970 Because of expected uses such as that just described for Cyrus (when no
21971 domain is involved), there is no checking on the syntax of the provided
21972 value.
21973
21974
21975 .option authenticated_sender_force smtp boolean false
21976 If this option is set true, the &%authenticated_sender%& option's value
21977 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21978 authenticated as a client.
21979
21980
21981 .option command_timeout smtp time 5m
21982 This sets a timeout for receiving a response to an SMTP command that has been
21983 sent out. It is also used when waiting for the initial banner line from the
21984 remote host. Its value must not be zero.
21985
21986
21987 .option connect_timeout smtp time 5m
21988 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21989 to a remote host. A setting of zero allows the system timeout (typically
21990 several minutes) to act. To have any effect, the value of this option must be
21991 less than the system timeout. However, it has been observed that on some
21992 systems there is no system timeout, which is why the default value for this
21993 option is 5 minutes, a value recommended by RFC 1123.
21994
21995
21996 .option connection_max_messages smtp integer 500
21997 .cindex "SMTP" "passed connection"
21998 .cindex "SMTP" "multiple deliveries"
21999 .cindex "multiple SMTP deliveries"
22000 This controls the maximum number of separate message deliveries that are sent
22001 over a single TCP/IP connection. If the value is zero, there is no limit.
22002 For testing purposes, this value can be overridden by the &%-oB%& command line
22003 option.
22004
22005
22006 .option data_timeout smtp time 5m
22007 This sets a timeout for the transmission of each block in the data portion of
22008 the message. As a result, the overall timeout for a message depends on the size
22009 of the message. Its value must not be zero. See also &%final_timeout%&.
22010
22011
22012 .option delay_after_cutoff smtp boolean true
22013 This option controls what happens when all remote IP addresses for a given
22014 domain have been inaccessible for so long that they have passed their retry
22015 cutoff times.
22016
22017 In the default state, if the next retry time has not been reached for any of
22018 them, the address is bounced without trying any deliveries. In other words,
22019 Exim delays retrying an IP address after the final cutoff time until a new
22020 retry time is reached, and can therefore bounce an address without ever trying
22021 a delivery, when machines have been down for a long time. Some people are
22022 unhappy at this prospect, so...
22023
22024 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22025 addresses are past their final cutoff time, Exim tries to deliver to those
22026 IP addresses that have not been tried since the message arrived. If there are
22027 none, of if they all fail, the address is bounced. In other words, it does not
22028 delay when a new message arrives, but immediately tries those expired IP
22029 addresses that haven't been tried since the message arrived. If there is a
22030 continuous stream of messages for the dead hosts, unsetting
22031 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22032 to them.
22033
22034
22035 .option dns_qualify_single smtp boolean true
22036 If the &%hosts%& or &%fallback_hosts%& option is being used,
22037 and the &%gethostbyname%& option is false,
22038 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22039 in chapter &<<CHAPdnslookup>>& for more details.
22040
22041
22042 .option dns_search_parents smtp boolean false
22043 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22044 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22045 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22046 details.
22047
22048
22049
22050 .option fallback_hosts smtp "string list" unset
22051 .cindex "fallback" "hosts specified on transport"
22052 String expansion is not applied to this option. The argument must be a
22053 colon-separated list of host names or IP addresses, optionally also including
22054 port numbers, though the separator can be changed, as described in section
22055 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22056 item in a &%route_list%& setting for the &(manualroute)& router, as described
22057 in section &<<SECTformatonehostitem>>&.
22058
22059 Fallback hosts can also be specified on routers, which associate them with the
22060 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22061 &%fallback_hosts%& specified on the transport is used only if the address does
22062 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22063 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22064 However, &%hosts_randomize%& does apply to fallback host lists.
22065
22066 If Exim is unable to deliver to any of the hosts for a particular address, and
22067 the errors are not permanent rejections, the address is put on a separate
22068 transport queue with its host list replaced by the fallback hosts, unless the
22069 address was routed via MX records and the current host was in the original MX
22070 list. In that situation, the fallback host list is not used.
22071
22072 Once normal deliveries are complete, the fallback queue is delivered by
22073 re-running the same transports with the new host lists. If several failing
22074 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22075 copy of the message is sent.
22076
22077 The resolution of the host names on the fallback list is controlled by the
22078 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22079 both to cases when the host list comes with the address and when it is taken
22080 from &%hosts%&. This option provides a &"use a smart host only if delivery
22081 fails"& facility.
22082
22083
22084 .option final_timeout smtp time 10m
22085 This is the timeout that applies while waiting for the response to the final
22086 line containing just &"."& that terminates a message. Its value must not be
22087 zero.
22088
22089 .option gethostbyname smtp boolean false
22090 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22091 being used, names are looked up using &[gethostbyname()]&
22092 (or &[getipnodebyname()]& when available)
22093 instead of using the DNS. Of course, that function may in fact use the DNS, but
22094 it may also consult other sources of information such as &_/etc/hosts_&.
22095
22096 .option gnutls_compat_mode smtp boolean unset
22097 This option controls whether GnuTLS is used in compatibility mode in an Exim
22098 server. This reduces security slightly, but improves interworking with older
22099 implementations of TLS.
22100
22101 .option helo_data smtp string&!! "see below"
22102 .cindex "HELO" "argument, setting"
22103 .cindex "EHLO" "argument, setting"
22104 .cindex "LHLO argument setting"
22105 The value of this option is expanded after a connection to a another host has
22106 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22107 command that starts the outgoing SMTP or LMTP session. The default value of the
22108 option is:
22109 .code
22110 $primary_hostname
22111 .endd
22112 During the expansion, the variables &$host$& and &$host_address$& are set to
22113 the identity of the remote host, and the variables &$sending_ip_address$& and
22114 &$sending_port$& are set to the local IP address and port number that are being
22115 used. These variables can be used to generate different values for different
22116 servers or different local IP addresses. For example, if you want the string
22117 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22118 interface address, you could use this:
22119 .code
22120 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22121   {$primary_hostname}}
22122 .endd
22123 The use of &%helo_data%& applies both to sending messages and when doing
22124 callouts.
22125
22126 .option hosts smtp "string list&!!" unset
22127 Hosts are associated with an address by a router such as &(dnslookup)&, which
22128 finds the hosts by looking up the address domain in the DNS, or by
22129 &(manualroute)&, which has lists of hosts in its configuration. However,
22130 email addresses can be passed to the &(smtp)& transport by any router, and not
22131 all of them can provide an associated list of hosts.
22132
22133 The &%hosts%& option specifies a list of hosts to be used if the address being
22134 processed does not have any hosts associated with it. The hosts specified by
22135 &%hosts%& are also used, whether or not the address has its own hosts, if
22136 &%hosts_override%& is set.
22137
22138 The string is first expanded, before being interpreted as a colon-separated
22139 list of host names or IP addresses, possibly including port numbers. The
22140 separator may be changed to something other than colon, as described in section
22141 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22142 item in a &%route_list%& setting for the &(manualroute)& router, as described
22143 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22144 of the &(manualroute)& router is not available here.
22145
22146 If the expansion fails, delivery is deferred. Unless the failure was caused by
22147 the inability to complete a lookup, the error is logged to the panic log as
22148 well as the main log. Host names are looked up either by searching directly for
22149 address records in the DNS or by calling &[gethostbyname()]& (or
22150 &[getipnodebyname()]& when available), depending on the setting of the
22151 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22152 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22153 address are used.
22154
22155 During delivery, the hosts are tried in order, subject to their retry status,
22156 unless &%hosts_randomize%& is set.
22157
22158
22159 .option hosts_avoid_esmtp smtp "host list&!!" unset
22160 .cindex "ESMTP, avoiding use of"
22161 .cindex "HELO" "forcing use of"
22162 .cindex "EHLO" "avoiding use of"
22163 .cindex "PIPELINING" "avoiding the use of"
22164 This option is for use with broken hosts that announce ESMTP facilities (for
22165 example, PIPELINING) and then fail to implement them properly. When a host
22166 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22167 start of the SMTP session. This means that it cannot use any of the ESMTP
22168 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22169
22170
22171 .option hosts_avoid_pipelining smtp "host list&!!" unset
22172 .cindex "PIPELINING" "avoiding the use of"
22173 Exim will not use the SMTP PIPELINING extension when delivering to any host
22174 that matches this list, even if the server host advertises PIPELINING support.
22175
22176
22177 .option hosts_avoid_tls smtp "host list&!!" unset
22178 .cindex "TLS" "avoiding for certain hosts"
22179 Exim will not try to start a TLS session when delivering to any host that
22180 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22181
22182
22183 .option hosts_max_try smtp integer 5
22184 .cindex "host" "maximum number to try"
22185 .cindex "limit" "number of hosts tried"
22186 .cindex "limit" "number of MX tried"
22187 .cindex "MX record" "maximum tried"
22188 This option limits the number of IP addresses that are tried for any one
22189 delivery in cases where there are temporary delivery errors. Section
22190 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22191
22192
22193 .option hosts_max_try_hardlimit smtp integer 50
22194 This is an additional check on the maximum number of IP addresses that Exim
22195 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22196 why it exists.
22197
22198
22199
22200 .option hosts_nopass_tls smtp "host list&!!" unset
22201 .cindex "TLS" "passing connection"
22202 .cindex "multiple SMTP deliveries"
22203 .cindex "TLS" "multiple message deliveries"
22204 For any host that matches this list, a connection on which a TLS session has
22205 been started will not be passed to a new delivery process for sending another
22206 message on the same connection. See section &<<SECTmulmessam>>& for an
22207 explanation of when this might be needed.
22208
22209
22210 .option hosts_override smtp boolean false
22211 If this option is set and the &%hosts%& option is also set, any hosts that are
22212 attached to the address are ignored, and instead the hosts specified by the
22213 &%hosts%& option are always used. This option does not apply to
22214 &%fallback_hosts%&.
22215
22216
22217 .option hosts_randomize smtp boolean false
22218 .cindex "randomized host list"
22219 .cindex "host" "list of; randomized"
22220 .cindex "fallback" "randomized hosts"
22221 If this option is set, and either the list of hosts is taken from the
22222 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22223 were not obtained from MX records (this includes fallback hosts from the
22224 router), and were not randomized by the router, the order of trying the hosts
22225 is randomized each time the transport runs. Randomizing the order of a host
22226 list can be used to do crude load sharing.
22227
22228 When &%hosts_randomize%& is true, a host list may be split into groups whose
22229 order is separately randomized. This makes it possible to set up MX-like
22230 behaviour. The boundaries between groups are indicated by an item that is just
22231 &`+`& in the host list. For example:
22232 .code
22233 hosts = host1:host2:host3:+:host4:host5
22234 .endd
22235 The order of the first three hosts and the order of the last two hosts is
22236 randomized for each use, but the first three always end up before the last two.
22237 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22238
22239 .option hosts_require_auth smtp "host list&!!" unset
22240 .cindex "authentication" "required by client"
22241 This option provides a list of servers for which authentication must succeed
22242 before Exim will try to transfer a message. If authentication fails for
22243 servers which are not in this list, Exim tries to send unauthenticated. If
22244 authentication fails for one of these servers, delivery is deferred. This
22245 temporary error is detectable in the retry rules, so it can be turned into a
22246 hard failure if required. See also &%hosts_try_auth%&, and chapter
22247 &<<CHAPSMTPAUTH>>& for details of authentication.
22248
22249
22250 .option hosts_require_tls smtp "host list&!!" unset
22251 .cindex "TLS" "requiring for certain servers"
22252 Exim will insist on using a TLS session when delivering to any host that
22253 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22254 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22255 incoming messages, use an appropriate ACL.
22256
22257 .option hosts_try_auth smtp "host list&!!" unset
22258 .cindex "authentication" "optional in client"
22259 This option provides a list of servers to which, provided they announce
22260 authentication support, Exim will attempt to authenticate as a client when it
22261 connects. If authentication fails, Exim will try to transfer the message
22262 unauthenticated. See also &%hosts_require_auth%&, and chapter
22263 &<<CHAPSMTPAUTH>>& for details of authentication.
22264
22265 .option interface smtp "string list&!!" unset
22266 .cindex "bind IP address"
22267 .cindex "IP address" "binding"
22268 .vindex "&$host$&"
22269 .vindex "&$host_address$&"
22270 This option specifies which interface to bind to when making an outgoing SMTP
22271 call. The value is an IP address, not an interface name such as
22272 &`eth0`&. Do not confuse this with the interface address that was used when a
22273 message was received, which is in &$received_ip_address$&, formerly known as
22274 &$interface_address$&. The name was changed to minimize confusion with the
22275 outgoing interface address. There is no variable that contains an outgoing
22276 interface address because, unless it is set by this option, its value is
22277 unknown.
22278
22279 During the expansion of the &%interface%& option the variables &$host$& and
22280 &$host_address$& refer to the host to which a connection is about to be made
22281 during the expansion of the string. Forced expansion failure, or an empty
22282 string result causes the option to be ignored. Otherwise, after expansion, the
22283 string must be a list of IP addresses, colon-separated by default, but the
22284 separator can be changed in the usual way. For example:
22285 .code
22286 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22287 .endd
22288 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22289 connection. If none of them are the correct type, the option is ignored. If
22290 &%interface%& is not set, or is ignored, the system's IP functions choose which
22291 interface to use if the host has more than one.
22292
22293
22294 .option keepalive smtp boolean true
22295 .cindex "keepalive" "on outgoing connection"
22296 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22297 connections. When set, it causes the kernel to probe idle connections
22298 periodically, by sending packets with &"old"& sequence numbers. The other end
22299 of the connection should send a acknowledgment if the connection is still okay
22300 or a reset if the connection has been aborted. The reason for doing this is
22301 that it has the beneficial effect of freeing up certain types of connection
22302 that can get stuck when the remote host is disconnected without tidying up the
22303 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22304 unreachable hosts.
22305
22306
22307 .option lmtp_ignore_quota smtp boolean false
22308 .cindex "LMTP" "ignoring quota errors"
22309 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22310 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22311 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22312
22313 .option max_rcpt smtp integer 100
22314 .cindex "RCPT" "maximum number of outgoing"
22315 This option limits the number of RCPT commands that are sent in a single
22316 SMTP message transaction. Each set of addresses is treated independently, and
22317 so can cause parallel connections to the same host if &%remote_max_parallel%&
22318 permits this.
22319
22320
22321 .option multi_domain smtp boolean true
22322 .vindex "&$domain$&"
22323 When this option is set, the &(smtp)& transport can handle a number of
22324 addresses containing a mixture of different domains provided they all resolve
22325 to the same list of hosts. Turning the option off restricts the transport to
22326 handling only one domain at a time. This is useful if you want to use
22327 &$domain$& in an expansion for the transport, because it is set only when there
22328 is a single domain involved in a remote delivery.
22329
22330
22331 .option port smtp string&!! "see below"
22332 .cindex "port" "sending TCP/IP"
22333 .cindex "TCP/IP" "setting outgoing port"
22334 This option specifies the TCP/IP port on the server to which Exim connects.
22335 &*Note:*& Do not confuse this with the port that was used when a message was
22336 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22337 The name was changed to minimize confusion with the outgoing port. There is no
22338 variable that contains an outgoing port.
22339
22340 If the value of this option begins with a digit it is taken as a port number;
22341 otherwise it is looked up using &[getservbyname()]&. The default value is
22342 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22343 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22344 is deferred.
22345
22346
22347
22348 .option protocol smtp string smtp
22349 .cindex "LMTP" "over TCP/IP"
22350 .cindex "ssmtp protocol" "outbound"
22351 .cindex "TLS" "SSL-on-connect outbound"
22352 .vindex "&$port$&"
22353 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22354 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22355 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22356 deliveries into closed message stores. Exim also has support for running LMTP
22357 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22358
22359 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22360 changes to &"smtps"&, and the transport initiates TLS immediately after
22361 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22362 The Internet standards bodies strongly discourage use of this mode.
22363
22364
22365 .option retry_include_ip_address smtp boolean true
22366 Exim normally includes both the host name and the IP address in the key it
22367 constructs for indexing retry data after a temporary delivery failure. This
22368 means that when one of several IP addresses for a host is failing, it gets
22369 tried periodically (controlled by the retry rules), but use of the other IP
22370 addresses is not affected.
22371
22372 However, in some dialup environments hosts are assigned a different IP address
22373 each time they connect. In this situation the use of the IP address as part of
22374 the retry key leads to undesirable behaviour. Setting this option false causes
22375 Exim to use only the host name. This should normally be done on a separate
22376 instance of the &(smtp)& transport, set up specially to handle the dialup
22377 hosts.
22378
22379
22380 .option serialize_hosts smtp "host list&!!" unset
22381 .cindex "serializing connections"
22382 .cindex "host" "serializing connections"
22383 Because Exim operates in a distributed manner, if several messages for the same
22384 host arrive at around the same time, more than one simultaneous connection to
22385 the remote host can occur. This is not usually a problem except when there is a
22386 slow link between the hosts. In that situation it may be helpful to restrict
22387 Exim to one connection at a time. This can be done by setting
22388 &%serialize_hosts%& to match the relevant hosts.
22389
22390 .cindex "hints database" "serializing deliveries to a host"
22391 Exim implements serialization by means of a hints database in which a record is
22392 written whenever a process connects to one of the restricted hosts. The record
22393 is deleted when the connection is completed. Obviously there is scope for
22394 records to get left lying around if there is a system or program crash. To
22395 guard against this, Exim ignores any records that are more than six hours old.
22396
22397 If you set up this kind of serialization, you should also arrange to delete the
22398 relevant hints database whenever your system reboots. The names of the files
22399 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22400 may be one or two files, depending on the type of DBM in use. The same files
22401 are used for ETRN serialization.
22402
22403
22404 .option size_addition smtp integer 1024
22405 .cindex "SMTP" "SIZE"
22406 .cindex "message" "size issue for transport filter"
22407 .cindex "size" "of message"
22408 .cindex "transport" "filter"
22409 .cindex "filter" "transport filter"
22410 If a remote SMTP server indicates that it supports the SIZE option of the
22411 MAIL command, Exim uses this to pass over the message size at the start of
22412 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22413 sends, to allow for headers and other text that may be added during delivery by
22414 configuration options or in a transport filter. It may be necessary to increase
22415 this if a lot of text is added to messages.
22416
22417 Alternatively, if the value of &%size_addition%& is set negative, it disables
22418 the use of the SIZE option altogether.
22419
22420
22421 .option tls_certificate smtp string&!! unset
22422 .cindex "TLS" "client certificate, location of"
22423 .cindex "certificate" "client, location of"
22424 .vindex "&$host$&"
22425 .vindex "&$host_address$&"
22426 The value of this option must be the absolute path to a file which contains the
22427 client's certificate, for possible use when sending a message over an encrypted
22428 connection. The values of &$host$& and &$host_address$& are set to the name and
22429 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22430 details of TLS.
22431
22432 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22433 certificate when sending messages as a client. The global option of the same
22434 name specifies the certificate for Exim as a server; it is not automatically
22435 assumed that the same certificate should be used when Exim is operating as a
22436 client.
22437
22438
22439 .option tls_crl smtp string&!! unset
22440 .cindex "TLS" "client certificate revocation list"
22441 .cindex "certificate" "revocation list for client"
22442 This option specifies a certificate revocation list. The expanded value must
22443 be the name of a file that contains a CRL in PEM format.
22444
22445
22446 .option tls_privatekey smtp string&!! unset
22447 .cindex "TLS" "client private key, location of"
22448 .vindex "&$host$&"
22449 .vindex "&$host_address$&"
22450 The value of this option must be the absolute path to a file which contains the
22451 client's private key. This is used when sending a message over an encrypted
22452 connection using a client certificate. The values of &$host$& and
22453 &$host_address$& are set to the name and address of the server during the
22454 expansion. If this option is unset, or the expansion is forced to fail, or the
22455 result is an empty string, the private key is assumed to be in the same file as
22456 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22457
22458
22459 .option tls_require_ciphers smtp string&!! unset
22460 .cindex "TLS" "requiring specific ciphers"
22461 .cindex "cipher" "requiring specific"
22462 .vindex "&$host$&"
22463 .vindex "&$host_address$&"
22464 The value of this option must be a list of permitted cipher suites, for use
22465 when setting up an outgoing encrypted connection. (There is a global option of
22466 the same name for controlling incoming connections.) The values of &$host$& and
22467 &$host_address$& are set to the name and address of the server during the
22468 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22469 is used in different ways by OpenSSL and GnuTLS (see sections
22470 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22471 ciphers is a preference order.
22472
22473
22474
22475 .option tls_sni smtp string&!! unset
22476 .cindex "TLS" "Server Name Indication"
22477 .vindex "&$tls_sni$&"
22478 If this option is set then it sets the $tls_sni variable and causes any
22479 TLS session to pass this value as the Server Name Indication extension to
22480 the remote side, which can be used by the remote side to select an appropriate
22481 certificate and private key for the session.
22482
22483 See &<<SECTtlssni>>& for more information.
22484
22485 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22486 TLS extensions.
22487
22488
22489
22490
22491 .option tls_tempfail_tryclear smtp boolean true
22492 .cindex "4&'xx'& responses" "to STARTTLS"
22493 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22494 setting up a TLS session, this option determines whether or not Exim should try
22495 to deliver the message unencrypted. If it is set false, delivery to the
22496 current host is deferred; if there are other hosts, they are tried. If this
22497 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22498 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22499 TLS negotiation fails, Exim closes the current connection (because it is in an
22500 unknown state), opens a new one to the same host, and then tries the delivery
22501 in clear.
22502
22503
22504 .option tls_verify_certificates smtp string&!! unset
22505 .cindex "TLS" "server certificate verification"
22506 .cindex "certificate" "verification of server"
22507 .vindex "&$host$&"
22508 .vindex "&$host_address$&"
22509 The value of this option must be the absolute path to a file containing
22510 permitted server certificates, for use when setting up an encrypted connection.
22511 Alternatively, if you are using OpenSSL, you can set
22512 &%tls_verify_certificates%& to the name of a directory containing certificate
22513 files. This does not work with GnuTLS; the option must be set to the name of a
22514 single file if you are using GnuTLS. The values of &$host$& and
22515 &$host_address$& are set to the name and address of the server during the
22516 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22517
22518
22519
22520
22521 .section "How the limits for the number of hosts to try are used" &&&
22522          "SECTvalhosmax"
22523 .cindex "host" "maximum number to try"
22524 .cindex "limit" "hosts; maximum number tried"
22525 There are two options that are concerned with the number of hosts that are
22526 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22527 &%hosts_max_try_hardlimit%&.
22528
22529
22530 The &%hosts_max_try%& option limits the number of hosts that are tried
22531 for a single delivery. However, despite the term &"host"& in its name, the
22532 option actually applies to each IP address independently. In other words, a
22533 multihomed host is treated as several independent hosts, just as it is for
22534 retrying.
22535
22536 Many of the larger ISPs have multiple MX records which often point to
22537 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22538 created as a result of routing one of these domains.
22539
22540 Trying every single IP address on such a long list does not seem sensible; if
22541 several at the top of the list fail, it is reasonable to assume there is some
22542 problem that is likely to affect all of them. Roughly speaking, the value of
22543 &%hosts_max_try%& is the maximum number that are tried before deferring the
22544 delivery. However, the logic cannot be quite that simple.
22545
22546 Firstly, IP addresses that are skipped because their retry times have not
22547 arrived do not count, and in addition, addresses that are past their retry
22548 limits are also not counted, even when they are tried. This means that when
22549 some IP addresses are past their retry limits, more than the value of
22550 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22551 that all IP addresses are considered before timing out an email address (but
22552 see below for an exception).
22553
22554 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22555 list to see if there is a subsequent host with a different (higher valued) MX.
22556 If there is, that host is considered next, and the current IP address is used
22557 but not counted. This behaviour helps in the case of a domain with a retry rule
22558 that hardly ever delays any hosts, as is now explained:
22559
22560 Consider the case of a long list of hosts with one MX value, and a few with a
22561 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22562 hosts at the top of the list are tried at first. With the default retry rule,
22563 which specifies increasing retry times, the higher MX hosts are eventually
22564 tried when those at the top of the list are skipped because they have not
22565 reached their retry times.
22566
22567 However, it is common practice to put a fixed short retry time on domains for
22568 large ISPs, on the grounds that their servers are rarely down for very long.
22569 Unfortunately, these are exactly the domains that tend to resolve to long lists
22570 of hosts. The short retry time means that the lowest MX hosts are tried every
22571 time. The attempts may be in a different order because of random sorting, but
22572 without the special MX check, the higher MX hosts would never be tried until
22573 all the lower MX hosts had timed out (which might be several days), because
22574 there are always some lower MX hosts that have reached their retry times. With
22575 the special check, Exim considers at least one IP address from each MX value at
22576 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22577 reached.
22578
22579 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22580 particular, Exim normally eventually tries all the IP addresses before timing
22581 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22582 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22583 been set up with hundreds of IP addresses for some domains. It can
22584 take a very long time indeed for an address to time out in these cases.
22585
22586 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22587 Exim never tries more than this number of IP addresses; if it hits this limit
22588 and they are all timed out, the email address is bounced, even though not all
22589 possible IP addresses have been tried.
22590 .ecindex IIDsmttra1
22591 .ecindex IIDsmttra2
22592
22593
22594
22595
22596
22597 . ////////////////////////////////////////////////////////////////////////////
22598 . ////////////////////////////////////////////////////////////////////////////
22599
22600 .chapter "Address rewriting" "CHAPrewrite"
22601 .scindex IIDaddrew "rewriting" "addresses"
22602 There are some circumstances in which Exim automatically rewrites domains in
22603 addresses. The two most common are when an address is given without a domain
22604 (referred to as an &"unqualified address"&) or when an address contains an
22605 abbreviated domain that is expanded by DNS lookup.
22606
22607 Unqualified envelope addresses are accepted only for locally submitted
22608 messages, or for messages that are received from hosts matching
22609 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22610 appropriate. Unqualified addresses in header lines are qualified if they are in
22611 locally submitted messages, or messages from hosts that are permitted to send
22612 unqualified envelope addresses. Otherwise, unqualified addresses in header
22613 lines are neither qualified nor rewritten.
22614
22615 One situation in which Exim does &'not'& automatically rewrite a domain is
22616 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22617 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22618 do this. The new RFCs do not contain this suggestion.
22619
22620
22621 .section "Explicitly configured address rewriting" "SECID147"
22622 This chapter describes the rewriting rules that can be used in the
22623 main rewrite section of the configuration file, and also in the generic
22624 &%headers_rewrite%& option that can be set on any transport.
22625
22626 Some people believe that configured address rewriting is a Mortal Sin.
22627 Others believe that life is not possible without it. Exim provides the
22628 facility; you do not have to use it.
22629
22630 The main rewriting rules that appear in the &"rewrite"& section of the
22631 configuration file are applied to addresses in incoming messages, both envelope
22632 addresses and addresses in header lines. Each rule specifies the types of
22633 address to which it applies.
22634
22635 Whether or not addresses in header lines are rewritten depends on the origin of
22636 the headers and the type of rewriting. Global rewriting, that is, rewriting
22637 rules from the rewrite section of the configuration file, is applied only to
22638 those headers that were received with the message. Header lines that are added
22639 by ACLs or by a system filter or by individual routers or transports (which
22640 are specific to individual recipient addresses) are not rewritten by the global
22641 rules.
22642
22643 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22644 applies all headers except those added by routers and transports. That is, as
22645 well as the headers that were received with the message, it also applies to
22646 headers that were added by an ACL or a system filter.
22647
22648
22649 In general, rewriting addresses from your own system or domain has some
22650 legitimacy. Rewriting other addresses should be done only with great care and
22651 in special circumstances. The author of Exim believes that rewriting should be
22652 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22653 Although it can sometimes be used as a routing tool, this is very strongly
22654 discouraged.
22655
22656 There are two commonly encountered circumstances where rewriting is used, as
22657 illustrated by these examples:
22658
22659 .ilist
22660 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22661 exchange mail with each other behind a firewall, but there is only a single
22662 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22663 &'hitch.fict.example'& when sending mail off-site.
22664 .next
22665 A host rewrites the local parts of its own users so that, for example,
22666 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22667 .endlist
22668
22669
22670
22671 .section "When does rewriting happen?" "SECID148"
22672 .cindex "rewriting" "timing of"
22673 .cindex "&ACL;" "rewriting addresses in"
22674 Configured address rewriting can take place at several different stages of a
22675 message's processing.
22676
22677 .vindex "&$sender_address$&"
22678 At the start of an ACL for MAIL, the sender address may have been rewritten
22679 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22680 ordinary rewrite rules have yet been applied. If, however, the sender address
22681 is verified in the ACL, it is rewritten before verification, and remains
22682 rewritten thereafter. The subsequent value of &$sender_address$& is the
22683 rewritten address. This also applies if sender verification happens in a
22684 RCPT ACL. Otherwise, when the sender address is not verified, it is
22685 rewritten as soon as a message's header lines have been received.
22686
22687 .vindex "&$domain$&"
22688 .vindex "&$local_part$&"
22689 Similarly, at the start of an ACL for RCPT, the current recipient's address
22690 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22691 rewrite rules have yet been applied to it. However, the behaviour is different
22692 from the sender address when a recipient is verified. The address is rewritten
22693 for the verification, but the rewriting is not remembered at this stage. The
22694 value of &$local_part$& and &$domain$& after verification are always the same
22695 as they were before (that is, they contain the unrewritten &-- except for
22696 SMTP-time rewriting &-- address).
22697
22698 As soon as a message's header lines have been received, all the envelope
22699 recipient addresses are permanently rewritten, and rewriting is also applied to
22700 the addresses in the header lines (if configured). This happens before adding
22701 any header lines that were specified in MAIL or RCPT ACLs, and
22702 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22703 before the DATA ACL and &[local_scan()]& functions are run.
22704
22705 When an address is being routed, either for delivery or for verification,
22706 rewriting is applied immediately to child addresses that are generated by
22707 redirection, unless &%no_rewrite%& is set on the router.
22708
22709 .cindex "envelope sender" "rewriting at transport time"
22710 .cindex "rewriting" "at transport time"
22711 .cindex "header lines" "rewriting at transport time"
22712 At transport time, additional rewriting of addresses in header lines can be
22713 specified by setting the generic &%headers_rewrite%& option on a transport.
22714 This option contains rules that are identical in form to those in the rewrite
22715 section of the configuration file. They are applied to the original message
22716 header lines and any that were added by ACLs or a system filter. They are not
22717 applied to header lines that are added by routers or the transport.
22718
22719 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22720 transport option. However, it is not possible to rewrite envelope recipients at
22721 transport time.
22722
22723
22724
22725
22726 .section "Testing the rewriting rules that apply on input" "SECID149"
22727 .cindex "rewriting" "testing"
22728 .cindex "testing" "rewriting"
22729 Exim's input rewriting configuration appears in a part of the run time
22730 configuration file headed by &"begin rewrite"&. It can be tested by the
22731 &%-brw%& command line option. This takes an address (which can be a full RFC
22732 2822 address) as its argument. The output is a list of how the address would be
22733 transformed by the rewriting rules for each of the different places it might
22734 appear in an incoming message, that is, for each different header and for the
22735 envelope sender and recipient fields. For example,
22736 .code
22737 exim -brw ph10@exim.workshop.example
22738 .endd
22739 might produce the output
22740 .code
22741 sender: Philip.Hazel@exim.workshop.example
22742 from: Philip.Hazel@exim.workshop.example
22743 to: ph10@exim.workshop.example
22744 cc: ph10@exim.workshop.example
22745 bcc: ph10@exim.workshop.example
22746 reply-to: Philip.Hazel@exim.workshop.example
22747 env-from: Philip.Hazel@exim.workshop.example
22748 env-to: ph10@exim.workshop.example
22749 .endd
22750 which shows that rewriting has been set up for that address when used in any of
22751 the source fields, but not when it appears as a recipient address. At the
22752 present time, there is no equivalent way of testing rewriting rules that are
22753 set for a particular transport.
22754
22755
22756 .section "Rewriting rules" "SECID150"
22757 .cindex "rewriting" "rules"
22758 The rewrite section of the configuration file consists of lines of rewriting
22759 rules in the form
22760 .display
22761 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22762 .endd
22763 Rewriting rules that are specified for the &%headers_rewrite%& generic
22764 transport option are given as a colon-separated list. Each item in the list
22765 takes the same form as a line in the main rewriting configuration (except that
22766 any colons must be doubled, of course).
22767
22768 The formats of source patterns and replacement strings are described below.
22769 Each is terminated by white space, unless enclosed in double quotes, in which
22770 case normal quoting conventions apply inside the quotes. The flags are single
22771 characters which may appear in any order. Spaces and tabs between them are
22772 ignored.
22773
22774 For each address that could potentially be rewritten, the rules are scanned in
22775 order, and replacements for the address from earlier rules can themselves be
22776 replaced by later rules (but see the &"q"& and &"R"& flags).
22777
22778 The order in which addresses are rewritten is undefined, may change between
22779 releases, and must not be relied on, with one exception: when a message is
22780 received, the envelope sender is always rewritten first, before any header
22781 lines are rewritten. For example, the replacement string for a rewrite of an
22782 address in &'To:'& must not assume that the message's address in &'From:'& has
22783 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22784 that the envelope sender has already been rewritten.
22785
22786 .vindex "&$domain$&"
22787 .vindex "&$local_part$&"
22788 The variables &$local_part$& and &$domain$& can be used in the replacement
22789 string to refer to the address that is being rewritten. Note that lookup-driven
22790 rewriting can be done by a rule of the form
22791 .code
22792 *@*   ${lookup ...
22793 .endd
22794 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22795 refer to the address that is being rewritten.
22796
22797
22798 .section "Rewriting patterns" "SECID151"
22799 .cindex "rewriting" "patterns"
22800 .cindex "address list" "in a rewriting pattern"
22801 The source pattern in a rewriting rule is any item which may appear in an
22802 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22803 single-item address list, which means that it is expanded before being tested
22804 against the address. As always, if you use a regular expression as a pattern,
22805 you must take care to escape dollar and backslash characters, or use the &`\N`&
22806 facility to suppress string expansion within the regular expression.
22807
22808 Domains in patterns should be given in lower case. Local parts in patterns are
22809 case-sensitive. If you want to do case-insensitive matching of local parts, you
22810 can use a regular expression that starts with &`^(?i)`&.
22811
22812 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22813 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22814 depending on the type of match which occurred. These can be used in the
22815 replacement string to insert portions of the incoming address. &$0$& always
22816 refers to the complete incoming address. When a regular expression is used, the
22817 numerical variables are set from its capturing subexpressions. For other types
22818 of pattern they are set as follows:
22819
22820 .ilist
22821 If a local part or domain starts with an asterisk, the numerical variables
22822 refer to the character strings matched by asterisks, with &$1$& associated with
22823 the first asterisk, and &$2$& with the second, if present. For example, if the
22824 pattern
22825 .code
22826 *queen@*.fict.example
22827 .endd
22828 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22829 .code
22830 $0 = hearts-queen@wonderland.fict.example
22831 $1 = hearts-
22832 $2 = wonderland
22833 .endd
22834 Note that if the local part does not start with an asterisk, but the domain
22835 does, it is &$1$& that contains the wild part of the domain.
22836
22837 .next
22838 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22839 of the domain are placed in the next available numerical variables. Suppose,
22840 for example, that the address &'foo@bar.baz.example'& is processed by a
22841 rewriting rule of the form
22842 .display
22843 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22844 .endd
22845 and the key in the file that matches the domain is &`*.baz.example`&. Then
22846 .code
22847 $1 = foo
22848 $2 = bar
22849 $3 = baz.example
22850 .endd
22851 If the address &'foo@baz.example'& is looked up, this matches the same
22852 wildcard file entry, and in this case &$2$& is set to the empty string, but
22853 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22854 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22855 whole domain. For non-partial domain lookups, no numerical variables are set.
22856 .endlist
22857
22858
22859 .section "Rewriting replacements" "SECID152"
22860 .cindex "rewriting" "replacements"
22861 If the replacement string for a rule is a single asterisk, addresses that
22862 match the pattern and the flags are &'not'& rewritten, and no subsequent
22863 rewriting rules are scanned. For example,
22864 .code
22865 hatta@lookingglass.fict.example  *  f
22866 .endd
22867 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22868 &'From:'& headers.
22869
22870 .vindex "&$domain$&"
22871 .vindex "&$local_part$&"
22872 If the replacement string is not a single asterisk, it is expanded, and must
22873 yield a fully qualified address. Within the expansion, the variables
22874 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22875 Any letters they contain retain their original case &-- they are not lower
22876 cased. The numerical variables are set up according to the type of pattern that
22877 matched the address, as described above. If the expansion is forced to fail by
22878 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22879 current rule is abandoned, but subsequent rules may take effect. Any other
22880 expansion failure causes the entire rewriting operation to be abandoned, and an
22881 entry written to the panic log.
22882
22883
22884
22885 .section "Rewriting flags" "SECID153"
22886 There are three different kinds of flag that may appear on rewriting rules:
22887
22888 .ilist
22889 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22890 c, f, h, r, s, t.
22891 .next
22892 A flag that specifies rewriting at SMTP time: S.
22893 .next
22894 Flags that control the rewriting process: Q, q, R, w.
22895 .endlist
22896
22897 For rules that are part of the &%headers_rewrite%& generic transport option,
22898 E, F, T, and S are not permitted.
22899
22900
22901
22902 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22903          "SECID154"
22904 .cindex "rewriting" "flags"
22905 If none of the following flag letters, nor the &"S"& flag (see section
22906 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22907 and to both the sender and recipient fields of the envelope, whereas a
22908 transport-time rewriting rule just applies to all headers. Otherwise, the
22909 rewriting rule is skipped unless the relevant addresses are being processed.
22910 .display
22911 &`E`&       rewrite all envelope fields
22912 &`F`&       rewrite the envelope From field
22913 &`T`&       rewrite the envelope To field
22914 &`b`&       rewrite the &'Bcc:'& header
22915 &`c`&       rewrite the &'Cc:'& header
22916 &`f`&       rewrite the &'From:'& header
22917 &`h`&       rewrite all headers
22918 &`r`&       rewrite the &'Reply-To:'& header
22919 &`s`&       rewrite the &'Sender:'& header
22920 &`t`&       rewrite the &'To:'& header
22921 .endd
22922 "All headers" means all of the headers listed above that can be selected
22923 individually, plus their &'Resent-'& versions. It does not include
22924 other headers such as &'Subject:'& etc.
22925
22926 You should be particularly careful about rewriting &'Sender:'& headers, and
22927 restrict this to special known cases in your own domains.
22928
22929
22930 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22931 .cindex "SMTP" "rewriting malformed addresses"
22932 .cindex "RCPT" "rewriting argument of"
22933 .cindex "MAIL" "rewriting argument of"
22934 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22935 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22936 before any other processing; even before syntax checking. The pattern is
22937 required to be a regular expression, and it is matched against the whole of the
22938 data for the command, including any surrounding angle brackets.
22939
22940 .vindex "&$domain$&"
22941 .vindex "&$local_part$&"
22942 This form of rewrite rule allows for the handling of addresses that are not
22943 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22944 input). Because the input is not required to be a syntactically valid address,
22945 the variables &$local_part$& and &$domain$& are not available during the
22946 expansion of the replacement string. The result of rewriting replaces the
22947 original address in the MAIL or RCPT command.
22948
22949
22950 .section "Flags controlling the rewriting process" "SECID155"
22951 There are four flags which control the way the rewriting process works. These
22952 take effect only when a rule is invoked, that is, when the address is of the
22953 correct type (matches the flags) and matches the pattern:
22954
22955 .ilist
22956 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22957 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22958 absence of &"Q"& the rewritten address must always include a domain.
22959 .next
22960 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22961 even if no rewriting actually takes place because of a &"fail"& in the
22962 expansion. The &"q"& flag is not effective if the address is of the wrong type
22963 (does not match the flags) or does not match the pattern.
22964 .next
22965 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22966 address, up to ten times. It can be combined with the &"q"& flag, to stop
22967 rewriting once it fails to match (after at least one successful rewrite).
22968 .next
22969 .cindex "rewriting" "whole addresses"
22970 When an address in a header is rewritten, the rewriting normally applies only
22971 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22972 left unchanged. For example, rewriting might change
22973 .code
22974 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22975 .endd
22976 into
22977 .code
22978 From: Ford Prefect <prefectf@hitch.fict.example>
22979 .endd
22980 .cindex "RFC 2047"
22981 Sometimes there is a need to replace the whole address item, and this can be
22982 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22983 causes an address in a header line to be rewritten, the entire address is
22984 replaced, not just the working part. The replacement must be a complete RFC
22985 2822 address, including the angle brackets if necessary. If text outside angle
22986 brackets contains a character whose value is greater than 126 or less than 32
22987 (except for tab), the text is encoded according to RFC 2047. The character set
22988 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22989
22990 When the &"w"& flag is set on a rule that causes an envelope address to be
22991 rewritten, all but the working part of the replacement address is discarded.
22992 .endlist
22993
22994
22995 .section "Rewriting examples" "SECID156"
22996 Here is an example of the two common rewriting paradigms:
22997 .code
22998 *@*.hitch.fict.example  $1@hitch.fict.example
22999 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23000                      {$value}fail}@hitch.fict.example bctfrF
23001 .endd
23002 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23003 the string expansion to fail if the lookup does not succeed. In this context it
23004 has the effect of leaving the original address unchanged, but Exim goes on to
23005 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23006 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23007 explicitly, which would cause the rewritten address to be the same as before,
23008 at the cost of a small bit of processing. Not supplying either of these is an
23009 error, since the rewritten address would then contain no local part.
23010
23011 The first example above replaces the domain with a superior, more general
23012 domain. This may not be desirable for certain local parts. If the rule
23013 .code
23014 root@*.hitch.fict.example  *
23015 .endd
23016 were inserted before the first rule, rewriting would be suppressed for the
23017 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23018
23019 Rewriting can be made conditional on a number of tests, by making use of
23020 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23021 messages that originate outside the local host:
23022 .code
23023 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23024                          {$1@hitch.fict.example}fail}"
23025 .endd
23026 The replacement string is quoted in this example because it contains white
23027 space.
23028
23029 .cindex "rewriting" "bang paths"
23030 .cindex "bang paths" "rewriting"
23031 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23032 an address it treats it as an unqualified local part which it qualifies with
23033 the local qualification domain (if the source of the message is local or if the
23034 remote host is permitted to send unqualified addresses). Rewriting can
23035 sometimes be used to handle simple bang paths with a fixed number of
23036 components. For example, the rule
23037 .code
23038 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23039 .endd
23040 rewrites a two-component bang path &'host.name!user'& as the domain address
23041 &'user@host.name'&. However, there is a security implication in using this as
23042 a global rewriting rule for envelope addresses. It can provide a backdoor
23043 method for using your system as a relay, because the incoming addresses appear
23044 to be local. If the bang path addresses are received via SMTP, it is safer to
23045 use the &"S"& flag to rewrite them as they are received, so that relay checking
23046 can be done on the rewritten addresses.
23047 .ecindex IIDaddrew
23048
23049
23050
23051
23052
23053 . ////////////////////////////////////////////////////////////////////////////
23054 . ////////////////////////////////////////////////////////////////////////////
23055
23056 .chapter "Retry configuration" "CHAPretry"
23057 .scindex IIDretconf1 "retry" "configuration, description of"
23058 .scindex IIDregconf2 "configuration file" "retry section"
23059 The &"retry"& section of the runtime configuration file contains a list of
23060 retry rules that control how often Exim tries to deliver messages that cannot
23061 be delivered at the first attempt. If there are no retry rules (the section is
23062 empty or not present), there are no retries. In this situation, temporary
23063 errors are treated as permanent. The default configuration contains a single,
23064 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23065 line option can be used to test which retry rule will be used for a given
23066 address, domain and error.
23067
23068 The most common cause of retries is temporary failure to deliver to a remote
23069 host because the host is down, or inaccessible because of a network problem.
23070 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23071 address) basis, not on a per-message basis. Thus, if one message has recently
23072 been delayed, delivery of a new message to the same host is not immediately
23073 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23074 log selector is set, the message
23075 .cindex "retry" "time not reached"
23076 &"retry time not reached"& is written to the main log whenever a delivery is
23077 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23078 the handling of errors during remote deliveries.
23079
23080 Retry processing applies to routing as well as to delivering, except as covered
23081 in the next paragraph. The retry rules do not distinguish between these
23082 actions. It is not possible, for example, to specify different behaviour for
23083 failures to route the domain &'snark.fict.example'& and failures to deliver to
23084 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23085 added complication, so did not implement it. However, although they share the
23086 same retry rule, the actual retry times for routing and transporting a given
23087 domain are maintained independently.
23088
23089 When a delivery is not part of a queue run (typically an immediate delivery on
23090 receipt of a message), the routers are always run, and local deliveries are
23091 always attempted, even if retry times are set for them. This makes for better
23092 behaviour if one particular message is causing problems (for example, causing
23093 quota overflow, or provoking an error in a filter file). If such a delivery
23094 suffers a temporary failure, the retry data is updated as normal, and
23095 subsequent delivery attempts from queue runs occur only when the retry time for
23096 the local address is reached.
23097
23098 .section "Changing retry rules" "SECID157"
23099 If you change the retry rules in your configuration, you should consider
23100 whether or not to delete the retry data that is stored in Exim's spool area in
23101 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23102 always safe; that is why they are called &"hints"&.
23103
23104 The hints retry data contains suggested retry times based on the previous
23105 rules. In the case of a long-running problem with a remote host, it might
23106 record the fact that the host has timed out. If your new rules increase the
23107 timeout time for such a host, you should definitely remove the old retry data
23108 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23109 messages that it should now be retaining.
23110
23111
23112
23113 .section "Format of retry rules" "SECID158"
23114 .cindex "retry" "rules"
23115 Each retry rule occupies one line and consists of three or four parts,
23116 separated by white space: a pattern, an error name, an optional list of sender
23117 addresses, and a list of retry parameters. The pattern and sender lists must be
23118 enclosed in double quotes if they contain white space. The rules are searched
23119 in order until one is found where the pattern, error name, and sender list (if
23120 present) match the failing host or address, the error that occurred, and the
23121 message's sender, respectively.
23122
23123
23124 The pattern is any single item that may appear in an address list (see section
23125 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23126 which means that it is expanded before being tested against the address that
23127 has been delayed. A negated address list item is permitted. Address
23128 list processing treats a plain domain name as if it were preceded by &"*@"&,
23129 which makes it possible for many retry rules to start with just a domain. For
23130 example,
23131 .code
23132 lookingglass.fict.example        *  F,24h,30m;
23133 .endd
23134 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23135 whereas
23136 .code
23137 alice@lookingglass.fict.example  *  F,24h,30m;
23138 .endd
23139 applies only to temporary failures involving the local part &%alice%&.
23140 In practice, almost all rules start with a domain name pattern without a local
23141 part.
23142
23143 .cindex "regular expressions" "in retry rules"
23144 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23145 must match a complete address, not just a domain, because that is how regular
23146 expressions work in address lists.
23147 .display
23148 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23149 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23150 .endd
23151
23152
23153 .section "Choosing which retry rule to use for address errors" "SECID159"
23154 When Exim is looking for a retry rule after a routing attempt has failed (for
23155 example, after a DNS timeout), each line in the retry configuration is tested
23156 against the complete address only if &%retry_use_local_part%& is set for the
23157 router. Otherwise, only the domain is used, except when matching against a
23158 regular expression, when the local part of the address is replaced with &"*"&.
23159 A domain on its own can match a domain pattern, or a pattern that starts with
23160 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23161 &%check_local_user%& is true, and false for other routers.
23162
23163 Similarly, when Exim is looking for a retry rule after a local delivery has
23164 failed (for example, after a mailbox full error), each line in the retry
23165 configuration is tested against the complete address only if
23166 &%retry_use_local_part%& is set for the transport (it defaults true for all
23167 local transports).
23168
23169 .cindex "4&'xx'& responses" "retry rules for"
23170 However, when Exim is looking for a retry rule after a remote delivery attempt
23171 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23172 whole address is always used as the key when searching the retry rules. The
23173 rule that is found is used to create a retry time for the combination of the
23174 failing address and the message's sender. It is the combination of sender and
23175 recipient that is delayed in subsequent queue runs until its retry time is
23176 reached. You can delay the recipient without regard to the sender by setting
23177 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23178 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23179 commands.
23180
23181
23182
23183 .section "Choosing which retry rule to use for host and message errors" &&&
23184          "SECID160"
23185 For a temporary error that is not related to an individual address (for
23186 example, a connection timeout), each line in the retry configuration is checked
23187 twice. First, the name of the remote host is used as a domain name (preceded by
23188 &"*@"& when matching a regular expression). If this does not match the line,
23189 the domain from the email address is tried in a similar fashion. For example,
23190 suppose the MX records for &'a.b.c.example'& are
23191 .code
23192 a.b.c.example  MX  5  x.y.z.example
23193                MX  6  p.q.r.example
23194                MX  7  m.n.o.example
23195 .endd
23196 and the retry rules are
23197 .code
23198 p.q.r.example    *      F,24h,30m;
23199 a.b.c.example    *      F,4d,45m;
23200 .endd
23201 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23202 first rule matches neither the host nor the domain, so Exim looks at the second
23203 rule. This does not match the host, but it does match the domain, so it is used
23204 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23205 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23206 first retry rule is used, because it matches the host.
23207
23208 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23209 first rule to determine retry times, but for all the other hosts for the domain
23210 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23211 routing to &'a.b.c.example'& suffers a temporary failure.
23212
23213 &*Note*&: The host name is used when matching the patterns, not its IP address.
23214 However, if a message is routed directly to an IP address without the use of a
23215 host name, for example, if a &(manualroute)& router contains a setting such as:
23216 .code
23217 route_list = *.a.example  192.168.34.23
23218 .endd
23219 then the &"host name"& that is used when searching for a retry rule is the
23220 textual form of the IP address.
23221
23222 .section "Retry rules for specific errors" "SECID161"
23223 .cindex "retry" "specific errors; specifying"
23224 The second field in a retry rule is the name of a particular error, or an
23225 asterisk, which matches any error. The errors that can be tested for are:
23226
23227 .vlist
23228 .vitem &%auth_failed%&
23229 Authentication failed when trying to send to a host in the
23230 &%hosts_require_auth%& list in an &(smtp)& transport.
23231
23232 .vitem &%data_4xx%&
23233 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23234 after the command, or after sending the message's data.
23235
23236 .vitem &%mail_4xx%&
23237 A 4&'xx'& error was received for an outgoing MAIL command.
23238
23239 .vitem &%rcpt_4xx%&
23240 A 4&'xx'& error was received for an outgoing RCPT command.
23241 .endlist
23242
23243 For the three 4&'xx'& errors, either the first or both of the x's can be given
23244 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23245 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23246 and have retries every ten minutes with a one-hour timeout, you could set up a
23247 retry rule of this form:
23248 .code
23249 the.domain.name  rcpt_452   F,1h,10m
23250 .endd
23251 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23252 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23253
23254 .vlist
23255 .vitem &%lost_connection%&
23256 A server unexpectedly closed the SMTP connection. There may, of course,
23257 legitimate reasons for this (host died, network died), but if it repeats a lot
23258 for the same host, it indicates something odd.
23259
23260 .vitem &%refused_MX%&
23261 A connection to a host obtained from an MX record was refused.
23262
23263 .vitem &%refused_A%&
23264 A connection to a host not obtained from an MX record was refused.
23265
23266 .vitem &%refused%&
23267 A connection was refused.
23268
23269 .vitem &%timeout_connect_MX%&
23270 A connection attempt to a host obtained from an MX record timed out.
23271
23272 .vitem &%timeout_connect_A%&
23273 A connection attempt to a host not obtained from an MX record timed out.
23274
23275 .vitem &%timeout_connect%&
23276 A connection attempt timed out.
23277
23278 .vitem &%timeout_MX%&
23279 There was a timeout while connecting or during an SMTP session with a host
23280 obtained from an MX record.
23281
23282 .vitem &%timeout_A%&
23283 There was a timeout while connecting or during an SMTP session with a host not
23284 obtained from an MX record.
23285
23286 .vitem &%timeout%&
23287 There was a timeout while connecting or during an SMTP session.
23288
23289 .vitem &%tls_required%&
23290 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23291 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23292 to STARTTLS, or there was a problem setting up the TLS connection.
23293
23294 .vitem &%quota%&
23295 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23296 transport.
23297
23298 .vitem &%quota_%&<&'time'&>
23299 .cindex "quota" "error testing in retry rule"
23300 .cindex "retry" "quota error testing"
23301 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23302 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23303 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23304 for four days.
23305 .endlist
23306
23307 .cindex "mailbox" "time of last read"
23308 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23309 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23310 it should be based on the last time that the user accessed the mailbox.
23311 However, it is not always possible to determine this. Exim uses the following
23312 heuristic rules:
23313
23314 .ilist
23315 If the mailbox is a single file, the time of last access (the &"atime"&) is
23316 used. As no new messages are being delivered (because the mailbox is over
23317 quota), Exim does not access the file, so this is the time of last user access.
23318 .next
23319 .cindex "maildir format" "time of last read"
23320 For a maildir delivery, the time of last modification of the &_new_&
23321 subdirectory is used. As the mailbox is over quota, no new files are created in
23322 the &_new_& subdirectory, because no new messages are being delivered. Any
23323 change to the &_new_& subdirectory is therefore assumed to be the result of an
23324 MUA moving a new message to the &_cur_& directory when it is first read. The
23325 time that is used is therefore the last time that the user read a new message.
23326 .next
23327 For other kinds of multi-file mailbox, the time of last access cannot be
23328 obtained, so a retry rule that uses this type of error field is never matched.
23329 .endlist
23330
23331 The quota errors apply both to system-enforced quotas and to Exim's own quota
23332 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23333 when a local delivery is deferred because a partition is full (the ENOSPC
23334 error).
23335
23336
23337
23338 .section "Retry rules for specified senders" "SECID162"
23339 .cindex "retry" "rules; sender-specific"
23340 You can specify retry rules that apply only when the failing message has a
23341 specific sender. In particular, this can be used to define retry rules that
23342 apply only to bounce messages. The third item in a retry rule can be of this
23343 form:
23344 .display
23345 &`senders=`&<&'address list'&>
23346 .endd
23347 The retry timings themselves are then the fourth item. For example:
23348 .code
23349 *   rcpt_4xx   senders=:   F,1h,30m
23350 .endd
23351 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23352 host. If the address list contains white space, it must be enclosed in quotes.
23353 For example:
23354 .code
23355 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23356 .endd
23357 &*Warning*&: This facility can be unhelpful if it is used for host errors
23358 (which do not depend on the recipient). The reason is that the sender is used
23359 only to match the retry rule. Once the rule has been found for a host error,
23360 its contents are used to set a retry time for the host, and this will apply to
23361 all messages, not just those with specific senders.
23362
23363 When testing retry rules using &%-brt%&, you can supply a sender using the
23364 &%-f%& command line option, like this:
23365 .code
23366 exim -f "" -brt user@dom.ain
23367 .endd
23368 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23369 list is never matched.
23370
23371
23372
23373
23374
23375 .section "Retry parameters" "SECID163"
23376 .cindex "retry" "parameters in rules"
23377 The third (or fourth, if a senders list is present) field in a retry rule is a
23378 sequence of retry parameter sets, separated by semicolons. Each set consists of
23379 .display
23380 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23381 .endd
23382 The letter identifies the algorithm for computing a new retry time; the cutoff
23383 time is the time beyond which this algorithm no longer applies, and the
23384 arguments vary the algorithm's action. The cutoff time is measured from the
23385 time that the first failure for the domain (combined with the local part if
23386 relevant) was detected, not from the time the message was received.
23387
23388 .cindex "retry" "algorithms"
23389 .cindex "retry" "fixed intervals"
23390 .cindex "retry" "increasing intervals"
23391 .cindex "retry" "random intervals"
23392 The available algorithms are:
23393
23394 .ilist
23395 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23396 the interval.
23397 .next
23398 &'G'&: retry at geometrically increasing intervals. The first argument
23399 specifies a starting value for the interval, and the second a multiplier, which
23400 is used to increase the size of the interval at each retry.
23401 .next
23402 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23403 retry, the previous interval is multiplied by the factor in order to get a
23404 maximum for the next interval. The minimum interval is the first argument of
23405 the parameter, and an actual interval is chosen randomly between them. Such a
23406 rule has been found to be helpful in cluster configurations when all the
23407 members of the cluster restart at once, and may therefore synchronize their
23408 queue processing times.
23409 .endlist
23410
23411 When computing the next retry time, the algorithm definitions are scanned in
23412 order until one whose cutoff time has not yet passed is reached. This is then
23413 used to compute a new retry time that is later than the current time. In the
23414 case of fixed interval retries, this simply means adding the interval to the
23415 current time. For geometrically increasing intervals, retry intervals are
23416 computed from the rule's parameters until one that is greater than the previous
23417 interval is found. The main configuration variable
23418 .cindex "limit" "retry interval"
23419 .cindex "retry" "interval, maximum"
23420 .oindex "&%retry_interval_max%&"
23421 &%retry_interval_max%& limits the maximum interval between retries. It
23422 cannot be set greater than &`24h`&, which is its default value.
23423
23424 A single remote domain may have a number of hosts associated with it, and each
23425 host may have more than one IP address. Retry algorithms are selected on the
23426 basis of the domain name, but are applied to each IP address independently. If,
23427 for example, a host has two IP addresses and one is unusable, Exim will
23428 generate retry times for it and will not try to use it until its next retry
23429 time comes. Thus the good IP address is likely to be tried first most of the
23430 time.
23431
23432 .cindex "hints database" "use for retrying"
23433 Retry times are hints rather than promises. Exim does not make any attempt to
23434 run deliveries exactly at the computed times. Instead, a queue runner process
23435 starts delivery processes for delayed messages periodically, and these attempt
23436 new deliveries only for those addresses that have passed their next retry time.
23437 If a new message arrives for a deferred address, an immediate delivery attempt
23438 occurs only if the address has passed its retry time. In the absence of new
23439 messages, the minimum time between retries is the interval between queue runner
23440 processes. There is not much point in setting retry times of five minutes if
23441 your queue runners happen only once an hour, unless there are a significant
23442 number of incoming messages (which might be the case on a system that is
23443 sending everything to a smart host, for example).
23444
23445 The data in the retry hints database can be inspected by using the
23446 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23447 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23448 &'exinext'& utility script can be used to find out what the next retry times
23449 are for the hosts associated with a particular mail domain, and also for local
23450 deliveries that have been deferred.
23451
23452
23453 .section "Retry rule examples" "SECID164"
23454 Here are some example retry rules:
23455 .code
23456 alice@wonderland.fict.example quota_5d  F,7d,3h
23457 wonderland.fict.example       quota_5d
23458 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23459 lookingglass.fict.example     *         F,24h,30m;
23460 *                 refused_A   F,2h,20m;
23461 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23462 .endd
23463 The first rule sets up special handling for mail to
23464 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23465 mailbox has not been read for at least 5 days. Retries continue every three
23466 hours for 7 days. The second rule handles over-quota errors for all other local
23467 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23468 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23469 fail are bounced immediately if the mailbox has not been read for at least 5
23470 days.
23471
23472 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23473 happen every 15 minutes for an hour, then with geometrically increasing
23474 intervals until two days have passed since a delivery first failed. After the
23475 first hour there is a delay of one hour, then two hours, then four hours, and
23476 so on (this is a rather extreme example).
23477
23478 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23479 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23480 all other domains, with special action for connection refusal from hosts that
23481 were not obtained from an MX record.
23482
23483 The final rule in a retry configuration should always have asterisks in the
23484 first two fields so as to provide a general catch-all for any addresses that do
23485 not have their own special handling. This example tries every 15 minutes for 2
23486 hours, then with intervals starting at one hour and increasing by a factor of
23487 1.5 up to 16 hours, then every 8 hours up to 5 days.
23488
23489
23490
23491 .section "Timeout of retry data" "SECID165"
23492 .cindex "timeout" "of retry data"
23493 .oindex "&%retry_data_expire%&"
23494 .cindex "hints database" "data expiry"
23495 .cindex "retry" "timeout of data"
23496 Exim timestamps the data that it writes to its retry hints database. When it
23497 consults the data during a delivery it ignores any that is older than the value
23498 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23499 been tried for 7 days, Exim will try to deliver to it immediately a message
23500 arrives, and if that fails, it will calculate a retry time as if it were
23501 failing for the first time.
23502
23503 This improves the behaviour for messages routed to rarely-used hosts such as MX
23504 backups. If such a host was down at one time, and happens to be down again when
23505 Exim tries a month later, using the old retry data would imply that it had been
23506 down all the time, which is not a justified assumption.
23507
23508 If a host really is permanently dead, this behaviour causes a burst of retries
23509 every now and again, but only if messages routed to it are rare. If there is a
23510 message at least once every 7 days the retry data never expires.
23511
23512
23513
23514
23515 .section "Long-term failures" "SECID166"
23516 .cindex "delivery failure, long-term"
23517 .cindex "retry" "after long-term failure"
23518 Special processing happens when an email address has been failing for so long
23519 that the cutoff time for the last algorithm is reached. For example, using the
23520 default retry rule:
23521 .code
23522 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23523 .endd
23524 the cutoff time is four days. Reaching the retry cutoff is independent of how
23525 long any specific message has been failing; it is the length of continuous
23526 failure for the recipient address that counts.
23527
23528 When the cutoff time is reached for a local delivery, or for all the IP
23529 addresses associated with a remote delivery, a subsequent delivery failure
23530 causes Exim to give up on the address, and a bounce message is generated.
23531 In order to cater for new messages that use the failing address, a next retry
23532 time is still computed from the final algorithm, and is used as follows:
23533
23534 For local deliveries, one delivery attempt is always made for any subsequent
23535 messages. If this delivery fails, the address fails immediately. The
23536 post-cutoff retry time is not used.
23537
23538 If the delivery is remote, there are two possibilities, controlled by the
23539 .oindex "&%delay_after_cutoff%&"
23540 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23541 default. Until the post-cutoff retry time for one of the IP addresses is
23542 reached, the failing email address is bounced immediately, without a delivery
23543 attempt taking place. After that time, one new delivery attempt is made to
23544 those IP addresses that are past their retry times, and if that still fails,
23545 the address is bounced and new retry times are computed.
23546
23547 In other words, when all the hosts for a given email address have been failing
23548 for a long time, Exim bounces rather then defers until one of the hosts' retry
23549 times is reached. Then it tries once, and bounces if that attempt fails. This
23550 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23551 to a broken destination, but if the host does recover, Exim will eventually
23552 notice.
23553
23554 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23555 addresses are past their final cutoff time, Exim tries to deliver to those IP
23556 addresses that have not been tried since the message arrived. If there are
23557 no suitable IP addresses, or if they all fail, the address is bounced. In other
23558 words, it does not delay when a new message arrives, but tries the expired
23559 addresses immediately, unless they have been tried since the message arrived.
23560 If there is a continuous stream of messages for the failing domains, setting
23561 &%delay_after_cutoff%& false means that there will be many more attempts to
23562 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23563 true.
23564
23565 .section "Deliveries that work intermittently" "SECID167"
23566 .cindex "retry" "intermittently working deliveries"
23567 Some additional logic is needed to cope with cases where a host is
23568 intermittently available, or when a message has some attribute that prevents
23569 its delivery when others to the same address get through. In this situation,
23570 because some messages are successfully delivered, the &"retry clock"& for the
23571 host or address keeps getting reset by the successful deliveries, and so
23572 failing messages remain on the queue for ever because the cutoff time is never
23573 reached.
23574
23575 Two exceptional actions are applied to prevent this happening. The first
23576 applies to errors that are related to a message rather than a remote host.
23577 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23578 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23579 commands, and quota failures. For this type of error, if a message's arrival
23580 time is earlier than the &"first failed"& time for the error, the earlier time
23581 is used when scanning the retry rules to decide when to try next and when to
23582 time out the address.
23583
23584 The exceptional second action applies in all cases. If a message has been on
23585 the queue for longer than the cutoff time of any applicable retry rule for a
23586 given address, a delivery is attempted for that address, even if it is not yet
23587 time, and if this delivery fails, the address is timed out. A new retry time is
23588 not computed in this case, so that other messages for the same address are
23589 considered immediately.
23590 .ecindex IIDretconf1
23591 .ecindex IIDregconf2
23592
23593
23594
23595
23596
23597
23598 . ////////////////////////////////////////////////////////////////////////////
23599 . ////////////////////////////////////////////////////////////////////////////
23600
23601 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23602 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23603 .scindex IIDauthconf2 "authentication"
23604 The &"authenticators"& section of Exim's run time configuration is concerned
23605 with SMTP authentication. This facility is an extension to the SMTP protocol,
23606 described in RFC 2554, which allows a client SMTP host to authenticate itself
23607 to a server. This is a common way for a server to recognize clients that are
23608 permitted to use it as a relay. SMTP authentication is not of relevance to the
23609 transfer of mail between servers that have no managerial connection with each
23610 other.
23611
23612 .cindex "AUTH" "description of"
23613 Very briefly, the way SMTP authentication works is as follows:
23614
23615 .ilist
23616 The server advertises a number of authentication &'mechanisms'& in response to
23617 the client's EHLO command.
23618 .next
23619 The client issues an AUTH command, naming a specific mechanism. The command
23620 may, optionally, contain some authentication data.
23621 .next
23622 The server may issue one or more &'challenges'&, to which the client must send
23623 appropriate responses. In simple authentication mechanisms, the challenges are
23624 just prompts for user names and passwords. The server does not have to issue
23625 any challenges &-- in some mechanisms the relevant data may all be transmitted
23626 with the AUTH command.
23627 .next
23628 The server either accepts or denies authentication.
23629 .next
23630 If authentication succeeds, the client may optionally make use of the AUTH
23631 option on the MAIL command to pass an authenticated sender in subsequent
23632 mail transactions. Authentication lasts for the remainder of the SMTP
23633 connection.
23634 .next
23635 If authentication fails, the client may give up, or it may try a different
23636 authentication mechanism, or it may try transferring mail over the
23637 unauthenticated connection.
23638 .endlist
23639
23640 If you are setting up a client, and want to know which authentication
23641 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23642 SMTP port) on the server, and issue an EHLO command. The response to this
23643 includes the list of supported mechanisms. For example:
23644 .display
23645 &`$ `&&*&`telnet server.example 25`&*&
23646 &`Trying 192.168.34.25...`&
23647 &`Connected to server.example.`&
23648 &`Escape character is &#x0027;^]&#x0027;.`&
23649 &`220 server.example ESMTP Exim 4.20 ...`&
23650 &*&`ehlo client.example`&*&
23651 &`250-server.example Hello client.example [10.8.4.5]`&
23652 &`250-SIZE 52428800`&
23653 &`250-PIPELINING`&
23654 &`250-AUTH PLAIN`&
23655 &`250 HELP`&
23656 .endd
23657 The second-last line of this example output shows that the server supports
23658 authentication using the PLAIN mechanism. In Exim, the different authentication
23659 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23660 routers and transports, which authenticators are included in the binary is
23661 controlled by build-time definitions. The following are currently available,
23662 included by setting
23663 .code
23664 AUTH_CRAM_MD5=yes
23665 AUTH_CYRUS_SASL=yes
23666 AUTH_DOVECOT=yes
23667 AUTH_GSASL=yes
23668 AUTH_HEIMDAL_GSSAPI=yes
23669 AUTH_PLAINTEXT=yes
23670 AUTH_SPA=yes
23671 .endd
23672 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23673 authentication mechanism (RFC 2195), and the second provides an interface to
23674 the Cyrus SASL authentication library.
23675 The third is an interface to Dovecot's authentication system, delegating the
23676 work via a socket interface.
23677 The fourth provides an interface to the GNU SASL authentication library, which
23678 provides mechanisms but typically not data sources.
23679 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23680 supporting setting a server keytab.
23681 The sixth can be configured to support
23682 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23683 not formally documented, but used by several MUAs. The seventh authenticator
23684 supports Microsoft's &'Secure Password Authentication'& mechanism.
23685
23686 The authenticators are configured using the same syntax as other drivers (see
23687 section &<<SECTfordricon>>&). If no authenticators are required, no
23688 authentication section need be present in the configuration file. Each
23689 authenticator can in principle have both server and client functions. When Exim
23690 is receiving SMTP mail, it is acting as a server; when it is sending out
23691 messages over SMTP, it is acting as a client. Authenticator configuration
23692 options are provided for use in both these circumstances.
23693
23694 To make it clear which options apply to which situation, the prefixes
23695 &%server_%& and &%client_%& are used on option names that are specific to
23696 either the server or the client function, respectively. Server and client
23697 functions are disabled if none of their options are set. If an authenticator is
23698 to be used for both server and client functions, a single definition, using
23699 both sets of options, is required. For example:
23700 .code
23701 cram:
23702   driver = cram_md5
23703   public_name = CRAM-MD5
23704   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23705   client_name = ph10
23706   client_secret = secret2
23707 .endd
23708 The &%server_%& option is used when Exim is acting as a server, and the
23709 &%client_%& options when it is acting as a client.
23710
23711 Descriptions of the individual authenticators are given in subsequent chapters.
23712 The remainder of this chapter covers the generic options for the
23713 authenticators, followed by general discussion of the way authentication works
23714 in Exim.
23715
23716 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
23717 per-mechanism basis.  Please read carefully to determine which variables hold
23718 account labels such as usercodes and which hold passwords or other
23719 authenticating data.
23720
23721 Note that some mechanisms support two different identifiers for accounts: the
23722 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
23723 and &'authz'& are commonly encountered.  The American spelling is standard here.
23724 Conceptually, authentication data such as passwords are tied to the identifier
23725 used to authenticate; servers may have rules to permit one user to act as a
23726 second user, so that after login the session is treated as though that second
23727 user had logged in.  That second user is the &'authorization id'&.  A robust
23728 configuration might confirm that the &'authz'& field is empty or matches the
23729 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
23730 as verified data, the &'authz'& as an unverified request which the server might
23731 choose to honour.
23732
23733 A &'realm'& is a text string, typically a domain name, presented by a server
23734 to a client to help it select an account and credentials to use.  In some
23735 mechanisms, the client and server provably agree on the realm, but clients
23736 typically can not treat the realm as secure data to be blindly trusted.
23737
23738
23739
23740 .section "Generic options for authenticators" "SECID168"
23741 .cindex "authentication" "generic options"
23742 .cindex "options" "generic; for authenticators"
23743
23744 .option client_condition authenticators string&!! unset
23745 When Exim is authenticating as a client, it skips any authenticator whose
23746 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23747 used, for example, to skip plain text authenticators when the connection is not
23748 encrypted by a setting such as:
23749 .code
23750 client_condition = ${if !eq{$tls_cipher}{}}
23751 .endd
23752 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23753 used for incoming messages. In fact, during SMTP delivery, it contains the
23754 cipher used for the delivery.)
23755
23756
23757 .option driver authenticators string unset
23758 This option must always be set. It specifies which of the available
23759 authenticators is to be used.
23760
23761
23762 .option public_name authenticators string unset
23763 This option specifies the name of the authentication mechanism that the driver
23764 implements, and by which it is known to the outside world. These names should
23765 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23766 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23767 defaults to the driver's instance name.
23768
23769
23770 .option server_advertise_condition authenticators string&!! unset
23771 When a server is about to advertise an authentication mechanism, the condition
23772 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23773 mechanism is not advertised.
23774 If the expansion fails, the mechanism is not advertised. If the failure was not
23775 forced, and was not caused by a lookup defer, the incident is logged.
23776 See section &<<SECTauthexiser>>& below for further discussion.
23777
23778
23779 .option server_condition authenticators string&!! unset
23780 This option must be set for a &%plaintext%& server authenticator, where it
23781 is used directly to control authentication. See section &<<SECTplainserver>>&
23782 for details.
23783
23784 For the &(gsasl)& authenticator, this option is required for various
23785 mechanisms; see chapter &<<CHAPgsasl>>& for details.
23786
23787 For the other authenticators, &%server_condition%& can be used as an additional
23788 authentication or authorization mechanism that is applied after the other
23789 authenticator conditions succeed. If it is set, it is expanded when the
23790 authenticator would otherwise return a success code. If the expansion is forced
23791 to fail, authentication fails. Any other expansion failure causes a temporary
23792 error code to be returned. If the result of a successful expansion is an empty
23793 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23794 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23795 other result, a temporary error code is returned, with the expanded string as
23796 the error text.
23797
23798
23799 .option server_debug_print authenticators string&!! unset
23800 If this option is set and authentication debugging is enabled (see the &%-d%&
23801 command line option), the string is expanded and included in the debugging
23802 output when the authenticator is run as a server. This can help with checking
23803 out the values of variables.
23804 If expansion of the string fails, the error message is written to the debugging
23805 output, and Exim carries on processing.
23806
23807
23808 .option server_set_id authenticators string&!! unset
23809 .vindex "&$authenticated_id$&"
23810 When an Exim server successfully authenticates a client, this string is
23811 expanded using data from the authentication, and preserved for any incoming
23812 messages in the variable &$authenticated_id$&. It is also included in the log
23813 lines for incoming messages. For example, a user/password authenticator
23814 configuration might preserve the user name that was used to authenticate, and
23815 refer to it subsequently during delivery of the message.
23816 If expansion fails, the option is ignored.
23817
23818
23819 .option server_mail_auth_condition authenticators string&!! unset
23820 This option allows a server to discard authenticated sender addresses supplied
23821 as part of MAIL commands in SMTP connections that are authenticated by the
23822 driver on which &%server_mail_auth_condition%& is set. The option is not used
23823 as part of the authentication process; instead its (unexpanded) value is
23824 remembered for later use.
23825 How it is used is described in the following section.
23826
23827
23828
23829
23830
23831 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23832 .cindex "authentication" "sender; authenticated"
23833 .cindex "AUTH" "on MAIL command"
23834 When a client supplied an AUTH= item on a MAIL command, Exim applies
23835 the following checks before accepting it as the authenticated sender of the
23836 message:
23837
23838 .ilist
23839 If the connection is not using extended SMTP (that is, HELO was used rather
23840 than EHLO), the use of AUTH= is a syntax error.
23841 .next
23842 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23843 .next
23844 .vindex "&$authenticated_sender$&"
23845 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23846 running, the value of &$authenticated_sender$& is set to the value obtained
23847 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23848 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23849 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23850 given for the MAIL command.
23851 .next
23852 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23853 is accepted and placed in &$authenticated_sender$& only if the client has
23854 authenticated.
23855 .next
23856 If the AUTH= value was accepted by either of the two previous rules, and
23857 the client has authenticated, and the authenticator has a setting for the
23858 &%server_mail_auth_condition%&, the condition is checked at this point. The
23859 valued that was saved from the authenticator is expanded. If the expansion
23860 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23861 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23862 the value of &$authenticated_sender$& is retained and passed on with the
23863 message.
23864 .endlist
23865
23866
23867 When &$authenticated_sender$& is set for a message, it is passed on to other
23868 hosts to which Exim authenticates as a client. Do not confuse this value with
23869 &$authenticated_id$&, which is a string obtained from the authentication
23870 process, and which is not usually a complete email address.
23871
23872 .vindex "&$sender_address$&"
23873 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23874 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23875 therefore make use of &$authenticated_sender$&. The converse is not true: the
23876 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23877 ACL is run.
23878
23879
23880
23881 .section "Authentication on an Exim server" "SECTauthexiser"
23882 .cindex "authentication" "on an Exim server"
23883 When Exim receives an EHLO command, it advertises the public names of those
23884 authenticators that are configured as servers, subject to the following
23885 conditions:
23886
23887 .ilist
23888 The client host must match &%auth_advertise_hosts%& (default *).
23889 .next
23890 It the &%server_advertise_condition%& option is set, its expansion must not
23891 yield the empty string, &"0"&, &"no"&, or &"false"&.
23892 .endlist
23893
23894 The order in which the authenticators are defined controls the order in which
23895 the mechanisms are advertised.
23896
23897 Some mail clients (for example, some versions of Netscape) require the user to
23898 provide a name and password for authentication whenever AUTH is advertised,
23899 even though authentication may not in fact be needed (for example, Exim may be
23900 set up to allow unconditional relaying from the client by an IP address check).
23901 You can make such clients more friendly by not advertising AUTH to them.
23902 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23903 that runs for RCPT) to relay without authentication, you should set
23904 .code
23905 auth_advertise_hosts = ! 10.9.8.0/24
23906 .endd
23907 so that no authentication mechanisms are advertised to them.
23908
23909 The &%server_advertise_condition%& controls the advertisement of individual
23910 authentication mechanisms. For example, it can be used to restrict the
23911 advertisement of a particular mechanism to encrypted connections, by a setting
23912 such as:
23913 .code
23914 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23915 .endd
23916 .vindex "&$tls_cipher$&"
23917 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23918 yields &"yes"&, which allows the advertisement to happen.
23919
23920 When an Exim server receives an AUTH command from a client, it rejects it
23921 immediately if AUTH was not advertised in response to an earlier EHLO
23922 command. This is the case if
23923
23924 .ilist
23925 The client host does not match &%auth_advertise_hosts%&; or
23926 .next
23927 No authenticators are configured with server options; or
23928 .next
23929 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23930 server authenticators.
23931 .endlist
23932
23933
23934 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23935 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23936 AUTH is accepted from any client host.
23937
23938 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23939 server authentication mechanism that was advertised in response to EHLO and
23940 that matches the one named in the AUTH command. If it finds one, it runs
23941 the appropriate authentication protocol, and authentication either succeeds or
23942 fails. If there is no matching advertised mechanism, the AUTH command is
23943 rejected with a 504 error.
23944
23945 .vindex "&$received_protocol$&"
23946 .vindex "&$sender_host_authenticated$&"
23947 When a message is received from an authenticated host, the value of
23948 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23949 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23950 public name) of the authenticator driver that successfully authenticated the
23951 client from which the message was received. This variable is empty if there was
23952 no successful authentication.
23953
23954
23955
23956
23957 .section "Testing server authentication" "SECID169"
23958 .cindex "authentication" "testing a server"
23959 .cindex "AUTH" "testing a server"
23960 .cindex "base64 encoding" "creating authentication test data"
23961 Exim's &%-bh%& option can be useful for testing server authentication
23962 configurations. The data for the AUTH command has to be sent using base64
23963 encoding. A quick way to produce such data for testing is the following Perl
23964 script:
23965 .code
23966 use MIME::Base64;
23967 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23968 .endd
23969 .cindex "binary zero" "in authentication data"
23970 This interprets its argument as a Perl string, and then encodes it. The
23971 interpretation as a Perl string allows binary zeros, which are required for
23972 some kinds of authentication, to be included in the data. For example, a
23973 command line to run this script on such data might be
23974 .code
23975 encode '\0user\0password'
23976 .endd
23977 Note the use of single quotes to prevent the shell interpreting the
23978 backslashes, so that they can be interpreted by Perl to specify characters
23979 whose code value is zero.
23980
23981 &*Warning 1*&: If either of the user or password strings starts with an octal
23982 digit, you must use three zeros instead of one after the leading backslash. If
23983 you do not, the octal digit that starts your string will be incorrectly
23984 interpreted as part of the code for the first character.
23985
23986 &*Warning 2*&: If there are characters in the strings that Perl interprets
23987 specially, you must use a Perl escape to prevent them being misinterpreted. For
23988 example, a command such as
23989 .code
23990 encode '\0user@domain.com\0pas$$word'
23991 .endd
23992 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23993
23994 If you have the &%mimencode%& command installed, another way to do produce
23995 base64-encoded strings is to run the command
23996 .code
23997 echo -e -n `\0user\0password' | mimencode
23998 .endd
23999 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24000 in the argument, and the &%-n%& option specifies no newline at the end of its
24001 output. However, not all versions of &%echo%& recognize these options, so you
24002 should check your version before relying on this suggestion.
24003
24004
24005
24006 .section "Authentication by an Exim client" "SECID170"
24007 .cindex "authentication" "on an Exim client"
24008 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24009 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24010 announces support for authentication, and the host matches an entry in either
24011 of these options, Exim (as a client) tries to authenticate as follows:
24012
24013 .ilist
24014 For each authenticator that is configured as a client, in the order in which
24015 they are defined in the configuration, it searches the authentication
24016 mechanisms announced by the server for one whose name matches the public name
24017 of the authenticator.
24018 .next
24019 .vindex "&$host$&"
24020 .vindex "&$host_address$&"
24021 When it finds one that matches, it runs the authenticator's client code. The
24022 variables &$host$& and &$host_address$& are available for any string expansions
24023 that the client might do. They are set to the server's name and IP address. If
24024 any expansion is forced to fail, the authentication attempt is abandoned, and
24025 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24026 delivery to be deferred.
24027 .next
24028 If the result of the authentication attempt is a temporary error or a timeout,
24029 Exim abandons trying to send the message to the host for the moment. It will
24030 try again later. If there are any backup hosts available, they are tried in the
24031 usual way.
24032 .next
24033 If the response to authentication is a permanent error (5&'xx'& code), Exim
24034 carries on searching the list of authenticators and tries another one if
24035 possible. If all authentication attempts give permanent errors, or if there are
24036 no attempts because no mechanisms match (or option expansions force failure),
24037 what happens depends on whether the host matches &%hosts_require_auth%& or
24038 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24039 delivery is deferred. The error can be detected in the retry rules, and thereby
24040 turned into a permanent error if you wish. In the second case, Exim tries to
24041 deliver the message unauthenticated.
24042 .endlist
24043
24044 .cindex "AUTH" "on MAIL command"
24045 When Exim has authenticated itself to a remote server, it adds the AUTH
24046 parameter to the MAIL commands it sends, if it has an authenticated sender for
24047 the message. If the message came from a remote host, the authenticated sender
24048 is the one that was receiving on an incoming MAIL command, provided that the
24049 incoming connection was authenticated and the &%server_mail_auth%& condition
24050 allowed the authenticated sender to be retained. If a local process calls Exim
24051 to send a message, the sender address that is built from the login name and
24052 &%qualify_domain%& is treated as authenticated. However, if the
24053 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24054 the authenticated sender that was received with the message.
24055 .ecindex IIDauthconf1
24056 .ecindex IIDauthconf2
24057
24058
24059
24060
24061
24062
24063 . ////////////////////////////////////////////////////////////////////////////
24064 . ////////////////////////////////////////////////////////////////////////////
24065
24066 .chapter "The plaintext authenticator" "CHAPplaintext"
24067 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24068 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24069 The &(plaintext)& authenticator can be configured to support the PLAIN and
24070 LOGIN authentication mechanisms, both of which transfer authentication data as
24071 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24072 security risk; you are strongly advised to insist on the use of SMTP encryption
24073 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24074 use unencrypted plain text, you should not use the same passwords for SMTP
24075 connections as you do for login accounts.
24076
24077 .section "Plaintext options" "SECID171"
24078 .cindex "options" "&(plaintext)& authenticator (server)"
24079 When configured as a server, &(plaintext)& uses the following options:
24080
24081 .option server_condition authenticators string&!! unset
24082 This is actually a global authentication option, but it must be set in order to
24083 configure the &(plaintext)& driver as a server. Its use is described below.
24084
24085 .option server_prompts plaintext string&!! unset
24086 The contents of this option, after expansion, must be a colon-separated list of
24087 prompt strings. If expansion fails, a temporary authentication rejection is
24088 given.
24089
24090 .section "Using plaintext in a server" "SECTplainserver"
24091 .cindex "AUTH" "in &(plaintext)& authenticator"
24092 .cindex "binary zero" "in &(plaintext)& authenticator"
24093 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24094         "in &(plaintext)& authenticator"
24095 .vindex "&$auth1$&, &$auth2$&, etc"
24096 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24097
24098 When running as a server, &(plaintext)& performs the authentication test by
24099 expanding a string. The data sent by the client with the AUTH command, or in
24100 response to subsequent prompts, is base64 encoded, and so may contain any byte
24101 values when decoded. If any data is supplied with the command, it is treated as
24102 a list of strings, separated by NULs (binary zeros), the first three of which
24103 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24104 (neither LOGIN nor PLAIN uses more than three strings).
24105
24106 For compatibility with previous releases of Exim, the values are also placed in
24107 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24108 variables for this purpose is now deprecated, as it can lead to confusion in
24109 string expansions that also use them for other things.
24110
24111 If there are more strings in &%server_prompts%& than the number of strings
24112 supplied with the AUTH command, the remaining prompts are used to obtain more
24113 data. Each response from the client may be a list of NUL-separated strings.
24114
24115 .vindex "&$authenticated_id$&"
24116 Once a sufficient number of data strings have been received,
24117 &%server_condition%& is expanded. If the expansion is forced to fail,
24118 authentication fails. Any other expansion failure causes a temporary error code
24119 to be returned. If the result of a successful expansion is an empty string,
24120 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24121 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24122 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24123 For any other result, a temporary error code is returned, with the expanded
24124 string as the error text.
24125
24126 &*Warning*&: If you use a lookup in the expansion to find the user's
24127 password, be sure to make the authentication fail if the user is unknown.
24128 There are good and bad examples at the end of the next section.
24129
24130
24131
24132 .section "The PLAIN authentication mechanism" "SECID172"
24133 .cindex "PLAIN authentication mechanism"
24134 .cindex "authentication" "PLAIN mechanism"
24135 .cindex "binary zero" "in &(plaintext)& authenticator"
24136 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24137 sent as one item of data (that is, one combined string containing two NUL
24138 separators). The data is sent either as part of the AUTH command, or
24139 subsequently in response to an empty prompt from the server.
24140
24141 The second and third strings are a user name and a corresponding password.
24142 Using a single fixed user name and password as an example, this could be
24143 configured as follows:
24144 .code
24145 fixed_plain:
24146   driver = plaintext
24147   public_name = PLAIN
24148   server_prompts = :
24149   server_condition = \
24150     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24151   server_set_id = $auth2
24152 .endd
24153 Note that the default result strings from &%if%& (&"true"& or an empty string)
24154 are exactly what we want here, so they need not be specified. Obviously, if the
24155 password contains expansion-significant characters such as dollar, backslash,
24156 or closing brace, they have to be escaped.
24157
24158 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24159 the end of a string list are ignored). If all the data comes as part of the
24160 AUTH command, as is commonly the case, the prompt is not used. This
24161 authenticator is advertised in the response to EHLO as
24162 .code
24163 250-AUTH PLAIN
24164 .endd
24165 and a client host can authenticate itself by sending the command
24166 .code
24167 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24168 .endd
24169 As this contains three strings (more than the number of prompts), no further
24170 data is required from the client. Alternatively, the client may just send
24171 .code
24172 AUTH PLAIN
24173 .endd
24174 to initiate authentication, in which case the server replies with an empty
24175 prompt. The client must respond with the combined data string.
24176
24177 The data string is base64 encoded, as required by the RFC. This example,
24178 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24179 represents a zero byte. This is split up into three strings, the first of which
24180 is empty. The &%server_condition%& option in the authenticator checks that the
24181 second two are &`username`& and &`mysecret`& respectively.
24182
24183 Having just one fixed user name and password, as in this example, is not very
24184 realistic, though for a small organization with only a handful of
24185 authenticating clients it could make sense.
24186
24187 A more sophisticated instance of this authenticator could use the user name in
24188 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24189 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24190 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24191 This is an incorrect example:
24192 .code
24193 server_condition = \
24194   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24195 .endd
24196 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24197 which it then compares to the supplied password (&$auth3$&). Why is this example
24198 incorrect? It works fine for existing users, but consider what happens if a
24199 non-existent user name is given. The lookup fails, but as no success/failure
24200 strings are given for the lookup, it yields an empty string. Thus, to defeat
24201 the authentication, all a client has to do is to supply a non-existent user
24202 name and an empty password. The correct way of writing this test is:
24203 .code
24204 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24205   {${if eq{$value}{$auth3}}} {false}}
24206 .endd
24207 In this case, if the lookup succeeds, the result is checked; if the lookup
24208 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24209 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24210 always fails if its second argument is empty. However, the second way of
24211 writing the test makes the logic clearer.
24212
24213
24214 .section "The LOGIN authentication mechanism" "SECID173"
24215 .cindex "LOGIN authentication mechanism"
24216 .cindex "authentication" "LOGIN mechanism"
24217 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24218 in a number of programs. No data is sent with the AUTH command. Instead, a
24219 user name and password are supplied separately, in response to prompts. The
24220 plaintext authenticator can be configured to support this as in this example:
24221 .code
24222 fixed_login:
24223   driver = plaintext
24224   public_name = LOGIN
24225   server_prompts = User Name : Password
24226   server_condition = \
24227     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24228   server_set_id = $auth1
24229 .endd
24230 Because of the way plaintext operates, this authenticator accepts data supplied
24231 with the AUTH command (in contravention of the specification of LOGIN), but
24232 if the client does not supply it (as is the case for LOGIN clients), the prompt
24233 strings are used to obtain two data items.
24234
24235 Some clients are very particular about the precise text of the prompts. For
24236 example, Outlook Express is reported to recognize only &"Username:"& and
24237 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24238 strings. It uses the &%ldapauth%& expansion condition to check the user
24239 name and password by binding to an LDAP server:
24240 .code
24241 login:
24242   driver = plaintext
24243   public_name = LOGIN
24244   server_prompts = Username:: : Password::
24245   server_condition = ${if and{{ \
24246     !eq{}{$auth1} }{ \
24247     ldapauth{\
24248       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24249       pass=${quote:$auth2} \
24250       ldap://ldap.example.org/} }} }
24251   server_set_id = uid=$auth1,ou=people,o=example.org
24252 .endd
24253 We have to check that the username is not empty before using it, because LDAP
24254 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24255 operator to correctly quote the DN for authentication. However, the basic
24256 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24257 correct one to use for the password, because quoting is needed only to make
24258 the password conform to the Exim syntax. At the LDAP level, the password is an
24259 uninterpreted string.
24260
24261
24262 .section "Support for different kinds of authentication" "SECID174"
24263 A number of string expansion features are provided for the purpose of
24264 interfacing to different ways of user authentication. These include checking
24265 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24266 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24267 &<<SECTexpcond>>&.
24268
24269
24270
24271
24272 .section "Using plaintext in a client" "SECID175"
24273 .cindex "options" "&(plaintext)& authenticator (client)"
24274 The &(plaintext)& authenticator has two client options:
24275
24276 .option client_ignore_invalid_base64 plaintext boolean false
24277 If the client receives a server prompt that is not a valid base64 string,
24278 authentication is abandoned by default. However, if this option is set true,
24279 the error in the challenge is ignored and the client sends the response as
24280 usual.
24281
24282 .option client_send plaintext string&!! unset
24283 The string is a colon-separated list of authentication data strings. Each
24284 string is independently expanded before being sent to the server. The first
24285 string is sent with the AUTH command; any more strings are sent in response
24286 to prompts from the server. Before each string is expanded, the value of the
24287 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24288 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24289 way. Thus, the prompt that is received in response to sending the first string
24290 (with the AUTH command) can be used in the expansion of the second string, and
24291 so on. If an invalid base64 string is received when
24292 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24293 &$auth$&<&'n'&> variable.
24294
24295 &*Note*&: You cannot use expansion to create multiple strings, because
24296 splitting takes priority and happens first.
24297
24298 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24299 the data, further processing is applied to each string before it is sent. If
24300 there are any single circumflex characters in the string, they are converted to
24301 NULs. Should an actual circumflex be required as data, it must be doubled in
24302 the string.
24303
24304 This is an example of a client configuration that implements the PLAIN
24305 authentication mechanism with a fixed user name and password:
24306 .code
24307 fixed_plain:
24308   driver = plaintext
24309   public_name = PLAIN
24310   client_send = ^username^mysecret
24311 .endd
24312 The lack of colons means that the entire text is sent with the AUTH
24313 command, with the circumflex characters converted to NULs. A similar example
24314 that uses the LOGIN mechanism is:
24315 .code
24316 fixed_login:
24317   driver = plaintext
24318   public_name = LOGIN
24319   client_send = : username : mysecret
24320 .endd
24321 The initial colon means that the first string is empty, so no data is sent with
24322 the AUTH command itself. The remaining strings are sent in response to
24323 prompts.
24324 .ecindex IIDplaiauth1
24325 .ecindex IIDplaiauth2
24326
24327
24328
24329
24330 . ////////////////////////////////////////////////////////////////////////////
24331 . ////////////////////////////////////////////////////////////////////////////
24332
24333 .chapter "The cram_md5 authenticator" "CHID9"
24334 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24335 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24336 .cindex "CRAM-MD5 authentication mechanism"
24337 .cindex "authentication" "CRAM-MD5 mechanism"
24338 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24339 sends a challenge string to the client, and the response consists of a user
24340 name and the CRAM-MD5 digest of the challenge string combined with a secret
24341 string (password) which is known to both server and client. Thus, the secret
24342 is not sent over the network as plain text, which makes this authenticator more
24343 secure than &(plaintext)&. However, the downside is that the secret has to be
24344 available in plain text at either end.
24345
24346
24347 .section "Using cram_md5 as a server" "SECID176"
24348 .cindex "options" "&(cram_md5)& authenticator (server)"
24349 This authenticator has one server option, which must be set to configure the
24350 authenticator as a server:
24351
24352 .option server_secret cram_md5 string&!! unset
24353 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24354 When the server receives the client's response, the user name is placed in
24355 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24356 obtain the password for that user. The server then computes the CRAM-MD5 digest
24357 that the client should have sent, and checks that it received the correct
24358 string. If the expansion of &%server_secret%& is forced to fail, authentication
24359 fails. If the expansion fails for some other reason, a temporary error code is
24360 returned to the client.
24361
24362 For compatibility with previous releases of Exim, the user name is also placed
24363 in &$1$&. However, the use of this variables for this purpose is now
24364 deprecated, as it can lead to confusion in string expansions that also use
24365 numeric variables for other things.
24366
24367 For example, the following authenticator checks that the user name given by the
24368 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24369 user name, authentication fails.
24370 .code
24371 fixed_cram:
24372   driver = cram_md5
24373   public_name = CRAM-MD5
24374   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24375   server_set_id = $auth1
24376 .endd
24377 .vindex "&$authenticated_id$&"
24378 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24379 name in &$authenticated_id$&. A more typical configuration might look up the
24380 secret string in a file, using the user name as the key. For example:
24381 .code
24382 lookup_cram:
24383   driver = cram_md5
24384   public_name = CRAM-MD5
24385   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24386                   {$value}fail}
24387   server_set_id = $auth1
24388 .endd
24389 Note that this expansion explicitly forces failure if the lookup fails
24390 because &$auth1$& contains an unknown user name.
24391
24392 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24393 using the relevant libraries, you need to know the realm to specify in the
24394 lookup and then ask for the &"userPassword"& attribute for that user in that
24395 realm, with:
24396 .code
24397 cyrusless_crammd5:
24398   driver = cram_md5
24399   public_name = CRAM-MD5
24400   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24401                   dbmjz{/etc/sasldb2}}
24402   server_set_id = $auth1
24403 .endd
24404
24405 .section "Using cram_md5 as a client" "SECID177"
24406 .cindex "options" "&(cram_md5)& authenticator (client)"
24407 When used as a client, the &(cram_md5)& authenticator has two options:
24408
24409
24410
24411 .option client_name cram_md5 string&!! "the primary host name"
24412 This string is expanded, and the result used as the user name data when
24413 computing the response to the server's challenge.
24414
24415
24416 .option client_secret cram_md5 string&!! unset
24417 This option must be set for the authenticator to work as a client. Its value is
24418 expanded and the result used as the secret string when computing the response.
24419
24420
24421 .vindex "&$host$&"
24422 .vindex "&$host_address$&"
24423 Different user names and secrets can be used for different servers by referring
24424 to &$host$& or &$host_address$& in the options. Forced failure of either
24425 expansion string is treated as an indication that this authenticator is not
24426 prepared to handle this case. Exim moves on to the next configured client
24427 authenticator. Any other expansion failure causes Exim to give up trying to
24428 send the message to the current server.
24429
24430 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24431 strings, is:
24432 .code
24433 fixed_cram:
24434   driver = cram_md5
24435   public_name = CRAM-MD5
24436   client_name = ph10
24437   client_secret = secret
24438 .endd
24439 .ecindex IIDcramauth1
24440 .ecindex IIDcramauth2
24441
24442
24443
24444 . ////////////////////////////////////////////////////////////////////////////
24445 . ////////////////////////////////////////////////////////////////////////////
24446
24447 .chapter "The cyrus_sasl authenticator" "CHID10"
24448 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24449 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24450 .cindex "Cyrus" "SASL library"
24451 .cindex "Kerberos"
24452 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24453 Digital Ltd (&url(http://www.aldigital.co.uk)).
24454
24455 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24456 library implementation of the RFC 2222 (&"Simple Authentication and Security
24457 Layer"&). This library supports a number of authentication mechanisms,
24458 including PLAIN and LOGIN, but also several others that Exim does not support
24459 directly. In particular, there is support for Kerberos authentication.
24460
24461 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24462 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24463 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24464 name of the driver to determine which mechanism to support.
24465
24466 Where access to some kind of secret file is required, for example in GSSAPI
24467 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24468 user, and that the Cyrus SASL library has no way of escalating privileges
24469 by default. You may also find you need to set environment variables,
24470 depending on the driver you are using.
24471
24472 The application name provided by Exim is &"exim"&, so various SASL options may
24473 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24474 Kerberos, note that because of limitations in the GSSAPI interface,
24475 changing the server keytab might need to be communicated down to the Kerberos
24476 layer independently. The mechanism for doing so is dependent upon the Kerberos
24477 implementation.
24478
24479 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24480 may be set to point to an alternative keytab file. Exim will pass this
24481 variable through from its own inherited environment when started as root or the
24482 Exim user. The keytab file needs to be readable by the Exim user.
24483 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24484 environment variable.  In practice, for those releases, the Cyrus authenticator
24485 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24486 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24487
24488
24489 .section "Using cyrus_sasl as a server" "SECID178"
24490 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24491 (on a successful authentication) into &$auth1$&. For compatibility with
24492 previous releases of Exim, the username is also placed in &$1$&. However, the
24493 use of this variable for this purpose is now deprecated, as it can lead to
24494 confusion in string expansions that also use numeric variables for other
24495 things.
24496
24497
24498 .option server_hostname cyrus_sasl string&!! "see below"
24499 This option selects the hostname that is used when communicating with the
24500 library. The default value is &`$primary_hostname`&. It is up to the underlying
24501 SASL plug-in what it does with this data.
24502
24503
24504 .option server_mech cyrus_sasl string "see below"
24505 This option selects the authentication mechanism this driver should use. The
24506 default is the value of the generic &%public_name%& option. This option allows
24507 you to use a different underlying mechanism from the advertised name. For
24508 example:
24509 .code
24510 sasl:
24511   driver = cyrus_sasl
24512   public_name = X-ANYTHING
24513   server_mech = CRAM-MD5
24514   server_set_id = $auth1
24515 .endd
24516
24517 .option server_realm cyrus_sasl string&!! unset
24518 This specifies the SASL realm that the server claims to be in.
24519
24520
24521 .option server_service cyrus_sasl string &`smtp`&
24522 This is the SASL service that the server claims to implement.
24523
24524
24525 For straightforward cases, you do not need to set any of the authenticator's
24526 private options. All you need to do is to specify an appropriate mechanism as
24527 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24528 PLAIN, you could have two authenticators as follows:
24529 .code
24530 sasl_cram_md5:
24531   driver = cyrus_sasl
24532   public_name = CRAM-MD5
24533   server_set_id = $auth1
24534
24535 sasl_plain:
24536   driver = cyrus_sasl
24537   public_name = PLAIN
24538   server_set_id = $auth2
24539 .endd
24540 Cyrus SASL does implement the LOGIN authentication method, even though it is
24541 not a standard method. It is disabled by default in the source distribution,
24542 but it is present in many binary distributions.
24543 .ecindex IIDcyrauth1
24544 .ecindex IIDcyrauth2
24545
24546
24547
24548
24549 . ////////////////////////////////////////////////////////////////////////////
24550 . ////////////////////////////////////////////////////////////////////////////
24551 .chapter "The dovecot authenticator" "CHAPdovecot"
24552 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24553 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24554 This authenticator is an interface to the authentication facility of the
24555 Dovecot POP/IMAP server, which can support a number of authentication methods.
24556 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24557 to use the same mechanisms for SMTP authentication. This is a server
24558 authenticator only. There is only one option:
24559
24560 .option server_socket dovecot string unset
24561
24562 This option must specify the socket that is the interface to Dovecot
24563 authentication. The &%public_name%& option must specify an authentication
24564 mechanism that Dovecot is configured to support. You can have several
24565 authenticators for different mechanisms. For example:
24566 .code
24567 dovecot_plain:
24568   driver = dovecot
24569   public_name = PLAIN
24570   server_socket = /var/run/dovecot/auth-client
24571   server_set_id = $auth2
24572
24573 dovecot_ntlm:
24574   driver = dovecot
24575   public_name = NTLM
24576   server_socket = /var/run/dovecot/auth-client
24577   server_set_id = $auth1
24578 .endd
24579 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24580 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24581 option is passed in the Dovecot authentication command. If, for a TLS
24582 connection, a client certificate has been verified, the &"valid-client-cert"&
24583 option is passed. When authentication succeeds, the identity of the user
24584 who authenticated is placed in &$auth1$&.
24585 .ecindex IIDdcotauth1
24586 .ecindex IIDdcotauth2
24587
24588
24589 . ////////////////////////////////////////////////////////////////////////////
24590 . ////////////////////////////////////////////////////////////////////////////
24591 .chapter "The gsasl authenticator" "CHAPgsasl"
24592 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24593 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24594 .cindex "authentication" "GNU SASL"
24595 .cindex "authentication" "SASL"
24596 .cindex "authentication" "EXTERNAL"
24597 .cindex "authentication" "ANONYMOUS"
24598 .cindex "authentication" "PLAIN"
24599 .cindex "authentication" "LOGIN"
24600 .cindex "authentication" "DIGEST-MD5"
24601 .cindex "authentication" "CRAM-MD5"
24602 .cindex "authentication" "SCRAM-SHA-1"
24603 The &(gsasl)& authenticator provides server integration for the GNU SASL
24604 library and the mechanisms it provides.  This is new as of the 4.80 release
24605 and there are a few areas where the library does not let Exim smoothly
24606 scale to handle future authentication mechanisms, so no guarantee can be
24607 made that any particular new authentication mechanism will be supported
24608 without code changes in Exim.
24609
24610
24611 .option server_channelbinding gsasl boolean false
24612 Some authentication mechanisms are able to use external context at both ends
24613 of the session to bind the authentication to that context, and fail the
24614 authentication process if that context differs.  Specifically, some TLS
24615 ciphersuites can provide identifying information about the cryptographic
24616 context.
24617
24618 This means that certificate identity and verification becomes a non-issue,
24619 as a man-in-the-middle attack will cause the correct client and server to
24620 see different identifiers and authentication will fail.
24621
24622 This is currently only supported when using the GnuTLS library.  This is
24623 only usable by mechanisms which support "channel binding"; at time of
24624 writing, that's the SCRAM family.
24625
24626 This defaults off to ensure smooth upgrade across Exim releases, in case
24627 this option causes some clients to start failing.  Some future release
24628 of Exim may switch the default to be true.
24629
24630
24631 .option server_hostname gsasl string&!! "see below"
24632 This option selects the hostname that is used when communicating with the
24633 library. The default value is &`$primary_hostname`&.
24634 Some mechanisms will use this data.
24635
24636
24637 .option server_mech gsasl string "see below"
24638 This option selects the authentication mechanism this driver should use. The
24639 default is the value of the generic &%public_name%& option. This option allows
24640 you to use a different underlying mechanism from the advertised name. For
24641 example:
24642 .code
24643 sasl:
24644   driver = gsasl
24645   public_name = X-ANYTHING
24646   server_mech = CRAM-MD5
24647   server_set_id = $auth1
24648 .endd
24649
24650
24651 .option server_password gsasl string&!! unset
24652 Various mechanisms need access to the cleartext password on the server, so
24653 that proof-of-possession can be demonstrated on the wire, without sending
24654 the password itself.
24655
24656 The data available for lookup varies per mechanism.
24657 In all cases, &$auth1$& is set to the &'authentication id'&.
24658 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24659 if available, else the empty string.
24660 The &$auth3$& variable will always be the &'realm'& if available,
24661 else the empty string.
24662
24663 A forced failure will cause authentication to defer.
24664
24665 If using this option, it may make sense to set the &%server_condition%&
24666 option to be simply "true".
24667
24668
24669 .option server_realm gsasl string&!! unset
24670 This specifies the SASL realm that the server claims to be in.
24671 Some mechanisms will use this data.
24672
24673
24674 .option server_scram_iter gsasl string&!! unset
24675 This option provides data for the SCRAM family of mechanisms.
24676 &$auth1$& is not available at evaluation time.
24677 (This may change, as we receive feedback on use)
24678
24679
24680 .option server_scram_salt gsasl string&!! unset
24681 This option provides data for the SCRAM family of mechanisms.
24682 &$auth1$& is not available at evaluation time.
24683 (This may change, as we receive feedback on use)
24684
24685
24686 .option server_service gsasl string &`smtp`&
24687 This is the SASL service that the server claims to implement.
24688 Some mechanisms will use this data.
24689
24690
24691 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24692 .vindex "&$auth1$&, &$auth2$&, etc"
24693 These may be set when evaluating specific options, as detailed above.
24694 They will also be set when evaluating &%server_condition%&.
24695
24696 Unless otherwise stated below, the &(gsasl)& integration will use the following
24697 meanings for these variables:
24698
24699 .ilist
24700 .vindex "&$auth1$&"
24701 &$auth1$&: the &'authentication id'&
24702 .next
24703 .vindex "&$auth2$&"
24704 &$auth2$&: the &'authorization id'&
24705 .next
24706 .vindex "&$auth3$&"
24707 &$auth3$&: the &'realm'&
24708 .endlist
24709
24710 On a per-mechanism basis:
24711
24712 .ilist
24713 .cindex "authentication" "EXTERNAL"
24714 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
24715 the &%server_condition%& option must be present.
24716 .next
24717 .cindex "authentication" "ANONYMOUS"
24718 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
24719 the &%server_condition%& option must be present.
24720 .next
24721 .cindex "authentication" "GSSAPI"
24722 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
24723 &$auth2$& will be set to the &'authorization id'&,
24724 the &%server_condition%& option must be present.
24725 .endlist
24726
24727 An &'anonymous token'& is something passed along as an unauthenticated
24728 identifier; this is analogous to FTP anonymous authentication passing an
24729 email address, or software-identifier@, as the "password".
24730
24731
24732 An example showing the password having the realm specified in the callback
24733 and demonstrating a Cyrus SASL to GSASL migration approach is:
24734 .code
24735 gsasl_cyrusless_crammd5:
24736   driver = gsasl
24737   public_name = CRAM-MD5
24738   server_realm = imap.example.org
24739   server_password = ${lookup{$auth1:$auth3:userPassword}\
24740                     dbmjz{/etc/sasldb2}{$value}fail}
24741   server_set_id = ${quote:$auth1}
24742   server_condition = yes
24743 .endd
24744
24745
24746 . ////////////////////////////////////////////////////////////////////////////
24747 . ////////////////////////////////////////////////////////////////////////////
24748
24749 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
24750 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
24751 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
24752 .cindex "authentication" "GSSAPI"
24753 .cindex "authentication" "Kerberos"
24754 The &(heimdal_gssapi)& authenticator provides server integration for the
24755 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
24756 reliably.
24757
24758 .option server_hostname heimdal_gssapi string&!! "see below"
24759 This option selects the hostname that is used, with &%server_service%&,
24760 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
24761 identifier.  The default value is &`$primary_hostname`&.
24762
24763 .option server_keytab heimdal_gssapi string&!! unset
24764 If set, then Heimdal will not use the system default keytab (typically
24765 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
24766 The value should be a pathname, with no &"file:"& prefix.
24767
24768 .option server_service heimdal_gssapi string&!! "smtp"
24769 This option specifies the service identifier used, in conjunction with
24770 &%server_hostname%&, for building the identifer for finding credentials
24771 from the keytab.
24772
24773
24774 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
24775 Beware that these variables will typically include a realm, thus will appear
24776 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
24777 not verified, so a malicious client can set it to anything.
24778
24779 The &$auth1$& field should be safely trustable as a value from the Key
24780 Distribution Center.  Note that these are not quite email addresses.
24781 Each identifier is for a role, and so the left-hand-side may include a
24782 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
24783
24784 .vindex "&$auth1$&, &$auth2$&, etc"
24785 .ilist
24786 .vindex "&$auth1$&"
24787 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
24788 .next
24789 .vindex "&$auth2$&"
24790 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
24791 authentication.  If that was empty, this will also be set to the
24792 GSS Display Name.
24793 .endlist
24794
24795
24796 . ////////////////////////////////////////////////////////////////////////////
24797 . ////////////////////////////////////////////////////////////////////////////
24798
24799 .chapter "The spa authenticator" "CHAPspa"
24800 .scindex IIDspaauth1 "&(spa)& authenticator"
24801 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24802 .cindex "authentication" "Microsoft Secure Password"
24803 .cindex "authentication" "NTLM"
24804 .cindex "Microsoft Secure Password Authentication"
24805 .cindex "NTLM authentication"
24806 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24807 Password Authentication'& mechanism,
24808 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24809 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24810 taken from the Samba project (&url(http://www.samba.org)). The code for the
24811 server side was subsequently contributed by Tom Kistner. The mechanism works as
24812 follows:
24813
24814 .ilist
24815 After the AUTH command has been accepted, the client sends an SPA
24816 authentication request based on the user name and optional domain.
24817 .next
24818 The server sends back a challenge.
24819 .next
24820 The client builds a challenge response which makes use of the user's password
24821 and sends it to the server, which then accepts or rejects it.
24822 .endlist
24823
24824 Encryption is used to protect the password in transit.
24825
24826
24827
24828 .section "Using spa as a server" "SECID179"
24829 .cindex "options" "&(spa)& authenticator (server)"
24830 The &(spa)& authenticator has just one server option:
24831
24832 .option server_password spa string&!! unset
24833 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24834 This option is expanded, and the result must be the cleartext password for the
24835 authenticating user, whose name is at this point in &$auth1$&. For
24836 compatibility with previous releases of Exim, the user name is also placed in
24837 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24838 it can lead to confusion in string expansions that also use numeric variables
24839 for other things. For example:
24840 .code
24841 spa:
24842   driver = spa
24843   public_name = NTLM
24844   server_password = \
24845     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24846 .endd
24847 If the expansion is forced to fail, authentication fails. Any other expansion
24848 failure causes a temporary error code to be returned.
24849
24850
24851
24852
24853
24854 .section "Using spa as a client" "SECID180"
24855 .cindex "options" "&(spa)& authenticator (client)"
24856 The &(spa)& authenticator has the following client options:
24857
24858
24859
24860 .option client_domain spa string&!! unset
24861 This option specifies an optional domain for the authentication.
24862
24863
24864 .option client_password spa string&!! unset
24865 This option specifies the user's password, and must be set.
24866
24867
24868 .option client_username spa string&!! unset
24869 This option specifies the user name, and must be set. Here is an example of a
24870 configuration of this authenticator for use with the mail servers at
24871 &'msn.com'&:
24872 .code
24873 msn:
24874   driver = spa
24875   public_name = MSN
24876   client_username = msn/msn_username
24877   client_password = msn_plaintext_password
24878   client_domain = DOMAIN_OR_UNSET
24879 .endd
24880 .ecindex IIDspaauth1
24881 .ecindex IIDspaauth2
24882
24883
24884
24885
24886
24887 . ////////////////////////////////////////////////////////////////////////////
24888 . ////////////////////////////////////////////////////////////////////////////
24889
24890 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24891          "Encrypted SMTP connections"
24892 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24893 .scindex IIDencsmtp2 "SMTP" "encryption"
24894 .cindex "TLS" "on SMTP connection"
24895 .cindex "OpenSSL"
24896 .cindex "GnuTLS"
24897 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24898 Sockets Layer), is implemented by making use of the OpenSSL library or the
24899 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24900 cryptographic code in the Exim distribution itself for implementing TLS. In
24901 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24902 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24903 You also need to understand the basic concepts of encryption at a managerial
24904 level, and in particular, the way that public keys, private keys, and
24905 certificates are used.
24906
24907 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24908 connection is established, the client issues a STARTTLS command. If the
24909 server accepts this, the client and the server negotiate an encryption
24910 mechanism. If the negotiation succeeds, the data that subsequently passes
24911 between them is encrypted.
24912
24913 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24914 and if so, what cipher suite is in use, whether the client supplied a
24915 certificate, and whether or not that certificate was verified. This makes it
24916 possible for an Exim server to deny or accept certain commands based on the
24917 encryption state.
24918
24919 &*Warning*&: Certain types of firewall and certain anti-virus products can
24920 disrupt TLS connections. You need to turn off SMTP scanning for these products
24921 in order to get TLS to work.
24922
24923
24924
24925 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24926          "SECID284"
24927 .cindex "ssmtp protocol"
24928 .cindex "smtps protocol"
24929 .cindex "SMTP" "ssmtp protocol"
24930 .cindex "SMTP" "smtps protocol"
24931 Early implementations of encrypted SMTP used a different TCP port from normal
24932 SMTP, and expected an encryption negotiation to start immediately, instead of
24933 waiting for a STARTTLS command from the client using the standard SMTP
24934 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24935 allocated for this purpose.
24936
24937 This approach was abandoned when encrypted SMTP was standardized, but there are
24938 still some legacy clients that use it. Exim supports these clients by means of
24939 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24940 numbers; the most common use is expected to be:
24941 .code
24942 tls_on_connect_ports = 465
24943 .endd
24944 The port numbers specified by this option apply to all SMTP connections, both
24945 via the daemon and via &'inetd'&. You still need to specify all the ports that
24946 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24947 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24948 an extra port &-- rather, it specifies different behaviour on a port that is
24949 defined elsewhere.
24950
24951 There is also a &%-tls-on-connect%& command line option. This overrides
24952 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24953
24954
24955
24956
24957
24958
24959 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24960 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24961 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24962 followed later, when the first versions of GnuTLS were released. To build Exim
24963 to use GnuTLS, you need to set
24964 .code
24965 USE_GNUTLS=yes
24966 .endd
24967 in Local/Makefile, in addition to
24968 .code
24969 SUPPORT_TLS=yes
24970 .endd
24971 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24972 include files and libraries for GnuTLS can be found.
24973
24974 There are some differences in usage when using GnuTLS instead of OpenSSL:
24975
24976 .ilist
24977 The &%tls_verify_certificates%& option must contain the name of a file, not the
24978 name of a directory (for OpenSSL it can be either).
24979 .next
24980 The default value for &%tls_dhparam%& differs for historical reasons.
24981 .next
24982 .vindex "&$tls_peerdn$&"
24983 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24984 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24985 affects the value of the &$tls_peerdn$& variable.
24986 .next
24987 OpenSSL identifies cipher suites using hyphens as separators, for example:
24988 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
24989 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
24990 in a cipher list. To make life simpler, Exim changes underscores to hyphens
24991 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
24992 to handle its own older variants) when processing lists of cipher suites in the
24993 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24994 option).
24995 .next
24996 The &%tls_require_ciphers%& options operate differently, as described in the
24997 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24998 .next
24999 Some other recently added features may only be available in one or the other.
25000 This should be documented with the feature.  If the documentation does not
25001 explicitly state that the feature is infeasible in the other TLS
25002 implementation, then patches are welcome.
25003 .endlist
25004
25005
25006 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25007 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25008 an explicit path; if the latter, then the text about generation still applies,
25009 but not the chosen filename.
25010 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25011 See the documentation of &%tls_dhparam%& for more information.
25012
25013 GnuTLS uses D-H parameters that may take a substantial amount of time
25014 to compute. It is unreasonable to re-compute them for every TLS session.
25015 Therefore, Exim keeps this data in a file in its spool directory, called
25016 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25017 of bits requested.
25018 The file is owned by the Exim user and is readable only by
25019 its owner. Every Exim process that start up GnuTLS reads the D-H
25020 parameters from this file. If the file does not exist, the first Exim process
25021 that needs it computes the data and writes it to a temporary file which is
25022 renamed once it is complete. It does not matter if several Exim processes do
25023 this simultaneously (apart from wasting a few resources). Once a file is in
25024 place, new Exim processes immediately start using it.
25025
25026 For maximum security, the parameters that are stored in this file should be
25027 recalculated periodically, the frequency depending on your paranoia level.
25028 If you are avoiding using the fixed D-H primes published in RFCs, then you
25029 are concerned about some advanced attacks and will wish to do this; if you do
25030 not regenerate then you might as well stick to the standard primes.
25031
25032 Arranging this is easy in principle; just delete the file when you want new
25033 values to be computed. However, there may be a problem. The calculation of new
25034 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25035 If the system is not very active, &_/dev/random_& may delay returning data
25036 until enough randomness (entropy) is available. This may cause Exim to hang for
25037 a substantial amount of time, causing timeouts on incoming connections.
25038
25039 The solution is to generate the parameters externally to Exim. They are stored
25040 in &_gnutls-params-N_& in PEM format, which means that they can be
25041 generated externally using the &(certtool)& command that is part of GnuTLS.
25042
25043 To replace the parameters with new ones, instead of deleting the file
25044 and letting Exim re-create it, you can generate new parameters using
25045 &(certtool)& and, when this has been done, replace Exim's cache file by
25046 renaming. The relevant commands are something like this:
25047 .code
25048 # ls
25049 [ look for file; assume gnutls-params-2236 is the most recent ]
25050 # rm -f new-params
25051 # touch new-params
25052 # chown exim:exim new-params
25053 # chmod 0600 new-params
25054 # certtool --generate-dh-params --bits 2236 >>new-params
25055 # openssl dhparam -noout -text -in new-params | head
25056 [ check the first line, make sure it's not more than 2236;
25057   if it is, then go back to the start ("rm") and repeat
25058   until the size generated is at most the size requested ]
25059 # chmod 0400 new-params
25060 # mv new-params gnutls-params-2236
25061 .endd
25062 If Exim never has to generate the parameters itself, the possibility of
25063 stalling is removed.
25064
25065 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25066 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25067 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25068 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25069 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25070 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25071 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25072 which applies to all D-H usage, client or server.  If the value returned by
25073 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25074 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25075 limit, which is still much higher than Exim historically used.
25076
25077 The filename and bits used will change as the GnuTLS maintainers change the
25078 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25079 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25080 2432 bits, while NSS is limited to 2236 bits.
25081
25082 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25083 increase the chance of the generated prime actually being within acceptable
25084 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25085 procedure above.  There is no sane procedure available to Exim to double-check
25086 the size of the generated prime, so it might still be too large.
25087
25088
25089 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25090 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25091 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25092 There is a function in the OpenSSL library that can be passed a list of cipher
25093 suites before the cipher negotiation takes place. This specifies which ciphers
25094 are acceptable. The list is colon separated and may contain names like
25095 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25096 directly to this function call.
25097 Many systems will install the OpenSSL manual-pages, so you may have
25098 &'ciphers(1)'& available to you.
25099 The following quotation from the OpenSSL
25100 documentation specifies what forms of item are allowed in the cipher string:
25101
25102 .ilist
25103 It can consist of a single cipher suite such as RC4-SHA.
25104 .next
25105 It can represent a list of cipher suites containing a certain algorithm,
25106 or cipher suites of a certain type. For example SHA1 represents all
25107 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25108 SSL v3 algorithms.
25109 .next
25110 Lists of cipher suites can be combined in a single cipher string using
25111 the + character. This is used as a logical and operation. For example
25112 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25113 algorithms.
25114 .endlist
25115
25116 Each cipher string can be optionally preceded by one of the characters &`!`&,
25117 &`-`& or &`+`&.
25118 .ilist
25119 If &`!`& is used, the ciphers are permanently deleted from the list. The
25120 ciphers deleted can never reappear in the list even if they are explicitly
25121 stated.
25122 .next
25123 If &`-`& is used, the ciphers are deleted from the list, but some or all
25124 of the ciphers can be added again by later options.
25125 .next
25126 If &`+`& is used, the ciphers are moved to the end of the list. This
25127 option does not add any new ciphers; it just moves matching existing ones.
25128 .endlist
25129
25130 If none of these characters is present, the string is interpreted as
25131 a list of ciphers to be appended to the current preference list. If the list
25132 includes any ciphers already present they will be ignored: that is, they will
25133 not be moved to the end of the list.
25134 .endlist
25135
25136 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25137 string:
25138 .code
25139 # note single-quotes to get ! past any shell history expansion
25140 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25141 .endd
25142
25143 This example will let the library defaults be permitted on the MX port, where
25144 there's probably no identity verification anyway, but ups the ante on the
25145 submission ports where the administrator might have some influence on the
25146 choice of clients used:
25147 .code
25148 # OpenSSL variant; see man ciphers(1)
25149 tls_require_ciphers = ${if =={$received_port}{25}\
25150                            {DEFAULT}\
25151                            {HIGH:!MD5:!SHA1}}
25152 .endd
25153
25154
25155
25156 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25157          "SECTreqciphgnu"
25158 .cindex "GnuTLS" "specifying parameters for"
25159 .cindex "TLS" "specifying ciphers (GnuTLS)"
25160 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25161 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25162 .cindex "TLS" "specifying protocols (GnuTLS)"
25163 .cindex "TLS" "specifying priority string (GnuTLS)"
25164 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25165 The GnuTLS library allows the caller to provide a "priority string", documented
25166 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25167 ciphersuite specification in OpenSSL.
25168
25169 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25170
25171 The &%tls_require_ciphers%& option is available both as an global option,
25172 controlling how Exim behaves as a server, and also as an option of the
25173 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25174 the value is string expanded.  The resulting string is not an Exim list and
25175 the string is given to the GnuTLS library, so that Exim does not need to be
25176 aware of future feature enhancements of GnuTLS.
25177
25178 Documentation of the strings accepted may be found in the GnuTLS manual, under
25179 "Priority strings".  This is online as
25180 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html),
25181 but beware that this relates to GnuTLS 3, which may be newer than the version
25182 installed on your system.  If you are using GnuTLS 3,
25183 &url(http://www.gnu.org/software/gnutls/manual/html_node/Listing-the-ciphersuites-in-a-priority-string.html, then the example code)
25184 on that site can be used to test a given string.
25185
25186 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25187 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25188 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25189
25190 This example will let the library defaults be permitted on the MX port, where
25191 there's probably no identity verification anyway, and lowers security further
25192 by increasing compatibility; but this ups the ante on the submission ports
25193 where the administrator might have some influence on the choice of clients
25194 used:
25195 .code
25196 # GnuTLS variant
25197 tls_require_ciphers = ${if =={$received_port}{25}\
25198                            {NORMAL:%COMPAT}\
25199                            {SECURE128}}
25200 .endd
25201
25202
25203 .section "Configuring an Exim server to use TLS" "SECID182"
25204 .cindex "TLS" "configuring an Exim server"
25205 When Exim has been built with TLS support, it advertises the availability of
25206 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25207 but not to any others. The default value of this option is unset, which means
25208 that STARTTLS is not advertised at all. This default is chosen because you
25209 need to set some other options in order to make TLS available, and also it is
25210 sensible for systems that want to use TLS only as a client.
25211
25212 If a client issues a STARTTLS command and there is some configuration
25213 problem in the server, the command is rejected with a 454 error. If the client
25214 persists in trying to issue SMTP commands, all except QUIT are rejected
25215 with the error
25216 .code
25217 554 Security failure
25218 .endd
25219 If a STARTTLS command is issued within an existing TLS session, it is
25220 rejected with a 554 error code.
25221
25222 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25223 match some hosts. You can, of course, set it to * to match all hosts.
25224 However, this is not all you need to do. TLS sessions to a server won't work
25225 without some further configuration at the server end.
25226
25227 It is rumoured that all existing clients that support TLS/SSL use RSA
25228 encryption. To make this work you need to set, in the server,
25229 .code
25230 tls_certificate = /some/file/name
25231 tls_privatekey = /some/file/name
25232 .endd
25233 These options are, in fact, expanded strings, so you can make them depend on
25234 the identity of the client that is connected if you wish. The first file
25235 contains the server's X509 certificate, and the second contains the private key
25236 that goes with it. These files need to be readable by the Exim user, and must
25237 always be given as full path names. They can be the same file if both the
25238 certificate and the key are contained within it. If &%tls_privatekey%& is not
25239 set, or if its expansion is forced to fail or results in an empty string, this
25240 is assumed to be the case. The certificate file may also contain intermediate
25241 certificates that need to be sent to the client to enable it to authenticate
25242 the server's certificate.
25243
25244 If you do not understand about certificates and keys, please try to find a
25245 source of this background information, which is not Exim-specific. (There are a
25246 few comments below in section &<<SECTcerandall>>&.)
25247
25248 &*Note*&: These options do not apply when Exim is operating as a client &--
25249 they apply only in the case of a server. If you need to use a certificate in an
25250 Exim client, you must set the options of the same names in an &(smtp)&
25251 transport.
25252
25253 With just these options, an Exim server will be able to use TLS. It does not
25254 require the client to have a certificate (but see below for how to insist on
25255 this). There is one other option that may be needed in other situations. If
25256 .code
25257 tls_dhparam = /some/file/name
25258 .endd
25259 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25260 with the parameters contained in the file.
25261 Set this to &`none`& to disable use of DH entirely, by making no prime
25262 available:
25263 .code
25264 tls_dhparam = none
25265 .endd
25266 This may also be set to a string identifying a standard prime to be used for
25267 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25268 used is &`ike23`&.  There are a few standard primes available, see the
25269 documetnation for &%tls_dhparam%& for the complete list.
25270
25271 See the command
25272 .code
25273 openssl dhparam
25274 .endd
25275 for a way of generating file data.
25276
25277 The strings supplied for these three options are expanded every time a client
25278 host connects. It is therefore possible to use different certificates and keys
25279 for different hosts, if you so wish, by making use of the client's IP address
25280 in &$sender_host_address$& to control the expansion. If a string expansion is
25281 forced to fail, Exim behaves as if the option is not set.
25282
25283 .cindex "cipher" "logging"
25284 .cindex "log" "TLS cipher"
25285 .vindex "&$tls_cipher$&"
25286 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
25287 an incoming TLS connection. It is included in the &'Received:'& header of an
25288 incoming message (by default &-- you can, of course, change this), and it is
25289 also included in the log line that records a message's arrival, keyed by
25290 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25291 condition can be used to test for specific cipher suites in ACLs.
25292 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
25293 &<<SECID185>>&.)
25294
25295 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25296 can check the name of the cipher suite and vary their actions accordingly. The
25297 cipher suite names vary, depending on which TLS library is being used. For
25298 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25299 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25300 documentation for more details.
25301
25302
25303 .section "Requesting and verifying client certificates" "SECID183"
25304 .cindex "certificate" "verification of client"
25305 .cindex "TLS" "client certificate verification"
25306 If you want an Exim server to request a certificate when negotiating a TLS
25307 session with a client, you must set either &%tls_verify_hosts%& or
25308 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25309 apply to all TLS connections. For any host that matches one of these options,
25310 Exim requests a certificate as part of the setup of the TLS session. The
25311 contents of the certificate are verified by comparing it with a list of
25312 expected certificates. These must be available in a file or,
25313 for OpenSSL only (not GnuTLS), a directory, identified by
25314 &%tls_verify_certificates%&.
25315
25316 A file can contain multiple certificates, concatenated end to end. If a
25317 directory is used
25318 (OpenSSL only),
25319 each certificate must be in a separate file, with a name (or a symbolic link)
25320 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25321 certificate. You can compute the relevant hash by running the command
25322 .code
25323 openssl x509 -hash -noout -in /cert/file
25324 .endd
25325 where &_/cert/file_& contains a single certificate.
25326
25327 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25328 what happens if the client does not supply a certificate, or if the certificate
25329 does not match any of the certificates in the collection named by
25330 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25331 attempt to set up a TLS session is aborted, and the incoming connection is
25332 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25333 session continues. ACLs that run for subsequent SMTP commands can detect the
25334 fact that no certificate was verified, and vary their actions accordingly. For
25335 example, you can insist on a certificate before accepting a message for
25336 relaying, but not when the message is destined for local delivery.
25337
25338 .vindex "&$tls_peerdn$&"
25339 When a client supplies a certificate (whether it verifies or not), the value of
25340 the Distinguished Name of the certificate is made available in the variable
25341 &$tls_peerdn$& during subsequent processing of the message.
25342
25343 .cindex "log" "distinguished name"
25344 Because it is often a long text string, it is not included in the log line or
25345 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25346 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25347 &%received_header_text%& to change the &'Received:'& header. When no
25348 certificate is supplied, &$tls_peerdn$& is empty.
25349
25350
25351 .section "Revoked certificates" "SECID184"
25352 .cindex "TLS" "revoked certificates"
25353 .cindex "revocation list"
25354 .cindex "certificate" "revocation list"
25355 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25356 certificates are revoked. If you have such a list, you can pass it to an Exim
25357 server using the global option called &%tls_crl%& and to an Exim client using
25358 an identically named option for the &(smtp)& transport. In each case, the value
25359 of the option is expanded and must then be the name of a file that contains a
25360 CRL in PEM format.
25361
25362
25363 .section "Configuring an Exim client to use TLS" "SECID185"
25364 .cindex "cipher" "logging"
25365 .cindex "log" "TLS cipher"
25366 .cindex "log" "distinguished name"
25367 .cindex "TLS" "configuring an Exim client"
25368 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25369 deliveries as well as to incoming, the latter one causing logging of the
25370 server certificate's DN. The remaining client configuration for TLS is all
25371 within the &(smtp)& transport.
25372
25373 It is not necessary to set any options to have TLS work in the &(smtp)&
25374 transport. If Exim is built with TLS support, and TLS is advertised by a
25375 server, the &(smtp)& transport always tries to start a TLS session. However,
25376 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25377 transport) to a list of server hosts for which TLS should not be used.
25378
25379 If you do not want Exim to attempt to send messages unencrypted when an attempt
25380 to set up an encrypted connection fails in any way, you can set
25381 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25382 those hosts, delivery is always deferred if an encrypted connection cannot be
25383 set up. If there are any other hosts for the address, they are tried in the
25384 usual way.
25385
25386 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25387 the message unencrypted. It always does this if the response to STARTTLS is
25388 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25389 session after a success response code, what happens is controlled by the
25390 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25391 delivery to this host is deferred, and other hosts (if available) are tried. If
25392 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25393 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25394 negotiation fails, Exim closes the current connection (because it is in an
25395 unknown state), opens a new one to the same host, and then tries the delivery
25396 unencrypted.
25397
25398 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25399 transport provide the client with a certificate, which is passed to the server
25400 if it requests it. If the server is Exim, it will request a certificate only if
25401 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25402
25403 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25404 must name a file or,
25405 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25406 expected server certificates. The client verifies the server's certificate
25407 against this collection, taking into account any revoked certificates that are
25408 in the list defined by &%tls_crl%&.
25409
25410 If
25411 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25412 list of permitted cipher suites. If either of these checks fails, delivery to
25413 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25414 alternative hosts, if any.
25415
25416  &*Note*&:
25417 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25418 is operating as a client. Exim does not assume that a server certificate (set
25419 by the global options of the same name) should also be used when operating as a
25420 client.
25421
25422 .vindex "&$host$&"
25423 .vindex "&$host_address$&"
25424 All the TLS options in the &(smtp)& transport are expanded before use, with
25425 &$host$& and &$host_address$& containing the name and address of the server to
25426 which the client is connected. Forced failure of an expansion causes Exim to
25427 behave as if the relevant option were unset.
25428
25429 .vindex &$tls_bits$&
25430 .vindex &$tls_cipher$&
25431 .vindex &$tls_peerdn$&
25432 .vindex &$tls_sni$&
25433 Before an SMTP connection is established, the
25434 &$tls_bits$&, &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25435 variables are emptied. (Until the first connection, they contain the values
25436 that were set when the message was received.) If STARTTLS is subsequently
25437 successfully obeyed, these variables are set to the relevant values for the
25438 outgoing connection.
25439
25440
25441
25442 .section "Use of TLS Server Name Indication" "SECTtlssni"
25443 .cindex "TLS" "Server Name Indication"
25444 .vindex "&$tls_sni$&"
25445 .oindex "&%tls_sni%&"
25446 With TLS1.0 or above, there is an extension mechanism by which extra
25447 information can be included at various points in the protocol.  One of these
25448 extensions, documented in RFC 6066 (and before that RFC 4366) is
25449 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25450 client in the initial handshake, so that the server can examine the servername
25451 within and possibly choose to use different certificates and keys (and more)
25452 for this session.
25453
25454 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25455 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25456 address.
25457
25458 With SMTP to MX, there are the same problems here as in choosing the identity
25459 against which to validate a certificate: you can't rely on insecure DNS to
25460 provide the identity which you then cryptographically verify.  So this will
25461 be of limited use in that environment.
25462
25463 With SMTP to Submission, there is a well-defined hostname which clients are
25464 connecting to and can validate certificates against.  Thus clients &*can*&
25465 choose to include this information in the TLS negotiation.  If this becomes
25466 wide-spread, then hosters can choose to present different certificates to
25467 different clients.  Or even negotiate different cipher suites.
25468
25469 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25470 if not empty, will be sent on a TLS session as part of the handshake.  There's
25471 nothing more to it.  Choosing a sensible value not derived insecurely is the
25472 only point of caution.  The &$tls_sni$& variable will be set to this string
25473 for the lifetime of the client connection (including during authentication).
25474
25475 Except during SMTP client sessions, if &$tls_sni$& is set then it is a string
25476 received from a client.
25477 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25478
25479 If the string &`tls_sni`& appears in the main section's &%tls_certificate%&
25480 option (prior to expansion) then the following options will be re-expanded
25481 during TLS session handshake, to permit alternative values to be chosen:
25482
25483 .ilist
25484 .vindex "&%tls_certificate%&"
25485 &%tls_certificate%&
25486 .next
25487 .vindex "&%tls_crl%&"
25488 &%tls_crl%&
25489 .next
25490 .vindex "&%tls_privatekey%&"
25491 &%tls_privatekey%&
25492 .next
25493 .vindex "&%tls_verify_certificates%&"
25494 &%tls_verify_certificates%&
25495 .endlist
25496
25497 Great care should be taken to deal with matters of case, various injection
25498 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25499 can always be referenced; it is important to remember that &$tls_sni$& is
25500 arbitrary unverified data provided prior to authentication.
25501
25502 The Exim developers are proceeding cautiously and so far no other TLS options
25503 are re-expanded.
25504
25505 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25506 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25507 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25508 see &`-servername`& in the output, then OpenSSL has support.
25509
25510 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25511 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25512 built, then you have SNI support).
25513
25514
25515
25516 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25517          "SECTmulmessam"
25518 .cindex "multiple SMTP deliveries with TLS"
25519 .cindex "TLS" "multiple message deliveries"
25520 Exim sends multiple messages down the same TCP/IP connection by starting up
25521 an entirely new delivery process for each message, passing the socket from
25522 one process to the next. This implementation does not fit well with the use
25523 of TLS, because there is quite a lot of state information associated with a TLS
25524 connection, not just a socket identification. Passing all the state information
25525 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25526 session before passing the socket to a new process. The new process may then
25527 try to start a new TLS session, and if successful, may try to re-authenticate
25528 if AUTH is in use, before sending the next message.
25529
25530 The RFC is not clear as to whether or not an SMTP session continues in clear
25531 after TLS has been shut down, or whether TLS may be restarted again later, as
25532 just described. However, if the server is Exim, this shutdown and
25533 reinitialization works. It is not known which (if any) other servers operate
25534 successfully if the client closes a TLS session and continues with unencrypted
25535 SMTP, but there are certainly some that do not work. For such servers, Exim
25536 should not pass the socket to another process, because the failure of the
25537 subsequent attempt to use it would cause Exim to record a temporary host error,
25538 and delay other deliveries to that host.
25539
25540 To test for this case, Exim sends an EHLO command to the server after
25541 closing down the TLS session. If this fails in any way, the connection is
25542 closed instead of being passed to a new delivery process, but no retry
25543 information is recorded.
25544
25545 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25546 &(smtp)& transport to match those hosts for which Exim should not pass
25547 connections to new processes if TLS has been used.
25548
25549
25550
25551
25552 .section "Certificates and all that" "SECTcerandall"
25553 .cindex "certificate" "references to discussion"
25554 In order to understand fully how TLS works, you need to know about
25555 certificates, certificate signing, and certificate authorities. This is not the
25556 place to give a tutorial, especially as I do not know very much about it
25557 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25558 to Apache, currently at
25559 .display
25560 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25561 .endd
25562 Other parts of the &'modssl'& documentation are also helpful, and have
25563 links to further files.
25564 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25565 0-201-61598-3), contains both introductory and more in-depth descriptions.
25566 Some sample programs taken from the book are available from
25567 .display
25568 &url(http://www.rtfm.com/openssl-examples/)
25569 .endd
25570
25571
25572 .section "Certificate chains" "SECID186"
25573 The file named by &%tls_certificate%& may contain more than one
25574 certificate. This is useful in the case where the certificate that is being
25575 sent is validated by an intermediate certificate which the other end does
25576 not have. Multiple certificates must be in the correct order in the file.
25577 First the host's certificate itself, then the first intermediate
25578 certificate to validate the issuer of the host certificate, then the next
25579 intermediate certificate to validate the issuer of the first intermediate
25580 certificate, and so on, until finally (optionally) the root certificate.
25581 The root certificate must already be trusted by the recipient for
25582 validation to succeed, of course, but if it's not preinstalled, sending the
25583 root certificate along with the rest makes it available for the user to
25584 install if the receiving end is a client MUA that can interact with a user.
25585
25586
25587 .section "Self-signed certificates" "SECID187"
25588 .cindex "certificate" "self-signed"
25589 You can create a self-signed certificate using the &'req'& command provided
25590 with OpenSSL, like this:
25591 .code
25592 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25593             -days 9999 -nodes
25594 .endd
25595 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25596 delimited and so can be identified independently. The &%-days%& option
25597 specifies a period for which the certificate is valid. The &%-nodes%& option is
25598 important: if you do not set it, the key is encrypted with a passphrase
25599 that you are prompted for, and any use that is made of the key causes more
25600 prompting for the passphrase. This is not helpful if you are going to use
25601 this certificate and key in an MTA, where prompting is not possible.
25602
25603 A self-signed certificate made in this way is sufficient for testing, and
25604 may be adequate for all your requirements if you are mainly interested in
25605 encrypting transfers, and not in secure identification.
25606
25607 However, many clients require that the certificate presented by the server be a
25608 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25609 certificate. In this situation, the self-signed certificate described above
25610 must be installed on the client host as a trusted root &'certification
25611 authority'& (CA), and the certificate used by Exim must be a user certificate
25612 signed with that self-signed certificate.
25613
25614 For information on creating self-signed CA certificates and using them to sign
25615 user certificates, see the &'General implementation overview'& chapter of the
25616 Open-source PKI book, available online at
25617 &url(http://ospkibook.sourceforge.net/).
25618 .ecindex IIDencsmtp1
25619 .ecindex IIDencsmtp2
25620
25621
25622
25623 . ////////////////////////////////////////////////////////////////////////////
25624 . ////////////////////////////////////////////////////////////////////////////
25625
25626 .chapter "Access control lists" "CHAPACL"
25627 .scindex IIDacl "&ACL;" "description"
25628 .cindex "control of incoming mail"
25629 .cindex "message" "controlling incoming"
25630 .cindex "policy control" "access control lists"
25631 Access Control Lists (ACLs) are defined in a separate section of the run time
25632 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25633 name, terminated by a colon. Here is a complete ACL section that contains just
25634 one very small ACL:
25635 .code
25636 begin acl
25637 small_acl:
25638   accept   hosts = one.host.only
25639 .endd
25640 You can have as many lists as you like in the ACL section, and the order in
25641 which they appear does not matter. The lists are self-terminating.
25642
25643 The majority of ACLs are used to control Exim's behaviour when it receives
25644 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25645 when a local process submits a message using SMTP by specifying the &%-bs%&
25646 option. The most common use is for controlling which recipients are accepted
25647 in incoming messages. In addition, you can define an ACL that is used to check
25648 local non-SMTP messages. The default configuration file contains an example of
25649 a realistic ACL for checking RCPT commands. This is discussed in chapter
25650 &<<CHAPdefconfil>>&.
25651
25652
25653 .section "Testing ACLs" "SECID188"
25654 The &%-bh%& command line option provides a way of testing your ACL
25655 configuration locally by running a fake SMTP session with which you interact.
25656 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25657 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25658
25659
25660
25661 .section "Specifying when ACLs are used" "SECID189"
25662 .cindex "&ACL;" "options for specifying"
25663 In order to cause an ACL to be used, you have to name it in one of the relevant
25664 options in the main part of the configuration. These options are:
25665 .cindex "AUTH" "ACL for"
25666 .cindex "DATA" "ACLs for"
25667 .cindex "ETRN" "ACL for"
25668 .cindex "EXPN" "ACL for"
25669 .cindex "HELO" "ACL for"
25670 .cindex "EHLO" "ACL for"
25671 .cindex "MAIL" "ACL for"
25672 .cindex "QUIT, ACL for"
25673 .cindex "RCPT" "ACL for"
25674 .cindex "STARTTLS, ACL for"
25675 .cindex "VRFY" "ACL for"
25676 .cindex "SMTP" "connection, ACL for"
25677 .cindex "non-SMTP messages" "ACLs for"
25678 .cindex "MIME content scanning" "ACL for"
25679
25680 .table2 140pt
25681 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25682 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25683 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25684 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25685 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25686 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25687 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25688 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25689 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25690 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25691 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25692 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25693 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25694 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25695 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25696 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25697 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25698 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25699 .endtable
25700
25701 For example, if you set
25702 .code
25703 acl_smtp_rcpt = small_acl
25704 .endd
25705 the little ACL defined above is used whenever Exim receives a RCPT command
25706 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25707 done when RCPT commands arrive. A rejection of RCPT should cause the
25708 sending MTA to give up on the recipient address contained in the RCPT
25709 command, whereas rejection at other times may cause the client MTA to keep on
25710 trying to deliver the message. It is therefore recommended that you do as much
25711 testing as possible at RCPT time.
25712
25713
25714 .section "The non-SMTP ACLs" "SECID190"
25715 .cindex "non-SMTP messages" "ACLs for"
25716 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25717 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25718 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25719 the state of the SMTP connection such as encryption and authentication) are not
25720 relevant and are forbidden in these ACLs. However, the sender and recipients
25721 are known, so the &%senders%& and &%sender_domains%& conditions and the
25722 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25723 &$authenticated_sender$& are also available. You can specify added header lines
25724 in any of these ACLs.
25725
25726 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25727 non-SMTP message, before any of the message has been read. (This is the
25728 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25729 batched SMTP input, it runs after the DATA command has been reached. The
25730 result of this ACL is ignored; it cannot be used to reject a message. If you
25731 really need to, you could set a value in an ACL variable here and reject based
25732 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25733 controls, and in particular, it can be used to set
25734 .code
25735 control = suppress_local_fixups
25736 .endd
25737 This cannot be used in the other non-SMTP ACLs because by the time they are
25738 run, it is too late.
25739
25740 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25741 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25742
25743 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25744 kind of rejection is treated as permanent, because there is no way of sending a
25745 temporary error for these kinds of message.
25746
25747
25748 .section "The SMTP connect ACL" "SECID191"
25749 .cindex "SMTP" "connection, ACL for"
25750 .oindex &%smtp_banner%&
25751 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25752 session, after the test specified by &%host_reject_connection%& (which is now
25753 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25754 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25755 the message override the banner message that is otherwise specified by the
25756 &%smtp_banner%& option.
25757
25758
25759 .section "The EHLO/HELO ACL" "SECID192"
25760 .cindex "EHLO" "ACL for"
25761 .cindex "HELO" "ACL for"
25762 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25763 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25764 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25765 Note that a client may issue more than one EHLO or HELO command in an SMTP
25766 session, and indeed is required to issue a new EHLO or HELO after successfully
25767 setting up encryption following a STARTTLS command.
25768
25769 If the command is accepted by an &%accept%& verb that has a &%message%&
25770 modifier, the message may not contain more than one line (it will be truncated
25771 at the first newline and a panic logged if it does). Such a message cannot
25772 affect the EHLO options that are listed on the second and subsequent lines of
25773 an EHLO response.
25774
25775
25776 .section "The DATA ACLs" "SECID193"
25777 .cindex "DATA" "ACLs for"
25778 Two ACLs are associated with the DATA command, because it is two-stage
25779 command, with two responses being sent to the client.
25780 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25781 is obeyed. This gives you control after all the RCPT commands, but before
25782 the message itself is received. It offers the opportunity to give a negative
25783 response to the DATA command before the data is transmitted. Header lines
25784 added by MAIL or RCPT ACLs are not visible at this time, but any that
25785 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25786
25787 You cannot test the contents of the message, for example, to verify addresses
25788 in the headers, at RCPT time or when the DATA command is received. Such
25789 tests have to appear in the ACL that is run after the message itself has been
25790 received, before the final response to the DATA command is sent. This is
25791 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25792 associated with the DATA command.
25793
25794 For both of these ACLs, it is not possible to reject individual recipients. An
25795 error response rejects the entire message. Unfortunately, it is known that some
25796 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25797 before or after the data) correctly &-- they keep the message on their queues
25798 and try again later, but that is their problem, though it does waste some of
25799 your resources.
25800
25801
25802 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25803 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25804 enabled (which is the default).
25805
25806 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25807 received, and is executed for each DKIM signature found in a message.  If not
25808 otherwise specified, the default action is to accept.
25809
25810 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25811
25812
25813 .section "The SMTP MIME ACL" "SECID194"
25814 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25815 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25816
25817
25818 .section "The QUIT ACL" "SECTQUITACL"
25819 .cindex "QUIT, ACL for"
25820 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25821 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25822 does not in fact control any access. For this reason, the only verbs that are
25823 permitted are &%accept%& and &%warn%&.
25824
25825 This ACL can be used for tasks such as custom logging at the end of an SMTP
25826 session. For example, you can use ACL variables in other ACLs to count
25827 messages, recipients, etc., and log the totals at QUIT time using one or
25828 more &%logwrite%& modifiers on a &%warn%& verb.
25829
25830 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25831 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25832
25833 You do not need to have a final &%accept%&, but if you do, you can use a
25834 &%message%& modifier to specify custom text that is sent as part of the 221
25835 response to QUIT.
25836
25837 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25838 failure (for example, failure to open a log file, or when Exim is bombing out
25839 because it has detected an unrecoverable error), all SMTP commands from the
25840 client are given temporary error responses until QUIT is received or the
25841 connection is closed. In these special cases, the QUIT ACL does not run.
25842
25843
25844 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25845 .vindex &$acl_smtp_notquit$&
25846 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25847 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25848 trouble, such as being unable to write to its log files, this ACL is not run,
25849 because it might try to do things (such as write to log files) that make the
25850 situation even worse.
25851
25852 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25853 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25854 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25855 and &%warn%&.
25856
25857 .vindex &$smtp_notquit_reason$&
25858 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25859 to a string that indicates the reason for the termination of the SMTP
25860 connection. The possible values are:
25861 .table2
25862 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25863 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25864 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25865 .irow &`connection-lost`&          "The SMTP connection has been lost"
25866 .irow &`data-timeout`&             "Timeout while reading message data"
25867 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25868 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25869 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25870 .irow &`synchronization-error`&    "SMTP synchronization error"
25871 .irow &`tls-failed`&               "TLS failed to start"
25872 .endtable
25873 In most cases when an SMTP connection is closed without having received QUIT,
25874 Exim sends an SMTP response message before actually closing the connection.
25875 With the exception of the &`acl-drop`& case, the default message can be
25876 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25877 &%drop%& verb in another ACL, it is the message from the other ACL that is
25878 used.
25879
25880
25881 .section "Finding an ACL to use" "SECID195"
25882 .cindex "&ACL;" "finding which to use"
25883 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25884 you can use different ACLs in different circumstances. For example,
25885 .code
25886 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25887                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25888 .endd
25889 In the default configuration file there are some example settings for
25890 providing an RFC 4409 message submission service on port 587 and a
25891 non-standard &"smtps"& service on port 465. You can use a string
25892 expansion like this to choose an ACL for MUAs on these ports which is
25893 more appropriate for this purpose than the default ACL on port 25.
25894
25895 The expanded string does not have to be the name of an ACL in the
25896 configuration file; there are other possibilities. Having expanded the
25897 string, Exim searches for an ACL as follows:
25898
25899 .ilist
25900 If the string begins with a slash, Exim uses it as a file name, and reads its
25901 contents as an ACL. The lines are processed in the same way as lines in the
25902 Exim configuration file. In particular, continuation lines are supported, blank
25903 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25904 If the file does not exist or cannot be read, an error occurs (typically
25905 causing a temporary failure of whatever caused the ACL to be run). For example:
25906 .code
25907 acl_smtp_data = /etc/acls/\
25908   ${lookup{$sender_host_address}lsearch\
25909   {/etc/acllist}{$value}{default}}
25910 .endd
25911 This looks up an ACL file to use on the basis of the host's IP address, falling
25912 back to a default if the lookup fails. If an ACL is successfully read from a
25913 file, it is retained in memory for the duration of the Exim process, so that it
25914 can be re-used without having to re-read the file.
25915 .next
25916 If the string does not start with a slash, and does not contain any spaces,
25917 Exim searches the ACL section of the configuration for an ACL whose name
25918 matches the string.
25919 .next
25920 If no named ACL is found, or if the string contains spaces, Exim parses
25921 the string as an inline ACL. This can save typing in cases where you just
25922 want to have something like
25923 .code
25924 acl_smtp_vrfy = accept
25925 .endd
25926 in order to allow free use of the VRFY command. Such a string may contain
25927 newlines; it is processed in the same way as an ACL that is read from a file.
25928 .endlist
25929
25930
25931
25932
25933 .section "ACL return codes" "SECID196"
25934 .cindex "&ACL;" "return codes"
25935 Except for the QUIT ACL, which does not affect the SMTP return code (see
25936 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25937 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25938 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25939 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25940 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25941 This also causes a 4&'xx'& return code.
25942
25943 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25944 &"deny"&, because there is no mechanism for passing temporary errors to the
25945 submitters of non-SMTP messages.
25946
25947
25948 ACLs that are relevant to message reception may also return &"discard"&. This
25949 has the effect of &"accept"&, but causes either the entire message or an
25950 individual recipient address to be discarded. In other words, it is a
25951 blackholing facility. Use it with care.
25952
25953 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25954 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25955 RCPT ACL is to discard just the one recipient address. If there are no
25956 recipients left when the message's data is received, the DATA ACL is not
25957 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25958 remaining recipients. The &"discard"& return is not permitted for the
25959 &%acl_smtp_predata%& ACL.
25960
25961
25962 .cindex "&[local_scan()]& function" "when all recipients discarded"
25963 The &[local_scan()]& function is always run, even if there are no remaining
25964 recipients; it may create new recipients.
25965
25966
25967
25968 .section "Unset ACL options" "SECID197"
25969 .cindex "&ACL;" "unset options"
25970 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25971 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25972 not defined at all. For any defined ACL, the default action when control
25973 reaches the end of the ACL statements is &"deny"&.
25974
25975 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25976 these two are ACLs that are used only for their side effects. They cannot be
25977 used to accept or reject anything.
25978
25979 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25980 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25981 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25982 when the ACL is not defined is &"accept"&.
25983
25984 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25985 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25986 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25987 messages over an SMTP connection. For an example, see the ACL in the default
25988 configuration file.
25989
25990
25991
25992
25993 .section "Data for message ACLs" "SECID198"
25994 .cindex "&ACL;" "data for message ACL"
25995 .vindex &$domain$&
25996 .vindex &$local_part$&
25997 .vindex &$sender_address$&
25998 .vindex &$sender_host_address$&
25999 .vindex &$smtp_command$&
26000 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26001 that contain information about the host and the message's sender (for example,
26002 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26003 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26004 &$local_part$& are set from the argument address. The entire SMTP command
26005 is available in &$smtp_command$&.
26006
26007 When an ACL for the AUTH parameter of MAIL is running, the variables that
26008 contain information about the host are set, but &$sender_address$& is not yet
26009 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26010 how it is used.
26011
26012 .vindex "&$message_size$&"
26013 The &$message_size$& variable is set to the value of the SIZE parameter on
26014 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26015 that parameter is not given. The value is updated to the true message size by
26016 the time the final DATA ACL is run (after the message data has been
26017 received).
26018
26019 .vindex "&$rcpt_count$&"
26020 .vindex "&$recipients_count$&"
26021 The &$rcpt_count$& variable increases by one for each RCPT command received.
26022 The &$recipients_count$& variable increases by one each time a RCPT command is
26023 accepted, so while an ACL for RCPT is being processed, it contains the number
26024 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26025 &$rcpt_count$& contains the total number of RCPT commands, and
26026 &$recipients_count$& contains the total number of accepted recipients.
26027
26028
26029
26030
26031
26032 .section "Data for non-message ACLs" "SECTdatfornon"
26033 .cindex "&ACL;" "data for non-message ACL"
26034 .vindex &$smtp_command_argument$&
26035 .vindex &$smtp_command$&
26036 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26037 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26038 and the entire SMTP command is available in &$smtp_command$&.
26039 These variables can be tested using a &%condition%& condition. For example,
26040 here is an ACL for use with AUTH, which insists that either the session is
26041 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26042 does not permit authentication methods that use cleartext passwords on
26043 unencrypted connections.
26044 .code
26045 acl_check_auth:
26046   accept encrypted = *
26047   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26048                      {CRAM-MD5}}
26049   deny   message   = TLS encryption or CRAM-MD5 required
26050 .endd
26051 (Another way of applying this restriction is to arrange for the authenticators
26052 that use cleartext passwords not to be advertised when the connection is not
26053 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26054 option to do this.)
26055
26056
26057
26058 .section "Format of an ACL" "SECID199"
26059 .cindex "&ACL;" "format of"
26060 .cindex "&ACL;" "verbs, definition of"
26061 An individual ACL consists of a number of statements. Each statement starts
26062 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26063 Modifiers can change the way the verb operates, define error and log messages,
26064 set variables, insert delays, and vary the processing of accepted messages.
26065
26066 If all the conditions are met, the verb is obeyed. The same condition may be
26067 used (with different arguments) more than once in the same statement. This
26068 provides a means of specifying an &"and"& conjunction between conditions. For
26069 example:
26070 .code
26071 deny  dnslists = list1.example
26072 dnslists = list2.example
26073 .endd
26074 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26075 the conditions and modifiers when it reaches a condition that fails. What
26076 happens then depends on the verb (and in one case, on a special modifier). Not
26077 all the conditions make sense at every testing point. For example, you cannot
26078 test a sender address in the ACL that is run for a VRFY command.
26079
26080
26081 .section "ACL verbs" "SECID200"
26082 The ACL verbs are as follows:
26083
26084 .ilist
26085 .cindex "&%accept%& ACL verb"
26086 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26087 of the conditions are not met, what happens depends on whether &%endpass%&
26088 appears among the conditions (for syntax see below). If the failing condition
26089 is before &%endpass%&, control is passed to the next ACL statement; if it is
26090 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26091 check a RCPT command:
26092 .code
26093 accept domains = +local_domains
26094 endpass
26095 verify = recipient
26096 .endd
26097 If the recipient domain does not match the &%domains%& condition, control
26098 passes to the next statement. If it does match, the recipient is verified, and
26099 the command is accepted if verification succeeds. However, if verification
26100 fails, the ACL yields &"deny"&, because the failing condition is after
26101 &%endpass%&.
26102
26103 The &%endpass%& feature has turned out to be confusing to many people, so its
26104 use is not recommended nowadays. It is always possible to rewrite an ACL so
26105 that &%endpass%& is not needed, and it is no longer used in the default
26106 configuration.
26107
26108 .cindex "&%message%& ACL modifier" "with &%accept%&"
26109 If a &%message%& modifier appears on an &%accept%& statement, its action
26110 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26111 (when an &%accept%& verb either accepts or passes control to the next
26112 statement), &%message%& can be used to vary the message that is sent when an
26113 SMTP command is accepted. For example, in a RCPT ACL you could have:
26114 .display
26115 &`accept  `&<&'some conditions'&>
26116 &`        message = OK, I will allow you through today`&
26117 .endd
26118 You can specify an SMTP response code, optionally followed by an &"extended
26119 response code"& at the start of the message, but the first digit must be the
26120 same as would be sent by default, which is 2 for an &%accept%& verb.
26121
26122 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26123 an error message that is used when access is denied. This behaviour is retained
26124 for backward compatibility, but current &"best practice"& is to avoid the use
26125 of &%endpass%&.
26126
26127
26128 .next
26129 .cindex "&%defer%& ACL verb"
26130 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26131 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26132 &%defer%& is the same as &%deny%&, because there is no way of sending a
26133 temporary error. For a RCPT command, &%defer%& is much the same as using a
26134 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26135 be used in any ACL, and even for a recipient it might be a simpler approach.
26136
26137
26138 .next
26139 .cindex "&%deny%& ACL verb"
26140 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26141 the conditions are not met, control is passed to the next ACL statement. For
26142 example,
26143 .code
26144 deny dnslists = blackholes.mail-abuse.org
26145 .endd
26146 rejects commands from hosts that are on a DNS black list.
26147
26148
26149 .next
26150 .cindex "&%discard%& ACL verb"
26151 &%discard%&: This verb behaves like &%accept%&, except that it returns
26152 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26153 that are concerned with receiving messages. When all the conditions are true,
26154 the sending entity receives a &"success"& response. However, &%discard%& causes
26155 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26156 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26157 message's recipients are discarded. Recipients that are discarded before DATA
26158 do not appear in the log line when the &%received_recipients%& log selector is set.
26159
26160 If the &%log_message%& modifier is set when &%discard%& operates,
26161 its contents are added to the line that is automatically written to the log.
26162 The &%message%& modifier operates exactly as it does for &%accept%&.
26163
26164
26165 .next
26166 .cindex "&%drop%& ACL verb"
26167 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26168 forcibly closed after the 5&'xx'& error message has been sent. For example:
26169 .code
26170 drop   message   = I don't take more than 20 RCPTs
26171        condition = ${if > {$rcpt_count}{20}}
26172 .endd
26173 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26174 The connection is always dropped after sending a 550 response.
26175
26176 .next
26177 .cindex "&%require%& ACL verb"
26178 &%require%&: If all the conditions are met, control is passed to the next ACL
26179 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26180 example, when checking a RCPT command,
26181 .code
26182 require message = Sender did not verify
26183         verify  = sender
26184 .endd
26185 passes control to subsequent statements only if the message's sender can be
26186 verified. Otherwise, it rejects the command. Note the positioning of the
26187 &%message%& modifier, before the &%verify%& condition. The reason for this is
26188 discussed in section &<<SECTcondmodproc>>&.
26189
26190 .next
26191 .cindex "&%warn%& ACL verb"
26192 &%warn%&: If all the conditions are true, a line specified by the
26193 &%log_message%& modifier is written to Exim's main log. Control always passes
26194 to the next ACL statement. If any condition is false, the log line is not
26195 written. If an identical log line is requested several times in the same
26196 message, only one copy is actually written to the log. If you want to force
26197 duplicates to be written, use the &%logwrite%& modifier instead.
26198
26199 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26200 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26201 &%logwrite%&, and &%add_header%&) that appear before the first failing
26202 condition. There is more about adding header lines in section
26203 &<<SECTaddheadacl>>&.
26204
26205 If any condition on a &%warn%& statement cannot be completed (that is, there is
26206 some sort of defer), the log line specified by &%log_message%& is not written.
26207 This does not include the case of a forced failure from a lookup, which
26208 is considered to be a successful completion. After a defer, no further
26209 conditions or modifiers in the &%warn%& statement are processed. The incident
26210 is logged, and the ACL continues to be processed, from the next statement
26211 onwards.
26212
26213
26214 .vindex "&$acl_verify_message$&"
26215 When one of the &%warn%& conditions is an address verification that fails, the
26216 text of the verification failure message is in &$acl_verify_message$&. If you
26217 want this logged, you must set it up explicitly. For example:
26218 .code
26219 warn   !verify = sender
26220        log_message = sender verify failed: $acl_verify_message
26221 .endd
26222 .endlist
26223
26224 At the end of each ACL there is an implicit unconditional &%deny%&.
26225
26226 As you can see from the examples above, the conditions and modifiers are
26227 written one to a line, with the first one on the same line as the verb, and
26228 subsequent ones on following lines. If you have a very long condition, you can
26229 continue it onto several physical lines by the usual backslash continuation
26230 mechanism. It is conventional to align the conditions vertically.
26231
26232
26233
26234 .section "ACL variables" "SECTaclvariables"
26235 .cindex "&ACL;" "variables"
26236 There are some special variables that can be set during ACL processing. They
26237 can be used to pass information between different ACLs, different invocations
26238 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26239 transports, and filters that are used to deliver a message. The names of these
26240 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26241 an underscore, but the remainder of the name can be any sequence of
26242 alphanumeric characters and underscores that you choose. There is no limit on
26243 the number of ACL variables. The two sets act as follows:
26244 .ilist
26245 The values of those variables whose names begin with &$acl_c$& persist
26246 throughout an SMTP connection. They are never reset. Thus, a value that is set
26247 while receiving one message is still available when receiving the next message
26248 on the same SMTP connection.
26249 .next
26250 The values of those variables whose names begin with &$acl_m$& persist only
26251 while a message is being received. They are reset afterwards. They are also
26252 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26253 .endlist
26254
26255 When a message is accepted, the current values of all the ACL variables are
26256 preserved with the message and are subsequently made available at delivery
26257 time. The ACL variables are set by a modifier called &%set%&. For example:
26258 .code
26259 accept hosts = whatever
26260        set acl_m4 = some value
26261 accept authenticated = *
26262        set acl_c_auth = yes
26263 .endd
26264 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26265 be set. If you want to set a variable without taking any action, you can use a
26266 &%warn%& verb without any other modifiers or conditions.
26267
26268 .oindex &%strict_acl_vars%&
26269 What happens if a syntactically valid but undefined ACL variable is
26270 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26271 false (the default), an empty string is substituted; if it is true, an
26272 error is generated.
26273
26274 Versions of Exim before 4.64 have a limited set of numbered variables, but
26275 their names are compatible, so there is no problem with upgrading.
26276
26277
26278 .section "Condition and modifier processing" "SECTcondmodproc"
26279 .cindex "&ACL;" "conditions; processing"
26280 .cindex "&ACL;" "modifiers; processing"
26281 An exclamation mark preceding a condition negates its result. For example:
26282 .code
26283 deny   domains = *.dom.example
26284       !verify  = recipient
26285 .endd
26286 causes the ACL to return &"deny"& if the recipient domain ends in
26287 &'dom.example'& and the recipient address cannot be verified. Sometimes
26288 negation can be used on the right-hand side of a condition. For example, these
26289 two statements are equivalent:
26290 .code
26291 deny  hosts = !192.168.3.4
26292 deny !hosts =  192.168.3.4
26293 .endd
26294 However, for many conditions (&%verify%& being a good example), only left-hand
26295 side negation of the whole condition is possible.
26296
26297 The arguments of conditions and modifiers are expanded. A forced failure
26298 of an expansion causes a condition to be ignored, that is, it behaves as if the
26299 condition is true. Consider these two statements:
26300 .code
26301 accept  senders = ${lookup{$host_name}lsearch\
26302                   {/some/file}{$value}fail}
26303 accept  senders = ${lookup{$host_name}lsearch\
26304                   {/some/file}{$value}{}}
26305 .endd
26306 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26307 the returned list is searched, but if the lookup fails the behaviour is
26308 different in the two cases. The &%fail%& in the first statement causes the
26309 condition to be ignored, leaving no further conditions. The &%accept%& verb
26310 therefore succeeds. The second statement, however, generates an empty list when
26311 the lookup fails. No sender can match an empty list, so the condition fails,
26312 and therefore the &%accept%& also fails.
26313
26314 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26315 specify actions that are taken as the conditions for a statement are checked;
26316 others specify text for messages that are used when access is denied or a
26317 warning is generated. The &%control%& modifier affects the way an incoming
26318 message is handled.
26319
26320 The positioning of the modifiers in an ACL statement important, because the
26321 processing of a verb ceases as soon as its outcome is known. Only those
26322 modifiers that have already been encountered will take effect. For example,
26323 consider this use of the &%message%& modifier:
26324 .code
26325 require message = Can't verify sender
26326         verify  = sender
26327         message = Can't verify recipient
26328         verify  = recipient
26329         message = This message cannot be used
26330 .endd
26331 If sender verification fails, Exim knows that the result of the statement is
26332 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26333 so its text is used as the error message. If sender verification succeeds, but
26334 recipient verification fails, the second message is used. If recipient
26335 verification succeeds, the third message becomes &"current"&, but is never used
26336 because there are no more conditions to cause failure.
26337
26338 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26339 modifier that is used, because all the conditions must be true for rejection to
26340 happen. Specifying more than one &%message%& modifier does not make sense, and
26341 the message can even be specified after all the conditions. For example:
26342 .code
26343 deny   hosts = ...
26344       !senders = *@my.domain.example
26345        message = Invalid sender from client host
26346 .endd
26347 The &"deny"& result does not happen until the end of the statement is reached,
26348 by which time Exim has set up the message.
26349
26350
26351
26352 .section "ACL modifiers" "SECTACLmodi"
26353 .cindex "&ACL;" "modifiers; list of"
26354 The ACL modifiers are as follows:
26355
26356 .vlist
26357 .vitem &*add_header*&&~=&~<&'text'&>
26358 This modifier specifies one or more header lines that are to be added to an
26359 incoming message, assuming, of course, that the message is ultimately
26360 accepted. For details, see section &<<SECTaddheadacl>>&.
26361
26362 .vitem &*continue*&&~=&~<&'text'&>
26363 .cindex "&%continue%& ACL modifier"
26364 .cindex "database" "updating in ACL"
26365 This modifier does nothing of itself, and processing of the ACL always
26366 continues with the next condition or modifier. The value of &%continue%& is in
26367 the side effects of expanding its argument. Typically this could be used to
26368 update a database. It is really just a syntactic tidiness, to avoid having to
26369 write rather ugly lines like this:
26370 .display
26371 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26372 .endd
26373 Instead, all you need is
26374 .display
26375 &`continue = `&<&'some expansion'&>
26376 .endd
26377
26378 .vitem &*control*&&~=&~<&'text'&>
26379 .cindex "&%control%& ACL modifier"
26380 This modifier affects the subsequent processing of the SMTP connection or of an
26381 incoming message that is accepted. The effect of the first type of control
26382 lasts for the duration of the connection, whereas the effect of the second type
26383 lasts only until the current message has been received. The message-specific
26384 controls always apply to the whole message, not to individual recipients,
26385 even if the &%control%& modifier appears in a RCPT ACL.
26386
26387 As there are now quite a few controls that can be applied, they are described
26388 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26389 in several different ways. For example:
26390
26391 . ==== As this is a nested list, any displays it contains must be indented
26392 . ==== as otherwise they are too far to the left. That comment applies only
26393 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26394 . ==== way.
26395
26396 .ilist
26397 It can be at the end of an &%accept%& statement:
26398 .code
26399     accept  ...some conditions
26400             control = queue_only
26401 .endd
26402 In this case, the control is applied when this statement yields &"accept"&, in
26403 other words, when the conditions are all true.
26404
26405 .next
26406 It can be in the middle of an &%accept%& statement:
26407 .code
26408     accept  ...some conditions...
26409             control = queue_only
26410             ...some more conditions...
26411 .endd
26412 If the first set of conditions are true, the control is applied, even if the
26413 statement does not accept because one of the second set of conditions is false.
26414 In this case, some subsequent statement must yield &"accept"& for the control
26415 to be relevant.
26416
26417 .next
26418 It can be used with &%warn%& to apply the control, leaving the
26419 decision about accepting or denying to a subsequent verb. For
26420 example:
26421 .code
26422     warn    ...some conditions...
26423             control = freeze
26424     accept  ...
26425 .endd
26426 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26427 &%logwrite%&, so it does not add anything to the message and does not write a
26428 log entry.
26429
26430 .next
26431 If you want to apply a control unconditionally, you can use it with a
26432 &%require%& verb. For example:
26433 .code
26434     require  control = no_multiline_responses
26435 .endd
26436 .endlist
26437
26438 .vitem &*delay*&&~=&~<&'time'&>
26439 .cindex "&%delay%& ACL modifier"
26440 .oindex "&%-bh%&"
26441 This modifier may appear in any ACL. It causes Exim to wait for the time
26442 interval before proceeding. However, when testing Exim using the &%-bh%&
26443 option, the delay is not actually imposed (an appropriate message is output
26444 instead). The time is given in the usual Exim notation, and the delay happens
26445 as soon as the modifier is processed. In an SMTP session, pending output is
26446 flushed before the delay is imposed.
26447
26448 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26449 example:
26450 .code
26451 deny    ...some conditions...
26452         delay = 30s
26453 .endd
26454 The delay happens if all the conditions are true, before the statement returns
26455 &"deny"&. Compare this with:
26456 .code
26457 deny    delay = 30s
26458         ...some conditions...
26459 .endd
26460 which waits for 30s before processing the conditions. The &%delay%& modifier
26461 can also be used with &%warn%& and together with &%control%&:
26462 .code
26463 warn    ...some conditions...
26464         delay = 2m
26465         control = freeze
26466 accept  ...
26467 .endd
26468
26469 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26470 responses to several commands are no longer buffered and sent in one packet (as
26471 they would normally be) because all output is flushed before imposing the
26472 delay. This optimization is disabled so that a number of small delays do not
26473 appear to the client as one large aggregated delay that might provoke an
26474 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26475 using a &%control%& modifier to set &%no_delay_flush%&.
26476
26477
26478 .vitem &*endpass*&
26479 .cindex "&%endpass%& ACL modifier"
26480 This modifier, which has no argument, is recognized only in &%accept%& and
26481 &%discard%& statements. It marks the boundary between the conditions whose
26482 failure causes control to pass to the next statement, and the conditions whose
26483 failure causes the ACL to return &"deny"&. This concept has proved to be
26484 confusing to some people, so the use of &%endpass%& is no longer recommended as
26485 &"best practice"&. See the description of &%accept%& above for more details.
26486
26487
26488 .vitem &*log_message*&&~=&~<&'text'&>
26489 .cindex "&%log_message%& ACL modifier"
26490 This modifier sets up a message that is used as part of the log message if the
26491 ACL denies access or a &%warn%& statement's conditions are true. For example:
26492 .code
26493 require log_message = wrong cipher suite $tls_cipher
26494         encrypted   = DES-CBC3-SHA
26495 .endd
26496 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26497 example:
26498 .display
26499 &`discard `&<&'some conditions'&>
26500 &`        log_message = Discarded $local_part@$domain because...`&
26501 .endd
26502 When access is denied, &%log_message%& adds to any underlying error message
26503 that may exist because of a condition failure. For example, while verifying a
26504 recipient address, a &':fail:'& redirection might have already set up a
26505 message.
26506
26507 The message may be defined before the conditions to which it applies, because
26508 the string expansion does not happen until Exim decides that access is to be
26509 denied. This means that any variables that are set by the condition are
26510 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26511 variables are set after a DNS black list lookup succeeds. If the expansion of
26512 &%log_message%& fails, or if the result is an empty string, the modifier is
26513 ignored.
26514
26515 .vindex "&$acl_verify_message$&"
26516 If you want to use a &%warn%& statement to log the result of an address
26517 verification, you can use &$acl_verify_message$& to include the verification
26518 error message.
26519
26520 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26521 the start of the logged message. If the same warning log message is requested
26522 more than once while receiving  a single email message, only one copy is
26523 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26524 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26525 is logged for a successful &%warn%& statement.
26526
26527 If &%log_message%& is not present and there is no underlying error message (for
26528 example, from the failure of address verification), but &%message%& is present,
26529 the &%message%& text is used for logging rejections. However, if any text for
26530 logging contains newlines, only the first line is logged. In the absence of
26531 both &%log_message%& and &%message%&, a default built-in message is used for
26532 logging rejections.
26533
26534
26535 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26536 .cindex "&%log_reject_target%& ACL modifier"
26537 .cindex "logging in ACL" "specifying which log"
26538 This modifier makes it possible to specify which logs are used for messages
26539 about ACL rejections. Its argument is a colon-separated list of words that can
26540 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26541 may be empty, in which case a rejection is not logged at all. For example, this
26542 ACL fragment writes no logging information when access is denied:
26543 .display
26544 &`deny `&<&'some conditions'&>
26545 &`     log_reject_target =`&
26546 .endd
26547 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26548 permanent and temporary rejections. Its effect lasts for the rest of the
26549 current ACL.
26550
26551
26552 .vitem &*logwrite*&&~=&~<&'text'&>
26553 .cindex "&%logwrite%& ACL modifier"
26554 .cindex "logging in ACL" "immediate"
26555 This modifier writes a message to a log file as soon as it is encountered when
26556 processing an ACL. (Compare &%log_message%&, which, except in the case of
26557 &%warn%& and &%discard%&, is used only if the ACL statement denies
26558 access.) The &%logwrite%& modifier can be used to log special incidents in
26559 ACLs. For example:
26560 .display
26561 &`accept `&<&'some special conditions'&>
26562 &`       control  = freeze`&
26563 &`       logwrite = froze message because ...`&
26564 .endd
26565 By default, the message is written to the main log. However, it may begin
26566 with a colon, followed by a comma-separated list of log names, and then
26567 another colon, to specify exactly which logs are to be written. For
26568 example:
26569 .code
26570 logwrite = :main,reject: text for main and reject logs
26571 logwrite = :panic: text for panic log only
26572 .endd
26573
26574
26575 .vitem &*message*&&~=&~<&'text'&>
26576 .cindex "&%message%& ACL modifier"
26577 This modifier sets up a text string that is expanded and used as a response
26578 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26579 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26580 there is some complication if &%endpass%& is involved; see the description of
26581 &%accept%& for details.)
26582
26583 The expansion of the message happens at the time Exim decides that the ACL is
26584 to end, not at the time it processes &%message%&. If the expansion fails, or
26585 generates an empty string, the modifier is ignored. Here is an example where
26586 &%message%& must be specified first, because the ACL ends with a rejection if
26587 the &%hosts%& condition fails:
26588 .code
26589 require  message = Host not recognized
26590          hosts = 10.0.0.0/8
26591 .endd
26592 (Once a condition has failed, no further conditions or modifiers are
26593 processed.)
26594
26595 .cindex "SMTP" "error codes"
26596 .oindex "&%smtp_banner%&
26597 For ACLs that are triggered by SMTP commands, the message is returned as part
26598 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26599 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26600 is accepted. In the case of the connect ACL, accepting with a message modifier
26601 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26602 accept message may not contain more than one line (otherwise it will be
26603 truncated at the first newline and a panic logged), and it cannot affect the
26604 EHLO options.
26605
26606 When SMTP is involved, the message may begin with an overriding response code,
26607 consisting of three digits optionally followed by an &"extended response code"&
26608 of the form &'n.n.n'&, each code being followed by a space. For example:
26609 .code
26610 deny  message = 599 1.2.3 Host not welcome
26611       hosts = 192.168.34.0/24
26612 .endd
26613 The first digit of the supplied response code must be the same as would be sent
26614 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26615 access, but for the predata ACL, note that the default success code is 354, not
26616 2&'xx'&.
26617
26618 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26619 the message modifier cannot override the 221 response code.
26620
26621 The text in a &%message%& modifier is literal; any quotes are taken as
26622 literals, but because the string is expanded, backslash escapes are processed
26623 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26624 response.
26625
26626 .vindex "&$acl_verify_message$&"
26627 If &%message%& is used on a statement that verifies an address, the message
26628 specified overrides any message that is generated by the verification process.
26629 However, the original message is available in the variable
26630 &$acl_verify_message$&, so you can incorporate it into your message if you
26631 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26632 routers to be passed back as part of the SMTP response, you should either not
26633 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26634
26635 For compatibility with previous releases of Exim, a &%message%& modifier that
26636 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26637 modifier, but this usage is now deprecated. However, &%message%& acts only when
26638 all the conditions are true, wherever it appears in an ACL command, whereas
26639 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26640 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26641 effect.
26642
26643
26644 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26645 .cindex "&%set%& ACL modifier"
26646 This modifier puts a value into one of the ACL variables (see section
26647 &<<SECTaclvariables>>&).
26648 .endlist
26649
26650
26651
26652
26653
26654 .section "Use of the control modifier" "SECTcontrols"
26655 .cindex "&%control%& ACL modifier"
26656 The &%control%& modifier supports the following settings:
26657
26658 .vlist
26659 .vitem &*control&~=&~allow_auth_unadvertised*&
26660 This modifier allows a client host to use the SMTP AUTH command even when it
26661 has not been advertised in response to EHLO. Furthermore, because there are
26662 apparently some really broken clients that do this, Exim will accept AUTH after
26663 HELO (rather than EHLO) when this control is set. It should be used only if you
26664 really need it, and you should limit its use to those broken clients that do
26665 not work without it. For example:
26666 .code
26667 warn hosts   = 192.168.34.25
26668      control = allow_auth_unadvertised
26669 .endd
26670 Normally, when an Exim server receives an AUTH command, it checks the name of
26671 the authentication mechanism that is given in the command to ensure that it
26672 matches an advertised mechanism. When this control is set, the check that a
26673 mechanism has been advertised is bypassed. Any configured mechanism can be used
26674 by the client. This control is permitted only in the connection and HELO ACLs.
26675
26676
26677 .vitem &*control&~=&~caseful_local_part*& &&&
26678        &*control&~=&~caselower_local_part*&
26679 .cindex "&ACL;" "case of local part in"
26680 .cindex "case of local parts"
26681 .vindex "&$local_part$&"
26682 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26683 (that is, during RCPT processing). By default, the contents of &$local_part$&
26684 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26685 any uppercase letters in the original local part are restored in &$local_part$&
26686 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26687 is encountered.
26688
26689 These controls affect only the current recipient. Moreover, they apply only to
26690 local part handling that takes place directly in the ACL (for example, as a key
26691 in lookups). If a test to verify the recipient is obeyed, the case-related
26692 handling of the local part during the verification is controlled by the router
26693 configuration (see the &%caseful_local_part%& generic router option).
26694
26695 This facility could be used, for example, to add a spam score to local parts
26696 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26697 spam score:
26698 .code
26699 warn  control = caseful_local_part
26700       set acl_m4 = ${eval:\
26701                      $acl_m4 + \
26702                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26703                     }
26704       control = caselower_local_part
26705 .endd
26706 Notice that we put back the lower cased version afterwards, assuming that
26707 is what is wanted for subsequent tests.
26708
26709
26710 .vitem &*control&~=&~debug/*&<&'options'&>
26711 .cindex "&ACL;" "enabling debug logging"
26712 .cindex "debugging" "enabling from an ACL"
26713 This control turns on debug logging, almost as though Exim had been invoked
26714 with &`-d`&, with the output going to a new logfile, by default called
26715 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26716 may access any variables already defined.  The logging may be adjusted with
26717 the &'opts'& option, which takes the same values as the &`-d`& command-line
26718 option.  Some examples (which depend on variables that don't exist in all
26719 contexts):
26720 .code
26721       control = debug
26722       control = debug/tag=.$sender_host_address
26723       control = debug/opts=+expand+acl
26724       control = debug/tag=.$message_exim_id/opts=+expand
26725 .endd
26726
26727
26728 .vitem &*control&~=&~enforce_sync*& &&&
26729        &*control&~=&~no_enforce_sync*&
26730 .cindex "SMTP" "synchronization checking"
26731 .cindex "synchronization checking in SMTP"
26732 These controls make it possible to be selective about when SMTP synchronization
26733 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26734 state of the switch (it is true by default). See the description of this option
26735 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26736
26737 The effect of these two controls lasts for the remainder of the SMTP
26738 connection. They can appear in any ACL except the one for the non-SMTP
26739 messages. The most straightforward place to put them is in the ACL defined by
26740 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26741 before the first synchronization check. The expected use is to turn off the
26742 synchronization checks for badly-behaved hosts that you nevertheless need to
26743 work with.
26744
26745
26746 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26747 .cindex "fake defer"
26748 .cindex "defer, fake"
26749 This control works in exactly the same way as &%fakereject%& (described below)
26750 except that it causes an SMTP 450 response after the message data instead of a
26751 550 response. You must take care when using &%fakedefer%& because it causes the
26752 messages to be duplicated when the sender retries. Therefore, you should not
26753 use &%fakedefer%& if the message is to be delivered normally.
26754
26755 .vitem &*control&~=&~fakereject/*&<&'message'&>
26756 .cindex "fake rejection"
26757 .cindex "rejection, fake"
26758 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26759 words, only when an SMTP message is being received. If Exim accepts the
26760 message, instead the final 250 response, a 550 rejection message is sent.
26761 However, Exim proceeds to deliver the message as normal. The control applies
26762 only to the current message, not to any subsequent ones that may be received in
26763 the same SMTP connection.
26764
26765 The text for the 550 response is taken from the &%control%& modifier. If no
26766 message is supplied, the following is used:
26767 .code
26768 550-Your message has been rejected but is being
26769 550-kept for evaluation.
26770 550-If it was a legitimate message, it may still be
26771 550 delivered to the target recipient(s).
26772 .endd
26773 This facility should be used with extreme caution.
26774
26775 .vitem &*control&~=&~freeze*&
26776 .cindex "frozen messages" "forcing in ACL"
26777 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26778 other words, only when a message is being received. If the message is accepted,
26779 it is placed on Exim's queue and frozen. The control applies only to the
26780 current message, not to any subsequent ones that may be received in the same
26781 SMTP connection.
26782
26783 This modifier can optionally be followed by &`/no_tell`&. If the global option
26784 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26785 is told about the freezing), provided all the &*control=freeze*& modifiers that
26786 are obeyed for the current message have the &`/no_tell`& option.
26787
26788 .vitem &*control&~=&~no_delay_flush*&
26789 .cindex "SMTP" "output flushing, disabling for delay"
26790 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26791 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26792 use. This control, as long as it is encountered before the &%delay%& modifier,
26793 disables such output flushing.
26794
26795 .vitem &*control&~=&~no_callout_flush*&
26796 .cindex "SMTP" "output flushing, disabling for callout"
26797 Exim normally flushes SMTP output before performing a callout in an ACL, to
26798 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26799 use. This control, as long as it is encountered before the &%verify%& condition
26800 that causes the callout, disables such output flushing.
26801
26802 .vitem &*control&~=&~no_mbox_unspool*&
26803 This control is available when Exim is compiled with the content scanning
26804 extension. Content scanning may require a copy of the current message, or parts
26805 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26806 or spam scanner. Normally, such copies are deleted when they are no longer
26807 needed. If this control is set, the copies are not deleted. The control applies
26808 only to the current message, not to any subsequent ones that may be received in
26809 the same SMTP connection. It is provided for debugging purposes and is unlikely
26810 to be useful in production.
26811
26812 .vitem &*control&~=&~no_multiline_responses*&
26813 .cindex "multiline responses, suppressing"
26814 This control is permitted for any ACL except the one for non-SMTP messages.
26815 It seems that there are broken clients in use that cannot handle multiline
26816 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26817
26818 If this control is set, multiline SMTP responses from ACL rejections are
26819 suppressed. One way of doing this would have been to put out these responses as
26820 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26821 (&"use multiline responses for more"& it says &-- ha!), and some of the
26822 responses might get close to that. So this facility, which is after all only a
26823 sop to broken clients, is implemented by doing two very easy things:
26824
26825 .ilist
26826 Extra information that is normally output as part of a rejection caused by
26827 sender verification failure is omitted. Only the final line (typically &"sender
26828 verification failed"&) is sent.
26829 .next
26830 If a &%message%& modifier supplies a multiline response, only the first
26831 line is output.
26832 .endlist
26833
26834 The setting of the switch can, of course, be made conditional on the
26835 calling host. Its effect lasts until the end of the SMTP connection.
26836
26837 .vitem &*control&~=&~no_pipelining*&
26838 .cindex "PIPELINING" "suppressing advertising"
26839 This control turns off the advertising of the PIPELINING extension to SMTP in
26840 the current session. To be useful, it must be obeyed before Exim sends its
26841 response to an EHLO command. Therefore, it should normally appear in an ACL
26842 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26843 &%pipelining_advertise_hosts%&.
26844
26845 .vitem &*control&~=&~queue_only*&
26846 .oindex "&%queue_only%&"
26847 .cindex "queueing incoming messages"
26848 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26849 other words, only when a message is being received. If the message is accepted,
26850 it is placed on Exim's queue and left there for delivery by a subsequent queue
26851 runner. No immediate delivery process is started. In other words, it has the
26852 effect as the &%queue_only%& global option. However, the control applies only
26853 to the current message, not to any subsequent ones that may be received in the
26854 same SMTP connection.
26855
26856 .vitem &*control&~=&~submission/*&<&'options'&>
26857 .cindex "message" "submission"
26858 .cindex "submission mode"
26859 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26860 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26861 the current message is a submission from a local MUA. In this case, Exim
26862 operates in &"submission mode"&, and applies certain fixups to the message if
26863 necessary. For example, it adds a &'Date:'& header line if one is not present.
26864 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26865 late (the message has already been created).
26866
26867 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26868 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26869 submission mode; the available options for this control are described there.
26870 The control applies only to the current message, not to any subsequent ones
26871 that may be received in the same SMTP connection.
26872
26873 .vitem &*control&~=&~suppress_local_fixups*&
26874 .cindex "submission fixups, suppressing"
26875 This control applies to locally submitted (non TCP/IP) messages, and is the
26876 complement of &`control = submission`&. It disables the fixups that are
26877 normally applied to locally-submitted messages. Specifically:
26878
26879 .ilist
26880 Any &'Sender:'& header line is left alone (in this respect, it is a
26881 dynamic version of &%local_sender_retain%&).
26882 .next
26883 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26884 .next
26885 There is no check that &'From:'& corresponds to the actual sender.
26886 .endlist ilist
26887
26888 This control may be useful when a remotely-originated message is accepted,
26889 passed to some scanning program, and then re-submitted for delivery. It can be
26890 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26891 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26892 data is read.
26893
26894 &*Note:*& This control applies only to the current message, not to any others
26895 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26896 .endlist vlist
26897
26898
26899 .section "Summary of message fixup control" "SECTsummesfix"
26900 All four possibilities for message fixups can be specified:
26901
26902 .ilist
26903 Locally submitted, fixups applied: the default.
26904 .next
26905 Locally submitted, no fixups applied: use
26906 &`control = suppress_local_fixups`&.
26907 .next
26908 Remotely submitted, no fixups applied: the default.
26909 .next
26910 Remotely submitted, fixups applied: use &`control = submission`&.
26911 .endlist
26912
26913
26914
26915 .section "Adding header lines in ACLs" "SECTaddheadacl"
26916 .cindex "header lines" "adding in an ACL"
26917 .cindex "header lines" "position of added lines"
26918 .cindex "&%message%& ACL modifier"
26919 The &%add_header%& modifier can be used to add one or more extra header lines
26920 to an incoming message, as in this example:
26921 .code
26922 warn dnslists = sbl.spamhaus.org : \
26923                 dialup.mail-abuse.org
26924      add_header = X-blacklisted-at: $dnslist_domain
26925 .endd
26926 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26927 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26928 receiving a message). The message must ultimately be accepted for
26929 &%add_header%& to have any significant effect. You can use &%add_header%& with
26930 any ACL verb, including &%deny%& (though this is potentially useful only in a
26931 RCPT ACL).
26932
26933 If the data for the &%add_header%& modifier contains one or more newlines that
26934 are not followed by a space or a tab, it is assumed to contain multiple header
26935 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26936 front of any line that is not a valid header line.
26937
26938 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26939 They are added to the message before processing the DATA and MIME ACLs.
26940 However, if an identical header line is requested more than once, only one copy
26941 is actually added to the message. Further header lines may be accumulated
26942 during the DATA and MIME ACLs, after which they are added to the message, again
26943 with duplicates suppressed. Thus, it is possible to add two identical header
26944 lines to an SMTP message, but only if one is added before DATA and one after.
26945 In the case of non-SMTP messages, new headers are accumulated during the
26946 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26947 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26948 are included in the entry that is written to the reject log.
26949
26950 .cindex "header lines" "added; visibility of"
26951 Header lines are not visible in string expansions until they are added to the
26952 message. It follows that header lines defined in the MAIL, RCPT, and predata
26953 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26954 header lines that are added by the DATA or MIME ACLs are not visible in those
26955 ACLs. Because of this restriction, you cannot use header lines as a way of
26956 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26957 this, you can use ACL variables, as described in section
26958 &<<SECTaclvariables>>&.
26959
26960 The &%add_header%& modifier acts immediately it is encountered during the
26961 processing of an ACL. Notice the difference between these two cases:
26962 .display
26963 &`accept add_header = ADDED: some text`&
26964 &`       `&<&'some condition'&>
26965
26966 &`accept `&<&'some condition'&>
26967 &`       add_header = ADDED: some text`&
26968 .endd
26969 In the first case, the header line is always added, whether or not the
26970 condition is true. In the second case, the header line is added only if the
26971 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26972 ACL statement. All those that are encountered before a condition fails are
26973 honoured.
26974
26975 .cindex "&%warn%& ACL verb"
26976 For compatibility with previous versions of Exim, a &%message%& modifier for a
26977 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26978 effect only if all the conditions are true, even if it appears before some of
26979 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26980 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26981 are present on a &%warn%& verb, both are processed according to their
26982 specifications.
26983
26984 By default, new header lines are added to a message at the end of the existing
26985 header lines. However, you can specify that any particular header line should
26986 be added right at the start (before all the &'Received:'& lines), immediately
26987 after the first block of &'Received:'& lines, or immediately before any line
26988 that is not a &'Received:'& or &'Resent-something:'& header.
26989
26990 This is done by specifying &":at_start:"&, &":after_received:"&, or
26991 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26992 header line, respectively. (Header text cannot start with a colon, as there has
26993 to be a header name first.) For example:
26994 .code
26995 warn add_header = \
26996        :after_received:X-My-Header: something or other...
26997 .endd
26998 If more than one header line is supplied in a single &%add_header%& modifier,
26999 each one is treated independently and can therefore be placed differently. If
27000 you add more than one line at the start, or after the Received: block, they end
27001 up in reverse order.
27002
27003 &*Warning*&: This facility currently applies only to header lines that are
27004 added in an ACL. It does NOT work for header lines that are added in a
27005 system filter or in a router or transport.
27006
27007
27008
27009
27010 .section "ACL conditions" "SECTaclconditions"
27011 .cindex "&ACL;" "conditions; list of"
27012 Some of conditions listed in this section are available only when Exim is
27013 compiled with the content-scanning extension. They are included here briefly
27014 for completeness. More detailed descriptions can be found in the discussion on
27015 content scanning in chapter &<<CHAPexiscan>>&.
27016
27017 Not all conditions are relevant in all circumstances. For example, testing
27018 senders and recipients does not make sense in an ACL that is being run as the
27019 result of the arrival of an ETRN command, and checks on message headers can be
27020 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27021 can use the same condition (with different parameters) more than once in the
27022 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27023 The conditions are as follows:
27024
27025
27026 .vlist
27027 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27028 .cindex "&ACL;" "nested"
27029 .cindex "&ACL;" "indirect"
27030 .cindex "&%acl%& ACL condition"
27031 The possible values of the argument are the same as for the
27032 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27033 &"accept"& the condition is true; if it returns &"deny"& the condition is
27034 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27035 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27036 condition false. This means that further processing of the &%warn%& verb
27037 ceases, but processing of the ACL continues.
27038
27039 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27040 the connection is dropped. If it returns &"discard"&, the verb must be
27041 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27042 conditions are tested.
27043
27044 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27045 loops. This condition allows you to use different ACLs in different
27046 circumstances. For example, different ACLs can be used to handle RCPT commands
27047 for different local users or different local domains.
27048
27049 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27050 .cindex "&%authenticated%& ACL condition"
27051 .cindex "authentication" "ACL checking"
27052 .cindex "&ACL;" "testing for authentication"
27053 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27054 the name of the authenticator is tested against the list. To test for
27055 authentication by any authenticator, you can set
27056 .code
27057 authenticated = *
27058 .endd
27059
27060 .vitem &*condition&~=&~*&<&'string'&>
27061 .cindex "&%condition%& ACL condition"
27062 .cindex "customizing" "ACL condition"
27063 .cindex "&ACL;" "customized test"
27064 .cindex "&ACL;" "testing, customized"
27065 This feature allows you to make up custom conditions. If the result of
27066 expanding the string is an empty string, the number zero, or one of the strings
27067 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27068 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27069 any other value, some error is assumed to have occurred, and the ACL returns
27070 &"defer"&. However, if the expansion is forced to fail, the condition is
27071 ignored. The effect is to treat it as true, whether it is positive or
27072 negative.
27073
27074 .vitem &*decode&~=&~*&<&'location'&>
27075 .cindex "&%decode%& ACL condition"
27076 This condition is available only when Exim is compiled with the
27077 content-scanning extension, and it is allowed only in the ACL defined by
27078 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27079 If all goes well, the condition is true. It is false only if there are
27080 problems such as a syntax error or a memory shortage. For more details, see
27081 chapter &<<CHAPexiscan>>&.
27082
27083 .vitem &*demime&~=&~*&<&'extension&~list'&>
27084 .cindex "&%demime%& ACL condition"
27085 This condition is available only when Exim is compiled with the
27086 content-scanning extension. Its use is described in section
27087 &<<SECTdemimecond>>&.
27088
27089 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27090 .cindex "&%dnslists%& ACL condition"
27091 .cindex "DNS list" "in ACL"
27092 .cindex "black list (DNS)"
27093 .cindex "&ACL;" "testing a DNS list"
27094 This condition checks for entries in DNS black lists. These are also known as
27095 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27096 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27097 different variants of this condition to describe briefly here. See sections
27098 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27099
27100 .vitem &*domains&~=&~*&<&'domain&~list'&>
27101 .cindex "&%domains%& ACL condition"
27102 .cindex "domain" "ACL checking"
27103 .cindex "&ACL;" "testing a recipient domain"
27104 .vindex "&$domain_data$&"
27105 This condition is relevant only after a RCPT command. It checks that the domain
27106 of the recipient address is in the domain list. If percent-hack processing is
27107 enabled, it is done before this test is done. If the check succeeds with a
27108 lookup, the result of the lookup is placed in &$domain_data$& until the next
27109 &%domains%& test.
27110
27111 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27112 use &%domains%& in a DATA ACL.
27113
27114
27115 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27116 .cindex "&%encrypted%& ACL condition"
27117 .cindex "encryption" "checking in an ACL"
27118 .cindex "&ACL;" "testing for encryption"
27119 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27120 name of the cipher suite in use is tested against the list. To test for
27121 encryption without testing for any specific cipher suite(s), set
27122 .code
27123 encrypted = *
27124 .endd
27125
27126
27127 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
27128 .cindex "&%hosts%& ACL condition"
27129 .cindex "host" "ACL checking"
27130 .cindex "&ACL;" "testing the client host"
27131 This condition tests that the calling host matches the host list. If you have
27132 name lookups or wildcarded host names and IP addresses in the same host list,
27133 you should normally put the IP addresses first. For example, you could have:
27134 .code
27135 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27136 .endd
27137 The lookup in this example uses the host name for its key. This is implied by
27138 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27139 and it wouldn't matter which way round you had these two items.)
27140
27141 The reason for the problem with host names lies in the left-to-right way that
27142 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27143 but when it reaches an item that requires a host name, it fails if it cannot
27144 find a host name to compare with the pattern. If the above list is given in the
27145 opposite order, the &%accept%& statement fails for a host whose name cannot be
27146 found, even if its IP address is 10.9.8.7.
27147
27148 If you really do want to do the name check first, and still recognize the IP
27149 address even if the name lookup fails, you can rewrite the ACL like this:
27150 .code
27151 accept hosts = dbm;/etc/friendly/hosts
27152 accept hosts = 10.9.8.7
27153 .endd
27154 The default action on failing to find the host name is to assume that the host
27155 is not in the list, so the first &%accept%& statement fails. The second
27156 statement can then check the IP address.
27157
27158 .vindex "&$host_data$&"
27159 If a &%hosts%& condition is satisfied by means of a lookup, the result
27160 of the lookup is made available in the &$host_data$& variable. This
27161 allows you, for example, to set up a statement like this:
27162 .code
27163 deny  hosts = net-lsearch;/some/file
27164 message = $host_data
27165 .endd
27166 which gives a custom error message for each denied host.
27167
27168 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27169 .cindex "&%local_parts%& ACL condition"
27170 .cindex "local part" "ACL checking"
27171 .cindex "&ACL;" "testing a local part"
27172 .vindex "&$local_part_data$&"
27173 This condition is relevant only after a RCPT command. It checks that the local
27174 part of the recipient address is in the list. If percent-hack processing is
27175 enabled, it is done before this test. If the check succeeds with a lookup, the
27176 result of the lookup is placed in &$local_part_data$&, which remains set until
27177 the next &%local_parts%& test.
27178
27179 .vitem &*malware&~=&~*&<&'option'&>
27180 .cindex "&%malware%& ACL condition"
27181 .cindex "&ACL;" "virus scanning"
27182 .cindex "&ACL;" "scanning for viruses"
27183 This condition is available only when Exim is compiled with the
27184 content-scanning extension. It causes the incoming message to be scanned for
27185 viruses. For details, see chapter &<<CHAPexiscan>>&.
27186
27187 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27188 .cindex "&%mime_regex%& ACL condition"
27189 .cindex "&ACL;" "testing by regex matching"
27190 This condition is available only when Exim is compiled with the
27191 content-scanning extension, and it is allowed only in the ACL defined by
27192 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27193 with any of the regular expressions. For details, see chapter
27194 &<<CHAPexiscan>>&.
27195
27196 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27197 .cindex "rate limiting"
27198 This condition can be used to limit the rate at which a user or host submits
27199 messages. Details are given in section &<<SECTratelimiting>>&.
27200
27201 .vitem &*recipients&~=&~*&<&'address&~list'&>
27202 .cindex "&%recipients%& ACL condition"
27203 .cindex "recipient" "ACL checking"
27204 .cindex "&ACL;" "testing a recipient"
27205 This condition is relevant only after a RCPT command. It checks the entire
27206 recipient address against a list of recipients.
27207
27208 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27209 .cindex "&%regex%& ACL condition"
27210 .cindex "&ACL;" "testing by regex matching"
27211 This condition is available only when Exim is compiled with the
27212 content-scanning extension, and is available only in the DATA, MIME, and
27213 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27214 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27215
27216 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27217 .cindex "&%sender_domains%& ACL condition"
27218 .cindex "sender" "ACL checking"
27219 .cindex "&ACL;" "testing a sender domain"
27220 .vindex "&$domain$&"
27221 .vindex "&$sender_address_domain$&"
27222 This condition tests the domain of the sender of the message against the given
27223 domain list. &*Note*&: The domain of the sender address is in
27224 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27225 of this condition. This is an exception to the general rule for testing domain
27226 lists. It is done this way so that, if this condition is used in an ACL for a
27227 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27228 influence the sender checking.
27229
27230 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27231 relaying, because sender addresses are easily, and commonly, forged.
27232
27233 .vitem &*senders&~=&~*&<&'address&~list'&>
27234 .cindex "&%senders%& ACL condition"
27235 .cindex "sender" "ACL checking"
27236 .cindex "&ACL;" "testing a sender"
27237 This condition tests the sender of the message against the given list. To test
27238 for a bounce message, which has an empty sender, set
27239 .code
27240 senders = :
27241 .endd
27242 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27243 relaying, because sender addresses are easily, and commonly, forged.
27244
27245 .vitem &*spam&~=&~*&<&'username'&>
27246 .cindex "&%spam%& ACL condition"
27247 .cindex "&ACL;" "scanning for spam"
27248 This condition is available only when Exim is compiled with the
27249 content-scanning extension. It causes the incoming message to be scanned by
27250 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27251
27252 .vitem &*verify&~=&~certificate*&
27253 .cindex "&%verify%& ACL condition"
27254 .cindex "TLS" "client certificate verification"
27255 .cindex "certificate" "verification of client"
27256 .cindex "&ACL;" "certificate verification"
27257 .cindex "&ACL;" "testing a TLS certificate"
27258 This condition is true in an SMTP session if the session is encrypted, and a
27259 certificate was received from the client, and the certificate was verified. The
27260 server requests a certificate only if the client matches &%tls_verify_hosts%&
27261 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27262
27263 .vitem &*verify&~=&~csa*&
27264 .cindex "CSA verification"
27265 This condition checks whether the sending host (the client) is authorized to
27266 send email. Details of how this works are given in section
27267 &<<SECTverifyCSA>>&.
27268
27269 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27270 .cindex "&%verify%& ACL condition"
27271 .cindex "&ACL;" "verifying sender in the header"
27272 .cindex "header lines" "verifying the sender in"
27273 .cindex "sender" "verifying in header"
27274 .cindex "verifying" "sender in header"
27275 This condition is relevant only in an ACL that is run after a message has been
27276 received, that is, in an ACL specified by &%acl_smtp_data%& or
27277 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27278 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27279 is loosely thought of as a &"sender"& address (hence the name of the test).
27280 However, an address that appears in one of these headers need not be an address
27281 that accepts bounce messages; only sender addresses in envelopes are required
27282 to accept bounces. Therefore, if you use the callout option on this check, you
27283 might want to arrange for a non-empty address in the MAIL command.
27284
27285 Details of address verification and the options are given later, starting at
27286 section &<<SECTaddressverification>>& (callouts are described in section
27287 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27288 condition to restrict it to bounce messages only:
27289 .code
27290 deny    senders = :
27291         message = A valid sender header is required for bounces
27292        !verify  = header_sender
27293 .endd
27294
27295 .vitem &*verify&~=&~header_syntax*&
27296 .cindex "&%verify%& ACL condition"
27297 .cindex "&ACL;" "verifying header syntax"
27298 .cindex "header lines" "verifying syntax"
27299 .cindex "verifying" "header syntax"
27300 This condition is relevant only in an ACL that is run after a message has been
27301 received, that is, in an ACL specified by &%acl_smtp_data%& or
27302 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27303 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27304 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27305 permitted only in locally generated messages and from hosts that match
27306 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27307 appropriate.
27308
27309 Note that this condition is a syntax check only. However, a common spamming
27310 ploy used to be to send syntactically invalid headers such as
27311 .code
27312 To: @
27313 .endd
27314 and this condition can be used to reject such messages, though they are not as
27315 common as they used to be.
27316
27317 .vitem &*verify&~=&~helo*&
27318 .cindex "&%verify%& ACL condition"
27319 .cindex "&ACL;" "verifying HELO/EHLO"
27320 .cindex "HELO" "verifying"
27321 .cindex "EHLO" "verifying"
27322 .cindex "verifying" "EHLO"
27323 .cindex "verifying" "HELO"
27324 This condition is true if a HELO or EHLO command has been received from the
27325 client host, and its contents have been verified. If there has been no previous
27326 attempt to verify the HELO/EHLO contents, it is carried out when this
27327 condition is encountered. See the description of the &%helo_verify_hosts%& and
27328 &%helo_try_verify_hosts%& options for details of how to request verification
27329 independently of this condition.
27330
27331 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27332 option), this condition is always true.
27333
27334
27335 .vitem &*verify&~=&~not_blind*&
27336 .cindex "verifying" "not blind"
27337 .cindex "bcc recipients, verifying none"
27338 This condition checks that there are no blind (bcc) recipients in the message.
27339 Every envelope recipient must appear either in a &'To:'& header line or in a
27340 &'Cc:'& header line for this condition to be true. Local parts are checked
27341 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27342 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27343 used only in a DATA or non-SMTP ACL.
27344
27345 There are, of course, many legitimate messages that make use of blind (bcc)
27346 recipients. This check should not be used on its own for blocking messages.
27347
27348
27349 .vitem &*verify&~=&~recipient/*&<&'options'&>
27350 .cindex "&%verify%& ACL condition"
27351 .cindex "&ACL;" "verifying recipient"
27352 .cindex "recipient" "verifying"
27353 .cindex "verifying" "recipient"
27354 .vindex "&$address_data$&"
27355 This condition is relevant only after a RCPT command. It verifies the current
27356 recipient. Details of address verification are given later, starting at section
27357 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27358 of &$address_data$& is the last value that was set while routing the address.
27359 This applies even if the verification fails. When an address that is being
27360 verified is redirected to a single address, verification continues with the new
27361 address, and in that case, the subsequent value of &$address_data$& is the
27362 value for the child address.
27363
27364 .vitem &*verify&~=&~reverse_host_lookup*&
27365 .cindex "&%verify%& ACL condition"
27366 .cindex "&ACL;" "verifying host reverse lookup"
27367 .cindex "host" "verifying reverse lookup"
27368 This condition ensures that a verified host name has been looked up from the IP
27369 address of the client host. (This may have happened already if the host name
27370 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27371 Verification ensures that the host name obtained from a reverse DNS lookup, or
27372 one of its aliases, does, when it is itself looked up in the DNS, yield the
27373 original IP address.
27374
27375 If this condition is used for a locally generated message (that is, when there
27376 is no client host involved), it always succeeds.
27377
27378 .vitem &*verify&~=&~sender/*&<&'options'&>
27379 .cindex "&%verify%& ACL condition"
27380 .cindex "&ACL;" "verifying sender"
27381 .cindex "sender" "verifying"
27382 .cindex "verifying" "sender"
27383 This condition is relevant only after a MAIL or RCPT command, or after a
27384 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27385 the message's sender is empty (that is, this is a bounce message), the
27386 condition is true. Otherwise, the sender address is verified.
27387
27388 .vindex "&$address_data$&"
27389 .vindex "&$sender_address_data$&"
27390 If there is data in the &$address_data$& variable at the end of routing, its
27391 value is placed in &$sender_address_data$& at the end of verification. This
27392 value can be used in subsequent conditions and modifiers in the same ACL
27393 statement. It does not persist after the end of the current statement. If you
27394 want to preserve the value for longer, you can save it in an ACL variable.
27395
27396 Details of verification are given later, starting at section
27397 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27398 to avoid doing it more than once per message.
27399
27400 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27401 .cindex "&%verify%& ACL condition"
27402 This is a variation of the previous option, in which a modified address is
27403 verified as a sender.
27404 .endlist
27405
27406
27407
27408 .section "Using DNS lists" "SECTmorednslists"
27409 .cindex "DNS list" "in ACL"
27410 .cindex "black list (DNS)"
27411 .cindex "&ACL;" "testing a DNS list"
27412 In its simplest form, the &%dnslists%& condition tests whether the calling host
27413 is on at least one of a number of DNS lists by looking up the inverted IP
27414 address in one or more DNS domains. (Note that DNS list domains are not mail
27415 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27416 special options instead.) For example, if the calling host's IP
27417 address is 192.168.62.43, and the ACL statement is
27418 .code
27419 deny dnslists = blackholes.mail-abuse.org : \
27420                 dialups.mail-abuse.org
27421 .endd
27422 the following records are looked up:
27423 .code
27424 43.62.168.192.blackholes.mail-abuse.org
27425 43.62.168.192.dialups.mail-abuse.org
27426 .endd
27427 As soon as Exim finds an existing DNS record, processing of the list stops.
27428 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27429 to test that a host is on more than one list (an &"and"& conjunction), you can
27430 use two separate conditions:
27431 .code
27432 deny dnslists = blackholes.mail-abuse.org
27433      dnslists = dialups.mail-abuse.org
27434 .endd
27435 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27436 behaves as if the host does not match the list item, that is, as if the DNS
27437 record does not exist. If there are further items in the DNS list, they are
27438 processed.
27439
27440 This is usually the required action when &%dnslists%& is used with &%deny%&
27441 (which is the most common usage), because it prevents a DNS failure from
27442 blocking mail. However, you can change this behaviour by putting one of the
27443 following special items in the list:
27444 .display
27445 &`+include_unknown `&   behave as if the item is on the list
27446 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27447 &`+defer_unknown   `&   give a temporary error
27448 .endd
27449 .cindex "&`+include_unknown`&"
27450 .cindex "&`+exclude_unknown`&"
27451 .cindex "&`+defer_unknown`&"
27452 Each of these applies to any subsequent items on the list. For example:
27453 .code
27454 deny dnslists = +defer_unknown : foo.bar.example
27455 .endd
27456 Testing the list of domains stops as soon as a match is found. If you want to
27457 warn for one list and block for another, you can use two different statements:
27458 .code
27459 deny  dnslists = blackholes.mail-abuse.org
27460 warn  message  = X-Warn: sending host is on dialups list
27461       dnslists = dialups.mail-abuse.org
27462 .endd
27463 DNS list lookups are cached by Exim for the duration of the SMTP session,
27464 so a lookup based on the IP address is done at most once for any incoming
27465 connection. Exim does not share information between multiple incoming
27466 connections (but your local name server cache should be active).
27467
27468
27469
27470 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27471 .cindex "DNS list" "keyed by explicit IP address"
27472 By default, the IP address that is used in a DNS list lookup is the IP address
27473 of the calling host. However, you can specify another IP address by listing it
27474 after the domain name, introduced by a slash. For example:
27475 .code
27476 deny dnslists = black.list.tld/192.168.1.2
27477 .endd
27478 This feature is not very helpful with explicit IP addresses; it is intended for
27479 use with IP addresses that are looked up, for example, the IP addresses of the
27480 MX hosts or nameservers of an email sender address. For an example, see section
27481 &<<SECTmulkeyfor>>& below.
27482
27483
27484
27485
27486 .section "DNS lists keyed on domain names" "SECID202"
27487 .cindex "DNS list" "keyed by domain name"
27488 There are some lists that are keyed on domain names rather than inverted IP
27489 addresses (see for example the &'domain based zones'& link at
27490 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27491 with these lists. You can change the name that is looked up in a DNS list by
27492 listing it after the domain name, introduced by a slash. For example,
27493 .code
27494 deny  message  = Sender's domain is listed at $dnslist_domain
27495       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27496 .endd
27497 This particular example is useful only in ACLs that are obeyed after the
27498 RCPT or DATA commands, when a sender address is available. If (for
27499 example) the message's sender is &'user@tld.example'& the name that is looked
27500 up by this example is
27501 .code
27502 tld.example.dsn.rfc-ignorant.org
27503 .endd
27504 A single &%dnslists%& condition can contain entries for both names and IP
27505 addresses. For example:
27506 .code
27507 deny dnslists = sbl.spamhaus.org : \
27508                 dsn.rfc-ignorant.org/$sender_address_domain
27509 .endd
27510 The first item checks the sending host's IP address; the second checks a domain
27511 name. The whole condition is true if either of the DNS lookups succeeds.
27512
27513
27514
27515
27516 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27517 .cindex "DNS list" "multiple keys for"
27518 The syntax described above for looking up explicitly-defined values (either
27519 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27520 name for the DNS list, what follows the slash can in fact be a list of items.
27521 As with all lists in Exim, the default separator is a colon. However, because
27522 this is a sublist within the list of DNS blacklist domains, it is necessary
27523 either to double the separators like this:
27524 .code
27525 dnslists = black.list.tld/name.1::name.2
27526 .endd
27527 or to change the separator character, like this:
27528 .code
27529 dnslists = black.list.tld/<;name.1;name.2
27530 .endd
27531 If an item in the list is an IP address, it is inverted before the DNS
27532 blacklist domain is appended. If it is not an IP address, no inversion
27533 occurs. Consider this condition:
27534 .code
27535 dnslists = black.list.tld/<;192.168.1.2;a.domain
27536 .endd
27537 The DNS lookups that occur are:
27538 .code
27539 2.1.168.192.black.list.tld
27540 a.domain.black.list.tld
27541 .endd
27542 Once a DNS record has been found (that matches a specific IP return
27543 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27544 are done. If there is a temporary DNS error, the rest of the sublist of domains
27545 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27546 only if no other DNS lookup in this sublist succeeds. In other words, a
27547 successful lookup for any of the items in the sublist overrides a temporary
27548 error for a previous item.
27549
27550 The ability to supply a list of items after the slash is in some sense just a
27551 syntactic convenience. These two examples have the same effect:
27552 .code
27553 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
27554 dnslists = black.list.tld/a.domain::b.domain
27555 .endd
27556 However, when the data for the list is obtained from a lookup, the second form
27557 is usually much more convenient. Consider this example:
27558 .code
27559 deny message  = The mail servers for the domain \
27560                 $sender_address_domain \
27561                 are listed at $dnslist_domain ($dnslist_value); \
27562                 see $dnslist_text.
27563      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
27564                                    ${lookup dnsdb {>|mxh=\
27565                                    $sender_address_domain} }} }
27566 .endd
27567 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
27568 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
27569 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
27570 of expanding the condition might be something like this:
27571 .code
27572 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
27573 .endd
27574 Thus, this example checks whether or not the IP addresses of the sender
27575 domain's mail servers are on the Spamhaus black list.
27576
27577 The key that was used for a successful DNS list lookup is put into the variable
27578 &$dnslist_matched$& (see section &<<SECID204>>&).
27579
27580
27581
27582
27583 .section "Data returned by DNS lists" "SECID203"
27584 .cindex "DNS list" "data returned from"
27585 DNS lists are constructed using address records in the DNS. The original RBL
27586 just used the address 127.0.0.1 on the right hand side of each record, but the
27587 RBL+ list and some other lists use a number of values with different meanings.
27588 The values used on the RBL+ list are:
27589 .display
27590 127.1.0.1  RBL
27591 127.1.0.2  DUL
27592 127.1.0.3  DUL and RBL
27593 127.1.0.4  RSS
27594 127.1.0.5  RSS and RBL
27595 127.1.0.6  RSS and DUL
27596 127.1.0.7  RSS and DUL and RBL
27597 .endd
27598 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
27599 different values. Some DNS lists may return more than one address record;
27600 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
27601
27602
27603 .section "Variables set from DNS lists" "SECID204"
27604 .cindex "expansion" "variables, set from DNS list"
27605 .cindex "DNS list" "variables set from"
27606 .vindex "&$dnslist_domain$&"
27607 .vindex "&$dnslist_matched$&"
27608 .vindex "&$dnslist_text$&"
27609 .vindex "&$dnslist_value$&"
27610 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
27611 the name of the overall domain that matched (for example,
27612 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
27613 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
27614 the DNS record. When the key is an IP address, it is not reversed in
27615 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
27616 cases, for example:
27617 .code
27618 deny dnslists = spamhaus.example
27619 .endd
27620 the key is also available in another variable (in this case,
27621 &$sender_host_address$&). In more complicated cases, however, this is not true.
27622 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
27623 might generate a dnslists lookup like this:
27624 .code
27625 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
27626 .endd
27627 If this condition succeeds, the value in &$dnslist_matched$& might be
27628 &`192.168.6.7`& (for example).
27629
27630 If more than one address record is returned by the DNS lookup, all the IP
27631 addresses are included in &$dnslist_value$&, separated by commas and spaces.
27632 The variable &$dnslist_text$& contains the contents of any associated TXT
27633 record. For lists such as RBL+ the TXT record for a merged entry is often not
27634 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
27635 information.
27636
27637 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
27638 &-- although these appear before the condition in the ACL, they are not
27639 expanded until after it has failed. For example:
27640 .code
27641 deny    hosts = !+local_networks
27642         message = $sender_host_address is listed \
27643                   at $dnslist_domain
27644         dnslists = rbl-plus.mail-abuse.example
27645 .endd
27646
27647
27648
27649 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
27650 .cindex "DNS list" "matching specific returned data"
27651 You can add an equals sign and an IP address after a &%dnslists%& domain name
27652 in order to restrict its action to DNS records with a matching right hand side.
27653 For example,
27654 .code
27655 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
27656 .endd
27657 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27658 any address record is considered to be a match. For the moment, we assume
27659 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27660 describes how multiple records are handled.
27661
27662 More than one IP address may be given for checking, using a comma as a
27663 separator. These are alternatives &-- if any one of them matches, the
27664 &%dnslists%& condition is true. For example:
27665 .code
27666 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27667 .endd
27668 If you want to specify a constraining address list and also specify names or IP
27669 addresses to be looked up, the constraining address list must be specified
27670 first. For example:
27671 .code
27672 deny dnslists = dsn.rfc-ignorant.org\
27673                 =127.0.0.2/$sender_address_domain
27674 .endd
27675
27676 If the character &`&&`& is used instead of &`=`&, the comparison for each
27677 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27678 In other words, the listed addresses are used as bit masks. The comparison is
27679 true if all the bits in the mask are present in the address that is being
27680 tested. For example:
27681 .code
27682 dnslists = a.b.c&0.0.0.3
27683 .endd
27684 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27685 want to test whether one bit or another bit is present (as opposed to both
27686 being present), you must use multiple values. For example:
27687 .code
27688 dnslists = a.b.c&0.0.0.1,0.0.0.2
27689 .endd
27690 matches if the final component of the address is an odd number or two times
27691 an odd number.
27692
27693
27694
27695 .section "Negated DNS matching conditions" "SECID205"
27696 You can supply a negative list of IP addresses as part of a &%dnslists%&
27697 condition. Whereas
27698 .code
27699 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27700 .endd
27701 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27702 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27703 .code
27704 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27705 .endd
27706 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27707 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27708 words, the result of the test is inverted if an exclamation mark appears before
27709 the &`=`& (or the &`&&`&) sign.
27710
27711 &*Note*&: This kind of negation is not the same as negation in a domain,
27712 host, or address list (which is why the syntax is different).
27713
27714 If you are using just one list, the negation syntax does not gain you much. The
27715 previous example is precisely equivalent to
27716 .code
27717 deny  dnslists = a.b.c
27718      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27719 .endd
27720 However, if you are using multiple lists, the negation syntax is clearer.
27721 Consider this example:
27722 .code
27723 deny  dnslists = sbl.spamhaus.org : \
27724                  list.dsbl.org : \
27725                  dnsbl.njabl.org!=127.0.0.3 : \
27726                  relays.ordb.org
27727 .endd
27728 Using only positive lists, this would have to be:
27729 .code
27730 deny  dnslists = sbl.spamhaus.org : \
27731                  list.dsbl.org
27732 deny  dnslists = dnsbl.njabl.org
27733      !dnslists = dnsbl.njabl.org=127.0.0.3
27734 deny  dnslists = relays.ordb.org
27735 .endd
27736 which is less clear, and harder to maintain.
27737
27738
27739
27740
27741 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27742 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27743 thereby providing more than one IP address. When an item in a &%dnslists%& list
27744 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27745 the match to specific results from the DNS lookup, there are two ways in which
27746 the checking can be handled. For example, consider the condition:
27747 .code
27748 dnslists = a.b.c=127.0.0.1
27749 .endd
27750 What happens if the DNS lookup for the incoming IP address yields both
27751 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27752 condition true because at least one given value was found, or is it false
27753 because at least one of the found values was not listed? And how does this
27754 affect negated conditions? Both possibilities are provided for with the help of
27755 additional separators &`==`& and &`=&&`&.
27756
27757 .ilist
27758 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27759 IP addresses matches one of the listed addresses. For the example above, the
27760 condition is true because 127.0.0.1 matches.
27761 .next
27762 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27763 looked up IP addresses matches one of the listed addresses. If the condition is
27764 changed to:
27765 .code
27766 dnslists = a.b.c==127.0.0.1
27767 .endd
27768 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27769 false because 127.0.0.2 is not listed. You would need to have:
27770 .code
27771 dnslists = a.b.c==127.0.0.1,127.0.0.2
27772 .endd
27773 for the condition to be true.
27774 .endlist
27775
27776 When &`!`& is used to negate IP address matching, it inverts the result, giving
27777 the precise opposite of the behaviour above. Thus:
27778 .ilist
27779 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27780 addresses matches one of the listed addresses. Consider:
27781 .code
27782 dnslists = a.b.c!&0.0.0.1
27783 .endd
27784 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27785 false because 127.0.0.1 matches.
27786 .next
27787 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27788 looked up IP address that does not match. Consider:
27789 .code
27790 dnslists = a.b.c!=&0.0.0.1
27791 .endd
27792 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27793 true, because 127.0.0.2 does not match. You would need to have:
27794 .code
27795 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27796 .endd
27797 for the condition to be false.
27798 .endlist
27799 When the DNS lookup yields only a single IP address, there is no difference
27800 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27801
27802
27803
27804
27805 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27806 .cindex "DNS list" "information from merged"
27807 When the facility for restricting the matching IP values in a DNS list is used,
27808 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27809 the true reason for rejection. This happens when lists are merged and the IP
27810 address in the A record is used to distinguish them; unfortunately there is
27811 only one TXT record. One way round this is not to use merged lists, but that
27812 can be inefficient because it requires multiple DNS lookups where one would do
27813 in the vast majority of cases when the host of interest is not on any of the
27814 lists.
27815
27816 A less inefficient way of solving this problem is available. If
27817 two domain names, comma-separated, are given, the second is used first to
27818 do an initial check, making use of any IP value restrictions that are set.
27819 If there is a match, the first domain is used, without any IP value
27820 restrictions, to get the TXT record. As a byproduct of this, there is also
27821 a check that the IP being tested is indeed on the first list. The first
27822 domain is the one that is put in &$dnslist_domain$&. For example:
27823 .code
27824 reject message  = \
27825          rejected because $sender_host_address is blacklisted \
27826          at $dnslist_domain\n$dnslist_text
27827        dnslists = \
27828          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27829          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27830 .endd
27831 For the first blacklist item, this starts by doing a lookup in
27832 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27833 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27834 value, and as long as something is found, it looks for the corresponding TXT
27835 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27836 The second blacklist item is processed similarly.
27837
27838 If you are interested in more than one merged list, the same list must be
27839 given several times, but because the results of the DNS lookups are cached,
27840 the DNS calls themselves are not repeated. For example:
27841 .code
27842 reject dnslists = \
27843          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27844          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27845          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27846          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27847 .endd
27848 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27849 values matches (or if no record is found), this is the only lookup that is
27850 done. Only if there is a match is one of the more specific lists consulted.
27851
27852
27853
27854 .section "DNS lists and IPv6" "SECTmorednslistslast"
27855 .cindex "IPv6" "DNS black lists"
27856 .cindex "DNS list" "IPv6 usage"
27857 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27858 nibble by nibble. For example, if the calling host's IP address is
27859 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27860 .code
27861 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27862   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27863 .endd
27864 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27865 lists contain wildcard records, intended for IPv4, that interact badly with
27866 IPv6. For example, the DNS entry
27867 .code
27868 *.3.some.list.example.    A    127.0.0.1
27869 .endd
27870 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27871 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27872
27873 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27874 &%condition%& condition, as in this example:
27875 .code
27876 deny   condition = ${if isip4{$sender_host_address}}
27877        dnslists  = some.list.example
27878 .endd
27879
27880 .section "Rate limiting incoming messages" "SECTratelimiting"
27881 .cindex "rate limiting" "client sending"
27882 .cindex "limiting client sending rates"
27883 .oindex "&%smtp_ratelimit_*%&"
27884 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27885 which clients can send email. This is more powerful than the
27886 &%smtp_ratelimit_*%& options, because those options control the rate of
27887 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27888 works across all connections (concurrent and sequential) from the same client
27889 host. The syntax of the &%ratelimit%& condition is:
27890 .display
27891 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27892 .endd
27893 If the average client sending rate is less than &'m'& messages per time
27894 period &'p'& then the condition is false; otherwise it is true.
27895
27896 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27897 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27898 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27899 of &'p'&.
27900
27901 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27902 time interval, for example, &`8h`& for eight hours. A larger time constant
27903 means that it takes Exim longer to forget a client's past behaviour. The
27904 parameter &'m'& is the maximum number of messages that a client is permitted to
27905 send in each time interval. It also specifies the number of messages permitted
27906 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27907 constant, you can allow a client to send more messages in a burst without
27908 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27909 both small, messages must be sent at an even rate.
27910
27911 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27912 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27913 when deploying the &%ratelimit%& ACL condition. The script prints usage
27914 instructions when it is run with no arguments.
27915
27916 The key is used to look up the data for calculating the client's average
27917 sending rate. This data is stored in Exim's spool directory, alongside the
27918 retry and other hints databases. The default key is &$sender_host_address$&,
27919 which means Exim computes the sending rate of each client host IP address.
27920 By changing the key you can change how Exim identifies clients for the purpose
27921 of ratelimiting. For example, to limit the sending rate of each authenticated
27922 user, independent of the computer they are sending from, set the key to
27923 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27924 example, &$authenticated_id$& is only meaningful if the client has
27925 authenticated (which you can check with the &%authenticated%& ACL condition).
27926
27927 The lookup key does not have to identify clients: If you want to limit the
27928 rate at which a recipient receives messages, you can use the key
27929 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27930 ACL.
27931
27932 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
27933 specifies what Exim measures the rate of, for example messages or recipients
27934 or bytes. You can adjust the measurement using the &%unique=%& and/or
27935 &%count=%& options. You can also control when Exim updates the recorded rate
27936 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
27937 separated by a slash, like the other parameters. They may appear in any order.
27938
27939 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
27940 any options that alter the meaning of the stored data. The limit &'m'& is not
27941 stored, so you can alter the configured maximum rate and Exim will still
27942 remember clients' past behaviour. If you change the &%per_*%& mode or add or
27943 remove the &%unique=%& option, the lookup key changes so Exim will forget past
27944 behaviour. The lookup key is not affected by changes to the update mode and
27945 the &%count=%& option.
27946
27947
27948 .section "Ratelimit options for what is being measured" "ratoptmea"
27949 .cindex "rate limiting" "per_* options"
27950 The &%per_conn%& option limits the client's connection rate. It is not
27951 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
27952 &%acl_not_smtp_start%& ACLs.
27953
27954 The &%per_mail%& option limits the client's rate of sending messages. This is
27955 the default if none of the &%per_*%& options is specified. It can be used in
27956 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
27957 &%acl_smtp_data%&, or &%acl_not_smtp%&.
27958
27959 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
27960 the same ACLs as the &%per_mail%& option, though it is best to use this option
27961 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
27962 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
27963 in its MAIL command, which may be inaccurate or completely missing. You can
27964 follow the limit &'m'& in the configuration with K, M, or G to specify limits
27965 in kilobytes, megabytes, or gigabytes, respectively.
27966
27967 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
27968 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27969 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
27970 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
27971 ACLs the rate is updated with the total recipient count in one go. Note that
27972 in either case the rate limiting engine will see a message with many
27973 recipients as a large high-speed burst.
27974
27975 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
27976 number of different recipients that the client has sent messages to in the
27977 last time period. That is, if the client repeatedly sends messages to the same
27978 recipient, its measured rate is not increased. This option can only be used in
27979 &%acl_smtp_rcpt%&.
27980
27981 The &%per_cmd%& option causes Exim to recompute the rate every time the
27982 condition is processed. This can be used to limit the rate of any SMTP
27983 command. If it is used in multiple ACLs it can limit the aggregate rate of
27984 multiple different commands.
27985
27986 The &%count=%& option can be used to alter how much Exim adds to the client's
27987 measured rate. For example, the &%per_byte%& option is equivalent to
27988 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
27989 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
27990 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
27991
27992 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
27993
27994
27995 .section "Ratelimit update modes" "ratoptupd"
27996 .cindex "rate limiting" "reading data without updating"
27997 You can specify one of three options with the &%ratelimit%& condition to
27998 control when its database is updated. This section describes the &%readonly%&
27999 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28000
28001 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28002 previously-computed rate to check against the limit.
28003
28004 For example, you can test the client's sending rate and deny it access (when
28005 it is too fast) in the connect ACL. If the client passes this check then it
28006 can go on to send a message, in which case its recorded rate will be updated
28007 in the MAIL ACL. Subsequent connections from the same client will check this
28008 new rate.
28009 .code
28010 acl_check_connect:
28011  deny ratelimit = 100 / 5m / readonly
28012     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28013                   (max $sender_rate_limit)
28014 # ...
28015 acl_check_mail:
28016  warn ratelimit = 100 / 5m / strict
28017     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28018                   (max $sender_rate_limit)
28019 .endd
28020
28021 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28022 processing a message then it may increase the client's measured rate more than
28023 it should. For example, this will happen if you check the &%per_rcpt%& option
28024 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28025 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28026 multiple update problems by using the &%readonly%& option on later ratelimit
28027 checks.
28028
28029 The &%per_*%& options described above do not make sense in some ACLs. If you
28030 use a &%per_*%& option in an ACL where it is not normally permitted then the
28031 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28032 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28033 next section) so you must specify the &%readonly%& option explicitly.
28034
28035
28036 .section "Ratelimit options for handling fast clients" "ratoptfast"
28037 .cindex "rate limiting" "strict and leaky modes"
28038 If a client's average rate is greater than the maximum, the rate limiting
28039 engine can react in two possible ways, depending on the presence of the
28040 &%strict%& or &%leaky%& update modes. This is independent of the other
28041 counter-measures (such as rejecting the message) that may be specified by the
28042 rest of the ACL.
28043
28044 The &%leaky%& (default) option means that the client's recorded rate is not
28045 updated if it is above the limit. The effect of this is that Exim measures the
28046 client's average rate of successfully sent email, which cannot be greater than
28047 the maximum allowed. If the client is over the limit it may suffer some
28048 counter-measures (as specified in the ACL), but it will still be able to send
28049 email at the configured maximum rate, whatever the rate of its attempts. This
28050 is generally the better choice if you have clients that retry automatically.
28051 For example, it does not prevent a sender with an over-aggressive retry rate
28052 from getting any email through.
28053
28054 The &%strict%& option means that the client's recorded rate is always
28055 updated. The effect of this is that Exim measures the client's average rate
28056 of attempts to send email, which can be much higher than the maximum it is
28057 actually allowed. If the client is over the limit it may be subjected to
28058 counter-measures by the ACL. It must slow down and allow sufficient time to
28059 pass that its computed rate falls below the maximum before it can send email
28060 again. The time (the number of smoothing periods) it must wait and not
28061 attempt to send mail can be calculated with this formula:
28062 .code
28063         ln(peakrate/maxrate)
28064 .endd
28065
28066
28067 .section "Limiting the rate of different events" "ratoptuniq"
28068 .cindex "rate limiting" "counting unique events"
28069 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28070 rate of different events. For example, the &%per_addr%& option uses this
28071 mechanism to count the number of different recipients that the client has
28072 sent messages to in the last time period; it is equivalent to
28073 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28074 measure the rate that a client uses different sender addresses with the
28075 options &`per_mail/unique=$sender_address`&.
28076
28077 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28078 has seen for that key. The whole set is thrown away when it is older than the
28079 rate smoothing period &'p'&, so each different event is counted at most once
28080 per period. In the &%leaky%& update mode, an event that causes the client to
28081 go over the limit is not added to the set, in the same way that the client's
28082 recorded rate is not updated in the same situation.
28083
28084 When you combine the &%unique=%& and &%readonly%& options, the specific
28085 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28086 rate.
28087
28088 The &%unique=%& mechanism needs more space in the ratelimit database than the
28089 other &%ratelimit%& options in order to store the event set. The number of
28090 unique values is potentially as large as the rate limit, so the extra space
28091 required increases with larger limits.
28092
28093 The uniqueification is not perfect: there is a small probability that Exim
28094 will think a new event has happened before. If the sender's rate is less than
28095 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28096 the measured rate can go above the limit, in which case Exim may under-count
28097 events by a significant margin. Fortunately, if the rate is high enough (2.7
28098 times the limit) that the false positive rate goes above 9%, then Exim will
28099 throw away the over-full event set before the measured rate falls below the
28100 limit. Therefore the only harm should be that exceptionally high sending rates
28101 are logged incorrectly; any countermeasures you configure will be as effective
28102 as intended.
28103
28104
28105 .section "Using rate limiting" "useratlim"
28106 Exim's other ACL facilities are used to define what counter-measures are taken
28107 when the rate limit is exceeded. This might be anything from logging a warning
28108 (for example, while measuring existing sending rates in order to define
28109 policy), through time delays to slow down fast senders, up to rejecting the
28110 message. For example:
28111 .code
28112 # Log all senders' rates
28113 warn ratelimit = 0 / 1h / strict
28114      log_message = Sender rate $sender_rate / $sender_rate_period
28115
28116 # Slow down fast senders; note the need to truncate $sender_rate
28117 # at the decimal point.
28118 warn ratelimit = 100 / 1h / per_rcpt / strict
28119      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28120                    $sender_rate_limit }s
28121
28122 # Keep authenticated users under control
28123 deny authenticated = *
28124      ratelimit = 100 / 1d / strict / $authenticated_id
28125
28126 # System-wide rate limit
28127 defer message = Sorry, too busy. Try again later.
28128      ratelimit = 10 / 1s / $primary_hostname
28129
28130 # Restrict incoming rate from each host, with a default
28131 # set using a macro and special cases looked up in a table.
28132 defer message = Sender rate exceeds $sender_rate_limit \
28133                messages per $sender_rate_period
28134      ratelimit = ${lookup {$sender_host_address} \
28135                    cdb {DB/ratelimits.cdb} \
28136                    {$value} {RATELIMIT} }
28137 .endd
28138 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28139 especially with the &%per_rcpt%& option, you may suffer from a performance
28140 bottleneck caused by locking on the ratelimit hints database. Apart from
28141 making your ACLs less complicated, you can reduce the problem by using a
28142 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28143 this means that Exim will lose its hints data after a reboot (including retry
28144 hints, the callout cache, and ratelimit data).
28145
28146
28147
28148 .section "Address verification" "SECTaddressverification"
28149 .cindex "verifying address" "options for"
28150 .cindex "policy control" "address verification"
28151 Several of the &%verify%& conditions described in section
28152 &<<SECTaclconditions>>& cause addresses to be verified. Section
28153 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28154 The verification conditions can be followed by options that modify the
28155 verification process. The options are separated from the keyword and from each
28156 other by slashes, and some of them contain parameters. For example:
28157 .code
28158 verify = sender/callout
28159 verify = recipient/defer_ok/callout=10s,defer_ok
28160 .endd
28161 The first stage of address verification, which always happens, is to run the
28162 address through the routers, in &"verify mode"&. Routers can detect the
28163 difference between verification and routing for delivery, and their actions can
28164 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28165 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28166 The available options are as follows:
28167
28168 .ilist
28169 If the &%callout%& option is specified, successful routing to one or more
28170 remote hosts is followed by a &"callout"& to those hosts as an additional
28171 check. Callouts and their sub-options are discussed in the next section.
28172 .next
28173 If there is a defer error while doing verification routing, the ACL
28174 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28175 options, the condition is forced to be true instead. Note that this is a main
28176 verification option as well as a suboption for callouts.
28177 .next
28178 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28179 discusses the reporting of sender address verification failures.
28180 .next
28181 The &%success_on_redirect%& option causes verification always to succeed
28182 immediately after a successful redirection. By default, if a redirection
28183 generates just one address, that address is also verified. See further
28184 discussion in section &<<SECTredirwhilveri>>&.
28185 .endlist
28186
28187 .cindex "verifying address" "differentiating failures"
28188 .vindex "&$recipient_verify_failure$&"
28189 .vindex "&$sender_verify_failure$&"
28190 .vindex "&$acl_verify_message$&"
28191 After an address verification failure, &$acl_verify_message$& contains the
28192 error message that is associated with the failure. It can be preserved by
28193 coding like this:
28194 .code
28195 warn  !verify = sender
28196        set acl_m0 = $acl_verify_message
28197 .endd
28198 If you are writing your own custom rejection message or log message when
28199 denying access, you can use this variable to include information about the
28200 verification failure.
28201
28202 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28203 appropriate) contains one of the following words:
28204
28205 .ilist
28206 &%qualify%&: The address was unqualified (no domain), and the message
28207 was neither local nor came from an exempted host.
28208 .next
28209 &%route%&: Routing failed.
28210 .next
28211 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28212 occurred at or before the MAIL command (that is, on initial
28213 connection, HELO, or MAIL).
28214 .next
28215 &%recipient%&: The RCPT command in a callout was rejected.
28216 .next
28217 &%postmaster%&: The postmaster check in a callout was rejected.
28218 .endlist
28219
28220 The main use of these variables is expected to be to distinguish between
28221 rejections of MAIL and rejections of RCPT in callouts.
28222
28223
28224
28225
28226 .section "Callout verification" "SECTcallver"
28227 .cindex "verifying address" "by callout"
28228 .cindex "callout" "verification"
28229 .cindex "SMTP" "callout verification"
28230 For non-local addresses, routing verifies the domain, but is unable to do any
28231 checking of the local part. There are situations where some means of verifying
28232 the local part is desirable. One way this can be done is to make an SMTP
28233 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28234 a subsequent host for a recipient address, to see if the host accepts the
28235 address. We use the term &'callout'& to cover both cases. Note that for a
28236 sender address, the callback is not to the client host that is trying to
28237 deliver the message, but to one of the hosts that accepts incoming mail for the
28238 sender's domain.
28239
28240 Exim does not do callouts by default. If you want them to happen, you must
28241 request them by setting appropriate options on the &%verify%& condition, as
28242 described below. This facility should be used with care, because it can add a
28243 lot of resource usage to the cost of verifying an address. However, Exim does
28244 cache the results of callouts, which helps to reduce the cost. Details of
28245 caching are in section &<<SECTcallvercache>>&.
28246
28247 Recipient callouts are usually used only between hosts that are controlled by
28248 the same administration. For example, a corporate gateway host could use
28249 callouts to check for valid recipients on an internal mailserver. A successful
28250 callout does not guarantee that a real delivery to the address would succeed;
28251 on the other hand, a failing callout does guarantee that a delivery would fail.
28252
28253 If the &%callout%& option is present on a condition that verifies an address, a
28254 second stage of verification occurs if the address is successfully routed to
28255 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28256 &(manualroute)& router, where the router specifies the hosts. However, if a
28257 router that does not set up hosts routes to an &(smtp)& transport with a
28258 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28259 &%hosts_override%& set, its hosts are always used, whether or not the router
28260 supplies a host list.
28261
28262 The port that is used is taken from the transport, if it is specified and is a
28263 remote transport. (For routers that do verification only, no transport need be
28264 specified.) Otherwise, the default SMTP port is used. If a remote transport
28265 specifies an outgoing interface, this is used; otherwise the interface is not
28266 specified. Likewise, the text that is used for the HELO command is taken from
28267 the transport's &%helo_data%& option; if there is no transport, the value of
28268 &$smtp_active_hostname$& is used.
28269
28270 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28271 test whether a bounce message could be delivered to the sender address. The
28272 following SMTP commands are sent:
28273 .display
28274 &`HELO `&<&'local host name'&>
28275 &`MAIL FROM:<>`&
28276 &`RCPT TO:`&<&'the address to be tested'&>
28277 &`QUIT`&
28278 .endd
28279 LHLO is used instead of HELO if the transport's &%protocol%& option is
28280 set to &"lmtp"&.
28281
28282 A recipient callout check is similar. By default, it also uses an empty address
28283 for the sender. This default is chosen because most hosts do not make use of
28284 the sender address when verifying a recipient. Using the same address means
28285 that a single cache entry can be used for each recipient. Some sites, however,
28286 do make use of the sender address when verifying. These are catered for by the
28287 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28288
28289 If the response to the RCPT command is a 2&'xx'& code, the verification
28290 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28291 Exim tries the next host, if any. If there is a problem with all the remote
28292 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28293 &%callout%& option is given, in which case the condition is forced to succeed.
28294
28295 .cindex "SMTP" "output flushing, disabling for callout"
28296 A callout may take a little time. For this reason, Exim normally flushes SMTP
28297 output before performing a callout in an ACL, to avoid unexpected timeouts in
28298 clients when the SMTP PIPELINING extension is in use. The flushing can be
28299 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28300
28301
28302
28303
28304 .section "Additional parameters for callouts" "CALLaddparcall"
28305 .cindex "callout" "additional parameters for"
28306 The &%callout%& option can be followed by an equals sign and a number of
28307 optional parameters, separated by commas. For example:
28308 .code
28309 verify = recipient/callout=10s,defer_ok
28310 .endd
28311 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28312 separate verify options, is retained for backwards compatibility, but is now
28313 deprecated. The additional parameters for &%callout%& are as follows:
28314
28315
28316 .vlist
28317 .vitem <&'a&~time&~interval'&>
28318 .cindex "callout" "timeout, specifying"
28319 This specifies the timeout that applies for the callout attempt to each host.
28320 For example:
28321 .code
28322 verify = sender/callout=5s
28323 .endd
28324 The default is 30 seconds. The timeout is used for each response from the
28325 remote host. It is also used for the initial connection, unless overridden by
28326 the &%connect%& parameter.
28327
28328
28329 .vitem &*connect&~=&~*&<&'time&~interval'&>
28330 .cindex "callout" "connection timeout, specifying"
28331 This parameter makes it possible to set a different (usually smaller) timeout
28332 for making the SMTP connection. For example:
28333 .code
28334 verify = sender/callout=5s,connect=1s
28335 .endd
28336 If not specified, this timeout defaults to the general timeout value.
28337
28338 .vitem &*defer_ok*&
28339 .cindex "callout" "defer, action on"
28340 When this parameter is present, failure to contact any host, or any other kind
28341 of temporary error, is treated as success by the ACL. However, the cache is not
28342 updated in this circumstance.
28343
28344 .vitem &*fullpostmaster*&
28345 .cindex "callout" "full postmaster check"
28346 This operates like the &%postmaster%& option (see below), but if the check for
28347 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28348 accordance with the specification in RFC 2821. The RFC states that the
28349 unqualified address &'postmaster'& should be accepted.
28350
28351
28352 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28353 .cindex "callout" "sender when verifying header"
28354 When verifying addresses in header lines using the &%header_sender%&
28355 verification option, Exim behaves by default as if the addresses are envelope
28356 sender addresses from a message. Callout verification therefore tests to see
28357 whether a bounce message could be delivered, by using an empty address in the
28358 MAIL command. However, it is arguable that these addresses might never be used
28359 as envelope senders, and could therefore justifiably reject bounce messages
28360 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28361 address to use in the MAIL command. For example:
28362 .code
28363 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28364 .endd
28365 This parameter is available only for the &%header_sender%& verification option.
28366
28367
28368 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28369 .cindex "callout" "overall timeout, specifying"
28370 This parameter sets an overall timeout for performing a callout verification.
28371 For example:
28372 .code
28373 verify = sender/callout=5s,maxwait=30s
28374 .endd
28375 This timeout defaults to four times the callout timeout for individual SMTP
28376 commands. The overall timeout applies when there is more than one host that can
28377 be tried. The timeout is checked before trying the next host. This prevents
28378 very long delays if there are a large number of hosts and all are timing out
28379 (for example, when network connections are timing out).
28380
28381
28382 .vitem &*no_cache*&
28383 .cindex "callout" "cache, suppressing"
28384 .cindex "caching callout, suppressing"
28385 When this parameter is given, the callout cache is neither read nor updated.
28386
28387 .vitem &*postmaster*&
28388 .cindex "callout" "postmaster; checking"
28389 When this parameter is set, a successful callout check is followed by a similar
28390 check for the local part &'postmaster'& at the same domain. If this address is
28391 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28392 the postmaster check is recorded in a cache record; if it is a failure, this is
28393 used to fail subsequent callouts for the domain without a connection being
28394 made, until the cache record expires.
28395
28396 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28397 The postmaster check uses an empty sender in the MAIL command by default.
28398 You can use this parameter to do a postmaster check using a different address.
28399 For example:
28400 .code
28401 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28402 .endd
28403 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28404 one overrides. The &%postmaster%& parameter is equivalent to this example:
28405 .code
28406 require  verify = sender/callout=postmaster_mailfrom=
28407 .endd
28408 &*Warning*&: The caching arrangements for postmaster checking do not take
28409 account of the sender address. It is assumed that either the empty address or
28410 a fixed non-empty address will be used. All that Exim remembers is that the
28411 postmaster check for the domain succeeded or failed.
28412
28413
28414 .vitem &*random*&
28415 .cindex "callout" "&""random""& check"
28416 When this parameter is set, before doing the normal callout check, Exim does a
28417 check for a &"random"& local part at the same domain. The local part is not
28418 really random &-- it is defined by the expansion of the option
28419 &%callout_random_local_part%&, which defaults to
28420 .code
28421 $primary_hostname-$tod_epoch-testing
28422 .endd
28423 The idea here is to try to determine whether the remote host accepts all local
28424 parts without checking. If it does, there is no point in doing callouts for
28425 specific local parts. If the &"random"& check succeeds, the result is saved in
28426 a cache record, and used to force the current and subsequent callout checks to
28427 succeed without a connection being made, until the cache record expires.
28428
28429 .vitem &*use_postmaster*&
28430 .cindex "callout" "sender for recipient check"
28431 This parameter applies to recipient callouts only. For example:
28432 .code
28433 deny  !verify = recipient/callout=use_postmaster
28434 .endd
28435 .vindex "&$qualify_domain$&"
28436 It causes a non-empty postmaster address to be used in the MAIL command when
28437 performing the callout for the recipient, and also for a &"random"& check if
28438 that is configured. The local part of the address is &`postmaster`& and the
28439 domain is the contents of &$qualify_domain$&.
28440
28441 .vitem &*use_sender*&
28442 This option applies to recipient callouts only. For example:
28443 .code
28444 require  verify = recipient/callout=use_sender
28445 .endd
28446 It causes the message's actual sender address to be used in the MAIL
28447 command when performing the callout, instead of an empty address. There is no
28448 need to use this option unless you know that the called hosts make use of the
28449 sender when checking recipients. If used indiscriminately, it reduces the
28450 usefulness of callout caching.
28451 .endlist
28452
28453 If you use any of the parameters that set a non-empty sender for the MAIL
28454 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28455 &%use_sender%&), you should think about possible loops. Recipient checking is
28456 usually done between two hosts that are under the same management, and the host
28457 that receives the callouts is not normally configured to do callouts itself.
28458 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28459 these circumstances.
28460
28461 However, if you use a non-empty sender address for a callout to an arbitrary
28462 host, there is the likelihood that the remote host will itself initiate a
28463 callout check back to your host. As it is checking what appears to be a message
28464 sender, it is likely to use an empty address in MAIL, thus avoiding a
28465 callout loop. However, to be on the safe side it would be best to set up your
28466 own ACLs so that they do not do sender verification checks when the recipient
28467 is the address you use for header sender or postmaster callout checking.
28468
28469 Another issue to think about when using non-empty senders for callouts is
28470 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28471 by the sender/recipient combination; thus, for any given recipient, many more
28472 actual callouts are performed than when an empty sender or postmaster is used.
28473
28474
28475
28476
28477 .section "Callout caching" "SECTcallvercache"
28478 .cindex "hints database" "callout cache"
28479 .cindex "callout" "cache, description of"
28480 .cindex "caching" "callout"
28481 Exim caches the results of callouts in order to reduce the amount of resources
28482 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28483 option. A hints database called &"callout"& is used for the cache. Two
28484 different record types are used: one records the result of a callout check for
28485 a specific address, and the other records information that applies to the
28486 entire domain (for example, that it accepts the local part &'postmaster'&).
28487
28488 When an original callout fails, a detailed SMTP error message is given about
28489 the failure. However, for subsequent failures use the cache data, this message
28490 is not available.
28491
28492 The expiry times for negative and positive address cache records are
28493 independent, and can be set by the global options &%callout_negative_expire%&
28494 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28495
28496 If a host gives a negative response to an SMTP connection, or rejects any
28497 commands up to and including
28498 .code
28499 MAIL FROM:<>
28500 .endd
28501 (but not including the MAIL command with a non-empty address),
28502 any callout attempt is bound to fail. Exim remembers such failures in a
28503 domain cache record, which it uses to fail callouts for the domain without
28504 making new connections, until the domain record times out. There are two
28505 separate expiry times for domain cache records:
28506 &%callout_domain_negative_expire%& (default 3h) and
28507 &%callout_domain_positive_expire%& (default 7d).
28508
28509 Domain records expire when the negative expiry time is reached if callouts
28510 cannot be made for the domain, or if the postmaster check failed.
28511 Otherwise, they expire when the positive expiry time is reached. This
28512 ensures that, for example, a host that stops accepting &"random"& local parts
28513 will eventually be noticed.
28514
28515 The callout caching mechanism is based on the domain of the address that is
28516 being tested. If the domain routes to several hosts, it is assumed that their
28517 behaviour will be the same.
28518
28519
28520
28521 .section "Sender address verification reporting" "SECTsenaddver"
28522 .cindex "verifying" "suppressing error details"
28523 See section &<<SECTaddressverification>>& for a general discussion of
28524 verification. When sender verification fails in an ACL, the details of the
28525 failure are given as additional output lines before the 550 response to the
28526 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28527 you might see:
28528 .code
28529 MAIL FROM:<xyz@abc.example>
28530 250 OK
28531 RCPT TO:<pqr@def.example>
28532 550-Verification failed for <xyz@abc.example>
28533 550-Called:   192.168.34.43
28534 550-Sent:     RCPT TO:<xyz@abc.example>
28535 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28536 550 Sender verification failed
28537 .endd
28538 If more than one RCPT command fails in the same way, the details are given
28539 only for the first of them. However, some administrators do not want to send
28540 out this much information. You can suppress the details by adding
28541 &`/no_details`& to the ACL statement that requests sender verification. For
28542 example:
28543 .code
28544 verify = sender/no_details
28545 .endd
28546
28547 .section "Redirection while verifying" "SECTredirwhilveri"
28548 .cindex "verifying" "redirection while"
28549 .cindex "address redirection" "while verifying"
28550 A dilemma arises when a local address is redirected by aliasing or forwarding
28551 during verification: should the generated addresses themselves be verified,
28552 or should the successful expansion of the original address be enough to verify
28553 it? By default, Exim takes the following pragmatic approach:
28554
28555 .ilist
28556 When an incoming address is redirected to just one child address, verification
28557 continues with the child address, and if that fails to verify, the original
28558 verification also fails.
28559 .next
28560 When an incoming address is redirected to more than one child address,
28561 verification does not continue. A success result is returned.
28562 .endlist
28563
28564 This seems the most reasonable behaviour for the common use of aliasing as a
28565 way of redirecting different local parts to the same mailbox. It means, for
28566 example, that a pair of alias entries of the form
28567 .code
28568 A.Wol:   aw123
28569 aw123:   :fail: Gone away, no forwarding address
28570 .endd
28571 work as expected, with both local parts causing verification failure. When a
28572 redirection generates more than one address, the behaviour is more like a
28573 mailing list, where the existence of the alias itself is sufficient for
28574 verification to succeed.
28575
28576 It is possible, however, to change the default behaviour so that all successful
28577 redirections count as successful verifications, however many new addresses are
28578 generated. This is specified by the &%success_on_redirect%& verification
28579 option. For example:
28580 .code
28581 require verify = recipient/success_on_redirect/callout=10s
28582 .endd
28583 In this example, verification succeeds if a router generates a new address, and
28584 the callout does not occur, because no address was routed to a remote host.
28585
28586 When verification is being tested via the &%-bv%& option, the treatment of
28587 redirections is as just described, unless the &%-v%& or any debugging option is
28588 also specified. In that case, full verification is done for every generated
28589 address and a report is output for each of them.
28590
28591
28592
28593 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
28594 .cindex "CSA" "verifying"
28595 Client SMTP Authorization is a system that allows a site to advertise
28596 which machines are and are not permitted to send email. This is done by placing
28597 special SRV records in the DNS; these are looked up using the client's HELO
28598 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
28599 Authorization checks in Exim are performed by the ACL condition:
28600 .code
28601 verify = csa
28602 .endd
28603 This fails if the client is not authorized. If there is a DNS problem, or if no
28604 valid CSA SRV record is found, or if the client is authorized, the condition
28605 succeeds. These three cases can be distinguished using the expansion variable
28606 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
28607 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
28608 be likely to cause problems for legitimate email.
28609
28610 The error messages produced by the CSA code include slightly more
28611 detail. If &$csa_status$& is &"defer"&, this may be because of problems
28612 looking up the CSA SRV record, or problems looking up the CSA target
28613 address record. There are four reasons for &$csa_status$& being &"fail"&:
28614
28615 .ilist
28616 The client's host name is explicitly not authorized.
28617 .next
28618 The client's IP address does not match any of the CSA target IP addresses.
28619 .next
28620 The client's host name is authorized but it has no valid target IP addresses
28621 (for example, the target's addresses are IPv6 and the client is using IPv4).
28622 .next
28623 The client's host name has no CSA SRV record but a parent domain has asserted
28624 that all subdomains must be explicitly authorized.
28625 .endlist
28626
28627 The &%csa%& verification condition can take an argument which is the domain to
28628 use for the DNS query. The default is:
28629 .code
28630 verify = csa/$sender_helo_name
28631 .endd
28632 This implementation includes an extension to CSA. If the query domain
28633 is an address literal such as [192.0.2.95], or if it is a bare IP
28634 address, Exim searches for CSA SRV records in the reverse DNS as if
28635 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
28636 meaningful to say:
28637 .code
28638 verify = csa/$sender_host_address
28639 .endd
28640 In fact, this is the check that Exim performs if the client does not say HELO.
28641 This extension can be turned off by setting the main configuration option
28642 &%dns_csa_use_reverse%& to be false.
28643
28644 If a CSA SRV record is not found for the domain itself, a search
28645 is performed through its parent domains for a record which might be
28646 making assertions about subdomains. The maximum depth of this search is limited
28647 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
28648 default. Exim does not look for CSA SRV records in a top level domain, so the
28649 default settings handle HELO domains as long as seven
28650 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
28651 of legitimate HELO domains.
28652
28653 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
28654 direct SRV lookups, this is not sufficient because of the extra parent domain
28655 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
28656 addresses into lookups in the reverse DNS space. The result of a successful
28657 lookup such as:
28658 .code
28659 ${lookup dnsdb {csa=$sender_helo_name}}
28660 .endd
28661 has two space-separated fields: an authorization code and a target host name.
28662 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
28663 authorization required but absent, or &"?"& for unknown.
28664
28665
28666
28667
28668 .section "Bounce address tag validation" "SECTverifyPRVS"
28669 .cindex "BATV, verifying"
28670 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
28671 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
28672 Genuine incoming bounce messages should therefore always be addressed to
28673 recipients that have a valid tag. This scheme is a way of detecting unwanted
28674 bounce messages caused by sender address forgeries (often called &"collateral
28675 spam"&), because the recipients of such messages do not include valid tags.
28676
28677 There are two expansion items to help with the implementation of the BATV
28678 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
28679 the original envelope sender address by using a simple key to add a hash of the
28680 address and some time-based randomizing information. The &%prvs%& expansion
28681 item creates a signed address, and the &%prvscheck%& expansion item checks one.
28682 The syntax of these expansion items is described in section
28683 &<<SECTexpansionitems>>&.
28684
28685 As an example, suppose the secret per-address keys are stored in an MySQL
28686 database. A query to look up the key for an address could be defined as a macro
28687 like this:
28688 .code
28689 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
28690                 WHERE sender='${quote_mysql:$prvscheck_address}'\
28691                 }{$value}}
28692 .endd
28693 Suppose also that the senders who make use of BATV are defined by an address
28694 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
28695 use this:
28696 .code
28697 # Bounces: drop unsigned addresses for BATV senders
28698 deny message = This address does not send an unsigned reverse path
28699      senders = :
28700      recipients = +batv_senders
28701
28702 # Bounces: In case of prvs-signed address, check signature.
28703 deny message = Invalid reverse path signature.
28704      senders = :
28705      condition  = ${prvscheck {$local_part@$domain}\
28706                   {PRVSCHECK_SQL}{1}}
28707      !condition = $prvscheck_result
28708 .endd
28709 The first statement rejects recipients for bounce messages that are addressed
28710 to plain BATV sender addresses, because it is known that BATV senders do not
28711 send out messages with plain sender addresses. The second statement rejects
28712 recipients that are prvs-signed, but with invalid signatures (either because
28713 the key is wrong, or the signature has timed out).
28714
28715 A non-prvs-signed address is not rejected by the second statement, because the
28716 &%prvscheck%& expansion yields an empty string if its first argument is not a
28717 prvs-signed address, thus causing the &%condition%& condition to be false. If
28718 the first argument is a syntactically valid prvs-signed address, the yield is
28719 the third string (in this case &"1"&), whether or not the cryptographic and
28720 timeout checks succeed. The &$prvscheck_result$& variable contains the result
28721 of the checks (empty for failure, &"1"& for success).
28722
28723 There is one more issue you must consider when implementing prvs-signing:
28724 you have to ensure that the routers accept prvs-signed addresses and
28725 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
28726 router to remove the signature with a configuration along these lines:
28727 .code
28728 batv_redirect:
28729   driver = redirect
28730   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
28731 .endd
28732 This works because, if the third argument of &%prvscheck%& is empty, the result
28733 of the expansion of a prvs-signed address is the decoded value of the original
28734 address. This router should probably be the first of your routers that handles
28735 local addresses.
28736
28737 To create BATV-signed addresses in the first place, a transport of this form
28738 can be used:
28739 .code
28740 external_smtp_batv:
28741   driver = smtp
28742   return_path = ${prvs {$return_path} \
28743                        {${lookup mysql{SELECT \
28744                        secret FROM batv_prvs WHERE \
28745                        sender='${quote_mysql:$sender_address}'} \
28746                        {$value}fail}}}
28747 .endd
28748 If no key can be found for the existing return path, no signing takes place.
28749
28750
28751
28752 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28753 .cindex "&ACL;" "relay control"
28754 .cindex "relaying" "control by ACL"
28755 .cindex "policy control" "relay control"
28756 An MTA is said to &'relay'& a message if it receives it from some host and
28757 delivers it directly to another host as a result of a remote address contained
28758 within it. Redirecting a local address via an alias or forward file and then
28759 passing the message on to another host is not relaying,
28760 .cindex "&""percent hack""&"
28761 but a redirection as a result of the &"percent hack"& is.
28762
28763 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28764 A host which is acting as a gateway or an MX backup is concerned with incoming
28765 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28766 a host which is acting as a smart host for a number of clients is concerned
28767 with outgoing relaying from those clients to the Internet at large. Often the
28768 same host is fulfilling both functions,
28769 . ///
28770 . as illustrated in the diagram below,
28771 . ///
28772 but in principle these two kinds of relaying are entirely independent. What is
28773 not wanted is the transmission of mail from arbitrary remote hosts through your
28774 system to arbitrary domains.
28775
28776
28777 You can implement relay control by means of suitable statements in the ACL that
28778 runs for each RCPT command. For convenience, it is often easiest to use
28779 Exim's named list facility to define the domains and hosts involved. For
28780 example, suppose you want to do the following:
28781
28782 .ilist
28783 Deliver a number of domains to mailboxes on the local host (or process them
28784 locally in some other way). Let's say these are &'my.dom1.example'& and
28785 &'my.dom2.example'&.
28786 .next
28787 Relay mail for a number of other domains for which you are the secondary MX.
28788 These might be &'friend1.example'& and &'friend2.example'&.
28789 .next
28790 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28791 Suppose your LAN is 192.168.45.0/24.
28792 .endlist
28793
28794
28795 In the main part of the configuration, you put the following definitions:
28796 .code
28797 domainlist local_domains = my.dom1.example : my.dom2.example
28798 domainlist relay_domains = friend1.example : friend2.example
28799 hostlist   relay_hosts   = 192.168.45.0/24
28800 .endd
28801 Now you can use these definitions in the ACL that is run for every RCPT
28802 command:
28803 .code
28804 acl_check_rcpt:
28805   accept domains = +local_domains : +relay_domains
28806   accept hosts   = +relay_hosts
28807 .endd
28808 The first statement accepts any RCPT command that contains an address in
28809 the local or relay domains. For any other domain, control passes to the second
28810 statement, which accepts the command only if it comes from one of the relay
28811 hosts. In practice, you will probably want to make your ACL more sophisticated
28812 than this, for example, by including sender and recipient verification. The
28813 default configuration includes a more comprehensive example, which is described
28814 in chapter &<<CHAPdefconfil>>&.
28815
28816
28817
28818 .section "Checking a relay configuration" "SECTcheralcon"
28819 .cindex "relaying" "checking control of"
28820 You can check the relay characteristics of your configuration in the same way
28821 that you can test any ACL behaviour for an incoming SMTP connection, by using
28822 the &%-bh%& option to run a fake SMTP session with which you interact.
28823
28824 For specifically testing for unwanted relaying, the host
28825 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28826 host from the host on which Exim is running, using the normal telnet port, you
28827 will see a normal telnet connection message and then quite a long delay. Be
28828 patient. The remote host is making an SMTP connection back to your host, and
28829 trying a number of common probes to test for open relay vulnerability. The
28830 results of the tests will eventually appear on your terminal.
28831 .ecindex IIDacl
28832
28833
28834
28835 . ////////////////////////////////////////////////////////////////////////////
28836 . ////////////////////////////////////////////////////////////////////////////
28837
28838 .chapter "Content scanning at ACL time" "CHAPexiscan"
28839 .scindex IIDcosca "content scanning" "at ACL time"
28840 The extension of Exim to include content scanning at ACL time, formerly known
28841 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28842 was integrated into the main source for Exim release 4.50, and Tom continues to
28843 maintain it. Most of the wording of this chapter is taken from Tom's
28844 specification.
28845
28846 It is also possible to scan the content of messages at other times. The
28847 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28848 scanning after all the ACLs have run. A transport filter can be used to scan
28849 messages at delivery time (see the &%transport_filter%& option, described in
28850 chapter &<<CHAPtransportgeneric>>&).
28851
28852 If you want to include the ACL-time content-scanning features when you compile
28853 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28854 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28855
28856 .ilist
28857 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28858 for all MIME parts for SMTP and non-SMTP messages, respectively.
28859 .next
28860 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28861 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28862 run at the end of message reception (the &%acl_smtp_data%& ACL).
28863 .next
28864 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28865 of messages, or parts of messages, for debugging purposes.
28866 .next
28867 Additional expansion variables that are set in the new ACL and by the new
28868 conditions.
28869 .next
28870 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28871 .endlist
28872
28873 There is another content-scanning configuration option for &_Local/Makefile_&,
28874 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28875 condition is compiled, in addition to all the other content-scanning features.
28876
28877 Content-scanning is continually evolving, and new features are still being
28878 added. While such features are still unstable and liable to incompatible
28879 changes, they are made available in Exim by setting options whose names begin
28880 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28881 this manual. You can find out about them by reading the file called
28882 &_doc/experimental.txt_&.
28883
28884 All the content-scanning facilities work on a MBOX copy of the message that is
28885 temporarily created in a file called:
28886 .display
28887 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28888 .endd
28889 The &_.eml_& extension is a friendly hint to virus scanners that they can
28890 expect an MBOX-like structure inside that file. The file is created when the
28891 first content scanning facility is called. Subsequent calls to content
28892 scanning conditions open the same file again. The directory is recursively
28893 removed when the &%acl_smtp_data%& ACL has finished running, unless
28894 .code
28895 control = no_mbox_unspool
28896 .endd
28897 has been encountered. When the MIME ACL decodes files, they are put into the
28898 same directory by default.
28899
28900
28901
28902 .section "Scanning for viruses" "SECTscanvirus"
28903 .cindex "virus scanning"
28904 .cindex "content scanning" "for viruses"
28905 .cindex "content scanning" "the &%malware%& condition"
28906 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28907 It supports a &"generic"& interface to scanners called via the shell, and
28908 specialized interfaces for &"daemon"& type virus scanners, which are resident
28909 in memory and thus are much faster.
28910
28911
28912 .oindex "&%av_scanner%&"
28913 You can set the &%av_scanner%& option in first part of the Exim configuration
28914 file to specify which scanner to use, together with any additional options that
28915 are needed. The basic syntax is as follows:
28916 .display
28917 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28918 .endd
28919 If you do not set &%av_scanner%&, it defaults to
28920 .code
28921 av_scanner = sophie:/var/run/sophie
28922 .endd
28923 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28924 before use. The following scanner types are supported in this release:
28925
28926 .vlist
28927 .vitem &%aveserver%&
28928 .cindex "virus scanners" "Kaspersky"
28929 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28930 at &url(http://www.kaspersky.com). This scanner type takes one option,
28931 which is the path to the daemon's UNIX socket. The default is shown in this
28932 example:
28933 .code
28934 av_scanner = aveserver:/var/run/aveserver
28935 .endd
28936
28937
28938 .vitem &%clamd%&
28939 .cindex "virus scanners" "clamd"
28940 This daemon-type scanner is GPL and free. You can get it at
28941 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28942 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28943 in the MIME ACL. This no longer believed to be necessary. One option is
28944 required: either the path and name of a UNIX socket file, or a hostname or IP
28945 number, and a port, separated by space, as in the second of these examples:
28946 .code
28947 av_scanner = clamd:/opt/clamd/socket
28948 av_scanner = clamd:192.0.2.3 1234
28949 av_scanner = clamd:192.0.2.3 1234:local
28950 .endd
28951 If the value of av_scanner points to a UNIX socket file or contains the local
28952 keyword, then the ClamAV interface will pass a filename containing the data
28953 to be scanned, which will should normally result in less I/O happening and be
28954 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28955 Exim does not assume that there is a common filesystem with the remote host.
28956 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28957 you be running a version of ClamAV prior to 0.95.
28958 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28959 contributing the code for this scanner.
28960
28961 .vitem &%cmdline%&
28962 .cindex "virus scanners" "command line interface"
28963 This is the keyword for the generic command line scanner interface. It can be
28964 used to attach virus scanners that are invoked from the shell. This scanner
28965 type takes 3 mandatory options:
28966
28967 .olist
28968 The full path and name of the scanner binary, with all command line options,
28969 and a placeholder (&`%s`&) for the directory to scan.
28970
28971 .next
28972 A regular expression to match against the STDOUT and STDERR output of the
28973 virus scanner. If the expression matches, a virus was found. You must make
28974 absolutely sure that this expression matches on &"virus found"&. This is called
28975 the &"trigger"& expression.
28976
28977 .next
28978 Another regular expression, containing exactly one pair of parentheses, to
28979 match the name of the virus found in the scanners output. This is called the
28980 &"name"& expression.
28981 .endlist olist
28982
28983 For example, Sophos Sweep reports a virus on a line like this:
28984 .code
28985 Virus 'W32/Magistr-B' found in file ./those.bat
28986 .endd
28987 For the trigger expression, we can match the phrase &"found in file"&. For the
28988 name expression, we want to extract the W32/Magistr-B string, so we can match
28989 for the single quotes left and right of it. Altogether, this makes the
28990 configuration setting:
28991 .code
28992 av_scanner = cmdline:\
28993              /path/to/sweep -ss -all -rec -archive %s:\
28994              found in file:'(.+)'
28995 .endd
28996 .vitem &%drweb%&
28997 .cindex "virus scanners" "DrWeb"
28998 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28999 argument, either a full path to a UNIX socket, or an IP address and port
29000 separated by white space, as in these examples:
29001 .code
29002 av_scanner = drweb:/var/run/drwebd.sock
29003 av_scanner = drweb:192.168.2.20 31337
29004 .endd
29005 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29006 is used. Thanks to Alex Miller for contributing the code for this scanner.
29007
29008 .vitem &%fsecure%&
29009 .cindex "virus scanners" "F-Secure"
29010 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29011 argument which is the path to a UNIX socket. For example:
29012 .code
29013 av_scanner = fsecure:/path/to/.fsav
29014 .endd
29015 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29016 Thelmen for contributing the code for this scanner.
29017
29018 .vitem &%kavdaemon%&
29019 .cindex "virus scanners" "Kaspersky"
29020 This is the scanner daemon of Kaspersky Version 4. This version of the
29021 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29022 scanner type takes one option, which is the path to the daemon's UNIX socket.
29023 For example:
29024 .code
29025 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29026 .endd
29027 The default path is &_/var/run/AvpCtl_&.
29028
29029 .vitem &%mksd%&
29030 .cindex "virus scanners" "mksd"
29031 This is a daemon type scanner that is aimed mainly at Polish users, though some
29032 parts of documentation are now available in English. You can get it at
29033 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29034 the maximum number of processes used simultaneously to scan the attachments,
29035 provided that the demime facility is employed and also provided that mksd has
29036 been run with at least the same number of child processes. For example:
29037 .code
29038 av_scanner = mksd:2
29039 .endd
29040 You can safely omit this option (the default value is 1).
29041
29042 .vitem &%sophie%&
29043 .cindex "virus scanners" "Sophos and Sophie"
29044 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29045 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29046 for this scanner type is the path to the UNIX socket that Sophie uses for
29047 client communication. For example:
29048 .code
29049 av_scanner = sophie:/tmp/sophie
29050 .endd
29051 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29052 the option.
29053 .endlist
29054
29055 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29056 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29057 ACL.
29058
29059 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29060 makes it possible to use different scanners. See further below for an example.
29061 The &%malware%& condition caches its results, so when you use it multiple times
29062 for the same message, the actual scanning process is only carried out once.
29063 However, using expandable items in &%av_scanner%& disables this caching, in
29064 which case each use of the &%malware%& condition causes a new scan of the
29065 message.
29066
29067 The &%malware%& condition takes a right-hand argument that is expanded before
29068 use. It can then be one of
29069
29070 .ilist
29071 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29072 The condition succeeds if a virus was found, and fail otherwise. This is the
29073 recommended usage.
29074 .next
29075 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29076 the condition fails immediately.
29077 .next
29078 A regular expression, in which case the message is scanned for viruses. The
29079 condition succeeds if a virus is found and its name matches the regular
29080 expression. This allows you to take special actions on certain types of virus.
29081 .endlist
29082
29083 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29084 even if there is a problem with the virus scanner. Otherwise, such a problem
29085 causes the ACL to defer.
29086
29087 .vindex "&$malware_name$&"
29088 When a virus is found, the condition sets up an expansion variable called
29089 &$malware_name$& that contains the name of the virus. You can use it in a
29090 &%message%& modifier that specifies the error returned to the sender, and/or in
29091 logging data.
29092
29093 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29094 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29095 &%malware%& condition.
29096
29097 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29098 imposed by your anti-virus scanner.
29099
29100 Here is a very simple scanning example:
29101 .code
29102 deny message = This message contains malware ($malware_name)
29103      demime = *
29104      malware = *
29105 .endd
29106 The next example accepts messages when there is a problem with the scanner:
29107 .code
29108 deny message = This message contains malware ($malware_name)
29109      demime = *
29110      malware = */defer_ok
29111 .endd
29112 The next example shows how to use an ACL variable to scan with both sophie and
29113 aveserver. It assumes you have set:
29114 .code
29115 av_scanner = $acl_m0
29116 .endd
29117 in the main Exim configuration.
29118 .code
29119 deny message = This message contains malware ($malware_name)
29120      set acl_m0 = sophie
29121      malware = *
29122
29123 deny message = This message contains malware ($malware_name)
29124      set acl_m0 = aveserver
29125      malware = *
29126 .endd
29127
29128
29129 .section "Scanning with SpamAssassin" "SECTscanspamass"
29130 .cindex "content scanning" "for spam"
29131 .cindex "spam scanning"
29132 .cindex "SpamAssassin"
29133 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29134 score and a report for the message. You can get SpamAssassin at
29135 &url(http://www.spamassassin.org), or, if you have a working Perl
29136 installation, you can use CPAN by running:
29137 .code
29138 perl -MCPAN -e 'install Mail::SpamAssassin'
29139 .endd
29140 SpamAssassin has its own set of configuration files. Please review its
29141 documentation to see how you can tweak it. The default installation should work
29142 nicely, however.
29143
29144 .oindex "&%spamd_address%&"
29145 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29146 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29147 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29148 part of the Exim configuration as follows (example):
29149 .code
29150 spamd_address = 192.168.99.45 387
29151 .endd
29152 You do not need to set this option if you use the default. As of version 2.60,
29153 &%spamd%& also supports communication over UNIX sockets. If you want to use
29154 these, supply &%spamd_address%& with an absolute file name instead of a
29155 address/port pair:
29156 .code
29157 spamd_address = /var/run/spamd_socket
29158 .endd
29159 You can have multiple &%spamd%& servers to improve scalability. These can
29160 reside on other hardware reachable over the network. To specify multiple
29161 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29162 option, separated with colons:
29163 .code
29164 spamd_address = 192.168.2.10 783 : \
29165                 192.168.2.11 783 : \
29166                 192.168.2.12 783
29167 .endd
29168 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29169 fashion. When a server fails to respond to the connection attempt, all other
29170 servers are tried until one succeeds. If no server responds, the &%spam%&
29171 condition defers.
29172
29173 &*Warning*&: It is not possible to use the UNIX socket connection method with
29174 multiple &%spamd%& servers.
29175
29176 The &%spamd_address%& variable is expanded before use if it starts with
29177 a dollar sign. In this case, the expansion may return a string that is
29178 used as the list so that multiple spamd servers can be the result of an
29179 expansion.
29180
29181 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29182 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29183 .code
29184 deny message = This message was classified as SPAM
29185      spam = joe
29186 .endd
29187 The right-hand side of the &%spam%& condition specifies a name. This is
29188 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29189 to scan using a specific profile, but rather use the SpamAssassin system-wide
29190 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29191 However, you must put something on the right-hand side.
29192
29193 The name allows you to use per-domain or per-user antispam profiles in
29194 principle, but this is not straightforward in practice, because a message may
29195 have multiple recipients, not necessarily all in the same domain. Because the
29196 &%spam%& condition has to be called from a DATA ACL in order to be able to
29197 read the contents of the message, the variables &$local_part$& and &$domain$&
29198 are not set.
29199
29200 The right-hand side of the &%spam%& condition is expanded before being used, so
29201 you can put lookups or conditions there. When the right-hand side evaluates to
29202 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29203
29204
29205 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29206 large ones may cause significant performance degradation. As most spam messages
29207 are quite small, it is recommended that you do not scan the big ones. For
29208 example:
29209 .code
29210 deny message = This message was classified as SPAM
29211      condition = ${if < {$message_size}{10K}}
29212      spam = nobody
29213 .endd
29214
29215 The &%spam%& condition returns true if the threshold specified in the user's
29216 SpamAssassin profile has been matched or exceeded. If you want to use the
29217 &%spam%& condition for its side effects (see the variables below), you can make
29218 it always return &"true"& by appending &`:true`& to the username.
29219
29220 .cindex "spam scanning" "returned variables"
29221 When the &%spam%& condition is run, it sets up a number of expansion
29222 variables. These variables are saved with the received message, thus they are
29223 available for use at delivery time.
29224
29225 .vlist
29226 .vitem &$spam_score$&
29227 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29228 for inclusion in log or reject messages.
29229
29230 .vitem &$spam_score_int$&
29231 The spam score of the message, multiplied by ten, as an integer value. For
29232 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29233 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29234 The integer value is useful for numeric comparisons in conditions.
29235
29236 .vitem &$spam_bar$&
29237 A string consisting of a number of &"+"& or &"-"& characters, representing the
29238 integer part of the spam score value. A spam score of 4.4 would have a
29239 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29240 headers, since MUAs can match on such strings.
29241
29242 .vitem &$spam_report$&
29243 A multiline text table, containing the full SpamAssassin report for the
29244 message. Useful for inclusion in headers or reject messages.
29245 .endlist
29246
29247 The &%spam%& condition caches its results unless expansion in
29248 spamd_address was used. If you call it again with the same user name, it
29249 does not scan again, but rather returns the same values as before.
29250
29251 The &%spam%& condition returns DEFER if there is any error while running
29252 the message through SpamAssassin or if the expansion of spamd_address
29253 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29254 statement block), append &`/defer_ok`& to the right-hand side of the
29255 spam condition, like this:
29256 .code
29257 deny message = This message was classified as SPAM
29258      spam    = joe/defer_ok
29259 .endd
29260 This causes messages to be accepted even if there is a problem with &%spamd%&.
29261
29262 Here is a longer, commented example of the use of the &%spam%&
29263 condition:
29264 .code
29265 # put headers in all messages (no matter if spam or not)
29266 warn  spam = nobody:true
29267       add_header = X-Spam-Score: $spam_score ($spam_bar)
29268       add_header = X-Spam-Report: $spam_report
29269
29270 # add second subject line with *SPAM* marker when message
29271 # is over threshold
29272 warn  spam = nobody
29273       add_header = Subject: *SPAM* $h_Subject:
29274
29275 # reject spam at high scores (> 12)
29276 deny  message = This message scored $spam_score spam points.
29277       spam = nobody:true
29278       condition = ${if >{$spam_score_int}{120}{1}{0}}
29279 .endd
29280
29281
29282
29283 .section "Scanning MIME parts" "SECTscanmimepart"
29284 .cindex "content scanning" "MIME parts"
29285 .cindex "MIME content scanning"
29286 .oindex "&%acl_smtp_mime%&"
29287 .oindex "&%acl_not_smtp_mime%&"
29288 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29289 each MIME part of an SMTP message, including multipart types, in the sequence
29290 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29291 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29292 options may both refer to the same ACL if you want the same processing in both
29293 cases.
29294
29295 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29296 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29297 the case of a non-SMTP message. However, a MIME ACL is called only if the
29298 message contains a &'Content-Type:'& header line. When a call to a MIME
29299 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29300 result code is sent to the client. In the case of an SMTP message, the
29301 &%acl_smtp_data%& ACL is not called when this happens.
29302
29303 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29304 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29305 condition to match against the raw MIME part. You can also use the
29306 &%mime_regex%& condition to match against the decoded MIME part (see section
29307 &<<SECTscanregex>>&).
29308
29309 At the start of a MIME ACL, a number of variables are set from the header
29310 information for the relevant MIME part. These are described below. The contents
29311 of the MIME part are not by default decoded into a disk file except for MIME
29312 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29313 part into a disk file, you can use the &%decode%& condition. The general
29314 syntax is:
29315 .display
29316 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29317 .endd
29318 The right hand side is expanded before use. After expansion,
29319 the value can be:
29320
29321 .olist
29322 &"0"& or &"false"&, in which case no decoding is done.
29323 .next
29324 The string &"default"&. In that case, the file is put in the temporary
29325 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29326 a sequential file name consisting of the message id and a sequence number. The
29327 full path and name is available in &$mime_decoded_filename$& after decoding.
29328 .next
29329 A full path name starting with a slash. If the full name is an existing
29330 directory, it is used as a replacement for the default directory. The filename
29331 is then sequentially assigned. If the path does not exist, it is used as
29332 the full path and file name.
29333 .next
29334 If the string does not start with a slash, it is used as the
29335 filename, and the default path is then used.
29336 .endlist
29337 The &%decode%& condition normally succeeds. It is only false for syntax
29338 errors or unusual circumstances such as memory shortages. You can easily decode
29339 a file with its original, proposed filename using
29340 .code
29341 decode = $mime_filename
29342 .endd
29343 However, you should keep in mind that &$mime_filename$& might contain
29344 anything. If you place files outside of the default path, they are not
29345 automatically unlinked.
29346
29347 For RFC822 attachments (these are messages attached to messages, with a
29348 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29349 as for the primary message, only that the &$mime_is_rfc822$& expansion
29350 variable is set (see below). Attached messages are always decoded to disk
29351 before being checked, and the files are unlinked once the check is done.
29352
29353 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29354 used to match regular expressions against raw and decoded MIME parts,
29355 respectively. They are described in section &<<SECTscanregex>>&.
29356
29357 .cindex "MIME content scanning" "returned variables"
29358 The following list describes all expansion variables that are
29359 available in the MIME ACL:
29360
29361 .vlist
29362 .vitem &$mime_boundary$&
29363 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29364 have a boundary string, which is stored in this variable. If the current part
29365 has no boundary parameter in the &'Content-Type:'& header, this variable
29366 contains the empty string.
29367
29368 .vitem &$mime_charset$&
29369 This variable contains the character set identifier, if one was found in the
29370 &'Content-Type:'& header. Examples for charset identifiers are:
29371 .code
29372 us-ascii
29373 gb2312 (Chinese)
29374 iso-8859-1
29375 .endd
29376 Please note that this value is not normalized, so you should do matches
29377 case-insensitively.
29378
29379 .vitem &$mime_content_description$&
29380 This variable contains the normalized content of the &'Content-Description:'&
29381 header. It can contain a human-readable description of the parts content. Some
29382 implementations repeat the filename for attachments here, but they are usually
29383 only used for display purposes.
29384
29385 .vitem &$mime_content_disposition$&
29386 This variable contains the normalized content of the &'Content-Disposition:'&
29387 header. You can expect strings like &"attachment"& or &"inline"& here.
29388
29389 .vitem &$mime_content_id$&
29390 This variable contains the normalized content of the &'Content-ID:'& header.
29391 This is a unique ID that can be used to reference a part from another part.
29392
29393 .vitem &$mime_content_size$&
29394 This variable is set only after the &%decode%& modifier (see above) has been
29395 successfully run. It contains the size of the decoded part in kilobytes. The
29396 size is always rounded up to full kilobytes, so only a completely empty part
29397 has a &$mime_content_size$& of zero.
29398
29399 .vitem &$mime_content_transfer_encoding$&
29400 This variable contains the normalized content of the
29401 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29402 type. Typical values are &"base64"& and &"quoted-printable"&.
29403
29404 .vitem &$mime_content_type$&
29405 If the MIME part has a &'Content-Type:'& header, this variable contains its
29406 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29407 are some examples of popular MIME types, as they may appear in this variable:
29408 .code
29409 text/plain
29410 text/html
29411 application/octet-stream
29412 image/jpeg
29413 audio/midi
29414 .endd
29415 If the MIME part has no &'Content-Type:'& header, this variable contains the
29416 empty string.
29417
29418 .vitem &$mime_decoded_filename$&
29419 This variable is set only after the &%decode%& modifier (see above) has been
29420 successfully run. It contains the full path and file name of the file
29421 containing the decoded data.
29422 .endlist
29423
29424 .cindex "RFC 2047"
29425 .vlist
29426 .vitem &$mime_filename$&
29427 This is perhaps the most important of the MIME variables. It contains a
29428 proposed filename for an attachment, if one was found in either the
29429 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29430 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29431 found, this variable contains the empty string.
29432
29433 .vitem &$mime_is_coverletter$&
29434 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29435 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29436 content in the cover letter, while not restricting attachments at all.
29437
29438 The variable contains 1 (true) for a MIME part believed to be part of the
29439 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29440 follows:
29441
29442 .olist
29443 The outermost MIME part of a message is always a cover letter.
29444
29445 .next
29446 If a multipart/alternative or multipart/related MIME part is a cover letter,
29447 so are all MIME subparts within that multipart.
29448
29449 .next
29450 If any other multipart is a cover letter, the first subpart is a cover letter,
29451 and the rest are attachments.
29452
29453 .next
29454 All parts contained within an attachment multipart are attachments.
29455 .endlist olist
29456
29457 As an example, the following will ban &"HTML mail"& (including that sent with
29458 alternative plain text), while allowing HTML files to be attached. HTML
29459 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29460 .code
29461 deny message = HTML mail is not accepted here
29462 !condition = $mime_is_rfc822
29463 condition = $mime_is_coverletter
29464 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29465 .endd
29466 .vitem &$mime_is_multipart$&
29467 This variable has the value 1 (true) when the current part has the main type
29468 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29469 Since multipart entities only serve as containers for other parts, you may not
29470 want to carry out specific actions on them.
29471
29472 .vitem &$mime_is_rfc822$&
29473 This variable has the value 1 (true) if the current part is not a part of the
29474 checked message itself, but part of an attached message. Attached message
29475 decoding is fully recursive.
29476
29477 .vitem &$mime_part_count$&
29478 This variable is a counter that is raised for each processed MIME part. It
29479 starts at zero for the very first part (which is usually a multipart). The
29480 counter is per-message, so it is reset when processing RFC822 attachments (see
29481 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29482 complete, so you can use it in the DATA ACL to determine the number of MIME
29483 parts of a message. For non-MIME messages, this variable contains the value -1.
29484 .endlist
29485
29486
29487
29488 .section "Scanning with regular expressions" "SECTscanregex"
29489 .cindex "content scanning" "with regular expressions"
29490 .cindex "regular expressions" "content scanning with"
29491 You can specify your own custom regular expression matches on the full body of
29492 the message, or on individual MIME parts.
29493
29494 The &%regex%& condition takes one or more regular expressions as arguments and
29495 matches them against the full message (when called in the DATA ACL) or a raw
29496 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29497 linewise, with a maximum line length of 32K characters. That means you cannot
29498 have multiline matches with the &%regex%& condition.
29499
29500 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29501 to 32K of decoded content (the whole content at once, not linewise). If the
29502 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29503 is decoded automatically when &%mime_regex%& is executed (using default path
29504 and filename values). If the decoded data is larger than  32K, only the first
29505 32K characters are checked.
29506
29507 The regular expressions are passed as a colon-separated list. To include a
29508 literal colon, you must double it. Since the whole right-hand side string is
29509 expanded before being used, you must also escape dollar signs and backslashes
29510 with more backslashes, or use the &`\N`& facility to disable expansion.
29511 Here is a simple example that contains two regular expressions:
29512 .code
29513 deny message = contains blacklisted regex ($regex_match_string)
29514      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29515 .endd
29516 The conditions returns true if any one of the regular expressions matches. The
29517 &$regex_match_string$& expansion variable is then set up and contains the
29518 matching regular expression.
29519
29520 &*Warning*&: With large messages, these conditions can be fairly
29521 CPU-intensive.
29522
29523
29524
29525
29526 .section "The demime condition" "SECTdemimecond"
29527 .cindex "content scanning" "MIME checking"
29528 .cindex "MIME content scanning"
29529 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29530 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29531 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29532 ACL functionality, but provides no additional facilities. Please note that this
29533 condition is deprecated and kept only for backward compatibility. You must set
29534 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29535 use the &%demime%& condition.
29536
29537 The &%demime%& condition unpacks MIME containers in the message. It detects
29538 errors in MIME containers and can match file extensions found in the message
29539 against a list. Using this facility produces files containing the unpacked MIME
29540 parts of the message in the temporary scan directory. If you do antivirus
29541 scanning, it is recommended that you use the &%demime%& condition before the
29542 antivirus (&%malware%&) condition.
29543
29544 On the right-hand side of the &%demime%& condition you can pass a
29545 colon-separated list of file extensions that it should match against. For
29546 example:
29547 .code
29548 deny message = Found blacklisted file attachment
29549      demime  = vbs:com:bat:pif:prf:lnk
29550 .endd
29551 If one of the file extensions is found, the condition is true, otherwise it is
29552 false. If there is a temporary error while demimeing (for example, &"disk
29553 full"&), the condition defers, and the message is temporarily rejected (unless
29554 the condition is on a &%warn%& verb).
29555
29556 The right-hand side is expanded before being treated as a list, so you can have
29557 conditions and lookups there. If it expands to an empty string, &"false"&, or
29558 zero (&"0"&), no demimeing is done and the condition is false.
29559
29560 The &%demime%& condition set the following variables:
29561
29562 .vlist
29563 .vitem &$demime_errorlevel$&
29564 .vindex "&$demime_errorlevel$&"
29565 When an error is detected in a MIME container, this variable contains the
29566 severity of the error, as an integer number. The higher the value, the more
29567 severe the error (the current maximum value is 3). If this variable is unset or
29568 zero, no error occurred.
29569
29570 .vitem &$demime_reason$&
29571 .vindex "&$demime_reason$&"
29572 When &$demime_errorlevel$& is greater than zero, this variable contains a
29573 human-readable text string describing the MIME error that occurred.
29574 .endlist
29575
29576 .vlist
29577 .vitem &$found_extension$&
29578 .vindex "&$found_extension$&"
29579 When the &%demime%& condition is true, this variable contains the file
29580 extension it found.
29581 .endlist
29582
29583 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
29584 the &%demime%& condition, and are not changed on subsequent calls.
29585
29586 If you do not want to check for file extensions, but rather use the &%demime%&
29587 condition for unpacking or error checking purposes, pass &"*"& as the
29588 right-hand side value. Here is a more elaborate example of how to use this
29589 facility:
29590 .code
29591 # Reject messages with serious MIME container errors
29592 deny  message = Found MIME error ($demime_reason).
29593       demime = *
29594       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
29595
29596 # Reject known virus spreading file extensions.
29597 # Accepting these is pretty much braindead.
29598 deny  message = contains $found_extension file (blacklisted).
29599       demime  = com:vbs:bat:pif:scr
29600
29601 # Freeze .exe and .doc files. Postmaster can
29602 # examine them and eventually thaw them.
29603 deny  log_message = Another $found_extension file.
29604       demime = exe:doc
29605       control = freeze
29606 .endd
29607 .ecindex IIDcosca
29608
29609
29610
29611
29612 . ////////////////////////////////////////////////////////////////////////////
29613 . ////////////////////////////////////////////////////////////////////////////
29614
29615 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
29616          "Local scan function"
29617 .scindex IIDlosca "&[local_scan()]& function" "description of"
29618 .cindex "customizing" "input scan using C function"
29619 .cindex "policy control" "by local scan function"
29620 In these days of email worms, viruses, and ever-increasing spam, some sites
29621 want to apply a lot of checking to messages before accepting them.
29622
29623 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
29624 passing messages to external virus and spam scanning software. You can also do
29625 a certain amount in Exim itself through string expansions and the &%condition%&
29626 condition in the ACL that runs after the SMTP DATA command or the ACL for
29627 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
29628
29629 To allow for further customization to a site's own requirements, there is the
29630 possibility of linking Exim with a private message scanning function, written
29631 in C. If you want to run code that is written in something other than C, you
29632 can of course use a little C stub to call it.
29633
29634 The local scan function is run once for every incoming message, at the point
29635 when Exim is just about to accept the message.
29636 It can therefore be used to control non-SMTP messages from local processes as
29637 well as messages arriving via SMTP.
29638
29639 Exim applies a timeout to calls of the local scan function, and there is an
29640 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
29641 Zero means &"no timeout"&.
29642 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
29643 before calling the local scan function, so that the most common types of crash
29644 are caught. If the timeout is exceeded or one of those signals is caught, the
29645 incoming message is rejected with a temporary error if it is an SMTP message.
29646 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
29647 code. The incident is logged on the main and reject logs.
29648
29649
29650
29651 .section "Building Exim to use a local scan function" "SECID207"
29652 .cindex "&[local_scan()]& function" "building Exim to use"
29653 To make use of the local scan function feature, you must tell Exim where your
29654 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
29655 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
29656 directory, so you might set
29657 .code
29658 LOCAL_SCAN_SOURCE=Local/local_scan.c
29659 .endd
29660 for example. The function must be called &[local_scan()]&. It is called by
29661 Exim after it has received a message, when the success return code is about to
29662 be sent. This is after all the ACLs have been run. The return code from your
29663 function controls whether the message is actually accepted or not. There is a
29664 commented template function (that just accepts the message) in the file
29665 _src/local_scan.c_.
29666
29667 If you want to make use of Exim's run time configuration file to set options
29668 for your &[local_scan()]& function, you must also set
29669 .code
29670 LOCAL_SCAN_HAS_OPTIONS=yes
29671 .endd
29672 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
29673
29674
29675
29676
29677 .section "API for local_scan()" "SECTapiforloc"
29678 .cindex "&[local_scan()]& function" "API description"
29679 You must include this line near the start of your code:
29680 .code
29681 #include "local_scan.h"
29682 .endd
29683 This header file defines a number of variables and other values, and the
29684 prototype for the function itself. Exim is coded to use unsigned char values
29685 almost exclusively, and one of the things this header defines is a shorthand
29686 for &`unsigned char`& called &`uschar`&.
29687 It also contains the following macro definitions, to simplify casting character
29688 strings and pointers to character strings:
29689 .code
29690 #define CS   (char *)
29691 #define CCS  (const char *)
29692 #define CSS  (char **)
29693 #define US   (unsigned char *)
29694 #define CUS  (const unsigned char *)
29695 #define USS  (unsigned char **)
29696 .endd
29697 The function prototype for &[local_scan()]& is:
29698 .code
29699 extern int local_scan(int fd, uschar **return_text);
29700 .endd
29701 The arguments are as follows:
29702
29703 .ilist
29704 &%fd%& is a file descriptor for the file that contains the body of the message
29705 (the -D file). The file is open for reading and writing, but updating it is not
29706 recommended. &*Warning*&: You must &'not'& close this file descriptor.
29707
29708 The descriptor is positioned at character 19 of the file, which is the first
29709 character of the body itself, because the first 19 characters are the message
29710 id followed by &`-D`& and a newline. If you rewind the file, you should use the
29711 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
29712 case this changes in some future version.
29713 .next
29714 &%return_text%& is an address which you can use to return a pointer to a text
29715 string at the end of the function. The value it points to on entry is NULL.
29716 .endlist
29717
29718 The function must return an &%int%& value which is one of the following macros:
29719
29720 .vlist
29721 .vitem &`LOCAL_SCAN_ACCEPT`&
29722 .vindex "&$local_scan_data$&"
29723 The message is accepted. If you pass back a string of text, it is saved with
29724 the message, and made available in the variable &$local_scan_data$&. No
29725 newlines are permitted (if there are any, they are turned into spaces) and the
29726 maximum length of text is 1000 characters.
29727
29728 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
29729 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29730 queued without immediate delivery, and is frozen.
29731
29732 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
29733 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29734 queued without immediate delivery.
29735
29736 .vitem &`LOCAL_SCAN_REJECT`&
29737 The message is rejected; the returned text is used as an error message which is
29738 passed back to the sender and which is also logged. Newlines are permitted &--
29739 they cause a multiline response for SMTP rejections, but are converted to
29740 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
29741 used.
29742
29743 .vitem &`LOCAL_SCAN_TEMPREJECT`&
29744 The message is temporarily rejected; the returned text is used as an error
29745 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
29746 problem"& is used.
29747
29748 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29749 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29750 message is not written to the reject log. It has the effect of unsetting the
29751 &%rejected_header%& log selector for just this rejection. If
29752 &%rejected_header%& is already unset (see the discussion of the
29753 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29754 same as LOCAL_SCAN_REJECT.
29755
29756 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29757 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29758 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29759 .endlist
29760
29761 If the message is not being received by interactive SMTP, rejections are
29762 reported by writing to &%stderr%& or by sending an email, as configured by the
29763 &%-oe%& command line options.
29764
29765
29766
29767 .section "Configuration options for local_scan()" "SECTconoptloc"
29768 .cindex "&[local_scan()]& function" "configuration options"
29769 It is possible to have option settings in the main configuration file
29770 that set values in static variables in the &[local_scan()]& module. If you
29771 want to do this, you must have the line
29772 .code
29773 LOCAL_SCAN_HAS_OPTIONS=yes
29774 .endd
29775 in your &_Local/Makefile_& when you build Exim. (This line is in
29776 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29777 file, you must define static variables to hold the option values, and a table
29778 to define them.
29779
29780 The table must be a vector called &%local_scan_options%&, of type
29781 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29782 and a pointer to the variable that holds the value. The entries must appear in
29783 alphabetical order. Following &%local_scan_options%& you must also define a
29784 variable called &%local_scan_options_count%& that contains the number of
29785 entries in the table. Here is a short example, showing two kinds of option:
29786 .code
29787 static int my_integer_option = 42;
29788 static uschar *my_string_option = US"a default string";
29789
29790 optionlist local_scan_options[] = {
29791   { "my_integer", opt_int,       &my_integer_option },
29792   { "my_string",  opt_stringptr, &my_string_option }
29793 };
29794
29795 int local_scan_options_count =
29796   sizeof(local_scan_options)/sizeof(optionlist);
29797 .endd
29798 The values of the variables can now be changed from Exim's runtime
29799 configuration file by including a local scan section as in this example:
29800 .code
29801 begin local_scan
29802 my_integer = 99
29803 my_string = some string of text...
29804 .endd
29805 The available types of option data are as follows:
29806
29807 .vlist
29808 .vitem &*opt_bool*&
29809 This specifies a boolean (true/false) option. The address should point to a
29810 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29811 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29812 whether such a variable has been set at all, you can initialize it to
29813 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29814 values.)
29815
29816 .vitem &*opt_fixed*&
29817 This specifies a fixed point number, such as is used for load averages.
29818 The address should point to a variable of type &`int`&. The value is stored
29819 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29820
29821 .vitem &*opt_int*&
29822 This specifies an integer; the address should point to a variable of type
29823 &`int`&. The value may be specified in any of the integer formats accepted by
29824 Exim.
29825
29826 .vitem &*opt_mkint*&
29827 This is the same as &%opt_int%&, except that when such a value is output in a
29828 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29829 printed with the suffix K or M.
29830
29831 .vitem &*opt_octint*&
29832 This also specifies an integer, but the value is always interpreted as an
29833 octal integer, whether or not it starts with the digit zero, and it is
29834 always output in octal.
29835
29836 .vitem &*opt_stringptr*&
29837 This specifies a string value; the address must be a pointer to a
29838 variable that points to a string (for example, of type &`uschar *`&).
29839
29840 .vitem &*opt_time*&
29841 This specifies a time interval value. The address must point to a variable of
29842 type &`int`&. The value that is placed there is a number of seconds.
29843 .endlist
29844
29845 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29846 out the values of all the &[local_scan()]& options.
29847
29848
29849
29850 .section "Available Exim variables" "SECID208"
29851 .cindex "&[local_scan()]& function" "available Exim variables"
29852 The header &_local_scan.h_& gives you access to a number of C variables. These
29853 are the only ones that are guaranteed to be maintained from release to release.
29854 Note, however, that you can obtain the value of any Exim expansion variable,
29855 including &$recipients$&, by calling &'expand_string()'&. The exported
29856 C variables are as follows:
29857
29858 .vlist
29859 .vitem &*int&~body_linecount*&
29860 This variable contains the number of lines in the message's body.
29861
29862 .vitem &*int&~body_zerocount*&
29863 This variable contains the number of binary zero bytes in the message's body.
29864
29865 .vitem &*unsigned&~int&~debug_selector*&
29866 This variable is set to zero when no debugging is taking place. Otherwise, it
29867 is a bitmap of debugging selectors. Two bits are identified for use in
29868 &[local_scan()]&; they are defined as macros:
29869
29870 .ilist
29871 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29872 testing option that is not privileged &-- any caller may set it. All the
29873 other selector bits can be set only by admin users.
29874
29875 .next
29876 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29877 by the &`+local_scan`& debug selector. It is not included in the default set
29878 of debugging bits.
29879 .endlist ilist
29880
29881 Thus, to write to the debugging output only when &`+local_scan`& has been
29882 selected, you should use code like this:
29883 .code
29884 if ((debug_selector & D_local_scan) != 0)
29885   debug_printf("xxx", ...);
29886 .endd
29887 .vitem &*uschar&~*expand_string_message*&
29888 After a failing call to &'expand_string()'& (returned value NULL), the
29889 variable &%expand_string_message%& contains the error message, zero-terminated.
29890
29891 .vitem &*header_line&~*header_list*&
29892 A pointer to a chain of header lines. The &%header_line%& structure is
29893 discussed below.
29894
29895 .vitem &*header_line&~*header_last*&
29896 A pointer to the last of the header lines.
29897
29898 .vitem &*uschar&~*headers_charset*&
29899 The value of the &%headers_charset%& configuration option.
29900
29901 .vitem &*BOOL&~host_checking*&
29902 This variable is TRUE during a host checking session that is initiated by the
29903 &%-bh%& command line option.
29904
29905 .vitem &*uschar&~*interface_address*&
29906 The IP address of the interface that received the message, as a string. This
29907 is NULL for locally submitted messages.
29908
29909 .vitem &*int&~interface_port*&
29910 The port on which this message was received. When testing with the &%-bh%&
29911 command line option, the value of this variable is -1 unless a port has been
29912 specified via the &%-oMi%& option.
29913
29914 .vitem &*uschar&~*message_id*&
29915 This variable contains Exim's message id for the incoming message (the value of
29916 &$message_exim_id$&) as a zero-terminated string.
29917
29918 .vitem &*uschar&~*received_protocol*&
29919 The name of the protocol by which the message was received.
29920
29921 .vitem &*int&~recipients_count*&
29922 The number of accepted recipients.
29923
29924 .vitem &*recipient_item&~*recipients_list*&
29925 .cindex "recipient" "adding in local scan"
29926 .cindex "recipient" "removing in local scan"
29927 The list of accepted recipients, held in a vector of length
29928 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29929 can add additional recipients by calling &'receive_add_recipient()'& (see
29930 below). You can delete recipients by removing them from the vector and
29931 adjusting the value in &%recipients_count%&. In particular, by setting
29932 &%recipients_count%& to zero you remove all recipients. If you then return the
29933 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29934 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29935 and then call &'receive_add_recipient()'& as often as needed.
29936
29937 .vitem &*uschar&~*sender_address*&
29938 The envelope sender address. For bounce messages this is the empty string.
29939
29940 .vitem &*uschar&~*sender_host_address*&
29941 The IP address of the sending host, as a string. This is NULL for
29942 locally-submitted messages.
29943
29944 .vitem &*uschar&~*sender_host_authenticated*&
29945 The name of the authentication mechanism that was used, or NULL if the message
29946 was not received over an authenticated SMTP connection.
29947
29948 .vitem &*uschar&~*sender_host_name*&
29949 The name of the sending host, if known.
29950
29951 .vitem &*int&~sender_host_port*&
29952 The port on the sending host.
29953
29954 .vitem &*BOOL&~smtp_input*&
29955 This variable is TRUE for all SMTP input, including BSMTP.
29956
29957 .vitem &*BOOL&~smtp_batched_input*&
29958 This variable is TRUE for BSMTP input.
29959
29960 .vitem &*int&~store_pool*&
29961 The contents of this variable control which pool of memory is used for new
29962 requests. See section &<<SECTmemhanloc>>& for details.
29963 .endlist
29964
29965
29966 .section "Structure of header lines" "SECID209"
29967 The &%header_line%& structure contains the members listed below.
29968 You can add additional header lines by calling the &'header_add()'& function
29969 (see below). You can cause header lines to be ignored (deleted) by setting
29970 their type to *.
29971
29972
29973 .vlist
29974 .vitem &*struct&~header_line&~*next*&
29975 A pointer to the next header line, or NULL for the last line.
29976
29977 .vitem &*int&~type*&
29978 A code identifying certain headers that Exim recognizes. The codes are printing
29979 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29980 Notice in particular that any header line whose type is * is not transmitted
29981 with the message. This flagging is used for header lines that have been
29982 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29983 lines.) Effectively, * means &"deleted"&.
29984
29985 .vitem &*int&~slen*&
29986 The number of characters in the header line, including the terminating and any
29987 internal newlines.
29988
29989 .vitem &*uschar&~*text*&
29990 A pointer to the text of the header. It always ends with a newline, followed by
29991 a zero byte. Internal newlines are preserved.
29992 .endlist
29993
29994
29995
29996 .section "Structure of recipient items" "SECID210"
29997 The &%recipient_item%& structure contains these members:
29998
29999 .vlist
30000 .vitem &*uschar&~*address*&
30001 This is a pointer to the recipient address as it was received.
30002
30003 .vitem &*int&~pno*&
30004 This is used in later Exim processing when top level addresses are created by
30005 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30006 and must always contain -1 at this stage.
30007
30008 .vitem &*uschar&~*errors_to*&
30009 If this value is not NULL, bounce messages caused by failing to deliver to the
30010 recipient are sent to the address it contains. In other words, it overrides the
30011 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30012 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30013 an unqualified address, Exim qualifies it using the domain from
30014 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30015 is NULL for all recipients.
30016 .endlist
30017
30018
30019
30020 .section "Available Exim functions" "SECID211"
30021 .cindex "&[local_scan()]& function" "available Exim functions"
30022 The header &_local_scan.h_& gives you access to a number of Exim functions.
30023 These are the only ones that are guaranteed to be maintained from release to
30024 release:
30025
30026 .vlist
30027 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30028        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30029
30030 This function creates a child process that runs the command specified by
30031 &%argv%&. The environment for the process is specified by &%envp%&, which can
30032 be NULL if no environment variables are to be passed. A new umask is supplied
30033 for the process in &%newumask%&.
30034
30035 Pipes to the standard input and output of the new process are set up
30036 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30037 standard error is cloned to the standard output. If there are any file
30038 descriptors &"in the way"& in the new process, they are closed. If the final
30039 argument is TRUE, the new process is made into a process group leader.
30040
30041 The function returns the pid of the new process, or -1 if things go wrong.
30042
30043 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30044 This function waits for a child process to terminate, or for a timeout (in
30045 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30046 return value is as follows:
30047
30048 .ilist
30049 >= 0
30050
30051 The process terminated by a normal exit and the value is the process
30052 ending status.
30053
30054 .next
30055 < 0 and > &--256
30056
30057 The process was terminated by a signal and the value is the negation of the
30058 signal number.
30059
30060 .next
30061 &--256
30062
30063 The process timed out.
30064 .next
30065 &--257
30066
30067 The was some other error in wait(); &%errno%& is still set.
30068 .endlist
30069
30070 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30071 This function provide you with a means of submitting a new message to
30072 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30073 want, but this packages it all up for you.) The function creates a pipe,
30074 forks a subprocess that is running
30075 .code
30076 exim -t -oem -oi -f <>
30077 .endd
30078 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30079 that is connected to the standard input. The yield of the function is the PID
30080 of the subprocess. You can then write a message to the file descriptor, with
30081 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30082
30083 When you have finished, call &'child_close()'& to wait for the process to
30084 finish and to collect its ending status. A timeout value of zero is usually
30085 fine in this circumstance. Unless you have made a mistake with the recipient
30086 addresses, you should get a return code of zero.
30087
30088
30089 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30090        *sender_authentication)*&
30091 This function is a more sophisticated version of &'child_open()'&. The command
30092 that it runs is:
30093 .display
30094 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30095 .endd
30096 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30097
30098
30099 .vitem &*void&~debug_printf(char&~*,&~...)*&
30100 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30101 output is written to the standard error stream. If no debugging is selected,
30102 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30103 conditional on the &`local_scan`& debug selector by coding like this:
30104 .code
30105 if ((debug_selector & D_local_scan) != 0)
30106   debug_printf("xxx", ...);
30107 .endd
30108
30109 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30110 This is an interface to Exim's string expansion code. The return value is the
30111 expanded string, or NULL if there was an expansion failure.
30112 The C variable &%expand_string_message%& contains an error message after an
30113 expansion failure. If expansion does not change the string, the return value is
30114 the pointer to the input string. Otherwise, the return value points to a new
30115 block of memory that was obtained by a call to &'store_get()'&. See section
30116 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30117
30118 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30119 This function allows you to an add additional header line at the end of the
30120 existing ones. The first argument is the type, and should normally be a space
30121 character. The second argument is a format string and any number of
30122 substitution arguments as for &[sprintf()]&. You may include internal newlines
30123 if you want, and you must ensure that the string ends with a newline.
30124
30125 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30126         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30127 This function adds a new header line at a specified point in the header
30128 chain. The header itself is specified as for &'header_add()'&.
30129
30130 If &%name%& is NULL, the new header is added at the end of the chain if
30131 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30132 NULL, the header lines are searched for the first non-deleted header that
30133 matches the name. If one is found, the new header is added before it if
30134 &%after%& is false. If &%after%& is true, the new header is added after the
30135 found header and any adjacent subsequent ones with the same name (even if
30136 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30137 option controls where the header is added. If it is true, addition is at the
30138 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30139 headers, or at the top if there are no &'Received:'& headers, you could use
30140 .code
30141 header_add_at_position(TRUE, US"Received", TRUE,
30142   ' ', "X-xxx: ...");
30143 .endd
30144 Normally, there is always at least one non-deleted &'Received:'& header, but
30145 there may not be if &%received_header_text%& expands to an empty string.
30146
30147
30148 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30149 This function removes header lines. If &%occurrence%& is zero or negative, all
30150 occurrences of the header are removed. If occurrence is greater than zero, that
30151 particular instance of the header is removed. If no header(s) can be found that
30152 match the specification, the function does nothing.
30153
30154
30155 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30156         int&~length,&~BOOL&~notdel)*&"
30157 This function tests whether the given header has the given name. It is not just
30158 a string comparison, because white space is permitted between the name and the
30159 colon. If the &%notdel%& argument is true, a false return is forced for all
30160 &"deleted"& headers; otherwise they are not treated specially. For example:
30161 .code
30162 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30163 .endd
30164 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30165 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30166 This function base64-encodes a string, which is passed by address and length.
30167 The text may contain bytes of any value, including zero. The result is passed
30168 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30169 zero-terminated.
30170
30171 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30172 This function decodes a base64-encoded string. Its arguments are a
30173 zero-terminated base64-encoded string and the address of a variable that is set
30174 to point to the result, which is in dynamic memory. The length of the decoded
30175 string is the yield of the function. If the input is invalid base64 data, the
30176 yield is -1. A zero byte is added to the end of the output string to make it
30177 easy to interpret as a C string (assuming it contains no zeros of its own). The
30178 added zero byte is not included in the returned count.
30179
30180 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30181 This function checks for a match in a domain list. Domains are always
30182 matched caselessly. The return value is one of the following:
30183 .display
30184 &`OK     `& match succeeded
30185 &`FAIL   `& match failed
30186 &`DEFER  `& match deferred
30187 .endd
30188 DEFER is usually caused by some kind of lookup defer, such as the
30189 inability to contact a database.
30190
30191 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30192         BOOL&~caseless)*&"
30193 This function checks for a match in a local part list. The third argument
30194 controls case-sensitivity. The return values are as for
30195 &'lss_match_domain()'&.
30196
30197 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30198         BOOL&~caseless)*&"
30199 This function checks for a match in an address list. The third argument
30200 controls the case-sensitivity of the local part match. The domain is always
30201 matched caselessly. The return values are as for &'lss_match_domain()'&.
30202
30203 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30204         uschar&~*list)*&"
30205 This function checks for a match in a host list. The most common usage is
30206 expected to be
30207 .code
30208 lss_match_host(sender_host_name, sender_host_address, ...)
30209 .endd
30210 .vindex "&$sender_host_address$&"
30211 An empty address field matches an empty item in the host list. If the host name
30212 is NULL, the name corresponding to &$sender_host_address$& is automatically
30213 looked up if a host name is required to match an item in the list. The return
30214 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30215 returns ERROR in the case when it had to look up a host name, but the lookup
30216 failed.
30217
30218 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30219         *format,&~...)*&"
30220 This function writes to Exim's log files. The first argument should be zero (it
30221 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30222 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30223 them. It specifies to which log or logs the message is written. The remaining
30224 arguments are a format and relevant insertion arguments. The string should not
30225 contain any newlines, not even at the end.
30226
30227
30228 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30229 This function adds an additional recipient to the message. The first argument
30230 is the recipient address. If it is unqualified (has no domain), it is qualified
30231 with the &%qualify_recipient%& domain. The second argument must always be -1.
30232
30233 This function does not allow you to specify a private &%errors_to%& address (as
30234 described with the structure of &%recipient_item%& above), because it pre-dates
30235 the addition of that field to the structure. However, it is easy to add such a
30236 value afterwards. For example:
30237 .code
30238  receive_add_recipient(US"monitor@mydom.example", -1);
30239  recipients_list[recipients_count-1].errors_to =
30240    US"postmaster@mydom.example";
30241 .endd
30242
30243 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30244 This is a convenience function to remove a named recipient from the list of
30245 recipients. It returns true if a recipient was removed, and false if no
30246 matching recipient could be found. The argument must be a complete email
30247 address.
30248 .endlist
30249
30250
30251 .cindex "RFC 2047"
30252 .vlist
30253 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30254   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30255 This function decodes strings that are encoded according to RFC 2047. Typically
30256 these are the contents of header lines. First, each &"encoded word"& is decoded
30257 from the Q or B encoding into a byte-string. Then, if provided with the name of
30258 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30259 made  to translate the result to the named character set. If this fails, the
30260 binary string is returned with an error message.
30261
30262 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30263 maximum MIME word length is enforced. The third argument is the target
30264 encoding, or NULL if no translation is wanted.
30265
30266 .cindex "binary zero" "in RFC 2047 decoding"
30267 .cindex "RFC 2047" "binary zero in"
30268 If a binary zero is encountered in the decoded string, it is replaced by the
30269 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30270 not be 0 because header lines are handled as zero-terminated strings.
30271
30272 The function returns the result of processing the string, zero-terminated; if
30273 &%lenptr%& is not NULL, the length of the result is set in the variable to
30274 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30275
30276 If an error is encountered, the function returns NULL and uses the &%error%&
30277 argument to return an error message. The variable pointed to by &%error%& is
30278 set to NULL if there is no error; it may be set non-NULL even when the function
30279 returns a non-NULL value if decoding was successful, but there was a problem
30280 with translation.
30281
30282
30283 .vitem &*int&~smtp_fflush(void)*&
30284 This function is used in conjunction with &'smtp_printf()'&, as described
30285 below.
30286
30287 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30288 The arguments of this function are like &[printf()]&; it writes to the SMTP
30289 output stream. You should use this function only when there is an SMTP output
30290 stream, that is, when the incoming message is being received via interactive
30291 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30292 is FALSE. If you want to test for an incoming message from another host (as
30293 opposed to a local process that used the &%-bs%& command line option), you can
30294 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30295 is involved.
30296
30297 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30298 output function, so it can be used for all forms of SMTP connection.
30299
30300 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30301 must start with an appropriate response code: 550 if you are going to return
30302 LOCAL_SCAN_REJECT, 451 if you are going to return
30303 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30304 initial lines of a multi-line response, the code must be followed by a hyphen
30305 to indicate that the line is not the final response line. You must also ensure
30306 that the lines you write terminate with CRLF. For example:
30307 .code
30308 smtp_printf("550-this is some extra info\r\n");
30309 return LOCAL_SCAN_REJECT;
30310 .endd
30311 Note that you can also create multi-line responses by including newlines in
30312 the data returned via the &%return_text%& argument. The added value of using
30313 &'smtp_printf()'& is that, for instance, you could introduce delays between
30314 multiple output lines.
30315
30316 The &'smtp_printf()'& function does not return any error indication, because it
30317 does not automatically flush pending output, and therefore does not test
30318 the state of the stream. (In the main code of Exim, flushing and error
30319 detection is done when Exim is ready for the next SMTP input command.) If
30320 you want to flush the output and check for an error (for example, the
30321 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30322 arguments. It flushes the output stream, and returns a non-zero value if there
30323 is an error.
30324
30325 .vitem &*void&~*store_get(int)*&
30326 This function accesses Exim's internal store (memory) manager. It gets a new
30327 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30328 runs out of memory. See the next section for a discussion of memory handling.
30329
30330 .vitem &*void&~*store_get_perm(int)*&
30331 This function is like &'store_get()'&, but it always gets memory from the
30332 permanent pool. See the next section for a discussion of memory handling.
30333
30334 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30335 See below.
30336
30337 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30338 See below.
30339
30340 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30341 These three functions create strings using Exim's dynamic memory facilities.
30342 The first makes a copy of an entire string. The second copies up to a maximum
30343 number of characters, indicated by the second argument. The third uses a format
30344 and insertion arguments to create a new string. In each case, the result is a
30345 pointer to a new string in the current memory pool. See the next section for
30346 more discussion.
30347 .endlist
30348
30349
30350
30351 .section "More about Exim's memory handling" "SECTmemhanloc"
30352 .cindex "&[local_scan()]& function" "memory handling"
30353 No function is provided for freeing memory, because that is never needed.
30354 The dynamic memory that Exim uses when receiving a message is automatically
30355 recycled if another message is received by the same process (this applies only
30356 to incoming SMTP connections &-- other input methods can supply only one
30357 message at a time). After receiving the last message, a reception process
30358 terminates.
30359
30360 Because it is recycled, the normal dynamic memory cannot be used for holding
30361 data that must be preserved over a number of incoming messages on the same SMTP
30362 connection. However, Exim in fact uses two pools of dynamic memory; the second
30363 one is not recycled, and can be used for this purpose.
30364
30365 If you want to allocate memory that remains available for subsequent messages
30366 in the same SMTP connection, you should set
30367 .code
30368 store_pool = POOL_PERM
30369 .endd
30370 before calling the function that does the allocation. There is no need to
30371 restore the value if you do not need to; however, if you do want to revert to
30372 the normal pool, you can either restore the previous value of &%store_pool%& or
30373 set it explicitly to POOL_MAIN.
30374
30375 The pool setting applies to all functions that get dynamic memory, including
30376 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30377 There is also a convenience function called &'store_get_perm()'& that gets a
30378 block of memory from the permanent pool while preserving the value of
30379 &%store_pool%&.
30380 .ecindex IIDlosca
30381
30382
30383
30384
30385 . ////////////////////////////////////////////////////////////////////////////
30386 . ////////////////////////////////////////////////////////////////////////////
30387
30388 .chapter "System-wide message filtering" "CHAPsystemfilter"
30389 .scindex IIDsysfil1 "filter" "system filter"
30390 .scindex IIDsysfil2 "filtering all mail"
30391 .scindex IIDsysfil3 "system filter"
30392 The previous chapters (on ACLs and the local scan function) describe checks
30393 that can be applied to messages before they are accepted by a host. There is
30394 also a mechanism for checking messages once they have been received, but before
30395 they are delivered. This is called the &'system filter'&.
30396
30397 The system filter operates in a similar manner to users' filter files, but it
30398 is run just once per message (however many recipients the message has).
30399 It should not normally be used as a substitute for routing, because &%deliver%&
30400 commands in a system router provide new envelope recipient addresses.
30401 The system filter must be an Exim filter. It cannot be a Sieve filter.
30402
30403 The system filter is run at the start of a delivery attempt, before any routing
30404 is done. If a message fails to be completely delivered at the first attempt,
30405 the system filter is run again at the start of every retry.
30406 If you want your filter to do something only once per message, you can make use
30407 of the &%first_delivery%& condition in an &%if%& command in the filter to
30408 prevent it happening on retries.
30409
30410 .vindex "&$domain$&"
30411 .vindex "&$local_part$&"
30412 &*Warning*&: Because the system filter runs just once, variables that are
30413 specific to individual recipient addresses, such as &$local_part$& and
30414 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30415 you want to run a centrally-specified filter for each recipient address
30416 independently, you can do so by setting up a suitable &(redirect)& router, as
30417 described in section &<<SECTperaddfil>>& below.
30418
30419
30420 .section "Specifying a system filter" "SECID212"
30421 .cindex "uid (user id)" "system filter"
30422 .cindex "gid (group id)" "system filter"
30423 The name of the file that contains the system filter must be specified by
30424 setting &%system_filter%&. If you want the filter to run under a uid and gid
30425 other than root, you must also set &%system_filter_user%& and
30426 &%system_filter_group%& as appropriate. For example:
30427 .code
30428 system_filter = /etc/mail/exim.filter
30429 system_filter_user = exim
30430 .endd
30431 If a system filter generates any deliveries directly to files or pipes (via the
30432 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30433 specified by setting &%system_filter_file_transport%& and
30434 &%system_filter_pipe_transport%&, respectively. Similarly,
30435 &%system_filter_reply_transport%& must be set to handle any messages generated
30436 by the &%reply%& command.
30437
30438
30439 .section "Testing a system filter" "SECID213"
30440 You can run simple tests of a system filter in the same way as for a user
30441 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30442 are permitted only in system filters are recognized.
30443
30444 If you want to test the combined effect of a system filter and a user filter,
30445 you can use both &%-bF%& and &%-bf%& on the same command line.
30446
30447
30448
30449 .section "Contents of a system filter" "SECID214"
30450 The language used to specify system filters is the same as for users' filter
30451 files. It is described in the separate end-user document &'Exim's interface to
30452 mail filtering'&. However, there are some additional features that are
30453 available only in system filters; these are described in subsequent sections.
30454 If they are encountered in a user's filter file or when testing with &%-bf%&,
30455 they cause errors.
30456
30457 .cindex "frozen messages" "manual thaw; testing in filter"
30458 There are two special conditions which, though available in users' filter
30459 files, are designed for use in system filters. The condition &%first_delivery%&
30460 is true only for the first attempt at delivering a message, and
30461 &%manually_thawed%& is true only if the message has been frozen, and
30462 subsequently thawed by an admin user. An explicit forced delivery counts as a
30463 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30464
30465 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30466 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30467 succeed, it will not be tried again.
30468 If you want Exim to retry an unseen delivery until it succeeds, you should
30469 arrange to set it up every time the filter runs.
30470
30471 When a system filter finishes running, the values of the variables &$n0$& &--
30472 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30473 users' filter files. Thus a system filter can, for example, set up &"scores"&
30474 to which users' filter files can refer.
30475
30476
30477
30478 .section "Additional variable for system filters" "SECID215"
30479 .vindex "&$recipients$&"
30480 The expansion variable &$recipients$&, containing a list of all the recipients
30481 of the message (separated by commas and white space), is available in system
30482 filters. It is not available in users' filters for privacy reasons.
30483
30484
30485
30486 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30487 .cindex "freezing messages"
30488 .cindex "message" "freezing"
30489 .cindex "message" "forced failure"
30490 .cindex "&%fail%&" "in system filter"
30491 .cindex "&%freeze%& in system filter"
30492 .cindex "&%defer%& in system filter"
30493 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30494 always available in system filters, but are not normally enabled in users'
30495 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30496 for the &(redirect)& router.) These commands can optionally be followed by the
30497 word &%text%& and a string containing an error message, for example:
30498 .code
30499 fail text "this message looks like spam to me"
30500 .endd
30501 The keyword &%text%& is optional if the next character is a double quote.
30502
30503 The &%defer%& command defers delivery of the original recipients of the
30504 message. The &%fail%& command causes all the original recipients to be failed,
30505 and a bounce message to be created. The &%freeze%& command suspends all
30506 delivery attempts for the original recipients. In all cases, any new deliveries
30507 that are specified by the filter are attempted as normal after the filter has
30508 run.
30509
30510 The &%freeze%& command is ignored if the message has been manually unfrozen and
30511 not manually frozen since. This means that automatic freezing by a system
30512 filter can be used as a way of checking out suspicious messages. If a message
30513 is found to be all right, manually unfreezing it allows it to be delivered.
30514
30515 .cindex "log" "&%fail%& command log line"
30516 .cindex "&%fail%&" "log line; reducing"
30517 The text given with a fail command is used as part of the bounce message as
30518 well as being written to the log. If the message is quite long, this can fill
30519 up a lot of log space when such failures are common. To reduce the size of the
30520 log message, Exim interprets the text in a special way if it starts with the
30521 two characters &`<<`& and contains &`>>`& later. The text between these two
30522 strings is written to the log, and the rest of the text is used in the bounce
30523 message. For example:
30524 .code
30525 fail "<<filter test 1>>Your message is rejected \
30526      because it contains attachments that we are \
30527      not prepared to receive."
30528 .endd
30529
30530 .cindex "loop" "caused by &%fail%&"
30531 Take great care with the &%fail%& command when basing the decision to fail on
30532 the contents of the message, because the bounce message will of course include
30533 the contents of the original message and will therefore trigger the &%fail%&
30534 command again (causing a mail loop) unless steps are taken to prevent this.
30535 Testing the &%error_message%& condition is one way to prevent this. You could
30536 use, for example
30537 .code
30538 if $message_body contains "this is spam" and not error_message
30539 then fail text "spam is not wanted here" endif
30540 .endd
30541 though of course that might let through unwanted bounce messages. The
30542 alternative is clever checking of the body and/or headers to detect bounces
30543 generated by the filter.
30544
30545 The interpretation of a system filter file ceases after a
30546 &%defer%&,
30547 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30548 set up earlier in the filter file are honoured, so you can use a sequence such
30549 as
30550 .code
30551 mail ...
30552 freeze
30553 .endd
30554 to send a specified message when the system filter is freezing (or deferring or
30555 failing) a message. The normal deliveries for the message do not, of course,
30556 take place.
30557
30558
30559
30560 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
30561 .cindex "header lines" "adding; in system filter"
30562 .cindex "header lines" "removing; in system filter"
30563 .cindex "filter" "header lines; adding/removing"
30564 Two filter commands that are available only in system filters are:
30565 .code
30566 headers add <string>
30567 headers remove <string>
30568 .endd
30569 The argument for the &%headers add%& is a string that is expanded and then
30570 added to the end of the message's headers. It is the responsibility of the
30571 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
30572 space is ignored, and if the string is otherwise empty, or if the expansion is
30573 forced to fail, the command has no effect.
30574
30575 You can use &"\n"& within the string, followed by white space, to specify
30576 continued header lines. More than one header may be added in one command by
30577 including &"\n"& within the string without any following white space. For
30578 example:
30579 .code
30580 headers add "X-header-1: ....\n  \
30581              continuation of X-header-1 ...\n\
30582              X-header-2: ...."
30583 .endd
30584 Note that the header line continuation white space after the first newline must
30585 be placed before the backslash that continues the input string, because white
30586 space after input continuations is ignored.
30587
30588 The argument for &%headers remove%& is a colon-separated list of header names.
30589 This command applies only to those headers that are stored with the message;
30590 those that are added at delivery time (such as &'Envelope-To:'& and
30591 &'Return-Path:'&) cannot be removed by this means. If there is more than one
30592 header with the same name, they are all removed.
30593
30594 The &%headers%& command in a system filter makes an immediate change to the set
30595 of header lines that was received with the message (with possible additions
30596 from ACL processing). Subsequent commands in the system filter operate on the
30597 modified set, which also forms the basis for subsequent message delivery.
30598 Unless further modified during routing or transporting, this set of headers is
30599 used for all recipients of the message.
30600
30601 During routing and transporting, the variables that refer to the contents of
30602 header lines refer only to those lines that are in this set. Thus, header lines
30603 that are added by a system filter are visible to users' filter files and to all
30604 routers and transports. This contrasts with the manipulation of header lines by
30605 routers and transports, which is not immediate, but which instead is saved up
30606 until the message is actually being written (see section
30607 &<<SECTheadersaddrem>>&).
30608
30609 If the message is not delivered at the first attempt, header lines that were
30610 added by the system filter are stored with the message, and so are still
30611 present at the next delivery attempt. Header lines that were removed are still
30612 present, but marked &"deleted"& so that they are not transported with the
30613 message. For this reason, it is usual to make the &%headers%& command
30614 conditional on &%first_delivery%& so that the set of header lines is not
30615 modified more than once.
30616
30617 Because header modification in a system filter acts immediately, you have to
30618 use an indirect approach if you want to modify the contents of a header line.
30619 For example:
30620 .code
30621 headers add "Old-Subject: $h_subject:"
30622 headers remove "Subject"
30623 headers add "Subject: new subject (was: $h_old-subject:)"
30624 headers remove "Old-Subject"
30625 .endd
30626
30627
30628
30629 .section "Setting an errors address in a system filter" "SECID217"
30630 .cindex "envelope sender"
30631 In a system filter, if a &%deliver%& command is followed by
30632 .code
30633 errors_to <some address>
30634 .endd
30635 in order to change the envelope sender (and hence the error reporting) for that
30636 delivery, any address may be specified. (In a user filter, only the current
30637 user's address can be set.) For example, if some mail is being monitored, you
30638 might use
30639 .code
30640 unseen deliver monitor@spying.example errors_to root@local.example
30641 .endd
30642 to take a copy which would not be sent back to the normal error reporting
30643 address if its delivery failed.
30644
30645
30646
30647 .section "Per-address filtering" "SECTperaddfil"
30648 .vindex "&$domain$&"
30649 .vindex "&$local_part$&"
30650 In contrast to the system filter, which is run just once per message for each
30651 delivery attempt, it is also possible to set up a system-wide filtering
30652 operation that runs once for each recipient address. In this case, variables
30653 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
30654 filter file could be made dependent on them. This is an example of a router
30655 which implements such a filter:
30656 .code
30657 central_filter:
30658   check_local_user
30659   driver = redirect
30660   domains = +local_domains
30661   file = /central/filters/$local_part
30662   no_verify
30663   allow_filter
30664   allow_freeze
30665 .endd
30666 The filter is run in a separate process under its own uid. Therefore, either
30667 &%check_local_user%& must be set (as above), in which case the filter is run as
30668 the local user, or the &%user%& option must be used to specify which user to
30669 use. If both are set, &%user%& overrides.
30670
30671 Care should be taken to ensure that none of the commands in the filter file
30672 specify a significant delivery if the message is to go on to be delivered to
30673 its intended recipient. The router will not then claim to have dealt with the
30674 address, so it will be passed on to subsequent routers to be delivered in the
30675 normal way.
30676 .ecindex IIDsysfil1
30677 .ecindex IIDsysfil2
30678 .ecindex IIDsysfil3
30679
30680
30681
30682
30683
30684
30685 . ////////////////////////////////////////////////////////////////////////////
30686 . ////////////////////////////////////////////////////////////////////////////
30687
30688 .chapter "Message processing" "CHAPmsgproc"
30689 .scindex IIDmesproc "message" "general processing"
30690 Exim performs various transformations on the sender and recipient addresses of
30691 all messages that it handles, and also on the messages' header lines. Some of
30692 these are optional and configurable, while others always take place. All of
30693 this processing, except rewriting as a result of routing, and the addition or
30694 removal of header lines while delivering, happens when a message is received,
30695 before it is placed on Exim's queue.
30696
30697 Some of the automatic processing takes place by default only for
30698 &"locally-originated"& messages. This adjective is used to describe messages
30699 that are not received over TCP/IP, but instead are passed to an Exim process on
30700 its standard input. This includes the interactive &"local SMTP"& case that is
30701 set up by the &%-bs%& command line option.
30702
30703 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
30704 or ::1) are not considered to be locally-originated. Exim does not treat the
30705 loopback interface specially in any way.
30706
30707 If you want the loopback interface to be treated specially, you must ensure
30708 that there are appropriate entries in your ACLs.
30709
30710
30711
30712
30713 .section "Submission mode for non-local messages" "SECTsubmodnon"
30714 .cindex "message" "submission"
30715 .cindex "submission mode"
30716 Processing that happens automatically for locally-originated messages (unless
30717 &%suppress_local_fixups%& is set) can also be requested for messages that are
30718 received over TCP/IP. The term &"submission mode"& is used to describe this
30719 state. Submission mode is set by the modifier
30720 .code
30721 control = submission
30722 .endd
30723 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
30724 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
30725 a local submission, and is normally used when the source of the message is
30726 known to be an MUA running on a client host (as opposed to an MTA). For
30727 example, to set submission mode for messages originating on the IPv4 loopback
30728 interface, you could include the following in the MAIL ACL:
30729 .code
30730 warn  hosts = 127.0.0.1
30731       control = submission
30732 .endd
30733 .cindex "&%sender_retain%& submission option"
30734 There are some options that can be used when setting submission mode. A slash
30735 is used to separate options. For example:
30736 .code
30737 control = submission/sender_retain
30738 .endd
30739 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
30740 true and &%local_from_check%& false for the current incoming message. The first
30741 of these allows an existing &'Sender:'& header in the message to remain, and
30742 the second suppresses the check to ensure that &'From:'& matches the
30743 authenticated sender. With this setting, Exim still fixes up messages by adding
30744 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
30745 attempt to check sender authenticity in header lines.
30746
30747 When &%sender_retain%& is not set, a submission mode setting may specify a
30748 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30749 example:
30750 .code
30751 control = submission/domain=some.domain
30752 .endd
30753 The domain may be empty. How this value is used is described in sections
30754 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30755 that allows you to specify the user's full name for inclusion in a created
30756 &'Sender:'& or &'From:'& header line. For example:
30757 .code
30758 accept authenticated = *
30759        control = submission/domain=wonderland.example/\
30760                             name=${lookup {$authenticated_id} \
30761                                    lsearch {/etc/exim/namelist}}
30762 .endd
30763 Because the name may contain any characters, including slashes, the &%name%&
30764 option must be given last. The remainder of the string is used as the name. For
30765 the example above, if &_/etc/exim/namelist_& contains:
30766 .code
30767 bigegg:  Humpty Dumpty
30768 .endd
30769 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30770 line would be:
30771 .code
30772 Sender: Humpty Dumpty <bigegg@wonderland.example>
30773 .endd
30774 .cindex "return path" "in submission mode"
30775 By default, submission mode forces the return path to the same address as is
30776 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30777 specified, the return path is also left unchanged.
30778
30779 &*Note*&: The changes caused by submission mode take effect after the predata
30780 ACL. This means that any sender checks performed before the fix-ups use the
30781 untrusted sender address specified by the user, not the trusted sender address
30782 specified by submission mode. Although this might be slightly unexpected, it
30783 does mean that you can configure ACL checks to spot that a user is trying to
30784 spoof another's address.
30785
30786 .section "Line endings" "SECTlineendings"
30787 .cindex "line endings"
30788 .cindex "carriage return"
30789 .cindex "linefeed"
30790 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30791 linefeed) is the line ending for messages transmitted over the Internet using
30792 SMTP over TCP/IP. However, within individual operating systems, different
30793 conventions are used. For example, Unix-like systems use just LF, but others
30794 use CRLF or just CR.
30795
30796 Exim was designed for Unix-like systems, and internally, it stores messages
30797 using the system's convention of a single LF as a line terminator. When
30798 receiving a message, all line endings are translated to this standard format.
30799 Originally, it was thought that programs that passed messages directly to an
30800 MTA within an operating system would use that system's convention. Experience
30801 has shown that this is not the case; for example, there are Unix applications
30802 that use CRLF in this circumstance. For this reason, and for compatibility with
30803 other MTAs, the way Exim handles line endings for all messages is now as
30804 follows:
30805
30806 .ilist
30807 LF not preceded by CR is treated as a line ending.
30808 .next
30809 CR is treated as a line ending; if it is immediately followed by LF, the LF
30810 is ignored.
30811 .next
30812 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30813 nor a local message in the state where a line containing only a dot is a
30814 terminator.
30815 .next
30816 If a bare CR is encountered within a header line, an extra space is added after
30817 the line terminator so as not to end the header line. The reasoning behind this
30818 is that bare CRs in header lines are most likely either to be mistakes, or
30819 people trying to play silly games.
30820 .next
30821 If the first header line received in a message ends with CRLF, a subsequent
30822 bare LF in a header line is treated in the same way as a bare CR in a header
30823 line.
30824 .endlist
30825
30826
30827
30828
30829
30830 .section "Unqualified addresses" "SECID218"
30831 .cindex "unqualified addresses"
30832 .cindex "address" "qualification"
30833 By default, Exim expects every envelope address it receives from an external
30834 host to be fully qualified. Unqualified addresses cause negative responses to
30835 SMTP commands. However, because SMTP is used as a means of transporting
30836 messages from MUAs running on personal workstations, there is sometimes a
30837 requirement to accept unqualified addresses from specific hosts or IP networks.
30838
30839 Exim has two options that separately control which hosts may send unqualified
30840 sender or recipient addresses in SMTP commands, namely
30841 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30842 cases, if an unqualified address is accepted, it is qualified by adding the
30843 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30844
30845 .oindex "&%qualify_domain%&"
30846 .oindex "&%qualify_recipient%&"
30847 Unqualified addresses in header lines are automatically qualified for messages
30848 that are locally originated, unless the &%-bnq%& option is given on the command
30849 line. For messages received over SMTP, unqualified addresses in header lines
30850 are qualified only if unqualified addresses are permitted in SMTP commands. In
30851 other words, such qualification is also controlled by
30852 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30853
30854
30855
30856
30857 .section "The UUCP From line" "SECID219"
30858 .cindex "&""From""& line"
30859 .cindex "UUCP" "&""From""& line"
30860 .cindex "sender" "address"
30861 .oindex "&%uucp_from_pattern%&"
30862 .oindex "&%uucp_from_sender%&"
30863 .cindex "envelope sender"
30864 .cindex "Sendmail compatibility" "&""From""& line"
30865 Messages that have come from UUCP (and some other applications) often begin
30866 with a line containing the envelope sender and a timestamp, following the word
30867 &"From"&. Examples of two common formats are:
30868 .code
30869 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30870 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30871 .endd
30872 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30873 Exim recognizes such lines at the start of messages that are submitted to it
30874 via the command line (that is, on the standard input). It does not recognize
30875 such lines in incoming SMTP messages, unless the sending host matches
30876 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30877 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30878 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30879 default value matches the two common cases shown above and puts the address
30880 that follows &"From"& into &$1$&.
30881
30882 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30883 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30884 a trusted user, the message's sender address is constructed by expanding the
30885 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30886 then parsed as an RFC 2822 address. If there is no domain, the local part is
30887 qualified with &%qualify_domain%& unless it is the empty string. However, if
30888 the command line &%-f%& option is used, it overrides the &"From"& line.
30889
30890 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30891 sender address is not changed. This is also the case for incoming SMTP messages
30892 that are permitted to contain &"From"& lines.
30893
30894 Only one &"From"& line is recognized. If there is more than one, the second is
30895 treated as a data line that starts the body of the message, as it is not valid
30896 as a header line. This also happens if a &"From"& line is present in an
30897 incoming SMTP message from a source that is not permitted to send them.
30898
30899
30900
30901 .section "Resent- header lines" "SECID220"
30902 .cindex "&%Resent-%& header lines"
30903 RFC 2822 makes provision for sets of header lines starting with the string
30904 &`Resent-`& to be added to a message when it is resent by the original
30905 recipient to somebody else. These headers are &'Resent-Date:'&,
30906 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30907 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30908
30909 .blockquote
30910 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30911 processing of replies or other such automatic actions on messages.'&
30912 .endblockquote
30913
30914 This leaves things a bit vague as far as other processing actions such as
30915 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30916 follows:
30917
30918 .ilist
30919 A &'Resent-From:'& line that just contains the login id of the submitting user
30920 is automatically rewritten in the same way as &'From:'& (see below).
30921 .next
30922 If there's a rewriting rule for a particular header line, it is also applied to
30923 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30924 &'From:'& also rewrites &'Resent-From:'&.
30925 .next
30926 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30927 also removed.
30928 .next
30929 For a locally-submitted message,
30930 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30931 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30932 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30933 included in log lines in this case.
30934 .next
30935 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30936 &%Resent-%& header lines are present.
30937 .endlist
30938
30939
30940
30941
30942 .section "The Auto-Submitted: header line" "SECID221"
30943 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30944 includes the header line:
30945 .code
30946 Auto-Submitted: auto-replied
30947 .endd
30948
30949 .section "The Bcc: header line" "SECID222"
30950 .cindex "&'Bcc:'& header line"
30951 If Exim is called with the &%-t%& option, to take recipient addresses from a
30952 message's header, it removes any &'Bcc:'& header line that may exist (after
30953 extracting its addresses). If &%-t%& is not present on the command line, any
30954 existing &'Bcc:'& is not removed.
30955
30956
30957 .section "The Date: header line" "SECID223"
30958 .cindex "&'Date:'& header line"
30959 If a locally-generated or submission-mode message has no &'Date:'& header line,
30960 Exim adds one, using the current date and time, unless the
30961 &%suppress_local_fixups%& control has been specified.
30962
30963 .section "The Delivery-date: header line" "SECID224"
30964 .cindex "&'Delivery-date:'& header line"
30965 .oindex "&%delivery_date_remove%&"
30966 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30967 set. Exim can be configured to add them to the final delivery of messages. (See
30968 the generic &%delivery_date_add%& transport option.) They should not be present
30969 in messages in transit. If the &%delivery_date_remove%& configuration option is
30970 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30971 messages.
30972
30973
30974 .section "The Envelope-to: header line" "SECID225"
30975 .cindex "&'Envelope-to:'& header line"
30976 .oindex "&%envelope_to_remove%&"
30977 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30978 Exim can be configured to add them to the final delivery of messages. (See the
30979 generic &%envelope_to_add%& transport option.) They should not be present in
30980 messages in transit. If the &%envelope_to_remove%& configuration option is set
30981 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30982 messages.
30983
30984
30985 .section "The From: header line" "SECTthefrohea"
30986 .cindex "&'From:'& header line"
30987 .cindex "Sendmail compatibility" "&""From""& line"
30988 .cindex "message" "submission"
30989 .cindex "submission mode"
30990 If a submission-mode message does not contain a &'From:'& header line, Exim
30991 adds one if either of the following conditions is true:
30992
30993 .ilist
30994 The envelope sender address is not empty (that is, this is not a bounce
30995 message). The added header line copies the envelope sender address.
30996 .next
30997 .vindex "&$authenticated_id$&"
30998 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30999 .olist
31000 .vindex "&$qualify_domain$&"
31001 If no domain is specified by the submission control, the local part is
31002 &$authenticated_id$& and the domain is &$qualify_domain$&.
31003 .next
31004 If a non-empty domain is specified by the submission control, the local
31005 part is &$authenticated_id$&, and the domain is the specified domain.
31006 .next
31007 If an empty domain is specified by the submission control,
31008 &$authenticated_id$& is assumed to be the complete address.
31009 .endlist
31010 .endlist
31011
31012 A non-empty envelope sender takes precedence.
31013
31014 If a locally-generated incoming message does not contain a &'From:'& header
31015 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31016 containing the sender's address. The calling user's login name and full name
31017 are used to construct the address, as described in section &<<SECTconstr>>&.
31018 They are obtained from the password data by calling &[getpwuid()]& (but see the
31019 &%unknown_login%& configuration option). The address is qualified with
31020 &%qualify_domain%&.
31021
31022 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31023 &'From:'& header line containing just the unqualified login name of the calling
31024 user, this is replaced by an address containing the user's login name and full
31025 name as described in section &<<SECTconstr>>&.
31026
31027
31028 .section "The Message-ID: header line" "SECID226"
31029 .cindex "&'Message-ID:'& header line"
31030 .cindex "message" "submission"
31031 .oindex "&%message_id_header_text%&"
31032 If a locally-generated or submission-mode incoming message does not contain a
31033 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31034 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31035 to the message. If there are any &'Resent-:'& headers in the message, it
31036 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31037 message id, preceded by the letter E to ensure it starts with a letter, and
31038 followed by @ and the primary host name. Additional information can be included
31039 in this header line by setting the &%message_id_header_text%& and/or
31040 &%message_id_header_domain%& options.
31041
31042
31043 .section "The Received: header line" "SECID227"
31044 .cindex "&'Received:'& header line"
31045 A &'Received:'& header line is added at the start of every message. The
31046 contents are defined by the &%received_header_text%& configuration option, and
31047 Exim automatically adds a semicolon and a timestamp to the configured string.
31048
31049 The &'Received:'& header is generated as soon as the message's header lines
31050 have been received. At this stage, the timestamp in the &'Received:'& header
31051 line is the time that the message started to be received. This is the value
31052 that is seen by the DATA ACL and by the &[local_scan()]& function.
31053
31054 Once a message is accepted, the timestamp in the &'Received:'& header line is
31055 changed to the time of acceptance, which is (apart from a small delay while the
31056 -H spool file is written) the earliest time at which delivery could start.
31057
31058
31059 .section "The References: header line" "SECID228"
31060 .cindex "&'References:'& header line"
31061 Messages created by the &(autoreply)& transport include a &'References:'&
31062 header line. This is constructed according to the rules that are described in
31063 section 3.64 of RFC 2822 (which states that replies should contain such a
31064 header line), and section 3.14 of RFC 3834 (which states that automatic
31065 responses are not different in this respect). However, because some mail
31066 processing software does not cope well with very long header lines, no more
31067 than 12 message IDs are copied from the &'References:'& header line in the
31068 incoming message. If there are more than 12, the first one and then the final
31069 11 are copied, before adding the message ID of the incoming message.
31070
31071
31072
31073 .section "The Return-path: header line" "SECID229"
31074 .cindex "&'Return-path:'& header line"
31075 .oindex "&%return_path_remove%&"
31076 &'Return-path:'& header lines are defined as something an MTA may insert when
31077 it does the final delivery of messages. (See the generic &%return_path_add%&
31078 transport option.) Therefore, they should not be present in messages in
31079 transit. If the &%return_path_remove%& configuration option is set (the
31080 default), Exim removes &'Return-path:'& header lines from incoming messages.
31081
31082
31083
31084 .section "The Sender: header line" "SECTthesenhea"
31085 .cindex "&'Sender:'& header line"
31086 .cindex "message" "submission"
31087 For a locally-originated message from an untrusted user, Exim may remove an
31088 existing &'Sender:'& header line, and it may add a new one. You can modify
31089 these actions by setting the &%local_sender_retain%& option true, the
31090 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31091 control setting.
31092
31093 When a local message is received from an untrusted user and
31094 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31095 control has not been set, a check is made to see if the address given in the
31096 &'From:'& header line is the correct (local) sender of the message. The address
31097 that is expected has the login name as the local part and the value of
31098 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31099 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31100 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31101 line is added to the message.
31102
31103 If you set &%local_from_check%& false, this checking does not occur. However,
31104 the removal of an existing &'Sender:'& line still happens, unless you also set
31105 &%local_sender_retain%& to be true. It is not possible to set both of these
31106 options true at the same time.
31107
31108 .cindex "submission mode"
31109 By default, no processing of &'Sender:'& header lines is done for messages
31110 received over TCP/IP or for messages submitted by trusted users. However, when
31111 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31112 not specified on the submission control, the following processing takes place:
31113
31114 .vindex "&$authenticated_id$&"
31115 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31116 authenticated, and &$authenticated_id$& is not empty, a sender address is
31117 created as follows:
31118
31119 .ilist
31120 .vindex "&$qualify_domain$&"
31121 If no domain is specified by the submission control, the local part is
31122 &$authenticated_id$& and the domain is &$qualify_domain$&.
31123 .next
31124 If a non-empty domain is specified by the submission control, the local part
31125 is &$authenticated_id$&, and the domain is the specified domain.
31126 .next
31127 If an empty domain is specified by the submission control,
31128 &$authenticated_id$& is assumed to be the complete address.
31129 .endlist
31130
31131 This address is compared with the address in the &'From:'& header line. If they
31132 are different, a &'Sender:'& header line containing the created address is
31133 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31134 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31135
31136 .cindex "return path" "created from &'Sender:'&"
31137 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31138 the message (the envelope sender address) is changed to be the same address,
31139 except in the case of submission mode when &%sender_retain%& is specified.
31140
31141
31142
31143 .section "Adding and removing header lines in routers and transports" &&&
31144          "SECTheadersaddrem"
31145 .cindex "header lines" "adding; in router or transport"
31146 .cindex "header lines" "removing; in router or transport"
31147 When a message is delivered, the addition and removal of header lines can be
31148 specified in a system filter, or on any of the routers and transports that
31149 process the message. Section &<<SECTaddremheasys>>& contains details about
31150 modifying headers in a system filter. Header lines can also be added in an ACL
31151 as a message is received (see section &<<SECTaddheadacl>>&).
31152
31153 In contrast to what happens in a system filter, header modifications that are
31154 specified on routers and transports apply only to the particular recipient
31155 addresses that are being processed by those routers and transports. These
31156 changes do not actually take place until a copy of the message is being
31157 transported. Therefore, they do not affect the basic set of header lines, and
31158 they do not affect the values of the variables that refer to header lines.
31159
31160 &*Note*&: In particular, this means that any expansions in the configuration of
31161 the transport cannot refer to the modified header lines, because such
31162 expansions all occur before the message is actually transported.
31163
31164 For both routers and transports, the result of expanding a &%headers_add%&
31165 option must be in the form of one or more RFC 2822 header lines, separated by
31166 newlines (coded as &"\n"&). For example:
31167 .code
31168 headers_add = X-added-header: added by $primary_hostname\n\
31169               X-added-second: another added header line
31170 .endd
31171 Exim does not check the syntax of these added header lines.
31172
31173 The result of expanding &%headers_remove%& must consist of a colon-separated
31174 list of header names. This is confusing, because header names themselves are
31175 often terminated by colons. In this case, the colons are the list separators,
31176 not part of the names. For example:
31177 .code
31178 headers_remove = return-receipt-to:acknowledge-to
31179 .endd
31180 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31181 is expanded at routing time, and then associated with all addresses that are
31182 accepted by that router, and also with any new addresses that it generates. If
31183 an address passes through several routers as a result of aliasing or
31184 forwarding, the changes are cumulative.
31185
31186 .oindex "&%unseen%&"
31187 However, this does not apply to multiple routers that result from the use of
31188 the &%unseen%& option. Any header modifications that were specified by the
31189 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31190
31191 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31192 settings cannot be delivered together in a batch, so a transport is always
31193 dealing with a set of addresses that have the same header-processing
31194 requirements.
31195
31196 The transport starts by writing the original set of header lines that arrived
31197 with the message, possibly modified by the system filter. As it writes out
31198 these lines, it consults the list of header names that were attached to the
31199 recipient address(es) by &%headers_remove%& options in routers, and it also
31200 consults the transport's own &%headers_remove%& option. Header lines whose
31201 names are on either of these lists are not written out. If there are multiple
31202 instances of any listed header, they are all skipped.
31203
31204 After the remaining original header lines have been written, new header
31205 lines that were specified by routers' &%headers_add%& options are written, in
31206 the order in which they were attached to the address. These are followed by any
31207 header lines specified by the transport's &%headers_add%& option.
31208
31209 This way of handling header line modifications in routers and transports has
31210 the following consequences:
31211
31212 .ilist
31213 The original set of header lines, possibly modified by the system filter,
31214 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31215 to it, at all times.
31216 .next
31217 Header lines that are added by a router's
31218 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31219 expansion syntax in subsequent routers or the transport.
31220 .next
31221 Conversely, header lines that are specified for removal by &%headers_remove%&
31222 in a router remain visible to subsequent routers and the transport.
31223 .next
31224 Headers added to an address by &%headers_add%& in a router cannot be removed by
31225 a later router or by a transport.
31226 .next
31227 An added header can refer to the contents of an original header that is to be
31228 removed, even it has the same name as the added header. For example:
31229 .code
31230 headers_remove = subject
31231 headers_add = Subject: new subject (was: $h_subject:)
31232 .endd
31233 .endlist
31234
31235 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31236 for a &(redirect)& router that has the &%one_time%& option set.
31237
31238
31239
31240
31241
31242 .section "Constructed addresses" "SECTconstr"
31243 .cindex "address" "constructed"
31244 .cindex "constructed address"
31245 When Exim constructs a sender address for a locally-generated message, it uses
31246 the form
31247 .display
31248 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31249 .endd
31250 For example:
31251 .code
31252 Zaphod Beeblebrox <zaphod@end.univ.example>
31253 .endd
31254 The user name is obtained from the &%-F%& command line option if set, or
31255 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31256 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31257 ampersand character, this is replaced by the login name with the first letter
31258 upper cased, as is conventional in a number of operating systems. See the
31259 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31260 The &%unknown_username%& option can be used to specify user names in cases when
31261 there is no password file entry.
31262
31263 .cindex "RFC 2047"
31264 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31265 parts of it if necessary. In addition, if it contains any non-printing
31266 characters, it is encoded as described in RFC 2047, which defines a way of
31267 including non-ASCII characters in header lines. The value of the
31268 &%headers_charset%& option specifies the name of the encoding that is used (the
31269 characters are assumed to be in this encoding). The setting of
31270 &%print_topbitchars%& controls whether characters with the top bit set (that
31271 is, with codes greater than 127) count as printing characters or not.
31272
31273
31274
31275 .section "Case of local parts" "SECID230"
31276 .cindex "case of local parts"
31277 .cindex "local part" "case of"
31278 RFC 2822 states that the case of letters in the local parts of addresses cannot
31279 be assumed to be non-significant. Exim preserves the case of local parts of
31280 addresses, but by default it uses a lower-cased form when it is routing,
31281 because on most Unix systems, usernames are in lower case and case-insensitive
31282 routing is required. However, any particular router can be made to use the
31283 original case for local parts by setting the &%caseful_local_part%& generic
31284 router option.
31285
31286 .cindex "mixed-case login names"
31287 If you must have mixed-case user names on your system, the best way to proceed,
31288 assuming you want case-independent handling of incoming email, is to set up
31289 your first router to convert incoming local parts in your domains to the
31290 correct case by means of a file lookup. For example:
31291 .code
31292 correct_case:
31293   driver = redirect
31294   domains = +local_domains
31295   data = ${lookup{$local_part}cdb\
31296               {/etc/usercased.cdb}{$value}fail}\
31297               @$domain
31298 .endd
31299 For this router, the local part is forced to lower case by the default action
31300 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31301 up a new local part in the correct case. If you then set &%caseful_local_part%&
31302 on any subsequent routers which process your domains, they will operate on
31303 local parts with the correct case in a case-sensitive manner.
31304
31305
31306
31307 .section "Dots in local parts" "SECID231"
31308 .cindex "dot" "in local part"
31309 .cindex "local part" "dots in"
31310 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31311 part may not begin or end with a dot, nor have two consecutive dots in the
31312 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31313 empty components for compatibility.
31314
31315
31316
31317 .section "Rewriting addresses" "SECID232"
31318 .cindex "rewriting" "addresses"
31319 Rewriting of sender and recipient addresses, and addresses in headers, can
31320 happen automatically, or as the result of configuration options, as described
31321 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31322 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31323
31324 Automatic rewriting includes qualification, as mentioned above. The other case
31325 in which it can happen is when an incomplete non-local domain is given. The
31326 routing process may cause this to be expanded into the full domain name. For
31327 example, a header such as
31328 .code
31329 To: hare@teaparty
31330 .endd
31331 might get rewritten as
31332 .code
31333 To: hare@teaparty.wonderland.fict.example
31334 .endd
31335 Rewriting as a result of routing is the one kind of message processing that
31336 does not happen at input time, as it cannot be done until the address has
31337 been routed.
31338
31339 Strictly, one should not do &'any'& deliveries of a message until all its
31340 addresses have been routed, in case any of the headers get changed as a
31341 result of routing. However, doing this in practice would hold up many
31342 deliveries for unreasonable amounts of time, just because one address could not
31343 immediately be routed. Exim therefore does not delay other deliveries when
31344 routing of one or more addresses is deferred.
31345 .ecindex IIDmesproc
31346
31347
31348
31349 . ////////////////////////////////////////////////////////////////////////////
31350 . ////////////////////////////////////////////////////////////////////////////
31351
31352 .chapter "SMTP processing" "CHAPSMTP"
31353 .scindex IIDsmtpproc1 "SMTP" "processing details"
31354 .scindex IIDsmtpproc2 "LMTP" "processing details"
31355 Exim supports a number of different ways of using the SMTP protocol, and its
31356 LMTP variant, which is an interactive protocol for transferring messages into a
31357 closed mail store application. This chapter contains details of how SMTP is
31358 processed. For incoming mail, the following are available:
31359
31360 .ilist
31361 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31362 .next
31363 SMTP over the standard input and output (the &%-bs%& option);
31364 .next
31365 Batched SMTP on the standard input (the &%-bS%& option).
31366 .endlist
31367
31368 For mail delivery, the following are available:
31369
31370 .ilist
31371 SMTP over TCP/IP (the &(smtp)& transport);
31372 .next
31373 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31374 &"lmtp"&);
31375 .next
31376 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31377 transport);
31378 .next
31379 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31380 the &%use_bsmtp%& option set).
31381 .endlist
31382
31383 &'Batched SMTP'& is the name for a process in which batches of messages are
31384 stored in or read from files (or pipes), in a format in which SMTP commands are
31385 used to contain the envelope information.
31386
31387
31388
31389 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31390 .cindex "SMTP" "outgoing over TCP/IP"
31391 .cindex "outgoing SMTP over TCP/IP"
31392 .cindex "LMTP" "over TCP/IP"
31393 .cindex "outgoing LMTP over TCP/IP"
31394 .cindex "EHLO"
31395 .cindex "HELO"
31396 .cindex "SIZE option on MAIL command"
31397 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31398 The &%protocol%& option selects which protocol is to be used, but the actual
31399 processing is the same in both cases.
31400
31401 If, in response to its EHLO command, Exim is told that the SIZE
31402 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31403 command. The value of <&'n'&> is the message size plus the value of the
31404 &%size_addition%& option (default 1024) to allow for additions to the message
31405 such as per-transport header lines, or changes made in a
31406 .cindex "transport" "filter"
31407 .cindex "filter" "transport filter"
31408 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31409 suppressed.
31410
31411 If the remote server advertises support for PIPELINING, Exim uses the
31412 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31413 required for the transaction.
31414
31415 If the remote server advertises support for the STARTTLS command, and Exim
31416 was built to support TLS encryption, it tries to start a TLS session unless the
31417 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31418
31419 If the remote server advertises support for the AUTH command, Exim scans
31420 the authenticators configuration for any suitable client settings, as described
31421 in chapter &<<CHAPSMTPAUTH>>&.
31422
31423 .cindex "carriage return"
31424 .cindex "linefeed"
31425 Responses from the remote host are supposed to be terminated by CR followed by
31426 LF. However, there are known to be hosts that do not send CR characters, so in
31427 order to be able to interwork with such hosts, Exim treats LF on its own as a
31428 line terminator.
31429
31430 If a message contains a number of different addresses, all those with the same
31431 characteristics (for example, the same envelope sender) that resolve to the
31432 same set of hosts, in the same order, are sent in a single SMTP transaction,
31433 even if they are for different domains, unless there are more than the setting
31434 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31435 they are split into groups containing no more than &%max_rcpt%&s addresses
31436 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31437 in parallel sessions. The order of hosts with identical MX values is not
31438 significant when checking whether addresses can be batched in this way.
31439
31440 When the &(smtp)& transport suffers a temporary failure that is not
31441 message-related, Exim updates its transport-specific database, which contains
31442 records indexed by host name that remember which messages are waiting for each
31443 particular host. It also updates the retry database with new retry times.
31444
31445 .cindex "hints database" "retry keys"
31446 Exim's retry hints are based on host name plus IP address, so if one address of
31447 a multi-homed host is broken, it will soon be skipped most of the time.
31448 See the next section for more detail about error handling.
31449
31450 .cindex "SMTP" "passed connection"
31451 .cindex "SMTP" "batching over TCP/IP"
31452 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31453 looks in the hints database for the transport to see if there are any queued
31454 messages waiting for the host to which it is connected. If it finds one, it
31455 creates a new Exim process using the &%-MC%& option (which can only be used by
31456 a process running as root or the Exim user) and passes the TCP/IP socket to it
31457 so that it can deliver another message using the same socket. The new process
31458 does only those deliveries that are routed to the connected host, and may in
31459 turn pass the socket on to a third process, and so on.
31460
31461 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31462 limit the number of messages sent down a single TCP/IP connection.
31463
31464 .cindex "asterisk" "after IP address"
31465 The second and subsequent messages delivered down an existing connection are
31466 identified in the main log by the addition of an asterisk after the closing
31467 square bracket of the IP address.
31468
31469
31470
31471
31472 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31473 .cindex "error" "in outgoing SMTP"
31474 .cindex "SMTP" "errors in outgoing"
31475 .cindex "host" "error"
31476 Three different kinds of error are recognized for outgoing SMTP: host errors,
31477 message errors, and recipient errors.
31478
31479 .vlist
31480 .vitem "&*Host errors*&"
31481 A host error is not associated with a particular message or with a
31482 particular recipient of a message. The host errors are:
31483
31484 .ilist
31485 Connection refused or timed out,
31486 .next
31487 Any error response code on connection,
31488 .next
31489 Any error response code to EHLO or HELO,
31490 .next
31491 Loss of connection at any time, except after &"."&,
31492 .next
31493 I/O errors at any time,
31494 .next
31495 Timeouts during the session, other than in response to MAIL, RCPT or
31496 the &"."& at the end of the data.
31497 .endlist ilist
31498
31499 For a host error, a permanent error response on connection, or in response to
31500 EHLO, causes all addresses routed to the host to be failed. Any other host
31501 error causes all addresses to be deferred, and retry data to be created for the
31502 host. It is not tried again, for any message, until its retry time arrives. If
31503 the current set of addresses are not all delivered in this run (to some
31504 alternative host), the message is added to the list of those waiting for this
31505 host, so if it is still undelivered when a subsequent successful delivery is
31506 made to the host, it will be sent down the same SMTP connection.
31507
31508 .vitem "&*Message errors*&"
31509 .cindex "message" "error"
31510 A message error is associated with a particular message when sent to a
31511 particular host, but not with a particular recipient of the message. The
31512 message errors are:
31513
31514 .ilist
31515 Any error response code to MAIL, DATA, or the &"."& that terminates
31516 the data,
31517 .next
31518 Timeout after MAIL,
31519 .next
31520 Timeout or loss of connection after the &"."& that terminates the data. A
31521 timeout after the DATA command itself is treated as a host error, as is loss of
31522 connection at any other time.
31523 .endlist ilist
31524
31525 For a message error, a permanent error response (5&'xx'&) causes all addresses
31526 to be failed, and a delivery error report to be returned to the sender. A
31527 temporary error response (4&'xx'&), or one of the timeouts, causes all
31528 addresses to be deferred. Retry data is not created for the host, but instead,
31529 a retry record for the combination of host plus message id is created. The
31530 message is not added to the list of those waiting for this host. This ensures
31531 that the failing message will not be sent to this host again until the retry
31532 time arrives. However, other messages that are routed to the host are not
31533 affected, so if it is some property of the message that is causing the error,
31534 it will not stop the delivery of other mail.
31535
31536 If the remote host specified support for the SIZE parameter in its response
31537 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31538 over-large message will cause a message error because the error arrives as a
31539 response to MAIL.
31540
31541 .vitem "&*Recipient errors*&"
31542 .cindex "recipient" "error"
31543 A recipient error is associated with a particular recipient of a message. The
31544 recipient errors are:
31545
31546 .ilist
31547 Any error response to RCPT,
31548 .next
31549 Timeout after RCPT.
31550 .endlist
31551
31552 For a recipient error, a permanent error response (5&'xx'&) causes the
31553 recipient address to be failed, and a bounce message to be returned to the
31554 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
31555 address to be deferred, and routing retry data to be created for it. This is
31556 used to delay processing of the address in subsequent queue runs, until its
31557 routing retry time arrives. This applies to all messages, but because it
31558 operates only in queue runs, one attempt will be made to deliver a new message
31559 to the failing address before the delay starts to operate. This ensures that,
31560 if the failure is really related to the message rather than the recipient
31561 (&"message too big for this recipient"& is a possible example), other messages
31562 have a chance of getting delivered. If a delivery to the address does succeed,
31563 the retry information gets cleared, so all stuck messages get tried again, and
31564 the retry clock is reset.
31565
31566 The message is not added to the list of those waiting for this host. Use of the
31567 host for other messages is unaffected, and except in the case of a timeout,
31568 other recipients are processed independently, and may be successfully delivered
31569 in the current SMTP session. After a timeout it is of course impossible to
31570 proceed with the session, so all addresses get deferred. However, those other
31571 than the one that failed do not suffer any subsequent retry delays. Therefore,
31572 if one recipient is causing trouble, the others have a chance of getting
31573 through when a subsequent delivery attempt occurs before the failing
31574 recipient's retry time.
31575 .endlist
31576
31577 In all cases, if there are other hosts (or IP addresses) available for the
31578 current set of addresses (for example, from multiple MX records), they are
31579 tried in this run for any undelivered addresses, subject of course to their
31580 own retry data. In other words, recipient error retry data does not take effect
31581 until the next delivery attempt.
31582
31583 Some hosts have been observed to give temporary error responses to every
31584 MAIL command at certain times (&"insufficient space"& has been seen). It
31585 would be nice if such circumstances could be recognized, and defer data for the
31586 host itself created, but this is not possible within the current Exim design.
31587 What actually happens is that retry data for every (host, message) combination
31588 is created.
31589
31590 The reason that timeouts after MAIL and RCPT are treated specially is that
31591 these can sometimes arise as a result of the remote host's verification
31592 procedures. Exim makes this assumption, and treats them as if a temporary error
31593 response had been received. A timeout after &"."& is treated specially because
31594 it is known that some broken implementations fail to recognize the end of the
31595 message if the last character of the last line is a binary zero. Thus, it is
31596 helpful to treat this case as a message error.
31597
31598 Timeouts at other times are treated as host errors, assuming a problem with the
31599 host, or the connection to it. If a timeout after MAIL, RCPT,
31600 or &"."& is really a connection problem, the assumption is that at the next try
31601 the timeout is likely to occur at some other point in the dialogue, causing it
31602 then to be treated as a host error.
31603
31604 There is experimental evidence that some MTAs drop the connection after the
31605 terminating &"."& if they do not like the contents of the message for some
31606 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
31607 should be given. That is why Exim treats this case as a message rather than a
31608 host error, in order not to delay other messages to the same host.
31609
31610
31611
31612
31613 .section "Incoming SMTP messages over TCP/IP" "SECID233"
31614 .cindex "SMTP" "incoming over TCP/IP"
31615 .cindex "incoming SMTP over TCP/IP"
31616 .cindex "inetd"
31617 .cindex "daemon"
31618 Incoming SMTP messages can be accepted in one of two ways: by running a
31619 listening daemon, or by using &'inetd'&. In the latter case, the entry in
31620 &_/etc/inetd.conf_& should be like this:
31621 .code
31622 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
31623 .endd
31624 Exim distinguishes between this case and the case of a locally running user
31625 agent using the &%-bs%& option by checking whether or not the standard input is
31626 a socket. When it is, either the port must be privileged (less than 1024), or
31627 the caller must be root or the Exim user. If any other user passes a socket
31628 with an unprivileged port number, Exim prints a message on the standard error
31629 stream and exits with an error code.
31630
31631 By default, Exim does not make a log entry when a remote host connects or
31632 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
31633 unexpected. It can be made to write such log entries by setting the
31634 &%smtp_connection%& log selector.
31635
31636 .cindex "carriage return"
31637 .cindex "linefeed"
31638 Commands from the remote host are supposed to be terminated by CR followed by
31639 LF. However, there are known to be hosts that do not send CR characters. In
31640 order to be able to interwork with such hosts, Exim treats LF on its own as a
31641 line terminator.
31642 Furthermore, because common code is used for receiving messages from all
31643 sources, a CR on its own is also interpreted as a line terminator. However, the
31644 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
31645
31646 .cindex "EHLO" "invalid data"
31647 .cindex "HELO" "invalid data"
31648 One area that sometimes gives rise to problems concerns the EHLO or
31649 HELO commands. Some clients send syntactically invalid versions of these
31650 commands, which Exim rejects by default. (This is nothing to do with verifying
31651 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
31652 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
31653 match the broken hosts that send invalid commands.
31654
31655 .cindex "SIZE option on MAIL command"
31656 .cindex "MAIL" "SIZE option"
31657 The amount of disk space available is checked whenever SIZE is received on
31658 a MAIL command, independently of whether &%message_size_limit%& or
31659 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
31660 false. A temporary error is given if there is not enough space. If
31661 &%check_spool_space%& is set, the check is for that amount of space plus the
31662 value given with SIZE, that is, it checks that the addition of the incoming
31663 message will not reduce the space below the threshold.
31664
31665 When a message is successfully received, Exim includes the local message id in
31666 its response to the final &"."& that terminates the data. If the remote host
31667 logs this text it can help with tracing what has happened to a message.
31668
31669 The Exim daemon can limit the number of simultaneous incoming connections it is
31670 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
31671 number of simultaneous incoming connections from a single remote host (see the
31672 &%smtp_accept_max_per_host%& option). Additional connection attempts are
31673 rejected using the SMTP temporary error code 421.
31674
31675 The Exim daemon does not rely on the SIGCHLD signal to detect when a
31676 subprocess has finished, as this can get lost at busy times. Instead, it looks
31677 for completed subprocesses every time it wakes up. Provided there are other
31678 things happening (new incoming calls, starts of queue runs), completed
31679 processes will be noticed and tidied away. On very quiet systems you may
31680 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
31681 it will be noticed when the daemon next wakes up.
31682
31683 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
31684 and can also be set up to reject SMTP calls from non-reserved hosts at times of
31685 high system load &-- for details see the &%smtp_accept_reserve%&,
31686 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
31687 applies in both the daemon and &'inetd'& cases.
31688
31689 Exim normally starts a delivery process for each message received, though this
31690 can be varied by means of the &%-odq%& command line option and the
31691 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
31692 number of simultaneously running delivery processes started in this way from
31693 SMTP input can be limited by the &%smtp_accept_queue%& and
31694 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
31695 subsequently received messages are just put on the input queue without starting
31696 a delivery process.
31697
31698 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
31699 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
31700 started up from the &'inetd'& daemon, because in that case each connection is
31701 handled by an entirely independent Exim process. Control by load average is,
31702 however, available with &'inetd'&.
31703
31704 Exim can be configured to verify addresses in incoming SMTP commands as they
31705 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
31706 to rewrite addresses at this time &-- before any syntax checking is done. See
31707 section &<<SECTrewriteS>>&.
31708
31709 Exim can also be configured to limit the rate at which a client host submits
31710 MAIL and RCPT commands in a single SMTP session. See the
31711 &%smtp_ratelimit_hosts%& option.
31712
31713
31714
31715 .section "Unrecognized SMTP commands" "SECID234"
31716 .cindex "SMTP" "unrecognized commands"
31717 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
31718 commands during a single SMTP connection, it drops the connection after sending
31719 the error response to the last command. The default value for
31720 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
31721 abuse that subvert web servers into making connections to SMTP ports; in these
31722 circumstances, a number of non-SMTP lines are sent first.
31723
31724
31725 .section "Syntax and protocol errors in SMTP commands" "SECID235"
31726 .cindex "SMTP" "syntax errors"
31727 .cindex "SMTP" "protocol errors"
31728 A syntax error is detected if an SMTP command is recognized, but there is
31729 something syntactically wrong with its data, for example, a malformed email
31730 address in a RCPT command. Protocol errors include invalid command
31731 sequencing such as RCPT before MAIL. If Exim receives more than
31732 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
31733 drops the connection after sending the error response to the last command. The
31734 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
31735 broken clients that loop sending bad commands (yes, it has been seen).
31736
31737
31738
31739 .section "Use of non-mail SMTP commands" "SECID236"
31740 .cindex "SMTP" "non-mail commands"
31741 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
31742 DATA. Exim counts such commands, and drops the connection if there are too
31743 many of them in a single SMTP session. This action catches some
31744 denial-of-service attempts and things like repeated failing AUTHs, or a mad
31745 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
31746 defines what &"too many"& means. Its default value is 10.
31747
31748 When a new message is expected, one occurrence of RSET is not counted. This
31749 allows a client to send one RSET between messages (this is not necessary,
31750 but some clients do it). Exim also allows one uncounted occurrence of HELO
31751 or EHLO, and one occurrence of STARTTLS between messages. After
31752 starting up a TLS session, another EHLO is expected, and so it too is not
31753 counted.
31754
31755 The first occurrence of AUTH in a connection, or immediately following
31756 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31757 RCPT, DATA, and QUIT are counted.
31758
31759 You can control which hosts are subject to the limit set by
31760 &%smtp_accept_max_nonmail%& by setting
31761 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31762 the limit apply to all hosts. This option means that you can exclude any
31763 specific badly-behaved hosts that you have to live with.
31764
31765
31766
31767
31768 .section "The VRFY and EXPN commands" "SECID237"
31769 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31770 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31771 appropriate) in order to decide whether the command should be accepted or not.
31772 If no ACL is defined, the command is rejected.
31773
31774 .cindex "VRFY" "processing"
31775 When VRFY is accepted, it runs exactly the same code as when Exim is
31776 called with the &%-bv%& option.
31777
31778 .cindex "EXPN" "processing"
31779 When EXPN is accepted, a single-level expansion of the address is done.
31780 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31781 than a verification (the &%-bv%& option). If an unqualified local part is given
31782 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31783 of VRFY and EXPN commands are logged on the main and reject logs, and
31784 VRFY verification failures are logged on the main log for consistency with
31785 RCPT failures.
31786
31787
31788
31789 .section "The ETRN command" "SECTETRN"
31790 .cindex "ETRN" "processing"
31791 RFC 1985 describes an SMTP command called ETRN that is designed to
31792 overcome the security problems of the TURN command (which has fallen into
31793 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31794 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31795 should be accepted or not. If no ACL is defined, the command is rejected.
31796
31797 The ETRN command is concerned with &"releasing"& messages that are awaiting
31798 delivery to certain hosts. As Exim does not organize its message queue by host,
31799 the only form of ETRN that is supported by default is the one where the
31800 text starts with the &"#"& prefix, in which case the remainder of the text is
31801 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31802 the &%-R%& option to happen, with the remainder of the ETRN text as its
31803 argument. For example,
31804 .code
31805 ETRN #brigadoon
31806 .endd
31807 runs the command
31808 .code
31809 exim -R brigadoon
31810 .endd
31811 which causes a delivery attempt on all messages with undelivered addresses
31812 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31813 default), Exim prevents the simultaneous execution of more than one queue run
31814 for the same argument string as a result of an ETRN command. This stops
31815 a misbehaving client from starting more than one queue runner at once.
31816
31817 .cindex "hints database" "ETRN serialization"
31818 Exim implements the serialization by means of a hints database in which a
31819 record is written whenever a process is started by ETRN, and deleted when
31820 the process completes. However, Exim does not keep the SMTP session waiting for
31821 the ETRN process to complete. Once ETRN is accepted, the client is sent
31822 a &"success"& return code. Obviously there is scope for hints records to get
31823 left lying around if there is a system or program crash. To guard against this,
31824 Exim ignores any records that are more than six hours old.
31825
31826 .oindex "&%smtp_etrn_command%&"
31827 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31828 used. This specifies a command that is run whenever ETRN is received,
31829 whatever the form of its argument. For
31830 example:
31831 .code
31832 smtp_etrn_command = /etc/etrn_command $domain \
31833                     $sender_host_address
31834 .endd
31835 .vindex "&$domain$&"
31836 The string is split up into arguments which are independently expanded. The
31837 expansion variable &$domain$& is set to the argument of the ETRN command,
31838 and no syntax checking is done on the contents of this argument. Exim does not
31839 wait for the command to complete, so its status code is not checked. Exim runs
31840 under its own uid and gid when receiving incoming SMTP, so it is not possible
31841 for it to change them before running the command.
31842
31843
31844
31845 .section "Incoming local SMTP" "SECID238"
31846 .cindex "SMTP" "local incoming"
31847 Some user agents use SMTP to pass messages to their local MTA using the
31848 standard input and output, as opposed to passing the envelope on the command
31849 line and writing the message to the standard input. This is supported by the
31850 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31851 messages over TCP/IP (including the use of ACLs), except that the envelope
31852 sender given in a MAIL command is ignored unless the caller is trusted. In
31853 an ACL you can detect this form of SMTP input by testing for an empty host
31854 identification. It is common to have this as the first line in the ACL that
31855 runs for RCPT commands:
31856 .code
31857 accept hosts = :
31858 .endd
31859 This accepts SMTP messages from local processes without doing any other tests.
31860
31861
31862
31863 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31864 .cindex "SMTP" "batched outgoing"
31865 .cindex "batched SMTP output"
31866 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31867 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31868 be output in BSMTP format. No SMTP responses are possible for this form of
31869 delivery. All it is doing is using SMTP commands as a way of transmitting the
31870 envelope along with the message.
31871
31872 The message is written to the file or pipe preceded by the SMTP commands
31873 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31874 the message that start with a dot have an extra dot added. The SMTP command
31875 HELO is not normally used. If it is required, the &%message_prefix%& option
31876 can be used to specify it.
31877
31878 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31879 one recipient address at a time by default. However, you can arrange for them
31880 to handle several addresses at once by setting the &%batch_max%& option. When
31881 this is done for BSMTP, messages may contain multiple RCPT commands. See
31882 chapter &<<CHAPbatching>>& for more details.
31883
31884 .vindex "&$host$&"
31885 When one or more addresses are routed to a BSMTP transport by a router that
31886 sets up a host list, the name of the first host on the list is available to the
31887 transport in the variable &$host$&. Here is an example of such a transport and
31888 router:
31889 .code
31890 begin routers
31891 route_append:
31892   driver = manualroute
31893   transport = smtp_appendfile
31894   route_list = domain.example  batch.host.example
31895
31896 begin transports
31897 smtp_appendfile:
31898   driver = appendfile
31899   directory = /var/bsmtp/$host
31900   batch_max = 1000
31901   use_bsmtp
31902   user = exim
31903 .endd
31904 This causes messages addressed to &'domain.example'& to be written in BSMTP
31905 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31906 message (unless there are more than 1000 recipients).
31907
31908
31909
31910 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31911 .cindex "SMTP" "batched incoming"
31912 .cindex "batched SMTP input"
31913 The &%-bS%& command line option causes Exim to accept one or more messages by
31914 reading SMTP on the standard input, but to generate no responses. If the caller
31915 is trusted, the senders in the MAIL commands are believed; otherwise the
31916 sender is always the caller of Exim. Unqualified senders and receivers are not
31917 rejected (there seems little point) but instead just get qualified. HELO
31918 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31919 as NOOP; QUIT quits.
31920
31921 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31922 ACL is run in the same way as for non-SMTP local input.
31923
31924 If an error is detected while reading a message, including a missing &"."& at
31925 the end, Exim gives up immediately. It writes details of the error to the
31926 standard output in a stylized way that the calling program should be able to
31927 make some use of automatically, for example:
31928 .code
31929 554 Unexpected end of file
31930 Transaction started in line 10
31931 Error detected in line 14
31932 .endd
31933 It writes a more verbose version, for human consumption, to the standard error
31934 file, for example:
31935 .code
31936 An error was detected while processing a file of BSMTP input.
31937 The error message was:
31938
31939 501 '>' missing at end of address
31940
31941 The SMTP transaction started in line 10.
31942 The error was detected in line 12.
31943 The SMTP command at fault was:
31944
31945 rcpt to:<malformed@in.com.plete
31946
31947 1 previous message was successfully processed.
31948 The rest of the batch was abandoned.
31949 .endd
31950 The return code from Exim is zero only if there were no errors. It is 1 if some
31951 messages were accepted before an error was detected, and 2 if no messages were
31952 accepted.
31953 .ecindex IIDsmtpproc1
31954 .ecindex IIDsmtpproc2
31955
31956
31957
31958 . ////////////////////////////////////////////////////////////////////////////
31959 . ////////////////////////////////////////////////////////////////////////////
31960
31961 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31962          "Customizing messages"
31963 When a message fails to be delivered, or remains on the queue for more than a
31964 configured amount of time, Exim sends a message to the original sender, or
31965 to an alternative configured address. The text of these messages is built into
31966 the code of Exim, but it is possible to change it, either by adding a single
31967 string, or by replacing each of the paragraphs by text supplied in a file.
31968
31969 The &'From:'& and &'To:'& header lines are automatically generated; you can
31970 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31971 option. Exim also adds the line
31972 .code
31973 Auto-Submitted: auto-generated
31974 .endd
31975 to all warning and bounce messages,
31976
31977
31978 .section "Customizing bounce messages" "SECID239"
31979 .cindex "customizing" "bounce message"
31980 .cindex "bounce message" "customizing"
31981 If &%bounce_message_text%& is set, its contents are included in the default
31982 message immediately after &"This message was created automatically by mail
31983 delivery software."& The string is not expanded. It is not used if
31984 &%bounce_message_file%& is set.
31985
31986 When &%bounce_message_file%& is set, it must point to a template file for
31987 constructing error messages. The file consists of a series of text items,
31988 separated by lines consisting of exactly four asterisks. If the file cannot be
31989 opened, default text is used and a message is written to the main and panic
31990 logs. If any text item in the file is empty, default text is used for that
31991 item.
31992
31993 .vindex "&$bounce_recipient$&"
31994 .vindex "&$bounce_return_size_limit$&"
31995 Each item of text that is read from the file is expanded, and there are two
31996 expansion variables which can be of use here: &$bounce_recipient$& is set to
31997 the recipient of an error message while it is being created, and
31998 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31999 option, rounded to a whole number.
32000
32001 The items must appear in the file in the following order:
32002
32003 .ilist
32004 The first item is included in the headers, and should include at least a
32005 &'Subject:'& header. Exim does not check the syntax of these headers.
32006 .next
32007 The second item forms the start of the error message. After it, Exim lists the
32008 failing addresses with their error messages.
32009 .next
32010 The third item is used to introduce any text from pipe transports that is to be
32011 returned to the sender. It is omitted if there is no such text.
32012 .next
32013 The fourth item is used to introduce the copy of the message that is returned
32014 as part of the error report.
32015 .next
32016 The fifth item is added after the fourth one if the returned message is
32017 truncated because it is bigger than &%return_size_limit%&.
32018 .next
32019 The sixth item is added after the copy of the original message.
32020 .endlist
32021
32022 The default state (&%bounce_message_file%& unset) is equivalent to the
32023 following file, in which the sixth item is empty. The &'Subject:'& and some
32024 other lines have been split in order to fit them on the page:
32025 .code
32026 Subject: Mail delivery failed
32027   ${if eq{$sender_address}{$bounce_recipient}
32028   {: returning message to sender}}
32029 ****
32030 This message was created automatically by mail delivery software.
32031
32032 A message ${if eq{$sender_address}{$bounce_recipient}
32033   {that you sent }{sent by
32034
32035 <$sender_address>
32036
32037 }}could not be delivered to all of its recipients.
32038 This is a permanent error. The following address(es) failed:
32039 ****
32040 The following text was generated during the delivery attempt(s):
32041 ****
32042 ------ This is a copy of the message, including all the headers.
32043   ------
32044 ****
32045 ------ The body of the message is $message_size characters long;
32046   only the first
32047 ------ $bounce_return_size_limit or so are included here.
32048 ****
32049 .endd
32050 .section "Customizing warning messages" "SECTcustwarn"
32051 .cindex "customizing" "warning message"
32052 .cindex "warning of delay" "customizing the message"
32053 The option &%warn_message_file%& can be pointed at a template file for use when
32054 warnings about message delays are created. In this case there are only three
32055 text sections:
32056
32057 .ilist
32058 The first item is included in the headers, and should include at least a
32059 &'Subject:'& header. Exim does not check the syntax of these headers.
32060 .next
32061 The second item forms the start of the warning message. After it, Exim lists
32062 the delayed addresses.
32063 .next
32064 The third item then ends the message.
32065 .endlist
32066
32067 The default state is equivalent to the following file, except that some lines
32068 have been split here, in order to fit them on the page:
32069 .code
32070 Subject: Warning: message $message_exim_id delayed
32071   $warn_message_delay
32072 ****
32073 This message was created automatically by mail delivery software.
32074
32075 A message ${if eq{$sender_address}{$warn_message_recipients}
32076 {that you sent }{sent by
32077
32078 <$sender_address>
32079
32080 }}has not been delivered to all of its recipients after
32081 more than $warn_message_delay on the queue on $primary_hostname.
32082
32083 The message identifier is:     $message_exim_id
32084 The subject of the message is: $h_subject
32085 The date of the message is:    $h_date
32086
32087 The following address(es) have not yet been delivered:
32088 ****
32089 No action is required on your part. Delivery attempts will
32090 continue for some time, and this warning may be repeated at
32091 intervals if the message remains undelivered. Eventually the
32092 mail delivery software will give up, and when that happens,
32093 the message will be returned to you.
32094 .endd
32095 .vindex "&$warn_message_delay$&"
32096 .vindex "&$warn_message_recipients$&"
32097 However, in the default state the subject and date lines are omitted if no
32098 appropriate headers exist. During the expansion of this file,
32099 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32100 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32101 of recipients for the warning message. There may be more than one if there are
32102 multiple addresses with different &%errors_to%& settings on the routers that
32103 handled them.
32104
32105
32106
32107
32108 . ////////////////////////////////////////////////////////////////////////////
32109 . ////////////////////////////////////////////////////////////////////////////
32110
32111 .chapter "Some common configuration settings" "CHAPcomconreq"
32112 This chapter discusses some configuration settings that seem to be fairly
32113 common. More examples and discussion can be found in the Exim book.
32114
32115
32116
32117 .section "Sending mail to a smart host" "SECID240"
32118 .cindex "smart host" "example router"
32119 If you want to send all mail for non-local domains to a &"smart host"&, you
32120 should replace the default &(dnslookup)& router with a router which does the
32121 routing explicitly:
32122 .code
32123 send_to_smart_host:
32124   driver = manualroute
32125   route_list = !+local_domains smart.host.name
32126   transport = remote_smtp
32127 .endd
32128 You can use the smart host's IP address instead of the name if you wish.
32129 If you are using Exim only to submit messages to a smart host, and not for
32130 receiving incoming messages, you can arrange for it to do the submission
32131 synchronously by setting the &%mua_wrapper%& option (see chapter
32132 &<<CHAPnonqueueing>>&).
32133
32134
32135
32136
32137 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32138 .cindex "mailing lists"
32139 Exim can be used to run simple mailing lists, but for large and/or complicated
32140 requirements, the use of additional specialized mailing list software such as
32141 Majordomo or Mailman is recommended.
32142
32143 The &(redirect)& router can be used to handle mailing lists where each list
32144 is maintained in a separate file, which can therefore be managed by an
32145 independent manager. The &%domains%& router option can be used to run these
32146 lists in a separate domain from normal mail. For example:
32147 .code
32148 lists:
32149   driver = redirect
32150   domains = lists.example
32151   file = /usr/lists/$local_part
32152   forbid_pipe
32153   forbid_file
32154   errors_to = $local_part-request@lists.example
32155   no_more
32156 .endd
32157 This router is skipped for domains other than &'lists.example'&. For addresses
32158 in that domain, it looks for a file that matches the local part. If there is no
32159 such file, the router declines, but because &%no_more%& is set, no subsequent
32160 routers are tried, and so the whole delivery fails.
32161
32162 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32163 expanded into a file name or a pipe delivery, which is usually inappropriate in
32164 a mailing list.
32165
32166 .oindex "&%errors_to%&"
32167 The &%errors_to%& option specifies that any delivery errors caused by addresses
32168 taken from a mailing list are to be sent to the given address rather than the
32169 original sender of the message. However, before acting on this, Exim verifies
32170 the error address, and ignores it if verification fails.
32171
32172 For example, using the configuration above, mail sent to
32173 &'dicts@lists.example'& is passed on to those addresses contained in
32174 &_/usr/lists/dicts_&, with error reports directed to
32175 &'dicts-request@lists.example'&, provided that this address can be verified.
32176 There could be a file called &_/usr/lists/dicts-request_& containing
32177 the address(es) of this particular list's manager(s), but other approaches,
32178 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32179 or &%local_part_suffix%& options) to handle addresses of the form
32180 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32181
32182
32183
32184 .section "Syntax errors in mailing lists" "SECID241"
32185 .cindex "mailing lists" "syntax errors in"
32186 If an entry in redirection data contains a syntax error, Exim normally defers
32187 delivery of the original address. That means that a syntax error in a mailing
32188 list holds up all deliveries to the list. This may not be appropriate when a
32189 list is being maintained automatically from data supplied by users, and the
32190 addresses are not rigorously checked.
32191
32192 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32193 entries that fail to parse, noting the incident in the log. If in addition
32194 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32195 whenever a broken address is skipped. It is usually appropriate to set
32196 &%syntax_errors_to%& to the same address as &%errors_to%&.
32197
32198
32199
32200 .section "Re-expansion of mailing lists" "SECID242"
32201 .cindex "mailing lists" "re-expansion of"
32202 Exim remembers every individual address to which a message has been delivered,
32203 in order to avoid duplication, but it normally stores only the original
32204 recipient addresses with a message. If all the deliveries to a mailing list
32205 cannot be done at the first attempt, the mailing list is re-expanded when the
32206 delivery is next tried. This means that alterations to the list are taken into
32207 account at each delivery attempt, so addresses that have been added to
32208 the list since the message arrived will therefore receive a copy of the
32209 message, even though it pre-dates their subscription.
32210
32211 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32212 on the &(redirect)& router. If this is done, any addresses generated by the
32213 router that fail to deliver at the first attempt are added to the message as
32214 &"top level"& addresses, and the parent address that generated them is marked
32215 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32216 subsequent delivery attempts. The disadvantage of this is that if any of the
32217 failing addresses are incorrect, correcting them in the file has no effect on
32218 pre-existing messages.
32219
32220 The original top-level address is remembered with each of the generated
32221 addresses, and is output in any log messages. However, any intermediate parent
32222 addresses are not recorded. This makes a difference to the log only if the
32223 &%all_parents%& selector is set, but for mailing lists there is normally only
32224 one level of expansion anyway.
32225
32226
32227
32228 .section "Closed mailing lists" "SECID243"
32229 .cindex "mailing lists" "closed"
32230 The examples so far have assumed open mailing lists, to which anybody may
32231 send mail. It is also possible to set up closed lists, where mail is accepted
32232 from specified senders only. This is done by making use of the generic
32233 &%senders%& option to restrict the router that handles the list.
32234
32235 The following example uses the same file as a list of recipients and as a list
32236 of permitted senders. It requires three routers:
32237 .code
32238 lists_request:
32239   driver = redirect
32240   domains = lists.example
32241   local_part_suffix = -request
32242   file = /usr/lists/$local_part$local_part_suffix
32243   no_more
32244
32245 lists_post:
32246   driver = redirect
32247   domains = lists.example
32248   senders = ${if exists {/usr/lists/$local_part}\
32249              {lsearch;/usr/lists/$local_part}{*}}
32250   file = /usr/lists/$local_part
32251   forbid_pipe
32252   forbid_file
32253   errors_to = $local_part-request@lists.example
32254   no_more
32255
32256 lists_closed:
32257   driver = redirect
32258   domains = lists.example
32259   allow_fail
32260   data = :fail: $local_part@lists.example is a closed mailing list
32261 .endd
32262 All three routers have the same &%domains%& setting, so for any other domains,
32263 they are all skipped. The first router runs only if the local part ends in
32264 &%-request%&. It handles messages to the list manager(s) by means of an open
32265 mailing list.
32266
32267 The second router runs only if the &%senders%& precondition is satisfied. It
32268 checks for the existence of a list that corresponds to the local part, and then
32269 checks that the sender is on the list by means of a linear search. It is
32270 necessary to check for the existence of the file before trying to search it,
32271 because otherwise Exim thinks there is a configuration error. If the file does
32272 not exist, the expansion of &%senders%& is *, which matches all senders. This
32273 means that the router runs, but because there is no list, declines, and
32274 &%no_more%& ensures that no further routers are run. The address fails with an
32275 &"unrouteable address"& error.
32276
32277 The third router runs only if the second router is skipped, which happens when
32278 a mailing list exists, but the sender is not on it. This router forcibly fails
32279 the address, giving a suitable error message.
32280
32281
32282
32283
32284 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32285 .cindex "VERP"
32286 .cindex "Variable Envelope Return Paths"
32287 .cindex "envelope sender"
32288 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32289 are a way of helping mailing list administrators discover which subscription
32290 address is the cause of a particular delivery failure. The idea is to encode
32291 the original recipient address in the outgoing envelope sender address, so that
32292 if the message is forwarded by another host and then subsequently bounces, the
32293 original recipient can be extracted from the recipient address of the bounce.
32294
32295 .oindex &%errors_to%&
32296 .oindex &%return_path%&
32297 Envelope sender addresses can be modified by Exim using two different
32298 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32299 list examples), or the &%return_path%& option on a transport. The second of
32300 these is effective only if the message is successfully delivered to another
32301 host; it is not used for errors detected on the local host (see the description
32302 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32303 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32304 .code
32305 verp_smtp:
32306   driver = smtp
32307   max_rcpt = 1
32308   return_path = \
32309     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32310       {$1-request+$local_part=$domain@your.dom.example}fail}
32311 .endd
32312 This has the effect of rewriting the return path (envelope sender) on outgoing
32313 SMTP messages, if the local part of the original return path ends in
32314 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32315 local part and domain of the recipient into the return path. Suppose, for
32316 example, that a message whose return path has been set to
32317 &'somelist-request@your.dom.example'& is sent to
32318 &'subscriber@other.dom.example'&. In the transport, the return path is
32319 rewritten as
32320 .code
32321 somelist-request+subscriber=other.dom.example@your.dom.example
32322 .endd
32323 .vindex "&$local_part$&"
32324 For this to work, you must tell Exim to send multiple copies of messages that
32325 have more than one recipient, so that each copy has just one recipient. This is
32326 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32327 might be sent to several different recipients in the same domain, in which case
32328 &$local_part$& is not available in the transport, because it is not unique.
32329
32330 Unless your host is doing nothing but mailing list deliveries, you should
32331 probably use a separate transport for the VERP deliveries, so as not to use
32332 extra resources in making one-per-recipient copies for other deliveries. This
32333 can easily be done by expanding the &%transport%& option in the router:
32334 .code
32335 dnslookup:
32336   driver = dnslookup
32337   domains = ! +local_domains
32338   transport = \
32339     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32340       {verp_smtp}{remote_smtp}}
32341   no_more
32342 .endd
32343 If you want to change the return path using &%errors_to%& in a router instead
32344 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32345 routers that handle mailing list addresses. This will ensure that all delivery
32346 errors, including those detected on the local host, are sent to the VERP
32347 address.
32348
32349 On a host that does no local deliveries and has no manual routing, only the
32350 &(dnslookup)& router needs to be changed. A special transport is not needed for
32351 SMTP deliveries. Every mailing list recipient has its own return path value,
32352 and so Exim must hand them to the transport one at a time. Here is an example
32353 of a &(dnslookup)& router that implements VERP:
32354 .code
32355 verp_dnslookup:
32356   driver = dnslookup
32357   domains = ! +local_domains
32358   transport = remote_smtp
32359   errors_to = \
32360     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32361      {$1-request+$local_part=$domain@your.dom.example}fail}
32362   no_more
32363 .endd
32364 Before you start sending out messages with VERPed return paths, you must also
32365 configure Exim to accept the bounce messages that come back to those paths.
32366 Typically this is done by setting a &%local_part_suffix%& option for a
32367 router, and using this to route the messages to wherever you want to handle
32368 them.
32369
32370 The overhead incurred in using VERP depends very much on the size of the
32371 message, the number of recipient addresses that resolve to the same remote
32372 host, and the speed of the connection over which the message is being sent. If
32373 a lot of addresses resolve to the same host and the connection is slow, sending
32374 a separate copy of the message for each address may take substantially longer
32375 than sending a single copy with many recipients (for which VERP cannot be
32376 used).
32377
32378
32379
32380
32381
32382
32383 .section "Virtual domains" "SECTvirtualdomains"
32384 .cindex "virtual domains"
32385 .cindex "domain" "virtual"
32386 The phrase &'virtual domain'& is unfortunately used with two rather different
32387 meanings:
32388
32389 .ilist
32390 A domain for which there are no real mailboxes; all valid local parts are
32391 aliases for other email addresses. Common examples are organizational
32392 top-level domains and &"vanity"& domains.
32393 .next
32394 One of a number of independent domains that are all handled by the same host,
32395 with mailboxes on that host, but where the mailbox owners do not necessarily
32396 have login accounts on that host.
32397 .endlist
32398
32399 The first usage is probably more common, and does seem more &"virtual"& than
32400 the second. This kind of domain can be handled in Exim with a straightforward
32401 aliasing router. One approach is to create a separate alias file for each
32402 virtual domain. Exim can test for the existence of the alias file to determine
32403 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32404 to a router of this form:
32405 .code
32406 virtual:
32407   driver = redirect
32408   domains = dsearch;/etc/mail/virtual
32409   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32410   no_more
32411 .endd
32412 The &%domains%& option specifies that the router is to be skipped, unless there
32413 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32414 domain that is being processed. When the router runs, it looks up the local
32415 part in the file to find a new address (or list of addresses). The &%no_more%&
32416 setting ensures that if the lookup fails (leading to &%data%& being an empty
32417 string), Exim gives up on the address without trying any subsequent routers.
32418
32419 This one router can handle all the virtual domains because the alias file names
32420 follow a fixed pattern. Permissions can be arranged so that appropriate people
32421 can edit the different alias files. A successful aliasing operation results in
32422 a new envelope recipient address, which is then routed from scratch.
32423
32424 The other kind of &"virtual"& domain can also be handled in a straightforward
32425 way. One approach is to create a file for each domain containing a list of
32426 valid local parts, and use it in a router like this:
32427 .code
32428 my_domains:
32429   driver = accept
32430   domains = dsearch;/etc/mail/domains
32431   local_parts = lsearch;/etc/mail/domains/$domain
32432   transport = my_mailboxes
32433 .endd
32434 The address is accepted if there is a file for the domain, and the local part
32435 can be found in the file. The &%domains%& option is used to check for the
32436 file's existence because &%domains%& is tested before the &%local_parts%&
32437 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32438 because that option is tested after &%local_parts%&. The transport is as
32439 follows:
32440 .code
32441 my_mailboxes:
32442   driver = appendfile
32443   file = /var/mail/$domain/$local_part
32444   user = mail
32445 .endd
32446 This uses a directory of mailboxes for each domain. The &%user%& setting is
32447 required, to specify which uid is to be used for writing to the mailboxes.
32448
32449 The configuration shown here is just one example of how you might support this
32450 requirement. There are many other ways this kind of configuration can be set
32451 up, for example, by using a database instead of separate files to hold all the
32452 information about the domains.
32453
32454
32455
32456 .section "Multiple user mailboxes" "SECTmulbox"
32457 .cindex "multiple mailboxes"
32458 .cindex "mailbox" "multiple"
32459 .cindex "local part" "prefix"
32460 .cindex "local part" "suffix"
32461 Heavy email users often want to operate with multiple mailboxes, into which
32462 incoming mail is automatically sorted. A popular way of handling this is to
32463 allow users to use multiple sender addresses, so that replies can easily be
32464 identified. Users are permitted to add prefixes or suffixes to their local
32465 parts for this purpose. The wildcard facility of the generic router options
32466 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32467 example, consider this router:
32468 .code
32469 userforward:
32470   driver = redirect
32471   check_local_user
32472   file = $home/.forward
32473   local_part_suffix = -*
32474   local_part_suffix_optional
32475   allow_filter
32476 .endd
32477 .vindex "&$local_part_suffix$&"
32478 It runs a user's &_.forward_& file for all local parts of the form
32479 &'username-*'&. Within the filter file the user can distinguish different
32480 cases by testing the variable &$local_part_suffix$&. For example:
32481 .code
32482 if $local_part_suffix contains -special then
32483 save /home/$local_part/Mail/special
32484 endif
32485 .endd
32486 If the filter file does not exist, or does not deal with such addresses, they
32487 fall through to subsequent routers, and, assuming no subsequent use of the
32488 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32489 control over which suffixes are valid.
32490
32491 Alternatively, a suffix can be used to trigger the use of a different
32492 &_.forward_& file &-- which is the way a similar facility is implemented in
32493 another MTA:
32494 .code
32495 userforward:
32496   driver = redirect
32497   check_local_user
32498   file = $home/.forward$local_part_suffix
32499   local_part_suffix = -*
32500   local_part_suffix_optional
32501   allow_filter
32502 .endd
32503 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32504 example, &_.forward-special_& is used. Once again, if the appropriate file
32505 does not exist, or does not deal with the address, it is passed on to
32506 subsequent routers, which could, if required, look for an unqualified
32507 &_.forward_& file to use as a default.
32508
32509
32510
32511 .section "Simplified vacation processing" "SECID244"
32512 .cindex "vacation processing"
32513 The traditional way of running the &'vacation'& program is for a user to set up
32514 a pipe command in a &_.forward_& file
32515 (see section &<<SECTspecitredli>>& for syntax details).
32516 This is prone to error by inexperienced users. There are two features of Exim
32517 that can be used to make this process simpler for users:
32518
32519 .ilist
32520 A local part prefix such as &"vacation-"& can be specified on a router which
32521 can cause the message to be delivered directly to the &'vacation'& program, or
32522 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32523 &_.forward_& file are then much simpler. For example:
32524 .code
32525 spqr, vacation-spqr
32526 .endd
32527 .next
32528 The &%require_files%& generic router option can be used to trigger a
32529 vacation delivery by checking for the existence of a certain file in the
32530 user's home directory. The &%unseen%& generic option should also be used, to
32531 ensure that the original delivery also proceeds. In this case, all the user has
32532 to do is to create a file called, say, &_.vacation_&, containing a vacation
32533 message.
32534 .endlist
32535
32536 Another advantage of both these methods is that they both work even when the
32537 use of arbitrary pipes by users is locked out.
32538
32539
32540
32541 .section "Taking copies of mail" "SECID245"
32542 .cindex "message" "copying every"
32543 Some installations have policies that require archive copies of all messages to
32544 be made. A single copy of each message can easily be taken by an appropriate
32545 command in a system filter, which could, for example, use a different file for
32546 each day's messages.
32547
32548 There is also a shadow transport mechanism that can be used to take copies of
32549 messages that are successfully delivered by local transports, one copy per
32550 delivery. This could be used, &'inter alia'&, to implement automatic
32551 notification of delivery by sites that insist on doing such things.
32552
32553
32554
32555 .section "Intermittently connected hosts" "SECID246"
32556 .cindex "intermittently connected hosts"
32557 It has become quite common (because it is cheaper) for hosts to connect to the
32558 Internet periodically rather than remain connected all the time. The normal
32559 arrangement is that mail for such hosts accumulates on a system that is
32560 permanently connected.
32561
32562 Exim was designed for use on permanently connected hosts, and so it is not
32563 particularly well-suited to use in an intermittently connected environment.
32564 Nevertheless there are some features that can be used.
32565
32566
32567 .section "Exim on the upstream server host" "SECID247"
32568 It is tempting to arrange for incoming mail for the intermittently connected
32569 host to remain on Exim's queue until the client connects. However, this
32570 approach does not scale very well. Two different kinds of waiting message are
32571 being mixed up in the same queue &-- those that cannot be delivered because of
32572 some temporary problem, and those that are waiting for their destination host
32573 to connect. This makes it hard to manage the queue, as well as wasting
32574 resources, because each queue runner scans the entire queue.
32575
32576 A better approach is to separate off those messages that are waiting for an
32577 intermittently connected host. This can be done by delivering these messages
32578 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
32579 format, from where they are transmitted by other software when their
32580 destination connects. This makes it easy to collect all the mail for one host
32581 in a single directory, and to apply local timeout rules on a per-message basis
32582 if required.
32583
32584 On a very small scale, leaving the mail on Exim's queue can be made to work. If
32585 you are doing this, you should configure Exim with a long retry period for the
32586 intermittent host. For example:
32587 .code
32588 cheshire.wonderland.fict.example    *   F,5d,24h
32589 .endd
32590 This stops a lot of failed delivery attempts from occurring, but Exim remembers
32591 which messages it has queued up for that host. Once the intermittent host comes
32592 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
32593 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
32594 causes all the queued up messages to be delivered, often down a single SMTP
32595 connection. While the host remains connected, any new messages get delivered
32596 immediately.
32597
32598 If the connecting hosts do not have fixed IP addresses, that is, if a host is
32599 issued with a different IP address each time it connects, Exim's retry
32600 mechanisms on the holding host get confused, because the IP address is normally
32601 used as part of the key string for holding retry information. This can be
32602 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
32603 Since this has disadvantages for permanently connected hosts, it is best to
32604 arrange a separate transport for the intermittently connected ones.
32605
32606
32607
32608 .section "Exim on the intermittently connected client host" "SECID248"
32609 The value of &%smtp_accept_queue_per_connection%& should probably be
32610 increased, or even set to zero (that is, disabled) on the intermittently
32611 connected host, so that all incoming messages down a single connection get
32612 delivered immediately.
32613
32614 .cindex "SMTP" "passed connection"
32615 .cindex "SMTP" "multiple deliveries"
32616 .cindex "multiple SMTP deliveries"
32617 Mail waiting to be sent from an intermittently connected host will probably
32618 not have been routed, because without a connection DNS lookups are not
32619 possible. This means that if a normal queue run is done at connection time,
32620 each message is likely to be sent in a separate SMTP session. This can be
32621 avoided by starting the queue run with a command line option beginning with
32622 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
32623 first pass, routing is done but no deliveries take place. The second pass is a
32624 normal queue run; since all the messages have been previously routed, those
32625 destined for the same host are likely to get sent as multiple deliveries in a
32626 single SMTP connection.
32627
32628
32629
32630 . ////////////////////////////////////////////////////////////////////////////
32631 . ////////////////////////////////////////////////////////////////////////////
32632
32633 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
32634          "Exim as a non-queueing client"
32635 .cindex "client, non-queueing"
32636 .cindex "smart host" "suppressing queueing"
32637 On a personal computer, it is a common requirement for all
32638 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
32639 configured to operate that way, for all the popular operating systems.
32640 However, there are some MUAs for Unix-like systems that cannot be so
32641 configured: they submit messages using the command line interface of
32642 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
32643 messages this way.
32644
32645 If the personal computer runs continuously, there is no problem, because it can
32646 run a conventional MTA that handles delivery to the smart host, and deal with
32647 any delays via its queueing mechanism. However, if the computer does not run
32648 continuously or runs different operating systems at different times, queueing
32649 email is not desirable.
32650
32651 There is therefore a requirement for something that can provide the
32652 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
32653 any queueing or retrying facilities. Furthermore, the delivery to the smart
32654 host should be synchronous, so that if it fails, the sending MUA is immediately
32655 informed. In other words, we want something that extends an MUA that submits
32656 to a local MTA via the command line so that it behaves like one that submits
32657 to a remote smart host using TCP/SMTP.
32658
32659 There are a number of applications (for example, there is one called &'ssmtp'&)
32660 that do this job. However, people have found them to be lacking in various
32661 ways. For instance, you might want to allow aliasing and forwarding to be done
32662 before sending a message to the smart host.
32663
32664 Exim already had the necessary infrastructure for doing this job. Just a few
32665 tweaks were needed to make it behave as required, though it is somewhat of an
32666 overkill to use a fully-featured MTA for this purpose.
32667
32668 .oindex "&%mua_wrapper%&"
32669 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
32670 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
32671 assumes that it is being used to &"wrap"& a command-line MUA in the manner
32672 just described. As well as setting &%mua_wrapper%&, you also need to provide a
32673 compatible router and transport configuration. Typically there will be just one
32674 router and one transport, sending everything to a smart host.
32675
32676 When run in MUA wrapping mode, the behaviour of Exim changes in the
32677 following ways:
32678
32679 .ilist
32680 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
32681 In other words, the only way to submit messages is via the command line.
32682 .next
32683 Each message is synchronously delivered as soon as it is received (&%-odi%& is
32684 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
32685 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
32686 does not finish until the delivery attempt is complete. If the delivery is
32687 successful, a zero return code is given.
32688 .next
32689 Address redirection is permitted, but the final routing for all addresses must
32690 be to the same remote transport, and to the same list of hosts. Furthermore,
32691 the return address (envelope sender) must be the same for all recipients, as
32692 must any added or deleted header lines. In other words, it must be possible to
32693 deliver the message in a single SMTP transaction, however many recipients there
32694 are.
32695 .next
32696 If these conditions are not met, or if routing any address results in a
32697 failure or defer status, or if Exim is unable to deliver all the recipients
32698 successfully to one of the smart hosts, delivery of the entire message fails.
32699 .next
32700 Because no queueing is allowed, all failures are treated as permanent; there
32701 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
32702 smart host. Furthermore, because only a single yes/no response can be given to
32703 the caller, it is not possible to deliver to some recipients and not others. If
32704 there is an error (temporary or permanent) for any recipient, all are failed.
32705 .next
32706 If more than one smart host is listed, Exim will try another host after a
32707 connection failure or a timeout, in the normal way. However, if this kind of
32708 failure happens for all the hosts, the delivery fails.
32709 .next
32710 When delivery fails, an error message is written to the standard error stream
32711 (as well as to Exim's log), and Exim exits to the caller with a return code
32712 value 1. The message is expunged from Exim's spool files. No bounce messages
32713 are ever generated.
32714 .next
32715 No retry data is maintained, and any retry rules are ignored.
32716 .next
32717 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
32718 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
32719 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
32720 .endlist
32721
32722 The overall effect is that Exim makes a single synchronous attempt to deliver
32723 the message, failing if there is any kind of problem. Because no local
32724 deliveries are done and no daemon can be run, Exim does not need root
32725 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
32726 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
32727 the advantages and disadvantages of running without root privilege.
32728
32729
32730
32731
32732 . ////////////////////////////////////////////////////////////////////////////
32733 . ////////////////////////////////////////////////////////////////////////////
32734
32735 .chapter "Log files" "CHAPlog"
32736 .scindex IIDloggen "log" "general description"
32737 .cindex "log" "types of"
32738 Exim writes three different logs, referred to as the main log, the reject log,
32739 and the panic log:
32740
32741 .ilist
32742 .cindex "main log"
32743 The main log records the arrival of each message and each delivery in a single
32744 line in each case. The format is as compact as possible, in an attempt to keep
32745 down the size of log files. Two-character flag sequences make it easy to pick
32746 out these lines. A number of other events are recorded in the main log. Some of
32747 them are optional, in which case the &%log_selector%& option controls whether
32748 they are included or not. A Perl script called &'eximstats'&, which does simple
32749 analysis of main log files, is provided in the Exim distribution (see section
32750 &<<SECTmailstat>>&).
32751 .next
32752 .cindex "reject log"
32753 The reject log records information from messages that are rejected as a result
32754 of a configuration option (that is, for policy reasons).
32755 The first line of each rejection is a copy of the line that is also written to
32756 the main log. Then, if the message's header has been read at the time the log
32757 is written, its contents are written to this log. Only the original header
32758 lines are available; header lines added by ACLs are not logged. You can use the
32759 reject log to check that your policy controls are working correctly; on a busy
32760 host this may be easier than scanning the main log for rejection messages. You
32761 can suppress the writing of the reject log by setting &%write_rejectlog%&
32762 false.
32763 .next
32764 .cindex "panic log"
32765 .cindex "system log"
32766 When certain serious errors occur, Exim writes entries to its panic log. If the
32767 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32768 are usually written to the main log as well, but can get lost amid the mass of
32769 other entries. The panic log should be empty under normal circumstances. It is
32770 therefore a good idea to check it (or to have a &'cron'& script check it)
32771 regularly, in order to become aware of any problems. When Exim cannot open its
32772 panic log, it tries as a last resort to write to the system log (syslog). This
32773 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32774 message itself is written at priority LOG_CRIT.
32775 .endlist
32776
32777 Every log line starts with a timestamp, in the format shown in the following
32778 example. Note that many of the examples shown in this chapter are line-wrapped.
32779 In the log file, this would be all on one line:
32780 .code
32781 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32782   by QUIT
32783 .endd
32784 By default, the timestamps are in the local timezone. There are two
32785 ways of changing this:
32786
32787 .ilist
32788 You can set the &%timezone%& option to a different time zone; in particular, if
32789 you set
32790 .code
32791 timezone = UTC
32792 .endd
32793 the timestamps will be in UTC (aka GMT).
32794 .next
32795 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32796 example:
32797 .code
32798 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32799 .endd
32800 .endlist
32801
32802 .cindex "log" "process ids in"
32803 .cindex "pid (process id)" "in log lines"
32804 Exim does not include its process id in log lines by default, but you can
32805 request that it does so by specifying the &`pid`& log selector (see section
32806 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32807 brackets, immediately after the time and date.
32808
32809
32810
32811
32812 .section "Where the logs are written" "SECTwhelogwri"
32813 .cindex "log" "destination"
32814 .cindex "log" "to file"
32815 .cindex "log" "to syslog"
32816 .cindex "syslog"
32817 The logs may be written to local files, or to syslog, or both. However, it
32818 should be noted that many syslog implementations use UDP as a transport, and
32819 are therefore unreliable in the sense that messages are not guaranteed to
32820 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32821 It has also been reported that on large log files (tens of megabytes) you may
32822 need to tweak syslog to prevent it syncing the file with each write &-- on
32823 Linux this has been seen to make syslog take 90% plus of CPU time.
32824
32825 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32826 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32827 configuration. This latter string is expanded, so it can contain, for example,
32828 references to the host name:
32829 .code
32830 log_file_path = /var/log/$primary_hostname/exim_%slog
32831 .endd
32832 It is generally advisable, however, to set the string in &_Local/Makefile_&
32833 rather than at run time, because then the setting is available right from the
32834 start of Exim's execution. Otherwise, if there's something it wants to log
32835 before it has read the configuration file (for example, an error in the
32836 configuration file) it will not use the path you want, and may not be able to
32837 log at all.
32838
32839 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32840 list, currently limited to at most two items. This is one option where the
32841 facility for changing a list separator may not be used. The list must always be
32842 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32843 otherwise the item must either be an absolute path, containing &`%s`& at the
32844 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32845 implying the use of a default path.
32846
32847 When Exim encounters an empty item in the list, it searches the list defined by
32848 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32849 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32850 mean &"use the path specified at build time"&. It no such item exists, log
32851 files are written in the &_log_& subdirectory of the spool directory. This is
32852 equivalent to the setting:
32853 .code
32854 log_file_path = $spool_directory/log/%slog
32855 .endd
32856 If you do not specify anything at build time or run time, that is where the
32857 logs are written.
32858
32859 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
32860 are in use &-- see section &<<SECTdatlogfil>>& below.
32861
32862 Here are some examples of possible settings:
32863 .display
32864 &`LOG_FILE_PATH=syslog                    `& syslog only
32865 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32866 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32867 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32868 .endd
32869 If there are more than two paths in the list, the first is used and a panic
32870 error is logged.
32871
32872
32873
32874 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32875 .cindex "log" "cycling local files"
32876 .cindex "cycling logs"
32877 .cindex "&'exicyclog'&"
32878 .cindex "log" "local files; writing to"
32879 Some operating systems provide centralized and standardized methods for cycling
32880 log files. For those that do not, a utility script called &'exicyclog'& is
32881 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32882 main and reject logs each time it is called. The maximum number of old logs to
32883 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32884
32885 An Exim delivery process opens the main log when it first needs to write to it,
32886 and it keeps the file open in case subsequent entries are required &-- for
32887 example, if a number of different deliveries are being done for the same
32888 message. However, remote SMTP deliveries can take a long time, and this means
32889 that the file may be kept open long after it is renamed if &'exicyclog'& or
32890 something similar is being used to rename log files on a regular basis. To
32891 ensure that a switch of log files is noticed as soon as possible, Exim calls
32892 &[stat()]& on the main log's name before reusing an open file, and if the file
32893 does not exist, or its inode has changed, the old file is closed and Exim
32894 tries to open the main log from scratch. Thus, an old log file may remain open
32895 for quite some time, but no Exim processes should write to it once it has been
32896 renamed.
32897
32898
32899
32900 .section "Datestamped log files" "SECTdatlogfil"
32901 .cindex "log" "datestamped files"
32902 Instead of cycling the main and reject log files by renaming them
32903 periodically, some sites like to use files whose names contain a datestamp,
32904 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
32905 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
32906 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
32907 point where the datestamp is required. For example:
32908 .code
32909 log_file_path = /var/spool/exim/log/%slog-%D
32910 log_file_path = /var/log/exim-%s-%D.log
32911 log_file_path = /var/spool/exim/log/%D-%slog
32912 log_file_path = /var/log/exim/%s.%M
32913 .endd
32914 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32915 examples of names generated by the above examples:
32916 .code
32917 /var/spool/exim/log/mainlog-20021225
32918 /var/log/exim-reject-20021225.log
32919 /var/spool/exim/log/20021225-mainlog
32920 /var/log/exim/main.200212
32921 .endd
32922 When this form of log file is specified, Exim automatically switches to new
32923 files at midnight. It does not make any attempt to compress old logs; you
32924 will need to write your own script if you require this. You should not
32925 run &'exicyclog'& with this form of logging.
32926
32927 The location of the panic log is also determined by &%log_file_path%&, but it
32928 is not datestamped, because rotation of the panic log does not make sense.
32929 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
32930 the string. In addition, if it immediately follows a slash, a following
32931 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
32932 character is removed. Thus, the four examples above would give these panic
32933 log names:
32934 .code
32935 /var/spool/exim/log/paniclog
32936 /var/log/exim-panic.log
32937 /var/spool/exim/log/paniclog
32938 /var/log/exim/panic
32939 .endd
32940
32941
32942 .section "Logging to syslog" "SECID249"
32943 .cindex "log" "syslog; writing to"
32944 The use of syslog does not change what Exim logs or the format of its messages,
32945 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32946 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32947 that, the same strings are written to syslog as to log files. The syslog
32948 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32949 by default, but you can change these by setting the &%syslog_facility%& and
32950 &%syslog_processname%& options, respectively. If Exim was compiled with
32951 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32952 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32953 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32954 the time and host name to each line.
32955 The three log streams are mapped onto syslog priorities as follows:
32956
32957 .ilist
32958 &'mainlog'& is mapped to LOG_INFO
32959 .next
32960 &'rejectlog'& is mapped to LOG_NOTICE
32961 .next
32962 &'paniclog'& is mapped to LOG_ALERT
32963 .endlist
32964
32965 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32966 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32967 these are routed by syslog to the same place. You can suppress this duplication
32968 by setting &%syslog_duplication%& false.
32969
32970 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32971 entries contain multiple lines when headers are included. To cope with both
32972 these cases, entries written to syslog are split into separate &[syslog()]&
32973 calls at each internal newline, and also after a maximum of
32974 870 data characters. (This allows for a total syslog line length of 1024, when
32975 additions such as timestamps are added.) If you are running a syslog
32976 replacement that can handle lines longer than the 1024 characters allowed by
32977 RFC 3164, you should set
32978 .code
32979 SYSLOG_LONG_LINES=yes
32980 .endd
32981 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32982 lines, but it still splits at internal newlines in &'reject'& log entries.
32983
32984 To make it easy to re-assemble split lines later, each component of a split
32985 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32986 where <&'n'&> is the component number and <&'m'&> is the total number of
32987 components in the entry. The / delimiter is used when the line was split
32988 because it was too long; if it was split because of an internal newline, the \
32989 delimiter is used. For example, supposing the length limit to be 50 instead of
32990 870, the following would be the result of a typical rejection message to
32991 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32992 name, and pid as added by syslog:
32993 .code
32994 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32995 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32996 [3/5]  when scanning for sender: missing or malformed lo
32997 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32998 [5/5] mple>)
32999 .endd
33000 The same error might cause the following lines to be written to &"rejectlog"&
33001 (LOG_NOTICE):
33002 .code
33003 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33004 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33005 [3/18] er when scanning for sender: missing or malformed
33006 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33007 [5\18] .example>)
33008 [6\18] Recipients: ph10@some.domain.cam.example
33009 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33010 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33011 [9\18]        id 16RdAL-0006pc-00
33012 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33013 [11\18] 09:43 +0100
33014 [12\18] F From: <>
33015 [13\18]   Subject: this is a test header
33016 [18\18]   X-something: this is another header
33017 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33018 [16\18] le>
33019 [17\18] B Bcc:
33020 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33021 .endd
33022 Log lines that are neither too long nor contain newlines are written to syslog
33023 without modification.
33024
33025 If only syslog is being used, the Exim monitor is unable to provide a log tail
33026 display, unless syslog is routing &'mainlog'& to a file on the local host and
33027 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33028 where it is.
33029
33030
33031
33032 .section "Log line flags" "SECID250"
33033 One line is written to the main log for each message received, and for each
33034 successful, unsuccessful, and delayed delivery. These lines can readily be
33035 picked out by the distinctive two-character flags that immediately follow the
33036 timestamp. The flags are:
33037 .display
33038 &`<=`&     message arrival
33039 &`=>`&     normal message delivery
33040 &`->`&     additional address in same delivery
33041 &`*>`&     delivery suppressed by &%-N%&
33042 &`**`&     delivery failed; address bounced
33043 &`==`&     delivery deferred; temporary problem
33044 .endd
33045
33046
33047 .section "Logging message reception" "SECID251"
33048 .cindex "log" "reception line"
33049 The format of the single-line entry in the main log that is written for every
33050 message received is shown in the basic example below, which is split over
33051 several lines in order to fit it on the page:
33052 .code
33053 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33054   H=mailer.fict.example [192.168.123.123] U=exim
33055   P=smtp S=5678 id=<incoming message id>
33056 .endd
33057 The address immediately following &"<="& is the envelope sender address. A
33058 bounce message is shown with the sender address &"<>"&, and if it is locally
33059 generated, this is followed by an item of the form
33060 .code
33061 R=<message id>
33062 .endd
33063 which is a reference to the message that caused the bounce to be sent.
33064
33065 .cindex "HELO"
33066 .cindex "EHLO"
33067 For messages from other hosts, the H and U fields identify the remote host and
33068 record the RFC 1413 identity of the user that sent the message, if one was
33069 received. The number given in square brackets is the IP address of the sending
33070 host. If there is a single, unparenthesized  host name in the H field, as
33071 above, it has been verified to correspond to the IP address (see the
33072 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33073 by the remote host in the SMTP HELO or EHLO command, and has not been
33074 verified. If verification yields a different name to that given for HELO or
33075 EHLO, the verified name appears first, followed by the HELO or EHLO
33076 name in parentheses.
33077
33078 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33079 without brackets, in the HELO or EHLO command, leading to entries in
33080 the log containing text like these examples:
33081 .code
33082 H=(10.21.32.43) [192.168.8.34]
33083 H=([10.21.32.43]) [192.168.8.34]
33084 .endd
33085 This can be confusing. Only the final address in square brackets can be relied
33086 on.
33087
33088 For locally generated messages (that is, messages not received over TCP/IP),
33089 the H field is omitted, and the U field contains the login name of the caller
33090 of Exim.
33091
33092 .cindex "authentication" "logging"
33093 .cindex "AUTH" "logging"
33094 For all messages, the P field specifies the protocol used to receive the
33095 message. This is the value that is stored in &$received_protocol$&. In the case
33096 of incoming SMTP messages, the value indicates whether or not any SMTP
33097 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33098 session was encrypted, there is an additional X field that records the cipher
33099 suite that was used.
33100
33101 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33102 hosts that have authenticated themselves using the SMTP AUTH command. The first
33103 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33104 there is an additional item A= followed by the name of the authenticator that
33105 was used. If an authenticated identification was set up by the authenticator's
33106 &%server_set_id%& option, this is logged too, separated by a colon from the
33107 authenticator name.
33108
33109 .cindex "size" "of message"
33110 The id field records the existing message id, if present. The size of the
33111 received message is given by the S field. When the message is delivered,
33112 headers may be removed or added, so that the size of delivered copies of the
33113 message may not correspond with this value (and indeed may be different to each
33114 other).
33115
33116 The &%log_selector%& option can be used to request the logging of additional
33117 data when a message is received. See section &<<SECTlogselector>>& below.
33118
33119
33120
33121 .section "Logging deliveries" "SECID252"
33122 .cindex "log" "delivery line"
33123 The format of the single-line entry in the main log that is written for every
33124 delivery is shown in one of the examples below, for local and remote
33125 deliveries, respectively. Each example has been split into two lines in order
33126 to fit it on the page:
33127 .code
33128 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33129   <marv@hitch.fict.example> R=localuser T=local_delivery
33130 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33131   monk@holistic.fict.example R=dnslookup T=remote_smtp
33132   H=holistic.fict.example [192.168.234.234]
33133 .endd
33134 For ordinary local deliveries, the original address is given in angle brackets
33135 after the final delivery address, which might be a pipe or a file. If
33136 intermediate address(es) exist between the original and the final address, the
33137 last of these is given in parentheses after the final address. The R and T
33138 fields record the router and transport that were used to process the address.
33139
33140 If a shadow transport was run after a successful local delivery, the log line
33141 for the successful delivery has an item added on the end, of the form
33142 .display
33143 &`ST=<`&&'shadow transport name'&&`>`&
33144 .endd
33145 If the shadow transport did not succeed, the error message is put in
33146 parentheses afterwards.
33147
33148 .cindex "asterisk" "after IP address"
33149 When more than one address is included in a single delivery (for example, two
33150 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33151 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33152 down a single SMTP connection, an asterisk follows the IP address in the log
33153 lines for the second and subsequent messages.
33154
33155 The generation of a reply message by a filter file gets logged as a
33156 &"delivery"& to the addressee, preceded by &">"&.
33157
33158 The &%log_selector%& option can be used to request the logging of additional
33159 data when a message is delivered. See section &<<SECTlogselector>>& below.
33160
33161
33162 .section "Discarded deliveries" "SECID253"
33163 .cindex "discarded messages"
33164 .cindex "message" "discarded"
33165 .cindex "delivery" "discarded; logging"
33166 When a message is discarded as a result of the command &"seen finish"& being
33167 obeyed in a filter file which generates no deliveries, a log entry of the form
33168 .code
33169 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33170   <low.club@bridge.example> R=userforward
33171 .endd
33172 is written, to record why no deliveries are logged. When a message is discarded
33173 because it is aliased to &":blackhole:"& the log line is like this:
33174 .code
33175 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33176   <hole@nowhere.example> R=blackhole_router
33177 .endd
33178
33179
33180 .section "Deferred deliveries" "SECID254"
33181 When a delivery is deferred, a line of the following form is logged:
33182 .code
33183 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33184   R=dnslookup T=smtp defer (146): Connection refused
33185 .endd
33186 In the case of remote deliveries, the error is the one that was given for the
33187 last IP address that was tried. Details of individual SMTP failures are also
33188 written to the log, so the above line would be preceded by something like
33189 .code
33190 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33191   mail1.endrest.example [192.168.239.239]: Connection refused
33192 .endd
33193 When a deferred address is skipped because its retry time has not been reached,
33194 a message is written to the log, but this can be suppressed by setting an
33195 appropriate value in &%log_selector%&.
33196
33197
33198
33199 .section "Delivery failures" "SECID255"
33200 .cindex "delivery" "failure; logging"
33201 If a delivery fails because an address cannot be routed, a line of the
33202 following form is logged:
33203 .code
33204 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33205   <jim@trek99.example>: unknown mail domain
33206 .endd
33207 If a delivery fails at transport time, the router and transport are shown, and
33208 the response from the remote host is included, as in this example:
33209 .code
33210 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33211   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33212   after pipelined RCPT TO:<ace400@pb.example>: host
33213   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33214   <ace400@pb.example>...Addressee unknown
33215 .endd
33216 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33217 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33218 disabling PIPELINING. The log lines for all forms of delivery failure are
33219 flagged with &`**`&.
33220
33221
33222
33223 .section "Fake deliveries" "SECID256"
33224 .cindex "delivery" "fake; logging"
33225 If a delivery does not actually take place because the &%-N%& option has been
33226 used to suppress it, a normal delivery line is written to the log, except that
33227 &"=>"& is replaced by &"*>"&.
33228
33229
33230
33231 .section "Completion" "SECID257"
33232 A line of the form
33233 .code
33234 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33235 .endd
33236 is written to the main log when a message is about to be removed from the spool
33237 at the end of its processing.
33238
33239
33240
33241
33242 .section "Summary of Fields in Log Lines" "SECID258"
33243 .cindex "log" "summary of fields"
33244 A summary of the field identifiers that are used in log lines is shown in
33245 the following table:
33246 .display
33247 &`A   `&        authenticator name (and optional id)
33248 &`C   `&        SMTP confirmation on delivery
33249 &`    `&        command list for &"no mail in SMTP session"&
33250 &`CV  `&        certificate verification status
33251 &`D   `&        duration of &"no mail in SMTP session"&
33252 &`DN  `&        distinguished name from peer certificate
33253 &`DT  `&        on &`=>`& lines: time taken for a delivery
33254 &`F   `&        sender address (on delivery lines)
33255 &`H   `&        host name and IP address
33256 &`I   `&        local interface used
33257 &`id  `&        message id for incoming message
33258 &`P   `&        on &`<=`& lines: protocol used
33259 &`    `&        on &`=>`& and &`**`& lines: return path
33260 &`QT  `&        on &`=>`& lines: time spent on queue so far
33261 &`    `&        on &"Completed"& lines: time spent on queue
33262 &`R   `&        on &`<=`& lines: reference for local bounce
33263 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33264 &`S   `&        size of message
33265 &`ST  `&        shadow transport name
33266 &`T   `&        on &`<=`& lines: message subject (topic)
33267 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33268 &`U   `&        local user or RFC 1413 identity
33269 &`X   `&        TLS cipher suite
33270 .endd
33271
33272
33273 .section "Other log entries" "SECID259"
33274 Various other types of log entry are written from time to time. Most should be
33275 self-explanatory. Among the more common are:
33276
33277 .ilist
33278 .cindex "retry" "time not reached"
33279 &'retry time not reached'&&~&~An address previously suffered a temporary error
33280 during routing or local delivery, and the time to retry has not yet arrived.
33281 This message is not written to an individual message log file unless it happens
33282 during the first delivery attempt.
33283 .next
33284 &'retry time not reached for any host'&&~&~An address previously suffered
33285 temporary errors during remote delivery, and the retry time has not yet arrived
33286 for any of the hosts to which it is routed.
33287 .next
33288 .cindex "spool directory" "file locked"
33289 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33290 some other Exim process is already working on the message. This can be quite
33291 common if queue running processes are started at frequent intervals. The
33292 &'exiwhat'& utility script can be used to find out what Exim processes are
33293 doing.
33294 .next
33295 .cindex "error" "ignored"
33296 &'error ignored'&&~&~There are several circumstances that give rise to this
33297 message:
33298 .olist
33299 Exim failed to deliver a bounce message whose age was greater than
33300 &%ignore_bounce_errors_after%&. The bounce was discarded.
33301 .next
33302 A filter file set up a delivery using the &"noerror"& option, and the delivery
33303 failed. The delivery was discarded.
33304 .next
33305 A delivery set up by a router configured with
33306 . ==== As this is a nested list, any displays it contains must be indented
33307 . ==== as otherwise they are too far to the left.
33308 .code
33309     errors_to = <>
33310 .endd
33311 failed. The delivery was discarded.
33312 .endlist olist
33313 .endlist ilist
33314
33315
33316
33317
33318
33319 .section "Reducing or increasing what is logged" "SECTlogselector"
33320 .cindex "log" "selectors"
33321 By setting the &%log_selector%& global option, you can disable some of Exim's
33322 default logging, or you can request additional logging. The value of
33323 &%log_selector%& is made up of names preceded by plus or minus characters. For
33324 example:
33325 .code
33326 log_selector = +arguments -retry_defer
33327 .endd
33328 The list of optional log items is in the following table, with the default
33329 selection marked by asterisks:
33330 .display
33331 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33332 &` address_rewrite            `&  address rewriting
33333 &` all_parents                `&  all parents in => lines
33334 &` arguments                  `&  command line arguments
33335 &`*connection_reject          `&  connection rejections
33336 &`*delay_delivery             `&  immediate delivery delayed
33337 &` deliver_time               `&  time taken to perform delivery
33338 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33339 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33340 &`*etrn                       `&  ETRN commands
33341 &`*host_lookup_failed         `&  as it says
33342 &` ident_timeout              `&  timeout for ident connection
33343 &` incoming_interface         `&  incoming interface on <= lines
33344 &` incoming_port              `&  incoming port on <= lines
33345 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33346 &` outgoing_port              `&  add remote port to => lines
33347 &`*queue_run                  `&  start and end queue runs
33348 &` queue_time                 `&  time on queue for one recipient
33349 &` queue_time_overall         `&  time on queue for whole message
33350 &` pid                        `&  Exim process id
33351 &` received_recipients        `&  recipients on <= lines
33352 &` received_sender            `&  sender on <= lines
33353 &`*rejected_header            `&  header contents on reject log
33354 &`*retry_defer                `&  &"retry time not reached"&
33355 &` return_path_on_delivery    `&  put return path on => and ** lines
33356 &` sender_on_delivery         `&  add sender to => lines
33357 &`*sender_verify_fail         `&  sender verification failures
33358 &`*size_reject                `&  rejection because too big
33359 &`*skip_delivery              `&  delivery skipped in a queue run
33360 &` smtp_confirmation          `&  SMTP confirmation on => lines
33361 &` smtp_connection            `&  SMTP connections
33362 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33363 &` smtp_no_mail               `&  session with no MAIL commands
33364 &` smtp_protocol_error        `&  SMTP protocol errors
33365 &` smtp_syntax_error          `&  SMTP syntax errors
33366 &` subject                    `&  contents of &'Subject:'& on <= lines
33367 &` tls_certificate_verified   `&  certificate verification status
33368 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33369 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33370 &` tls_sni                    `&  TLS SNI on <= lines
33371 &` unknown_in_list            `&  DNS lookup failed in list match
33372
33373 &` all                        `&  all of the above
33374 .endd
33375 More details on each of these items follows:
33376
33377 .ilist
33378 .cindex "&%warn%& ACL verb" "log when skipping"
33379 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33380 its conditions cannot be evaluated, a log line to this effect is written if
33381 this log selector is set.
33382 .next
33383 .cindex "log" "rewriting"
33384 .cindex "rewriting" "logging"
33385 &%address_rewrite%&: This applies both to global rewrites and per-transport
33386 rewrites, but not to rewrites in filters run as an unprivileged user (because
33387 such users cannot access the log).
33388 .next
33389 .cindex "log" "full parentage"
33390 &%all_parents%&: Normally only the original and final addresses are logged on
33391 delivery lines; with this selector, intermediate parents are given in
33392 parentheses between them.
33393 .next
33394 .cindex "log" "Exim arguments"
33395 .cindex "Exim arguments, logging"
33396 &%arguments%&: This causes Exim to write the arguments with which it was called
33397 to the main log, preceded by the current working directory. This is a debugging
33398 feature, added to make it easier to find out how certain MUAs call
33399 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33400 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33401 that are empty or that contain white space are quoted. Non-printing characters
33402 are shown as escape sequences. This facility cannot log unrecognized arguments,
33403 because the arguments are checked before the configuration file is read. The
33404 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33405 between the caller and Exim.
33406 .next
33407 .cindex "log" "connection rejections"
33408 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33409 connection is rejected, for whatever reason.
33410 .next
33411 .cindex "log" "delayed delivery"
33412 .cindex "delayed delivery, logging"
33413 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33414 started for an incoming message because the load is too high or too many
33415 messages were received on one connection. Logging does not occur if no delivery
33416 process is started because &%queue_only%& is set or &%-odq%& was used.
33417 .next
33418 .cindex "log" "delivery duration"
33419 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33420 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33421 .next
33422 .cindex "log" "message size on delivery"
33423 .cindex "size" "of message"
33424 &%delivery_size%&: For each delivery, the size of message delivered is added to
33425 the &"=>"& line, tagged with S=.
33426 .next
33427 .cindex "log" "dnslist defer"
33428 .cindex "DNS list" "logging defer"
33429 .cindex "black list (DNS)"
33430 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33431 DNS black list suffers a temporary error.
33432 .next
33433 .cindex "log" "ETRN commands"
33434 .cindex "ETRN" "logging"
33435 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33436 is run to determine whether or not it is actually accepted. An invalid ETRN
33437 command, or one received within a message transaction is not logged by this
33438 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33439 .next
33440 .cindex "log" "host lookup failure"
33441 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33442 any addresses, or when a lookup of an IP address fails to find a host name, a
33443 log line is written. This logging does not apply to direct DNS lookups when
33444 routing email addresses, but it does apply to &"byname"& lookups.
33445 .next
33446 .cindex "log" "ident timeout"
33447 .cindex "RFC 1413" "logging timeout"
33448 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33449 client's ident port times out.
33450 .next
33451 .cindex "log" "incoming interface"
33452 .cindex "interface" "logging"
33453 &%incoming_interface%&: The interface on which a message was received is added
33454 to the &"<="& line as an IP address in square brackets, tagged by I= and
33455 followed by a colon and the port number. The local interface and port are also
33456 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33457 rejection lines.
33458 .next
33459 .cindex "log" "incoming remote port"
33460 .cindex "port" "logging remote"
33461 .cindex "TCP/IP" "logging incoming remote port"
33462 .vindex "&$sender_fullhost$&"
33463 .vindex "&$sender_rcvhost$&"
33464 &%incoming_port%&: The remote port number from which a message was received is
33465 added to log entries and &'Received:'& header lines, following the IP address
33466 in square brackets, and separated from it by a colon. This is implemented by
33467 changing the value that is put in the &$sender_fullhost$& and
33468 &$sender_rcvhost$& variables. Recording the remote port number has become more
33469 important with the widening use of NAT (see RFC 2505).
33470 .next
33471 .cindex "log" "dropped connection"
33472 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33473 connection is unexpectedly dropped.
33474 .next
33475 .cindex "log" "outgoing remote port"
33476 .cindex "port" "logging outgoint remote"
33477 .cindex "TCP/IP" "logging ougtoing remote port"
33478 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33479 containing => tags) following the IP address. This option is not included in
33480 the default setting, because for most ordinary configurations, the remote port
33481 number is always 25 (the SMTP port).
33482 .next
33483 .cindex "log" "process ids in"
33484 .cindex "pid (process id)" "in log lines"
33485 &%pid%&: The current process id is added to every log line, in square brackets,
33486 immediately after the time and date.
33487 .next
33488 .cindex "log" "queue run"
33489 .cindex "queue runner" "logging"
33490 &%queue_run%&: The start and end of every queue run are logged.
33491 .next
33492 .cindex "log" "queue time"
33493 &%queue_time%&: The amount of time the message has been in the queue on the
33494 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33495 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33496 includes reception time as well as the delivery time for the current address.
33497 This means that it may be longer than the difference between the arrival and
33498 delivery log line times, because the arrival log line is not written until the
33499 message has been successfully received.
33500 .next
33501 &%queue_time_overall%&: The amount of time the message has been in the queue on
33502 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33503 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33504 message, so it includes reception time as well as the total delivery time.
33505 .next
33506 .cindex "log" "recipients"
33507 &%received_recipients%&: The recipients of a message are listed in the main log
33508 as soon as the message is received. The list appears at the end of the log line
33509 that is written when a message is received, preceded by the word &"for"&. The
33510 addresses are listed after they have been qualified, but before any rewriting
33511 has taken place.
33512 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33513 in the list.
33514 .next
33515 .cindex "log" "sender reception"
33516 &%received_sender%&: The unrewritten original sender of a message is added to
33517 the end of the log line that records the message's arrival, after the word
33518 &"from"& (before the recipients if &%received_recipients%& is also set).
33519 .next
33520 .cindex "log" "header lines for rejection"
33521 &%rejected_header%&: If a message's header has been received at the time a
33522 rejection is written to the reject log, the complete header is added to the
33523 log. Header logging can be turned off individually for messages that are
33524 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33525 .next
33526 .cindex "log" "retry defer"
33527 &%retry_defer%&: A log line is written if a delivery is deferred because a
33528 retry time has not yet been reached. However, this &"retry time not reached"&
33529 message is always omitted from individual message logs after the first delivery
33530 attempt.
33531 .next
33532 .cindex "log" "return path"
33533 &%return_path_on_delivery%&: The return path that is being transmitted with
33534 the message is included in delivery and bounce lines, using the tag P=.
33535 This is omitted if no delivery actually happens, for example, if routing fails,
33536 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33537 .next
33538 .cindex "log" "sender on delivery"
33539 &%sender_on_delivery%&: The message's sender address is added to every delivery
33540 and bounce line, tagged by F= (for &"from"&).
33541 This is the original sender that was received with the message; it is not
33542 necessarily the same as the outgoing return path.
33543 .next
33544 .cindex "log" "sender verify failure"
33545 &%sender_verify_fail%&: If this selector is unset, the separate log line that
33546 gives details of a sender verification failure is not written. Log lines for
33547 the rejection of SMTP commands contain just &"sender verify failed"&, so some
33548 detail is lost.
33549 .next
33550 .cindex "log" "size rejection"
33551 &%size_reject%&: A log line is written whenever a message is rejected because
33552 it is too big.
33553 .next
33554 .cindex "log" "frozen messages; skipped"
33555 .cindex "frozen messages" "logging skipping"
33556 &%skip_delivery%&: A log line is written whenever a message is skipped during a
33557 queue run because it is frozen or because another process is already delivering
33558 it.
33559 .cindex "&""spool file is locked""&"
33560 The message that is written is &"spool file is locked"&.
33561 .next
33562 .cindex "log" "smtp confirmation"
33563 .cindex "SMTP" "logging confirmation"
33564 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
33565 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
33566 A number of MTAs (including Exim) return an identifying string in this
33567 response.
33568 .next
33569 .cindex "log" "SMTP connections"
33570 .cindex "SMTP" "logging connections"
33571 &%smtp_connection%&: A log line is written whenever an SMTP connection is
33572 established or closed, unless the connection is from a host that matches
33573 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
33574 only when the closure is unexpected.) This applies to connections from local
33575 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
33576 dropped in the middle of a message, a log line is always written, whether or
33577 not this selector is set, but otherwise nothing is written at the start and end
33578 of connections unless this selector is enabled.
33579
33580 For TCP/IP connections to an Exim daemon, the current number of connections is
33581 included in the log message for each new connection, but note that the count is
33582 reset if the daemon is restarted.
33583 Also, because connections are closed (and the closure is logged) in
33584 subprocesses, the count may not include connections that have been closed but
33585 whose termination the daemon has not yet noticed. Thus, while it is possible to
33586 match up the opening and closing of connections in the log, the value of the
33587 logged counts may not be entirely accurate.
33588 .next
33589 .cindex "log" "SMTP transaction; incomplete"
33590 .cindex "SMTP" "logging incomplete transactions"
33591 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
33592 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
33593 and the message sender plus any accepted recipients are included in the log
33594 line. This can provide evidence of dictionary attacks.
33595 .next
33596 .cindex "log" "non-MAIL SMTP sessions"
33597 .cindex "MAIL" "logging session without"
33598 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
33599 connection terminates without having issued a MAIL command. This includes both
33600 the case when the connection is dropped, and the case when QUIT is used. It
33601 does not include cases where the connection is rejected right at the start (by
33602 an ACL, or because there are too many connections, or whatever). These cases
33603 already have their own log lines.
33604
33605 The log line that is written contains the identity of the client in the usual
33606 way, followed by D= and a time, which records the duration of the connection.
33607 If the connection was authenticated, this fact is logged exactly as it is for
33608 an incoming message, with an A= item. If the connection was encrypted, CV=,
33609 DN=, and X= items may appear as they do for an incoming message, controlled by
33610 the same logging options.
33611
33612 Finally, if any SMTP commands were issued during the connection, a C= item
33613 is added to the line, listing the commands that were used. For example,
33614 .code
33615 C=EHLO,QUIT
33616 .endd
33617 shows that the client issued QUIT straight after EHLO. If there were fewer
33618 than 20 commands, they are all listed. If there were more than 20 commands,
33619 the last 20 are listed, preceded by &"..."&. However, with the default
33620 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
33621 have been aborted before 20 non-mail commands are processed.
33622 .next
33623 .cindex "log" "SMTP protocol error"
33624 .cindex "SMTP" "logging protocol error"
33625 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
33626 encountered. Exim does not have perfect detection of all protocol errors
33627 because of transmission delays and the use of pipelining. If PIPELINING has
33628 been advertised to a client, an Exim server assumes that the client will use
33629 it, and therefore it does not count &"expected"& errors (for example, RCPT
33630 received after rejecting MAIL) as protocol errors.
33631 .next
33632 .cindex "SMTP" "logging syntax errors"
33633 .cindex "SMTP" "syntax errors; logging"
33634 .cindex "SMTP" "unknown command; logging"
33635 .cindex "log" "unknown SMTP command"
33636 .cindex "log" "SMTP syntax error"
33637 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
33638 encountered. An unrecognized command is treated as a syntax error. For an
33639 external connection, the host identity is given; for an internal connection
33640 using &%-bs%& the sender identification (normally the calling user) is given.
33641 .next
33642 .cindex "log" "subject"
33643 .cindex "subject, logging"
33644 &%subject%&: The subject of the message is added to the arrival log line,
33645 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
33646 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
33647 specifies whether characters with values greater than 127 should be logged
33648 unchanged, or whether they should be rendered as escape sequences.
33649 .next
33650 .cindex "log" "certificate verification"
33651 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
33652 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
33653 verified, and &`CV=no`& if not.
33654 .next
33655 .cindex "log" "TLS cipher"
33656 .cindex "TLS" "logging cipher"
33657 &%tls_cipher%&: When a message is sent or received over an encrypted
33658 connection, the cipher suite used is added to the log line, preceded by X=.
33659 .next
33660 .cindex "log" "TLS peer DN"
33661 .cindex "TLS" "logging peer DN"
33662 &%tls_peerdn%&: When a message is sent or received over an encrypted
33663 connection, and a certificate is supplied by the remote host, the peer DN is
33664 added to the log line, preceded by DN=.
33665 .next
33666 .cindex "log" "TLS SNI"
33667 .cindex "TLS" "logging SNI"
33668 &%tls_sni%&: When a message is received over an encrypted connection, and
33669 the remote host provided the Server Name Indication extension, the SNI is
33670 added to the log line, preceded by SNI=.
33671 .next
33672 .cindex "log" "DNS failure in list"
33673 &%unknown_in_list%&: This setting causes a log entry to be written when the
33674 result of a list match is failure because a DNS lookup failed.
33675 .endlist
33676
33677
33678 .section "Message log" "SECID260"
33679 .cindex "message" "log file for"
33680 .cindex "log" "message log; description of"
33681 .cindex "&_msglog_& directory"
33682 .oindex "&%preserve_message_logs%&"
33683 In addition to the general log files, Exim writes a log file for each message
33684 that it handles. The names of these per-message logs are the message ids, and
33685 they are kept in the &_msglog_& sub-directory of the spool directory. Each
33686 message log contains copies of the log lines that apply to the message. This
33687 makes it easier to inspect the status of an individual message without having
33688 to search the main log. A message log is deleted when processing of the message
33689 is complete, unless &%preserve_message_logs%& is set, but this should be used
33690 only with great care because they can fill up your disk very quickly.
33691
33692 On a heavily loaded system, it may be desirable to disable the use of
33693 per-message logs, in order to reduce disk I/O. This can be done by setting the
33694 &%message_logs%& option false.
33695 .ecindex IIDloggen
33696
33697
33698
33699
33700 . ////////////////////////////////////////////////////////////////////////////
33701 . ////////////////////////////////////////////////////////////////////////////
33702
33703 .chapter "Exim utilities" "CHAPutils"
33704 .scindex IIDutils "utilities"
33705 A number of utility scripts and programs are supplied with Exim and are
33706 described in this chapter. There is also the Exim Monitor, which is covered in
33707 the next chapter. The utilities described here are:
33708
33709 .itable none 0 0 3  7* left  15* left  40* left
33710 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
33711   "list what Exim processes are doing"
33712 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
33713 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
33714 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
33715 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
33716                                                 various criteria"
33717 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
33718 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
33719   "extract statistics from the log"
33720 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
33721   "check address acceptance from given IP"
33722 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
33723 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
33724 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
33725 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
33726 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
33727 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
33728 .endtable
33729
33730 Another utility that might be of use to sites with many MTAs is Tom Kistner's
33731 &'exilog'&. It provides log visualizations across multiple Exim servers. See
33732 &url(http://duncanthrax.net/exilog/) for details.
33733
33734
33735
33736
33737 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
33738 .cindex "&'exiwhat'&"
33739 .cindex "process, querying"
33740 .cindex "SIGUSR1"
33741 On operating systems that can restart a system call after receiving a signal
33742 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
33743 a line describing what it is doing to the file &_exim-process.info_& in the
33744 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
33745 processes it can find, having first emptied the file. It then waits for one
33746 second to allow the Exim processes to react before displaying the results. In
33747 order to run &'exiwhat'& successfully you have to have sufficient privilege to
33748 send the signal to the Exim processes, so it is normally run as root.
33749
33750 &*Warning*&: This is not an efficient process. It is intended for occasional
33751 use by system administrators. It is not sensible, for example, to set up a
33752 script that sends SIGUSR1 signals to Exim processes at short intervals.
33753
33754
33755 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
33756 varies in different operating systems. Not only are different options used,
33757 but the format of the output is different. For this reason, there are some
33758 system configuration options that configure exactly how &'exiwhat'& works. If
33759 it doesn't seem to be working for you, check the following compile-time
33760 options:
33761 .display
33762 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33763 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33764 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33765 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33766 .endd
33767 An example of typical output from &'exiwhat'& is
33768 .code
33769 164 daemon: -q1h, listening on port 25
33770 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33771 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33772   [10.19.42.42] (editor@ref.example)
33773 10592 handling incoming call from [192.168.243.242]
33774 10628 accepting a local non-SMTP message
33775 .endd
33776 The first number in the output line is the process number. The third line has
33777 been split here, in order to fit it on the page.
33778
33779
33780
33781 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33782 .cindex "&'exiqgrep'&"
33783 .cindex "queue" "grepping"
33784 This utility is a Perl script contributed by Matt Hubbard. It runs
33785 .code
33786 exim -bpu
33787 .endd
33788 to obtain a queue listing with undelivered recipients only, and then greps the
33789 output to select messages that match given criteria. The following selection
33790 options are available:
33791
33792 .vlist
33793 .vitem &*-f*&&~<&'regex'&>
33794 Match the sender address. The field that is tested is enclosed in angle
33795 brackets, so you can test for bounce messages with
33796 .code
33797 exiqgrep -f '^<>$'
33798 .endd
33799 .vitem &*-r*&&~<&'regex'&>
33800 Match a recipient address. The field that is tested is not enclosed in angle
33801 brackets.
33802
33803 .vitem &*-s*&&~<&'regex'&>
33804 Match against the size field.
33805
33806 .vitem &*-y*&&~<&'seconds'&>
33807 Match messages that are younger than the given time.
33808
33809 .vitem &*-o*&&~<&'seconds'&>
33810 Match messages that are older than the given time.
33811
33812 .vitem &*-z*&
33813 Match only frozen messages.
33814
33815 .vitem &*-x*&
33816 Match only non-frozen messages.
33817 .endlist
33818
33819 The following options control the format of the output:
33820
33821 .vlist
33822 .vitem &*-c*&
33823 Display only the count of matching messages.
33824
33825 .vitem &*-l*&
33826 Long format &-- display the full message information as output by Exim. This is
33827 the default.
33828
33829 .vitem &*-i*&
33830 Display message ids only.
33831
33832 .vitem &*-b*&
33833 Brief format &-- one line per message.
33834
33835 .vitem &*-R*&
33836 Display messages in reverse order.
33837 .endlist
33838
33839 There is one more option, &%-h%&, which outputs a list of options.
33840
33841
33842
33843 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33844 .cindex "&'exiqsumm'&"
33845 .cindex "queue" "summary"
33846 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33847 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33848 running a command such as
33849 .code
33850 exim -bp | exiqsumm
33851 .endd
33852 The output consists of one line for each domain that has messages waiting for
33853 it, as in the following example:
33854 .code
33855 3   2322   74m   66m  msn.com.example
33856 .endd
33857 Each line lists the number of pending deliveries for a domain, their total
33858 volume, and the length of time that the oldest and the newest messages have
33859 been waiting. Note that the number of pending deliveries is greater than the
33860 number of messages when messages have more than one recipient.
33861
33862 A summary line is output at the end. By default the output is sorted on the
33863 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33864 the output to be sorted by oldest message and by count of messages,
33865 respectively. There are also three options that split the messages for each
33866 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33867 separates frozen messages, and &%-s%& separates messages according to their
33868 sender.
33869
33870 The output of &'exim -bp'& contains the original addresses in the message, so
33871 this also applies to the output from &'exiqsumm'&. No domains from addresses
33872 generated by aliasing or forwarding are included (unless the &%one_time%&
33873 option of the &(redirect)& router has been used to convert them into &"top
33874 level"& addresses).
33875
33876
33877
33878
33879 .section "Extracting specific information from the log (exigrep)" &&&
33880          "SECTextspeinf"
33881 .cindex "&'exigrep'&"
33882 .cindex "log" "extracts; grepping for"
33883 The &'exigrep'& utility is a Perl script that searches one or more main log
33884 files for entries that match a given pattern. When it finds a match, it
33885 extracts all the log entries for the relevant message, not just those that
33886 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33887 given message, or all mail for a given user, or for a given host, for example.
33888 The input files can be in Exim log format or syslog format.
33889 If a matching log line is not associated with a specific message, it is
33890 included in &'exigrep'&'s output without any additional lines. The usage is:
33891 .display
33892 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33893 .endd
33894 If no log file names are given on the command line, the standard input is read.
33895
33896 The &%-t%& argument specifies a number of seconds. It adds an additional
33897 condition for message selection. Messages that are complete are shown only if
33898 they spent more than <&'n'&> seconds on the queue.
33899
33900 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33901 makes it case-sensitive. This may give a performance improvement when searching
33902 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33903 option; with &%-I%& they do not. In both cases it is possible to change the
33904 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33905
33906 The &%-l%& option means &"literal"&, that is, treat all characters in the
33907 pattern as standing for themselves. Otherwise the pattern must be a Perl
33908 regular expression.
33909
33910 The &%-v%& option inverts the matching condition. That is, a line is selected
33911 if it does &'not'& match the pattern.
33912
33913 If the location of a &'zcat'& command is known from the definition of
33914 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33915 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33916
33917
33918 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33919 .cindex "&'exipick'&"
33920 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33921 lists messages from the queue according to a variety of criteria. For details
33922 of &'exipick'&'s facilities, visit the web page at
33923 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33924 the &%--help%& option.
33925
33926
33927 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33928 .cindex "log" "cycling local files"
33929 .cindex "cycling logs"
33930 .cindex "&'exicyclog'&"
33931 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33932 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33933 you are using log files with datestamps in their names (see section
33934 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33935 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33936 There are two command line options for &'exicyclog'&:
33937 .ilist
33938 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33939 default that is set when Exim is built. The default default is 10.
33940 .next
33941 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33942 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33943 overriding the script's default, which is to find the setting from Exim's
33944 configuration.
33945 .endlist
33946
33947 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33948 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33949 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33950 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33951 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33952 logs are handled similarly.
33953
33954 If the limit is greater than 99, the script uses 3-digit numbers such as
33955 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33956 to one that is greater, or &'vice versa'&, you will have to fix the names of
33957 any existing log files.
33958
33959 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33960 the end are deleted. All files with numbers greater than 01 are compressed,
33961 using a compression command which is configured by the COMPRESS_COMMAND
33962 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33963 root &%crontab%& entry of the form
33964 .code
33965 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33966 .endd
33967 assuming you have used the name &"exim"& for the Exim user. You can run
33968 &'exicyclog'& as root if you wish, but there is no need.
33969
33970
33971
33972 .section "Mail statistics (eximstats)" "SECTmailstat"
33973 .cindex "statistics"
33974 .cindex "&'eximstats'&"
33975 A Perl script called &'eximstats'& is provided for extracting statistical
33976 information from log files. The output is either plain text, or HTML.
33977 Exim log files are also supported by the &'Lire'& system produced by the
33978 LogReport Foundation &url(http://www.logreport.org).
33979
33980 The &'eximstats'& script has been hacked about quite a bit over time. The
33981 latest version is the result of some extensive revision by Steve Campbell. A
33982 lot of information is given by default, but there are options for suppressing
33983 various parts of it. Following any options, the arguments to the script are a
33984 list of files, which should be main log files. For example:
33985 .code
33986 eximstats -nr /var/spool/exim/log/mainlog.01
33987 .endd
33988 By default, &'eximstats'& extracts information about the number and volume of
33989 messages received from or delivered to various hosts. The information is sorted
33990 both by message count and by volume, and the top fifty hosts in each category
33991 are listed on the standard output. Similar information, based on email
33992 addresses or domains instead of hosts can be requested by means of various
33993 options. For messages delivered and received locally, similar statistics are
33994 also produced per user.
33995
33996 The output also includes total counts and statistics about delivery errors, and
33997 histograms showing the number of messages received and deliveries made in each
33998 hour of the day. A delivery with more than one address in its envelope (for
33999 example, an SMTP transaction with more than one RCPT command) is counted
34000 as a single delivery by &'eximstats'&.
34001
34002 Though normally more deliveries than receipts are reported (as messages may
34003 have multiple recipients), it is possible for &'eximstats'& to report more
34004 messages received than delivered, even though the queue is empty at the start
34005 and end of the period in question. If an incoming message contains no valid
34006 recipients, no deliveries are recorded for it. A bounce message is handled as
34007 an entirely separate message.
34008
34009 &'eximstats'& always outputs a grand total summary giving the volume and number
34010 of messages received and deliveries made, and the number of hosts involved in
34011 each case. It also outputs the number of messages that were delayed (that is,
34012 not completely delivered at the first attempt), and the number that had at
34013 least one address that failed.
34014
34015 The remainder of the output is in sections that can be independently disabled
34016 or modified by various options. It consists of a summary of deliveries by
34017 transport, histograms of messages received and delivered per time interval
34018 (default per hour), information about the time messages spent on the queue,
34019 a list of relayed messages, lists of the top fifty sending hosts, local
34020 senders, destination hosts, and destination local users by count and by volume,
34021 and a list of delivery errors that occurred.
34022
34023 The relay information lists messages that were actually relayed, that is, they
34024 came from a remote host and were directly delivered to some other remote host,
34025 without being processed (for example, for aliasing or forwarding) locally.
34026
34027 There are quite a few options for &'eximstats'& to control exactly what it
34028 outputs. These are documented in the Perl script itself, and can be extracted
34029 by running the command &(perldoc)& on the script. For example:
34030 .code
34031 perldoc /usr/exim/bin/eximstats
34032 .endd
34033
34034 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34035 .cindex "&'exim_checkaccess'&"
34036 .cindex "policy control" "checking access"
34037 .cindex "checking access"
34038 The &%-bh%& command line argument allows you to run a fake SMTP session with
34039 debugging output, in order to check what Exim is doing when it is applying
34040 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34041 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34042 sometimes you just want to answer the question &"Does this address have
34043 access?"& without bothering with any further details.
34044
34045 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34046 two arguments, an IP address and an email address:
34047 .code
34048 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34049 .endd
34050 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34051 given email address would be accepted in a RCPT command in a TCP/IP
34052 connection from the host with the given IP address. The output of the utility
34053 is either the word &"accepted"&, or the SMTP error response, for example:
34054 .code
34055 Rejected:
34056 550 Relay not permitted
34057 .endd
34058 When running this test, the utility uses &`<>`& as the envelope sender address
34059 for the MAIL command, but you can change this by providing additional
34060 options. These are passed directly to the Exim command. For example, to specify
34061 that the test is to be run with the sender address &'himself@there.example'&
34062 you can use:
34063 .code
34064 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34065                  -f himself@there.example
34066 .endd
34067 Note that these additional Exim command line items must be given after the two
34068 mandatory arguments.
34069
34070 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34071 while running its checks. You can run checks that include callouts by using
34072 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34073
34074
34075
34076 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34077 .cindex "DBM" "building dbm files"
34078 .cindex "building DBM files"
34079 .cindex "&'exim_dbmbuild'&"
34080 .cindex "lower casing"
34081 .cindex "binary zero" "in lookup key"
34082 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34083 the format used by the &(lsearch)& lookup (see section
34084 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34085 names as keys and the remainder of the information as data. The lower-casing
34086 can be prevented by calling the program with the &%-nolc%& option.
34087
34088 A terminating zero is included as part of the key string. This is expected by
34089 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34090 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34091 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34092 files.
34093
34094 The program requires two arguments: the name of the input file (which can be a
34095 single hyphen to indicate the standard input), and the name of the output file.
34096 It creates the output under a temporary name, and then renames it if all went
34097 well.
34098
34099 .cindex "USE_DB"
34100 If the native DB interface is in use (USE_DB is set in a compile-time
34101 configuration file &-- this is common in free versions of Unix) the two file
34102 names must be different, because in this mode the Berkeley DB functions create
34103 a single output file using exactly the name given. For example,
34104 .code
34105 exim_dbmbuild /etc/aliases /etc/aliases.db
34106 .endd
34107 reads the system alias file and creates a DBM version of it in
34108 &_/etc/aliases.db_&.
34109
34110 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34111 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34112 environment, the suffixes are added to the second argument of
34113 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34114 when the Berkeley functions are used in compatibility mode (though this is not
34115 recommended), because in that case it adds a &_.db_& suffix to the file name.
34116
34117 If a duplicate key is encountered, the program outputs a warning, and when it
34118 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34119 option is used. By default, only the first of a set of duplicates is used &--
34120 this makes it compatible with &(lsearch)& lookups. There is an option
34121 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34122 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34123 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34124 return code is 2.
34125
34126
34127
34128
34129 .section "Finding individual retry times (exinext)" "SECTfinindret"
34130 .cindex "retry" "times"
34131 .cindex "&'exinext'&"
34132 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34133 fish specific information out of the retry database. Given a mail domain (or a
34134 complete address), it looks up the hosts for that domain, and outputs any retry
34135 information for the hosts or for the domain. At present, the retry information
34136 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34137 output. For example:
34138 .code
34139 $ exinext piglet@milne.fict.example
34140 kanga.milne.example:192.168.8.1 error 146: Connection refused
34141   first failed: 21-Feb-1996 14:57:34
34142   last tried:   21-Feb-1996 14:57:34
34143   next try at:  21-Feb-1996 15:02:34
34144 roo.milne.example:192.168.8.3 error 146: Connection refused
34145   first failed: 20-Jan-1996 13:12:08
34146   last tried:   21-Feb-1996 11:42:03
34147   next try at:  21-Feb-1996 19:42:03
34148   past final cutoff time
34149 .endd
34150 You can also give &'exinext'& a local part, without a domain, and it
34151 will give any retry information for that local part in your default domain.
34152 A message id can be used to obtain retry information pertaining to a specific
34153 message. This exists only when an attempt to deliver a message to a remote host
34154 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34155 &'exinext'& is not particularly efficient, but then it is not expected to be
34156 run very often.
34157
34158 The &'exinext'& utility calls Exim to find out information such as the location
34159 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34160 passed on to the &'exim'& commands. The first specifies an alternate Exim
34161 configuration file, and the second sets macros for use within the configuration
34162 file. These features are mainly to help in testing, but might also be useful in
34163 environments where more than one configuration file is in use.
34164
34165
34166
34167 .section "Hints database maintenance" "SECThindatmai"
34168 .cindex "hints database" "maintenance"
34169 .cindex "maintaining Exim's hints database"
34170 Three utility programs are provided for maintaining the DBM files that Exim
34171 uses to contain its delivery hint information. Each program requires two
34172 arguments. The first specifies the name of Exim's spool directory, and the
34173 second is the name of the database it is to operate on. These are as follows:
34174
34175 .ilist
34176 &'retry'&: the database of retry information
34177 .next
34178 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34179 for remote hosts
34180 .next
34181 &'callout'&: the callout cache
34182 .next
34183 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34184 .next
34185 &'misc'&: other hints data
34186 .endlist
34187
34188 The &'misc'& database is used for
34189
34190 .ilist
34191 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34192 .next
34193 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34194 &(smtp)& transport)
34195 .endlist
34196
34197
34198
34199 .section "exim_dumpdb" "SECID261"
34200 .cindex "&'exim_dumpdb'&"
34201 The entire contents of a database are written to the standard output by the
34202 &'exim_dumpdb'& program, which has no options or arguments other than the
34203 spool and database names. For example, to dump the retry database:
34204 .code
34205 exim_dumpdb /var/spool/exim retry
34206 .endd
34207 Two lines of output are produced for each entry:
34208 .code
34209 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34210 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34211 .endd
34212 The first item on the first line is the key of the record. It starts with one
34213 of the letters R, or T, depending on whether it refers to a routing or
34214 transport retry. For a local delivery, the next part is the local address; for
34215 a remote delivery it is the name of the remote host, followed by its failing IP
34216 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34217 transport). If the remote port is not the standard one (port 25), it is added
34218 to the IP address. Then there follows an error code, an additional error code,
34219 and a textual description of the error.
34220
34221 The three times on the second line are the time of first failure, the time of
34222 the last delivery attempt, and the computed time for the next attempt. The line
34223 ends with an asterisk if the cutoff time for the last retry rule has been
34224 exceeded.
34225
34226 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34227 consists of a host name followed by a list of ids for messages that are or were
34228 waiting to be delivered to that host. If there are a very large number for any
34229 one host, continuation records, with a sequence number added to the host name,
34230 may be seen. The data in these records is often out of date, because a message
34231 may be routed to several alternative hosts, and Exim makes no effort to keep
34232 cross-references.
34233
34234
34235
34236 .section "exim_tidydb" "SECID262"
34237 .cindex "&'exim_tidydb'&"
34238 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34239 database. If run with no options, it removes all records that are more than 30
34240 days old. The age is calculated from the date and time that the record was last
34241 updated. Note that, in the case of the retry database, it is &'not'& the time
34242 since the first delivery failure. Information about a host that has been down
34243 for more than 30 days will remain in the database, provided that the record is
34244 updated sufficiently often.
34245
34246 The cutoff date can be altered by means of the &%-t%& option, which must be
34247 followed by a time. For example, to remove all records older than a week from
34248 the retry database:
34249 .code
34250 exim_tidydb -t 7d /var/spool/exim retry
34251 .endd
34252 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34253 message ids. In the former these appear as data in records keyed by host &--
34254 they were messages that were waiting for that host &-- and in the latter they
34255 are the keys for retry information for messages that have suffered certain
34256 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34257 message ids in database records are those of messages that are still on the
34258 queue. Message ids for messages that no longer exist are removed from
34259 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34260 For the &'retry'& database, records whose keys are non-existent message ids are
34261 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34262 whenever it removes information from the database.
34263
34264 Certain records are automatically removed by Exim when they are no longer
34265 needed, but others are not. For example, if all the MX hosts for a domain are
34266 down, a retry record is created for each one. If the primary MX host comes back
34267 first, its record is removed when Exim successfully delivers to it, but the
34268 records for the others remain because Exim has not tried to use those hosts.
34269
34270 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34271 hints databases. You should do this at a quiet time of day, because it requires
34272 a database to be locked (and therefore inaccessible to Exim) while it does its
34273 work. Removing records from a DBM file does not normally make the file smaller,
34274 but all the common DBM libraries are able to re-use the space that is released.
34275 After an initial phase of increasing in size, the databases normally reach a
34276 point at which they no longer get any bigger, as long as they are regularly
34277 tidied.
34278
34279 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34280 databases is likely to keep on increasing.
34281
34282
34283
34284
34285 .section "exim_fixdb" "SECID263"
34286 .cindex "&'exim_fixdb'&"
34287 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34288 Its main use is for testing Exim, but it might also be occasionally useful for
34289 getting round problems in a live system. It has no options, and its interface
34290 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34291 key of a database record can then be entered, and the data for that record is
34292 displayed.
34293
34294 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34295 except the &'retry'& database, that is the only operation that can be carried
34296 out. For the &'retry'& database, each field is output preceded by a number, and
34297 data for individual fields can be changed by typing the field number followed
34298 by new data, for example:
34299 .code
34300 > 4 951102:1000
34301 .endd
34302 resets the time of the next delivery attempt. Time values are given as a
34303 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34304 used as optional separators.
34305
34306
34307
34308
34309 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34310 .cindex "mailbox" "maintenance"
34311 .cindex "&'exim_lock'&"
34312 .cindex "locking mailboxes"
34313 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34314 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34315 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34316 a user agent while investigating a problem. The utility requires the name of
34317 the file as its first argument. If the locking is successful, the second
34318 argument is run as a command (using C's &[system()]& function); if there is no
34319 second argument, the value of the SHELL environment variable is used; if this
34320 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34321 is unlocked and the utility ends. The following options are available:
34322
34323 .vlist
34324 .vitem &%-fcntl%&
34325 Use &[fcntl()]& locking on the open mailbox.
34326
34327 .vitem &%-flock%&
34328 Use &[flock()]& locking on the open mailbox, provided the operating system
34329 supports it.
34330
34331 .vitem &%-interval%&
34332 This must be followed by a number, which is a number of seconds; it sets the
34333 interval to sleep between retries (default 3).
34334
34335 .vitem &%-lockfile%&
34336 Create a lock file before opening the mailbox.
34337
34338 .vitem &%-mbx%&
34339 Lock the mailbox using MBX rules.
34340
34341 .vitem &%-q%&
34342 Suppress verification output.
34343
34344 .vitem &%-retries%&
34345 This must be followed by a number; it sets the number of times to try to get
34346 the lock (default 10).
34347
34348 .vitem &%-restore_time%&
34349 This option causes &%exim_lock%& to restore the modified and read times to the
34350 locked file before exiting. This allows you to access a locked mailbox (for
34351 example, to take a backup copy) without disturbing the times that the user
34352 subsequently sees.
34353
34354 .vitem &%-timeout%&
34355 This must be followed by a number, which is a number of seconds; it sets a
34356 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34357 default), a non-blocking call is used.
34358
34359 .vitem &%-v%&
34360 Generate verbose output.
34361 .endlist
34362
34363 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34364 default is to create a lock file and also to use &[fcntl()]& locking on the
34365 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34366 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34367 requires that the directory containing the file be writeable. Locking by lock
34368 file does not last for ever; Exim assumes that a lock file is expired if it is
34369 more than 30 minutes old.
34370
34371 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34372 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34373 to be taken out on the open mailbox, and an exclusive lock on the file
34374 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34375 number of the mailbox file. When the locking is released, if an exclusive lock
34376 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34377
34378 The default output contains verification of the locking that takes place. The
34379 &%-v%& option causes some additional information to be given. The &%-q%& option
34380 suppresses all output except error messages.
34381
34382 A command such as
34383 .code
34384 exim_lock /var/spool/mail/spqr
34385 .endd
34386 runs an interactive shell while the file is locked, whereas
34387 .display
34388 &`exim_lock -q /var/spool/mail/spqr <<End`&
34389 <&'some commands'&>
34390 &`End`&
34391 .endd
34392 runs a specific non-interactive sequence of commands while the file is locked,
34393 suppressing all verification output. A single command can be run by a command
34394 such as
34395 .code
34396 exim_lock -q /var/spool/mail/spqr \
34397   "cp /var/spool/mail/spqr /some/where"
34398 .endd
34399 Note that if a command is supplied, it must be entirely contained within the
34400 second argument &-- hence the quotes.
34401 .ecindex IIDutils
34402
34403
34404 . ////////////////////////////////////////////////////////////////////////////
34405 . ////////////////////////////////////////////////////////////////////////////
34406
34407 .chapter "The Exim monitor" "CHAPeximon"
34408 .scindex IIDeximon "Exim monitor" "description"
34409 .cindex "X-windows"
34410 .cindex "&'eximon'&"
34411 .cindex "Local/eximon.conf"
34412 .cindex "&_exim_monitor/EDITME_&"
34413 The Exim monitor is an application which displays in an X window information
34414 about the state of Exim's queue and what Exim is doing. An admin user can
34415 perform certain operations on messages from this GUI interface; however all
34416 such facilities are also available from the command line, and indeed, the
34417 monitor itself makes use of the command line to perform any actions requested.
34418
34419
34420
34421 .section "Running the monitor" "SECID264"
34422 The monitor is started by running the script called &'eximon'&. This is a shell
34423 script that sets up a number of environment variables, and then runs the
34424 binary called &_eximon.bin_&. The default appearance of the monitor window can
34425 be changed by editing the &_Local/eximon.conf_& file created by editing
34426 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34427 parameters are for.
34428
34429 The parameters that get built into the &'eximon'& script can be overridden for
34430 a particular invocation by setting up environment variables of the same names,
34431 preceded by &`EXIMON_`&. For example, a shell command such as
34432 .code
34433 EXIMON_LOG_DEPTH=400 eximon
34434 .endd
34435 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34436 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34437 overrides the Exim log file configuration. This makes it possible to have
34438 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34439 syslog messages are routed to a file on the local host.
34440
34441 X resources can be used to change the appearance of the window in the normal
34442 way. For example, a resource setting of the form
34443 .code
34444 Eximon*background: gray94
34445 .endd
34446 changes the colour of the background to light grey rather than white. The
34447 stripcharts are drawn with both the data lines and the reference lines in
34448 black. This means that the reference lines are not visible when on top of the
34449 data. However, their colour can be changed by setting a resource called
34450 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34451 For example, if your X server is running Unix, you could set up lighter
34452 reference lines in the stripcharts by obeying
34453 .code
34454 xrdb -merge <<End
34455 Eximon*highlight: gray
34456 End
34457 .endd
34458 .cindex "admin user"
34459 In order to see the contents of messages on the queue, and to operate on them,
34460 &'eximon'& must either be run as root or by an admin user.
34461
34462 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34463 contain X11 resource parameters interpreted by the X11 library.  In addition,
34464 if the first parameter starts with the string "gdb" then it is removed and the
34465 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34466 versioned variants of gdb can be invoked).
34467
34468 The monitor's window is divided into three parts. The first contains one or
34469 more stripcharts and two action buttons, the second contains a &"tail"& of the
34470 main log file, and the third is a display of the queue of messages awaiting
34471 delivery, with two more action buttons. The following sections describe these
34472 different parts of the display.
34473
34474
34475
34476
34477 .section "The stripcharts" "SECID265"
34478 .cindex "stripchart"
34479 The first stripchart is always a count of messages on the queue. Its name can
34480 be configured by setting QUEUE_STRIPCHART_NAME in the
34481 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34482 configuration script by regular expression matches on log file entries, making
34483 it possible to display, for example, counts of messages delivered to certain
34484 hosts or using certain transports. The supplied defaults display counts of
34485 received and delivered messages, and of local and SMTP deliveries. The default
34486 period between stripchart updates is one minute; this can be adjusted by a
34487 parameter in the &_Local/eximon.conf_& file.
34488
34489 The stripchart displays rescale themselves automatically as the value they are
34490 displaying changes. There are always 10 horizontal lines in each chart; the
34491 title string indicates the value of each division when it is greater than one.
34492 For example, &"x2"& means that each division represents a value of 2.
34493
34494 It is also possible to have a stripchart which shows the percentage fullness of
34495 a particular disk partition, which is useful when local deliveries are confined
34496 to a single partition.
34497
34498 .cindex "&%statvfs%& function"
34499 This relies on the availability of the &[statvfs()]& function or equivalent in
34500 the operating system. Most, but not all versions of Unix that support Exim have
34501 this. For this particular stripchart, the top of the chart always represents
34502 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34503 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34504 &_Local/eximon.conf_& file.
34505
34506
34507
34508
34509 .section "Main action buttons" "SECID266"
34510 .cindex "size" "of monitor window"
34511 .cindex "Exim monitor" "window size"
34512 .cindex "window size"
34513 Below the stripcharts there is an action button for quitting the monitor. Next
34514 to this is another button marked &"Size"&. They are placed here so that
34515 shrinking the window to its default minimum size leaves just the queue count
34516 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34517 the window to expand to its maximum size, unless it is already at the maximum,
34518 in which case it is reduced to its minimum.
34519
34520 When expanding to the maximum, if the window cannot be fully seen where it
34521 currently is, it is moved back to where it was the last time it was at full
34522 size. When it is expanding from its minimum size, the old position is
34523 remembered, and next time it is reduced to the minimum it is moved back there.
34524
34525 The idea is that you can keep a reduced window just showing one or two
34526 stripcharts at a convenient place on your screen, easily expand it to show
34527 the full window when required, and just as easily put it back to what it was.
34528 The idea is copied from what the &'twm'& window manager does for its
34529 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34530 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34531
34532 Normally, the monitor starts up with the window at its full size, but it can be
34533 built so that it starts up with the window at its smallest size, by setting
34534 START_SMALL=yes in &_Local/eximon.conf_&.
34535
34536
34537
34538 .section "The log display" "SECID267"
34539 .cindex "log" "tail of; in monitor"
34540 The second section of the window is an area in which a display of the tail of
34541 the main log is maintained.
34542 To save space on the screen, the timestamp on each log line is shortened by
34543 removing the date and, if &%log_timezone%& is set, the timezone.
34544 The log tail is not available when the only destination for logging data is
34545 syslog, unless the syslog lines are routed to a local file whose name is passed
34546 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
34547
34548 The log sub-window has a scroll bar at its lefthand side which can be used to
34549 move back to look at earlier text, and the up and down arrow keys also have a
34550 scrolling effect. The amount of log that is kept depends on the setting of
34551 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
34552 to use. When this is full, the earlier 50% of data is discarded &-- this is
34553 much more efficient than throwing it away line by line. The sub-window also has
34554 a horizontal scroll bar for accessing the ends of long log lines. This is the
34555 only means of horizontal scrolling; the right and left arrow keys are not
34556 available. Text can be cut from this part of the window using the mouse in the
34557 normal way. The size of this subwindow is controlled by parameters in the
34558 configuration file &_Local/eximon.conf_&.
34559
34560 Searches of the text in the log window can be carried out by means of the ^R
34561 and ^S keystrokes, which default to a reverse and a forward search,
34562 respectively. The search covers only the text that is displayed in the window.
34563 It cannot go further back up the log.
34564
34565 The point from which the search starts is indicated by a caret marker. This is
34566 normally at the end of the text in the window, but can be positioned explicitly
34567 by pointing and clicking with the left mouse button, and is moved automatically
34568 by a successful search. If new text arrives in the window when it is scrolled
34569 back, the caret remains where it is, but if the window is not scrolled back,
34570 the caret is moved to the end of the new text.
34571
34572 Pressing ^R or ^S pops up a window into which the search text can be typed.
34573 There are buttons for selecting forward or reverse searching, for carrying out
34574 the search, and for cancelling. If the &"Search"& button is pressed, the search
34575 happens and the window remains so that further searches can be done. If the
34576 &"Return"& key is pressed, a single search is done and the window is closed. If
34577 ^C is typed the search is cancelled.
34578
34579 The searching facility is implemented using the facilities of the Athena text
34580 widget. By default this pops up a window containing both &"search"& and
34581 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
34582 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
34583 However, the linkers in BSDI and HP-UX seem unable to handle an externally
34584 provided version of &%TextPop%& when the remaining parts of the text widget
34585 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
34586 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
34587 on these systems, at the expense of having unwanted items in the search popup
34588 window.
34589
34590
34591
34592 .section "The queue display" "SECID268"
34593 .cindex "queue" "display in monitor"
34594 The bottom section of the monitor window contains a list of all messages that
34595 are on the queue, which includes those currently being received or delivered,
34596 as well as those awaiting delivery. The size of this subwindow is controlled by
34597 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
34598 at which it is updated is controlled by another parameter in the same file &--
34599 the default is 5 minutes, since queue scans can be quite expensive. However,
34600 there is an &"Update"& action button just above the display which can be used
34601 to force an update of the queue display at any time.
34602
34603 When a host is down for some time, a lot of pending mail can build up for it,
34604 and this can make it hard to deal with other messages on the queue. To help
34605 with this situation there is a button next to &"Update"& called &"Hide"&. If
34606 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
34607 type anything in here and press &"Return"&, the text is added to a chain of
34608 such texts, and if every undelivered address in a message matches at least one
34609 of the texts, the message is not displayed.
34610
34611 If there is an address that does not match any of the texts, all the addresses
34612 are displayed as normal. The matching happens on the ends of addresses so, for
34613 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
34614 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
34615 has been set up, a button called &"Unhide"& is displayed. If pressed, it
34616 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
34617 a hide request is automatically cancelled after one hour.
34618
34619 While the dialogue box is displayed, you can't press any buttons or do anything
34620 else to the monitor window. For this reason, if you want to cut text from the
34621 queue display to use in the dialogue box, you have to do the cutting before
34622 pressing the &"Hide"& button.
34623
34624 The queue display contains, for each unhidden queued message, the length of
34625 time it has been on the queue, the size of the message, the message id, the
34626 message sender, and the first undelivered recipient, all on one line. If it is
34627 a bounce message, the sender is shown as &"<>"&. If there is more than one
34628 recipient to which the message has not yet been delivered, subsequent ones are
34629 listed on additional lines, up to a maximum configured number, following which
34630 an ellipsis is displayed. Recipients that have already received the message are
34631 not shown.
34632
34633 .cindex "frozen messages" "display"
34634 If a message is frozen, an asterisk is displayed at the left-hand side.
34635
34636 The queue display has a vertical scroll bar, and can also be scrolled by means
34637 of the arrow keys. Text can be cut from it using the mouse in the normal way.
34638 The text searching facilities, as described above for the log window, are also
34639 available, but the caret is always moved to the end of the text when the queue
34640 display is updated.
34641
34642
34643
34644 .section "The queue menu" "SECID269"
34645 .cindex "queue" "menu in monitor"
34646 If the &%shift%& key is held down and the left button is clicked when the mouse
34647 pointer is over the text for any message, an action menu pops up, and the first
34648 line of the queue display for the message is highlighted. This does not affect
34649 any selected text.
34650
34651 If you want to use some other event for popping up the menu, you can set the
34652 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
34653 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
34654 value set in this parameter is a standard X event description. For example, to
34655 run eximon using &%ctrl%& rather than &%shift%& you could use
34656 .code
34657 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
34658 .endd
34659 The title of the menu is the message id, and it contains entries which act as
34660 follows:
34661
34662 .ilist
34663 &'message log'&: The contents of the message log for the message are displayed
34664 in a new text window.
34665 .next
34666 &'headers'&: Information from the spool file that contains the envelope
34667 information and headers is displayed in a new text window. See chapter
34668 &<<CHAPspool>>& for a description of the format of spool files.
34669 .next
34670 &'body'&: The contents of the spool file containing the body of the message are
34671 displayed in a new text window. There is a default limit of 20,000 bytes to the
34672 amount of data displayed. This can be changed by setting the BODY_MAX
34673 option at compile time, or the EXIMON_BODY_MAX option at run time.
34674 .next
34675 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
34676 delivery of the message. This causes an automatic thaw if the message is
34677 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
34678 a new text window. The delivery is run in a separate process, to avoid holding
34679 up the monitor while the delivery proceeds.
34680 .next
34681 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
34682 that the message be frozen.
34683 .next
34684 .cindex "thawing messages"
34685 .cindex "unfreezing messages"
34686 .cindex "frozen messages" "thawing"
34687 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
34688 that the message be thawed.
34689 .next
34690 .cindex "delivery" "forcing failure"
34691 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
34692 that Exim gives up trying to deliver the message. A bounce message is generated
34693 for any remaining undelivered addresses.
34694 .next
34695 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
34696 that the message be deleted from the system without generating a bounce
34697 message.
34698 .next
34699 &'add recipient'&: A dialog box is displayed into which a recipient address can
34700 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34701 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34702 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34703 causes a call to Exim to be made using the &%-Mar%& option to request that an
34704 additional recipient be added to the message, unless the entry box is empty, in
34705 which case no action is taken.
34706 .next
34707 &'mark delivered'&: A dialog box is displayed into which a recipient address
34708 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
34709 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
34710 Otherwise it must be entered as a fully qualified address. Pressing RETURN
34711 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
34712 recipient address as already delivered, unless the entry box is empty, in which
34713 case no action is taken.
34714 .next
34715 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
34716 mark all recipient addresses as already delivered.
34717 .next
34718 &'edit sender'&: A dialog box is displayed initialized with the current
34719 sender's address. Pressing RETURN causes a call to Exim to be made using the
34720 &%-Mes%& option to replace the sender address, unless the entry box is empty,
34721 in which case no action is taken. If you want to set an empty sender (as in
34722 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
34723 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
34724 the address is qualified with that domain.
34725 .endlist
34726
34727 When a delivery is forced, a window showing the &%-v%& output is displayed. In
34728 other cases when a call to Exim is made, if there is any output from Exim (in
34729 particular, if the command fails) a window containing the command and the
34730 output is displayed. Otherwise, the results of the action are normally apparent
34731 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
34732 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
34733 if no output is generated.
34734
34735 The queue display is automatically updated for actions such as freezing and
34736 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
34737 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
34738 force an update of the display after one of these actions.
34739
34740 In any text window that is displayed as result of a menu action, the normal
34741 cut-and-paste facility is available, and searching can be carried out using ^R
34742 and ^S, as described above for the log tail window.
34743 .ecindex IIDeximon
34744
34745
34746
34747
34748
34749 . ////////////////////////////////////////////////////////////////////////////
34750 . ////////////////////////////////////////////////////////////////////////////
34751
34752 .chapter "Security considerations" "CHAPsecurity"
34753 .scindex IIDsecurcon "security" "discussion of"
34754 This chapter discusses a number of issues concerned with security, some of
34755 which are also covered in other parts of this manual.
34756
34757 For reasons that this author does not understand, some people have promoted
34758 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
34759 existence of this chapter in the documentation. However, the intent of the
34760 chapter is simply to describe the way Exim works in relation to certain
34761 security concerns, not to make any specific claims about the effectiveness of
34762 its security as compared with other MTAs.
34763
34764 What follows is a description of the way Exim is supposed to be. Best efforts
34765 have been made to try to ensure that the code agrees with the theory, but an
34766 absence of bugs can never be guaranteed. Any that are reported will get fixed
34767 as soon as possible.
34768
34769
34770 .section "Building a more &""hardened""& Exim" "SECID286"
34771 .cindex "security" "build-time features"
34772 There are a number of build-time options that can be set in &_Local/Makefile_&
34773 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34774 Exim administrator who does not have the root password, or by someone who has
34775 penetrated the Exim (but not the root) account. These options are as follows:
34776
34777 .ilist
34778 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34779 start of any file names used with the &%-C%& option. When it is set, these file
34780 names are also not allowed to contain the sequence &"/../"&. (However, if the
34781 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34782 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34783 default setting for &%ALT_CONFIG_PREFIX%&.
34784
34785 If the permitted configuration files are confined to a directory to
34786 which only root has access, this guards against someone who has broken
34787 into the Exim account from running a privileged Exim with an arbitrary
34788 configuration file, and using it to break into other accounts.
34789 .next
34790
34791 If a non-trusted configuration file (i.e. not the default configuration file
34792 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34793 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34794 the next item), then root privilege is retained only if the caller of Exim is
34795 root. This locks out the possibility of testing a configuration using &%-C%&
34796 right through message reception and delivery, even if the caller is root. The
34797 reception works, but by that time, Exim is running as the Exim user, so when
34798 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34799 privilege to be lost. However, root can test reception and delivery using two
34800 separate commands.
34801
34802 .next
34803 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34804 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34805 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34806 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34807 the restrictive side.  Requiring build-time selection of safe macros is onerous
34808 but this option is intended solely as a transition mechanism to permit
34809 previously-working configurations to continue to work after release 4.73.
34810 .next
34811 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34812 is disabled.
34813 .next
34814 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34815 never to be used for any deliveries. This is like the &%never_users%& runtime
34816 option, but it cannot be overridden; the runtime option adds additional users
34817 to the list. The default setting is &"root"&; this prevents a non-root user who
34818 is permitted to modify the runtime file from using Exim as a way to get root.
34819 .endlist
34820
34821
34822
34823 .section "Root privilege" "SECID270"
34824 .cindex "setuid"
34825 .cindex "root privilege"
34826 The Exim binary is normally setuid to root, which means that it gains root
34827 privilege (runs as root) when it starts execution. In some special cases (for
34828 example, when the daemon is not in use and there are no local deliveries), it
34829 may be possible to run Exim setuid to some user other than root. This is
34830 discussed in the next section. However, in most installations, root privilege
34831 is required for two things:
34832
34833 .ilist
34834 To set up a socket connected to the standard SMTP port (25) when initialising
34835 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34836 not required.
34837 .next
34838 To be able to change uid and gid in order to read users' &_.forward_& files and
34839 perform local deliveries as the receiving user or as specified in the
34840 configuration.
34841 .endlist
34842
34843 It is not necessary to be root to do any of the other things Exim does, such as
34844 receiving messages and delivering them externally over SMTP, and it is
34845 obviously more secure if Exim does not run as root except when necessary.
34846 For this reason, a user and group for Exim to use must be defined in
34847 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34848 group"&. Their values can be changed by the run time configuration, though this
34849 is not recommended. Often a user called &'exim'& is used, but some sites use
34850 &'mail'& or another user name altogether.
34851
34852 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34853 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34854 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34855
34856 After a new Exim process has interpreted its command line options, it changes
34857 uid and gid in the following cases:
34858
34859 .ilist
34860 .oindex "&%-C%&"
34861 .oindex "&%-D%&"
34862 If the &%-C%& option is used to specify an alternate configuration file, or if
34863 the &%-D%& option is used to define macro values for the configuration, and the
34864 calling process is not running as root, the uid and gid are changed to those of
34865 the calling process.
34866 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34867 option may not be used at all.
34868 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34869 can be supplied if the calling process is running as root, the Exim run-time
34870 user or CONFIGURE_OWNER, if defined.
34871 .next
34872 .oindex "&%-be%&"
34873 .oindex "&%-bf%&"
34874 .oindex "&%-bF%&"
34875 If the expansion test option (&%-be%&) or one of the filter testing options
34876 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34877 calling process.
34878 .next
34879 If the process is not a daemon process or a queue runner process or a delivery
34880 process or a process for testing address routing (started with &%-bt%&), the
34881 uid and gid are changed to the Exim user and group. This means that Exim always
34882 runs under its own uid and gid when receiving messages. This also applies when
34883 testing address verification
34884 .oindex "&%-bv%&"
34885 .oindex "&%-bh%&"
34886 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34887 option).
34888 .next
34889 For a daemon, queue runner, delivery, or address testing process, the uid
34890 remains as root at this stage, but the gid is changed to the Exim group.
34891 .endlist
34892
34893 The processes that initially retain root privilege behave as follows:
34894
34895 .ilist
34896 A daemon process changes the gid to the Exim group and the uid to the Exim
34897 user after setting up one or more listening sockets. The &[initgroups()]&
34898 function is called, so that if the Exim user is in any additional groups, they
34899 will be used during message reception.
34900 .next
34901 A queue runner process retains root privilege throughout its execution. Its
34902 job is to fork a controlled sequence of delivery processes.
34903 .next
34904 A delivery process retains root privilege throughout most of its execution,
34905 but any actual deliveries (that is, the transports themselves) are run in
34906 subprocesses which always change to a non-root uid and gid. For local
34907 deliveries this is typically the uid and gid of the owner of the mailbox; for
34908 remote deliveries, the Exim uid and gid are used. Once all the delivery
34909 subprocesses have been run, a delivery process changes to the Exim uid and gid
34910 while doing post-delivery tidying up such as updating the retry database and
34911 generating bounce and warning messages.
34912
34913 While the recipient addresses in a message are being routed, the delivery
34914 process runs as root. However, if a user's filter file has to be processed,
34915 this is done in a subprocess that runs under the individual user's uid and
34916 gid. A system filter is run as root unless &%system_filter_user%& is set.
34917 .next
34918 A process that is testing addresses (the &%-bt%& option) runs as root so that
34919 the routing is done in the same environment as a message delivery.
34920 .endlist
34921
34922
34923
34924
34925 .section "Running Exim without privilege" "SECTrunexiwitpri"
34926 .cindex "privilege, running without"
34927 .cindex "unprivileged running"
34928 .cindex "root privilege" "running without"
34929 Some installations like to run Exim in an unprivileged state for more of its
34930 operation, for added security. Support for this mode of operation is provided
34931 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34932 gid are changed to the Exim user and group at the start of a delivery process
34933 (and also queue runner and address testing processes). This means that address
34934 routing is no longer run as root, and the deliveries themselves cannot change
34935 to any other uid.
34936
34937 .cindex SIGHUP
34938 .cindex "daemon" "restarting"
34939 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34940 that the daemon can still be started in the usual way, and it can respond
34941 correctly to SIGHUP because the re-invocation regains root privilege.
34942
34943 An alternative approach is to make Exim setuid to the Exim user and also setgid
34944 to the Exim group. If you do this, the daemon must be started from a root
34945 process. (Calling Exim from a root process makes it behave in the way it does
34946 when it is setuid root.) However, the daemon cannot restart itself after a
34947 SIGHUP signal because it cannot regain privilege.
34948
34949 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34950 stops Exim from trying to re-invoke itself to do a delivery after a message has
34951 been received. Such a re-invocation is a waste of resources because it has no
34952 effect.
34953
34954 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34955 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34956 to the Exim user seems a clean approach, but there is one complication:
34957
34958 In this style of operation, Exim is running with the real uid and gid set to
34959 those of the calling process, and the effective uid/gid set to Exim's values.
34960 Ideally, any association with the calling process' uid/gid should be dropped,
34961 that is, the real uid/gid should be reset to the effective values so as to
34962 discard any privileges that the caller may have. While some operating systems
34963 have a function that permits this action for a non-root effective uid, quite a
34964 number of them do not. Because of this lack of standardization, Exim does not
34965 address this problem at this time.
34966
34967 For this reason, the recommended approach for &"mostly unprivileged"& running
34968 is to keep the Exim binary setuid to root, and to set
34969 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34970 be used in the most straightforward way.
34971
34972 If you configure Exim not to run delivery processes as root, there are a
34973 number of restrictions on what you can do:
34974
34975 .ilist
34976 You can deliver only as the Exim user/group. You should  explicitly use the
34977 &%user%& and &%group%& options to override routers or local transports that
34978 normally deliver as the recipient. This makes sure that configurations that
34979 work in this mode function the same way in normal mode. Any implicit or
34980 explicit specification of another user causes an error.
34981 .next
34982 Use of &_.forward_& files is severely restricted, such that it is usually
34983 not worthwhile to include them in the configuration.
34984 .next
34985 Users who wish to use &_.forward_& would have to make their home directory and
34986 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34987 and their equivalents in Exim filters, cannot be used. While they could be
34988 enabled in the Exim user's name, that would be insecure and not very useful.
34989 .next
34990 Unless the local user mailboxes are all owned by the Exim user (possible in
34991 some POP3 or IMAP-only environments):
34992
34993 .olist
34994 They must be owned by the Exim group and be writeable by that group. This
34995 implies you must set &%mode%& in the appendfile configuration, as well as the
34996 mode of the mailbox files themselves.
34997 .next
34998 You must set &%no_check_owner%&, since most or all of the files will not be
34999 owned by the Exim user.
35000 .next
35001 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35002 on a newly created mailbox when unprivileged. This also implies that new
35003 mailboxes need to be created manually.
35004 .endlist olist
35005 .endlist ilist
35006
35007
35008 These restrictions severely restrict what can be done in local deliveries.
35009 However, there are no restrictions on remote deliveries. If you are running a
35010 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35011 gives more security at essentially no cost.
35012
35013 If you are using the &%mua_wrapper%& facility (see chapter
35014 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35015
35016
35017
35018
35019 .section "Delivering to local files" "SECID271"
35020 Full details of the checks applied by &(appendfile)& before it writes to a file
35021 are given in chapter &<<CHAPappendfile>>&.
35022
35023
35024
35025 .section "IPv4 source routing" "SECID272"
35026 .cindex "source routing" "in IP packets"
35027 .cindex "IP source routing"
35028 Many operating systems suppress IP source-routed packets in the kernel, but
35029 some cannot be made to do this, so Exim does its own check. It logs incoming
35030 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35031 IPv6. No special checking is currently done.
35032
35033
35034
35035 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35036 Support for these SMTP commands is disabled by default. If required, they can
35037 be enabled by defining suitable ACLs.
35038
35039
35040
35041
35042 .section "Privileged users" "SECID274"
35043 .cindex "trusted users"
35044 .cindex "admin user"
35045 .cindex "privileged user"
35046 .cindex "user" "trusted"
35047 .cindex "user" "admin"
35048 Exim recognizes two sets of users with special privileges. Trusted users are
35049 able to submit new messages to Exim locally, but supply their own sender
35050 addresses and information about a sending host. For other users submitting
35051 local messages, Exim sets up the sender address from the uid, and doesn't
35052 permit a remote host to be specified.
35053
35054 .oindex "&%-f%&"
35055 However, an untrusted user is permitted to use the &%-f%& command line option
35056 in the special form &%-f <>%& to indicate that a delivery failure for the
35057 message should not cause an error report. This affects the message's envelope,
35058 but it does not affect the &'Sender:'& header. Untrusted users may also be
35059 permitted to use specific forms of address with the &%-f%& option by setting
35060 the &%untrusted_set_sender%& option.
35061
35062 Trusted users are used to run processes that receive mail messages from some
35063 other mail domain and pass them on to Exim for delivery either locally, or over
35064 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35065 as any user listed in the &%trusted_users%& configuration option, or under any
35066 group listed in the &%trusted_groups%& option.
35067
35068 Admin users are permitted to do things to the messages on Exim's queue. They
35069 can freeze or thaw messages, cause them to be returned to their senders, remove
35070 them entirely, or modify them in various ways. In addition, admin users can run
35071 the Exim monitor and see all the information it is capable of providing, which
35072 includes the contents of files on the spool.
35073
35074 .oindex "&%-M%&"
35075 .oindex "&%-q%&"
35076 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35077 delivery of messages on its queue is restricted to admin users. This
35078 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35079 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35080 queue is also restricted to admin users. This restriction can be relaxed by
35081 setting &%no_queue_list_requires_admin%&.
35082
35083 Exim recognizes an admin user if the calling process is running as root or as
35084 the Exim user or if any of the groups associated with the calling process is
35085 the Exim group. It is not necessary actually to be running under the Exim
35086 group. However, if admin users who are not root or the Exim user are to access
35087 the contents of files on the spool via the Exim monitor (which runs
35088 unprivileged), Exim must be built to allow group read access to its spool
35089 files.
35090
35091
35092
35093 .section "Spool files" "SECID275"
35094 .cindex "spool directory" "files"
35095 Exim's spool directory and everything it contains is owned by the Exim user and
35096 set to the Exim group. The mode for spool files is defined in the
35097 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35098 any user who is a member of the Exim group can access these files.
35099
35100
35101
35102 .section "Use of argv[0]" "SECID276"
35103 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35104 of specific strings, Exim assumes certain options. For example, calling Exim
35105 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35106 to calling it with the option &%-bS%&. There are no security implications in
35107 this.
35108
35109
35110
35111 .section "Use of %f formatting" "SECID277"
35112 The only use made of &"%f"& by Exim is in formatting load average values. These
35113 are actually stored in integer variables as 1000 times the load average.
35114 Consequently, their range is limited and so therefore is the length of the
35115 converted output.
35116
35117
35118
35119 .section "Embedded Exim path" "SECID278"
35120 Exim uses its own path name, which is embedded in the code, only when it needs
35121 to re-exec in order to regain root privilege. Therefore, it is not root when it
35122 does so. If some bug allowed the path to get overwritten, it would lead to an
35123 arbitrary program's being run as exim, not as root.
35124
35125
35126
35127 .section "Dynamic module directory" "SECTdynmoddir"
35128 Any dynamically loadable modules must be installed into the directory
35129 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35130 loading it.
35131
35132
35133 .section "Use of sprintf()" "SECID279"
35134 .cindex "&[sprintf()]&"
35135 A large number of occurrences of &"sprintf"& in the code are actually calls to
35136 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35137 The intermediate formatting is done into a large fixed buffer by a function
35138 that runs through the format string itself, and checks the length of each
35139 conversion before performing it, thus preventing buffer overruns.
35140
35141 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35142 the output buffer is known to be sufficiently long to contain the converted
35143 string.
35144
35145
35146
35147 .section "Use of debug_printf() and log_write()" "SECID280"
35148 Arbitrary strings are passed to both these functions, but they do their
35149 formatting by calling the function &'string_vformat()'&, which runs through
35150 the format string itself, and checks the length of each conversion.
35151
35152
35153
35154 .section "Use of strcat() and strcpy()" "SECID281"
35155 These are used only in cases where the output buffer is known to be large
35156 enough to hold the result.
35157 .ecindex IIDsecurcon
35158
35159
35160
35161
35162 . ////////////////////////////////////////////////////////////////////////////
35163 . ////////////////////////////////////////////////////////////////////////////
35164
35165 .chapter "Format of spool files" "CHAPspool"
35166 .scindex IIDforspo1 "format" "spool files"
35167 .scindex IIDforspo2 "spool directory" "format of files"
35168 .scindex IIDforspo3 "spool files" "format of"
35169 .cindex "spool files" "editing"
35170 A message on Exim's queue consists of two files, whose names are the message id
35171 followed by -D and -H, respectively. The data portion of the message is kept in
35172 the -D file on its own. The message's envelope, status, and headers are all
35173 kept in the -H file, whose format is described in this chapter. Each of these
35174 two files contains the final component of its own name as its first line. This
35175 is insurance against disk crashes where the directory is lost but the files
35176 themselves are recoverable.
35177
35178 Some people are tempted into editing -D files in order to modify messages. You
35179 need to be extremely careful if you do this; it is not recommended and you are
35180 on your own if you do it. Here are some of the pitfalls:
35181
35182 .ilist
35183 You must ensure that Exim does not try to deliver the message while you are
35184 fiddling with it. The safest way is to take out a write lock on the -D file,
35185 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35186 place, the lock will be retained. If you write a new file and rename it, the
35187 lock will be lost at the instant of rename.
35188 .next
35189 .vindex "&$body_linecount$&"
35190 If you change the number of lines in the file, the value of
35191 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35192 present, this value is not used by Exim, but there is no guarantee that this
35193 will always be the case.
35194 .next
35195 If the message is in MIME format, you must take care not to break it.
35196 .next
35197 If the message is cryptographically signed, any change will invalidate the
35198 signature.
35199 .endlist
35200 All in all, modifying -D files is fraught with danger.
35201
35202 Files whose names end with -J may also be seen in the &_input_& directory (or
35203 its subdirectories when &%split_spool_directory%& is set). These are journal
35204 files, used to record addresses to which the message has been delivered during
35205 the course of a delivery attempt. If there are still undelivered recipients at
35206 the end, the -H file is updated, and the -J file is deleted. If, however, there
35207 is some kind of crash (for example, a power outage) before this happens, the -J
35208 file remains in existence. When Exim next processes the message, it notices the
35209 -J file and uses it to update the -H file before starting the next delivery
35210 attempt.
35211
35212 .section "Format of the -H file" "SECID282"
35213 .cindex "uid (user id)" "in spool file"
35214 .cindex "gid (group id)" "in spool file"
35215 The second line of the -H file contains the login name for the uid of the
35216 process that called Exim to read the message, followed by the numerical uid and
35217 gid. For a locally generated message, this is normally the user who sent the
35218 message. For a message received over TCP/IP via the daemon, it is
35219 normally the Exim user.
35220
35221 The third line of the file contains the address of the message's sender as
35222 transmitted in the envelope, contained in angle brackets. The sender address is
35223 empty for bounce messages. For incoming SMTP mail, the sender address is given
35224 in the MAIL command. For locally generated mail, the sender address is
35225 created by Exim from the login name of the current user and the configured
35226 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35227 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35228 &"<>"& or an address that matches &%untrusted_set_senders%&.
35229
35230 The fourth line contains two numbers. The first is the time that the message
35231 was received, in the conventional Unix form &-- the number of seconds since the
35232 start of the epoch. The second number is a count of the number of messages
35233 warning of delayed delivery that have been sent to the sender.
35234
35235 There follow a number of lines starting with a hyphen. These can appear in any
35236 order, and are omitted when not relevant:
35237
35238 .vlist
35239 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35240 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35241 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35242 recognized, to provide backward compatibility. In the old format, a line of
35243 this form is present for every ACL variable that is not empty. The number
35244 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35245 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35246 the data string for the variable. The string itself starts at the beginning of
35247 the next line, and is followed by a newline character. It may contain internal
35248 newlines.
35249
35250 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35251 A line of this form is present for every ACL connection variable that is
35252 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35253 The length is the length of the data string for the variable. The string itself
35254 starts at the beginning of the next line, and is followed by a newline
35255 character. It may contain internal newlines.
35256
35257 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35258 A line of this form is present for every ACL message variable that is defined.
35259 Note that there is a space between &%-aclm%& and the rest of the name. The
35260 length is the length of the data string for the variable. The string itself
35261 starts at the beginning of the next line, and is followed by a newline
35262 character. It may contain internal newlines.
35263
35264 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35265 This is present if, when the message was received over SMTP, the value of
35266 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35267
35268 .vitem &%-allow_unqualified_recipient%&
35269 This is present if unqualified recipient addresses are permitted in header
35270 lines (to stop such addresses from being qualified if rewriting occurs at
35271 transport time). Local messages that were input using &%-bnq%& and remote
35272 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35273
35274 .vitem &%-allow_unqualified_sender%&
35275 This is present if unqualified sender addresses are permitted in header lines
35276 (to stop such addresses from being qualified if rewriting occurs at transport
35277 time). Local messages that were input using &%-bnq%& and remote messages from
35278 hosts that match &%sender_unqualified_hosts%& set this flag.
35279
35280 .vitem "&%-auth_id%&&~<&'text'&>"
35281 The id information for a message received on an authenticated SMTP connection
35282 &-- the value of the &$authenticated_id$& variable.
35283
35284 .vitem "&%-auth_sender%&&~<&'address'&>"
35285 The address of an authenticated sender &-- the value of the
35286 &$authenticated_sender$& variable.
35287
35288 .vitem "&%-body_linecount%&&~<&'number'&>"
35289 This records the number of lines in the body of the message, and is always
35290 present.
35291
35292 .vitem "&%-body_zerocount%&&~<&'number'&>"
35293 This records the number of binary zero bytes in the body of the message, and is
35294 present if the number is greater than zero.
35295
35296 .vitem &%-deliver_firsttime%&
35297 This is written when a new message is first added to the spool. When the spool
35298 file is updated after a deferral, it is omitted.
35299
35300 .vitem "&%-frozen%&&~<&'time'&>"
35301 .cindex "frozen messages" "spool data"
35302 The message is frozen, and the freezing happened at <&'time'&>.
35303
35304 .vitem "&%-helo_name%&&~<&'text'&>"
35305 This records the host name as specified by a remote host in a HELO or EHLO
35306 command.
35307
35308 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35309 This records the IP address of the host from which the message was received and
35310 the remote port number that was used. It is omitted for locally generated
35311 messages.
35312
35313 .vitem "&%-host_auth%&&~<&'text'&>"
35314 If the message was received on an authenticated SMTP connection, this records
35315 the name of the authenticator &-- the value of the
35316 &$sender_host_authenticated$& variable.
35317
35318 .vitem &%-host_lookup_failed%&
35319 This is present if an attempt to look up the sending host's name from its IP
35320 address failed. It corresponds to the &$host_lookup_failed$& variable.
35321
35322 .vitem "&%-host_name%&&~<&'text'&>"
35323 .cindex "reverse DNS lookup"
35324 .cindex "DNS" "reverse lookup"
35325 This records the name of the remote host from which the message was received,
35326 if the host name was looked up from the IP address when the message was being
35327 received. It is not present if no reverse lookup was done.
35328
35329 .vitem "&%-ident%&&~<&'text'&>"
35330 For locally submitted messages, this records the login of the originating user,
35331 unless it was a trusted user and the &%-oMt%& option was used to specify an
35332 ident value. For messages received over TCP/IP, this records the ident string
35333 supplied by the remote host, if any.
35334
35335 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35336 This records the IP address of the local interface and the port number through
35337 which a message was received from a remote host. It is omitted for locally
35338 generated messages.
35339
35340 .vitem &%-local%&
35341 The message is from a local sender.
35342
35343 .vitem &%-localerror%&
35344 The message is a locally-generated bounce message.
35345
35346 .vitem "&%-local_scan%&&~<&'string'&>"
35347 This records the data string that was returned by the &[local_scan()]& function
35348 when the message was received &-- the value of the &$local_scan_data$&
35349 variable. It is omitted if no data was returned.
35350
35351 .vitem &%-manual_thaw%&
35352 The message was frozen but has been thawed manually, that is, by an explicit
35353 Exim command rather than via the auto-thaw process.
35354
35355 .vitem &%-N%&
35356 A testing delivery process was started using the &%-N%& option to suppress any
35357 actual deliveries, but delivery was deferred. At any further delivery attempts,
35358 &%-N%& is assumed.
35359
35360 .vitem &%-received_protocol%&
35361 This records the value of the &$received_protocol$& variable, which contains
35362 the name of the protocol by which the message was received.
35363
35364 .vitem &%-sender_set_untrusted%&
35365 The envelope sender of this message was set by an untrusted local caller (used
35366 to ensure that the caller is displayed in queue listings).
35367
35368 .vitem "&%-spam_score_int%&&~<&'number'&>"
35369 If a message was scanned by SpamAssassin, this is present. It records the value
35370 of &$spam_score_int$&.
35371
35372 .vitem &%-tls_certificate_verified%&
35373 A TLS certificate was received from the client that sent this message, and the
35374 certificate was verified by the server.
35375
35376 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35377 When the message was received over an encrypted connection, this records the
35378 name of the cipher suite that was used.
35379
35380 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35381 When the message was received over an encrypted connection, and a certificate
35382 was received from the client, this records the Distinguished Name from that
35383 certificate.
35384 .endlist
35385
35386 Following the options there is a list of those addresses to which the message
35387 is not to be delivered. This set of addresses is initialized from the command
35388 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35389 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35390 the address is added to this set. The addresses are kept internally as a
35391 balanced binary tree, and it is a representation of that tree which is written
35392 to the spool file. If an address is expanded via an alias or forward file, the
35393 original address is added to the tree when deliveries to all its child
35394 addresses are complete.
35395
35396 If the tree is empty, there is a single line in the spool file containing just
35397 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35398 Y or N, followed by an address. The address is the value for the node of the
35399 tree, and the letters indicate whether the node has a left branch and/or a
35400 right branch attached to it, respectively. If branches exist, they immediately
35401 follow. Here is an example of a three-node tree:
35402 .code
35403 YY darcy@austen.fict.example
35404 NN alice@wonderland.fict.example
35405 NN editor@thesaurus.ref.example
35406 .endd
35407 After the non-recipients tree, there is a list of the message's recipients.
35408 This is a simple list, preceded by a count. It includes all the original
35409 recipients of the message, including those to whom the message has already been
35410 delivered. In the simplest case, the list contains one address per line. For
35411 example:
35412 .code
35413 4
35414 editor@thesaurus.ref.example
35415 darcy@austen.fict.example
35416 rdo@foundation
35417 alice@wonderland.fict.example
35418 .endd
35419 However, when a child address has been added to the top-level addresses as a
35420 result of the use of the &%one_time%& option on a &(redirect)& router, each
35421 line is of the following form:
35422 .display
35423 <&'top-level address'&> <&'errors_to address'&> &&&
35424   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35425 .endd
35426 The 01 flag bit indicates the presence of the three other fields that follow
35427 the top-level address. Other bits may be used in future to support additional
35428 fields. The <&'parent number'&> is the offset in the recipients list of the
35429 original parent of the &"one time"& address. The first two fields are the
35430 envelope sender that is associated with this address and its length. If the
35431 length is zero, there is no special envelope sender (there are then two space
35432 characters in the line). A non-empty field can arise from a &(redirect)& router
35433 that has an &%errors_to%& setting.
35434
35435
35436 A blank line separates the envelope and status information from the headers
35437 which follow. A header may occupy several lines of the file, and to save effort
35438 when reading it in, each header is preceded by a number and an identifying
35439 character. The number is the number of characters in the header, including any
35440 embedded newlines and the terminating newline. The character is one of the
35441 following:
35442
35443 .table2 50pt
35444 .row <&'blank'&>         "header in which Exim has no special interest"
35445 .row &`B`&               "&'Bcc:'& header"
35446 .row &`C`&               "&'Cc:'& header"
35447 .row &`F`&               "&'From:'& header"
35448 .row &`I`&               "&'Message-id:'& header"
35449 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35450 .row &`R`&               "&'Reply-To:'& header"
35451 .row &`S`&               "&'Sender:'& header"
35452 .row &`T`&               "&'To:'& header"
35453 .row &`*`&               "replaced or deleted header"
35454 .endtable
35455
35456 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35457 purposes. They are not transmitted when the message is delivered. Here is a
35458 typical set of headers:
35459 .code
35460 111P Received: by hobbit.fict.example with local (Exim 4.00)
35461 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35462 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35463 038* X-rewrote-sender: bb@hobbit.fict.example
35464 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35465 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35466 099* To: alice@wonderland.fict.example, rdo@foundation,
35467 darcy@austen.fict.example, editor@thesaurus.ref.example
35468 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35469 darcy@austen.fict.example, editor@thesaurus.ref.example
35470 038  Date: Fri, 11 May 2001 10:28:59 +0100
35471 .endd
35472 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35473 &'To:'& header have been rewritten, the last one because routing expanded the
35474 unqualified domain &'foundation'&.
35475 .ecindex IIDforspo1
35476 .ecindex IIDforspo2
35477 .ecindex IIDforspo3
35478
35479 . ////////////////////////////////////////////////////////////////////////////
35480 . ////////////////////////////////////////////////////////////////////////////
35481
35482 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35483          "DKIM Support"
35484 .cindex "DKIM"
35485
35486 DKIM is a mechanism by which messages sent by some entity can be provably
35487 linked to a domain which that entity controls.  It permits reputation to
35488 be tracked on a per-domain basis, rather than merely upon source IP address.
35489 DKIM is documented in RFC 4871.
35490
35491 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35492 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35493
35494 Exim's DKIM implementation allows to
35495 .olist
35496 Sign outgoing messages: This function is implemented in the SMTP transport.
35497 It can co-exist with all other Exim features, including transport filters.
35498 .next
35499 Verify signatures in incoming messages: This is implemented by an additional
35500 ACL (acl_smtp_dkim), which can be called several times per message, with
35501 different signature contexts.
35502 .endlist
35503
35504 In typical Exim style, the verification implementation does not include any
35505 default "policy". Instead it enables you to build your own policy using
35506 Exim's standard controls.
35507
35508 Please note that verification of DKIM signatures in incoming mail is turned
35509 on by default for logging purposes. For each signature in incoming email,
35510 exim will log a line displaying the most important signature details, and the
35511 signature status. Here is an example (with line-breaks added for clarity):
35512 .code
35513 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35514     d=facebookmail.com s=q1-2009b
35515     c=relaxed/relaxed a=rsa-sha1
35516     i=@facebookmail.com t=1252484542 [verification succeeded]
35517 .endd
35518 You might want to turn off DKIM verification processing entirely for internal
35519 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35520 control modifier. This should typically be done in the RCPT ACL, at points
35521 where you accept mail from relay sources (internal hosts or authenticated
35522 senders).
35523
35524
35525 .section "Signing outgoing messages" "SECID513"
35526 .cindex "DKIM" "signing"
35527
35528 Signing is implemented by setting private options on the SMTP transport.
35529 These options take (expandable) strings as arguments.
35530
35531 .option dkim_domain smtp string&!! unset
35532 MANDATORY:
35533 The domain you want to sign with. The result of this expanded
35534 option is put into the &%$dkim_domain%& expansion variable.
35535
35536 .option dkim_selector smtp string&!! unset
35537 MANDATORY:
35538 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35539 variable to look up a matching selector. The result is put in the expansion
35540 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35541 option along with &%$dkim_domain%&.
35542
35543 .option dkim_private_key smtp string&!! unset
35544 MANDATORY:
35545 This sets the private key to use. You can use the &%$dkim_domain%& and
35546 &%$dkim_selector%& expansion variables to determine the private key to use.
35547 The result can either
35548 .ilist
35549 be a valid RSA private key in ASCII armor, including line breaks.
35550 .next
35551 start with a slash, in which case it is treated as a file that contains
35552 the private key.
35553 .next
35554 be "0", "false" or the empty string, in which case the message will not
35555 be signed. This case will not result in an error, even if &%dkim_strict%&
35556 is set.
35557 .endlist
35558
35559 .option dkim_canon smtp string&!! unset
35560 OPTIONAL:
35561 This option sets the canonicalization method used when signing a message.
35562 The DKIM RFC currently supports two methods: "simple" and "relaxed".
35563 The option defaults to "relaxed" when unset. Note: the current implementation
35564 only supports using the same canonicalization method for both headers and body.
35565
35566 .option dkim_strict smtp string&!! unset
35567 OPTIONAL:
35568 This  option  defines  how  Exim  behaves  when  signing a message that
35569 should be signed fails for some reason.  When the expansion evaluates to
35570 either "1" or "true", Exim will defer. Otherwise Exim will send the message
35571 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
35572 variables here.
35573
35574 .option dkim_sign_headers smtp string&!! unset
35575 OPTIONAL:
35576 When set, this option must expand to (or be specified as) a colon-separated
35577 list of header names. Headers with these names will be included in the message
35578 signature. When unspecified, the header names recommended in RFC4871 will be
35579 used.
35580
35581
35582 .section "Verifying DKIM signatures in incoming mail" "SECID514"
35583 .cindex "DKIM" "verification"
35584
35585 Verification of DKIM signatures in incoming email is implemented via the
35586 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
35587 syntactically(!) correct signature in the incoming message.
35588
35589 To evaluate the signature in the ACL a large number of expansion variables
35590 containing the signature status and its details are set up during the
35591 runtime of the ACL.
35592
35593 Calling the ACL only for existing signatures is not sufficient to build
35594 more advanced policies. For that reason, the global option
35595 &%dkim_verify_signers%&, and a global expansion variable
35596 &%$dkim_signers%& exist.
35597
35598 The global option &%dkim_verify_signers%& can be set to a colon-separated
35599 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
35600 called. It is expanded when the message has been received. At this point,
35601 the expansion variable &%$dkim_signers%& already contains a colon-separated
35602 list of signer domains and identities for the message. When
35603 &%dkim_verify_signers%& is not specified in the main configuration,
35604 it defaults as:
35605 .code
35606 dkim_verify_signers = $dkim_signers
35607 .endd
35608 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
35609 DKIM signature in the message. Current DKIM verifiers may want to explicitly
35610 call the ACL for known domains or identities. This would be achieved as follows:
35611 .code
35612 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
35613 .endd
35614 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
35615 and "ebay.com", plus all domains and identities that have signatures in the message.
35616 You can also be more creative in constructing your policy. For example:
35617 .code
35618 dkim_verify_signers = $sender_address_domain:$dkim_signers
35619 .endd
35620
35621 If a domain or identity is listed several times in the (expanded) value of
35622 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
35623
35624
35625 Inside the &%acl_smtp_dkim%&, the following expansion variables are
35626 available (from most to least important):
35627
35628
35629 .vlist
35630 .vitem &%$dkim_cur_signer%&
35631 The signer that is being evaluated in this ACL run. This can be a domain or
35632 an identity. This is one of the list items from the expanded main option
35633 &%dkim_verify_signers%& (see above).
35634 .vitem &%$dkim_verify_status%&
35635 A string describing the general status of the signature. One of
35636 .ilist
35637 &%none%&: There is no signature in the message for the current domain or
35638 identity (as reflected by &%$dkim_cur_signer%&).
35639 .next
35640 &%invalid%&: The signature could not be verified due to a processing error.
35641 More detail is available in &%$dkim_verify_reason%&.
35642 .next
35643 &%fail%&: Verification of the signature failed.  More detail is
35644 available in &%$dkim_verify_reason%&.
35645 .next
35646 &%pass%&: The signature passed verification. It is valid.
35647 .endlist
35648 .vitem &%$dkim_verify_reason%&
35649 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
35650 "fail" or "invalid". One of
35651 .ilist
35652 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
35653 key for the domain could not be retrieved. This may be a temporary problem.
35654 .next
35655 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
35656 record for the domain is syntactically invalid.
35657 .next
35658 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
35659 body hash does not match the one specified in the signature header. This
35660 means that the message body was modified in transit.
35661 .next
35662 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
35663 could not be verified. This may mean that headers were modified,
35664 re-written or otherwise changed in a way which is incompatible with
35665 DKIM verification. It may of course also mean that the signature is forged.
35666 .endlist
35667 .vitem &%$dkim_domain%&
35668 The signing domain. IMPORTANT: This variable is only populated if there is
35669 an actual signature in the message for the current domain or identity (as
35670 reflected by &%$dkim_cur_signer%&).
35671 .vitem &%$dkim_identity%&
35672 The signing identity, if present. IMPORTANT: This variable is only populated
35673 if there is an actual signature in the message for the current domain or
35674 identity (as reflected by &%$dkim_cur_signer%&).
35675 .vitem &%$dkim_selector%&
35676 The key record selector string.
35677 .vitem &%$dkim_algo%&
35678 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
35679 .vitem &%$dkim_canon_body%&
35680 The body canonicalization method. One of 'relaxed' or 'simple'.
35681 .vitem &%dkim_canon_headers%&
35682 The header canonicalization method. One of 'relaxed' or 'simple'.
35683 .vitem &%$dkim_copiedheaders%&
35684 A transcript of headers and their values which are included in the signature
35685 (copied from the 'z=' tag of the signature).
35686 .vitem &%$dkim_bodylength%&
35687 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
35688 limit was set by the signer, "9999999999999" is returned. This makes sure
35689 that this variable always expands to an integer value.
35690 .vitem &%$dkim_created%&
35691 UNIX timestamp reflecting the date and time when the signature was created.
35692 When this was not specified by the signer, "0" is returned.
35693 .vitem &%$dkim_expires%&
35694 UNIX timestamp reflecting the date and time when the signer wants the
35695 signature to be treated as "expired". When this was not specified by the
35696 signer, "9999999999999" is returned. This makes it possible to do useful
35697 integer size comparisons against this value.
35698 .vitem &%$dkim_headernames%&
35699 A colon-separated list of names of headers included in the signature.
35700 .vitem &%$dkim_key_testing%&
35701 "1" if the key record has the "testing" flag set, "0" if not.
35702 .vitem &%$nosubdomains%&
35703 "1" if the key record forbids subdomaining, "0" otherwise.
35704 .vitem &%$dkim_key_srvtype%&
35705 Service type (tag s=) from the key record. Defaults to "*" if not specified
35706 in the key record.
35707 .vitem &%$dkim_key_granularity%&
35708 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
35709 in the key record.
35710 .vitem &%$dkim_key_notes%&
35711 Notes from the key record (tag n=).
35712 .endlist
35713
35714 In addition, two ACL conditions are provided:
35715
35716 .vlist
35717 .vitem &%dkim_signers%&
35718 ACL condition that checks a colon-separated list of domains or identities
35719 for a match against the domain or identity that the ACL is currently verifying
35720 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
35721 verb to a group of domains or identities. For example:
35722
35723 .code
35724 # Warn when Mail purportedly from GMail has no signature at all
35725 warn log_message = GMail sender without DKIM signature
35726      sender_domains = gmail.com
35727      dkim_signers = gmail.com
35728      dkim_status = none
35729 .endd
35730
35731 .vitem &%dkim_status%&
35732 ACL condition that checks a colon-separated list of possible DKIM verification
35733 results agains the actual result of verification. This is typically used
35734 to restrict an ACL verb to a list of verification outcomes, for example:
35735
35736 .code
35737 deny message = Mail from Paypal with invalid/missing signature
35738      sender_domains = paypal.com:paypal.de
35739      dkim_signers = paypal.com:paypal.de
35740      dkim_status = none:invalid:fail
35741 .endd
35742
35743 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
35744 see the documentation of the &%$dkim_verify_status%& expansion variable above
35745 for more information of what they mean.
35746 .endlist
35747
35748 . ////////////////////////////////////////////////////////////////////////////
35749 . ////////////////////////////////////////////////////////////////////////////
35750
35751 .chapter "Adding new drivers or lookup types" "CHID13" &&&
35752          "Adding drivers or lookups"
35753 .cindex "adding drivers"
35754 .cindex "new drivers, adding"
35755 .cindex "drivers" "adding new"
35756 The following actions have to be taken in order to add a new router, transport,
35757 authenticator, or lookup type to Exim:
35758
35759 .olist
35760 Choose a name for the driver or lookup type that does not conflict with any
35761 existing name; I will use &"newdriver"& in what follows.
35762 .next
35763 Add to &_src/EDITME_& the line:
35764 .display
35765 <&'type'&>&`_NEWDRIVER=yes`&
35766 .endd
35767 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35768 code is not to be included in the binary by default, comment this line out. You
35769 should also add any relevant comments about the driver or lookup type.
35770 .next
35771 Add to &_src/config.h.defaults_& the line:
35772 .code
35773 #define <type>_NEWDRIVER
35774 .endd
35775 .next
35776 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35777 and create a table entry as is done for all the other drivers and lookup types.
35778 .next
35779 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35780 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35781 driver or lookup type and add it to the definition of OBJ.
35782 .next
35783 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35784 &_src_&.
35785 .next
35786 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35787 as for other drivers and lookups.
35788 .endlist
35789
35790 Then all you need to do is write the code! A good way to start is to make a
35791 proforma by copying an existing module of the same type, globally changing all
35792 occurrences of the name, and cutting out most of the code. Note that any
35793 options you create must be listed in alphabetical order, because the tables are
35794 searched using a binary chop procedure.
35795
35796 There is a &_README_& file in each of the sub-directories of &_src_& describing
35797 the interface that is expected.
35798
35799
35800
35801
35802 . ////////////////////////////////////////////////////////////////////////////
35803 . ////////////////////////////////////////////////////////////////////////////
35804
35805 . /////////////////////////////////////////////////////////////////////////////
35806 . These lines are processing instructions for the Simple DocBook Processor that
35807 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35808 . PDFs than using xmlto and fop. They will be ignored by all other XML
35809 . processors.
35810 . /////////////////////////////////////////////////////////////////////////////
35811
35812 .literal xml
35813 <?sdop
35814   format="newpage"
35815   foot_right_recto="&chaptertitle;"
35816   foot_right_verso="&chaptertitle;"
35817 ?>
35818 .literal off
35819
35820 .makeindex "Options index"   "option"
35821 .makeindex "Variables index" "variable"
35822 .makeindex "Concept index"   "concept"
35823
35824
35825 . /////////////////////////////////////////////////////////////////////////////
35826 . /////////////////////////////////////////////////////////////////////////////