Add recognition of SMTP error codes in bespoke messages.
[exim.git] / src / README.UPDATING
1 $Cambridge: exim/src/README.UPDATING,v 1.12 2006/07/13 13:53:33 ph10 Exp $
2
3 This document contains detailed information about incompatibilities that might
4 be encountered when upgrading from one release of Exim to another. The
5 information is in reverse order of release numbers. Mostly these are relatively
6 small points, and the configuration file is normally upwards compatible, but
7 there have been two big upheavals...
8
9
10 **************************************************************************
11 * There was a big reworking of the way mail routing works for release    *
12 * 4.00. Previously used "directors" were abolished, and all routing is   *
13 * now done by routers. Policy controls for incoming mail are now done by *
14 * Access Control Lists instead of separate options. All this means that  *
15 * pre-4.00 configuration files have to be massively converted. If you    *
16 * are coming from a 3.xx release, please read the document in the file   *
17 * doc/Exim4.upgrade, and allow some time to complete the upgrade.        *
18 *                                                                        *
19 * There was a big reworking of the way domain/host/net/address lists are *
20 * handled at release 3.00. If you are coming from a pre-3.00 release, it *
21 * might be easier to start again from a default configuration. Otherwise *
22 * you need to read doc/Exim3.upgrade and do a double conversion of your  *
23 * configuration file.                                                    *
24 **************************************************************************
25
26
27 The rest of this document contains information about changes in 4.xx releases
28 that might affect a running system.
29
30
31 Exim version 4.63
32 -----------------
33
34 When an SMTP error message is specified in a "message" modifier in an ACL, or
35 in a :fail: or :defer: message in a redirect router, Exim now checks the start
36 of the message for an SMTP error code. This consists of three digits followed
37 by a space, optionally followed by an extended code of the form n.n.n, also
38 followed by a space. If this is the case and the very first digit is the same
39 as the default error code, the code from the message is used instead. If the
40 very first digit is incorrect, a panic error is logged, and the default code is
41 used. This is an incompatible change, but it is not expected to affect many (if
42 any) configurations. It is possible to suppress the use of the supplied code in
43 a redirect router by setting the smtp_error_code option false. In this case,
44 any SMTP code is quietly ignored.
45
46
47 Exim version 4.61
48 -----------------
49
50 1. The default number of ACL variables of each type has been increased to 20,
51 and it's possible to compile Exim with more. You can safely upgrade to this
52 release if you already have messages on the queue with saved ACL variable
53 values. However, if you downgrade from this release with messages on the queue,
54 any saved ACL values they may have will be lost.
55
56 2. The default value for rfc1413_query_timeout has been changed from 30s to 5s.
57
58
59 Exim version 4.54
60 -----------------
61
62 There was a problem with 4.52/TF/02 in that a "name=" option on control=
63 submission terminated at the next slash, thereby not allowing for slashes in
64 the name. This has been changed so that "name=" takes the rest of the string as
65 its data. It must therefore be the last option.
66
67
68 Version 4.53
69 ------------
70
71 If you are using the experimental Domain Keys support, you must upgrade to
72 at least libdomainkeys 0.67 in order to run this release of Exim.
73
74
75 Version 4.51
76 ------------
77
78 1. The format in which GnuTLS parameters are cached (in the file gnutls-params
79 in the spool directory) has been changed. The new format can also be generated
80 externally, so it is now possible to update the values from outside Exim. This
81 has been implemented in an upwards, BUT NOT downwards, compatible manner.
82 Upgrading should be seamless: when Exim finds that it cannot understand an
83 existing cache file, it generates new parameters and writes them to the cache
84 in the new format. If, however, you downgrade from 4.51 to a previous release,
85 you MUST delete the gnutls-params file in the spool directory, because the
86 older Exim will not recognize the new format.
87
88 2. When doing a callout as part of verifying an address, Exim was not paying
89 attention to any local part prefix or suffix that was matched by the router
90 that accepted the address. It now behaves in the same way as it does for
91 delivery: the affixes are removed from the local part unless
92 rcpt_include_affixes is set on the transport. If you have a configuration that
93 uses prefixes or suffixes on addresses that could be used for callouts, and you
94 want the affixes to be retained, you must make sure that rcpt_include_affixes
95 is set on the transport.
96
97 3. Bounce and delay warning messages no longer contain details of delivery
98 errors, except for explicit messages (e.g. generated by :fail:) and SMTP
99 responses from remote hosts.
100
101
102 Version 4.50
103 ------------
104
105 The exicyclog script has been updated to use three-digit numbers in rotated log
106 files if the maximum number to keep is greater than 99. If you are already
107 keeping more than 99, there will be an incompatible change when you upgrade.
108 You will probably want to rename your old log files to the new form before
109 running the new exicyclog.
110
111
112 Version 4.42
113 ------------
114
115 RFC 3848 specifies standard names for the "with" phrase in Received: header
116 lines when AUTH and/or TLS are in use. This is the "received protocol"
117 field. Exim used to use "asmtp" for authenticated SMTP, without any
118 indication (in the protocol name) for TLS use. Now it follows the RFC and
119 uses "esmtpa" if the connection is authenticated, "esmtps" if it is
120 encrypted, and "esmtpsa" if it is both encrypted and authenticated. These names
121 appear in log lines as well as in Received: header lines.
122
123
124 Version 4.34
125 ------------
126
127 Change 4.31/2 gave problems to data ACLs and local_scan() functions that
128 expected to see a Received: header. I have changed to yet another scheme. The
129 Received: header is now generated after the body is received, but before the
130 ACL or local_scan() is called. After they have run, the timestamp in the
131 Received: header is updated.
132
133 Thus, change (a) of 4.31/2 has been reversed, but change (b) is still true,
134 which is lucky, since I decided it was a bug fix.
135
136
137 Version 4.33
138 ------------
139
140 If an expansion in a condition on a "warn" statement fails because a lookup
141 defers, the "warn" statement is abandoned, and the next ACL statement is
142 processed. Previously this caused the whole ACL to be aborted.
143
144
145 Version 4.32
146 ------------
147
148 Change 4.31/2 has been reversed, as it proved contentious. Recipient callout
149 verification now uses <> in the MAIL command by default, as it did before. A
150 new callout option, "use_sender", has been added to request the other
151 behaviour.
152
153
154 Version 4.31
155 ------------
156
157 1. If you compile Exim to use GnuTLS, it now requires the use of release 1.0.0
158    or greater. The interface to the obsolete 0.8.x releases is no longer
159    supported. There is one externally visible change: the format for the
160    display of Distinguished Names now uses commas as a separator rather than a
161    slash. This is to comply with RFC 2253.
162
163 2. When a message is received, the Received: header line is now generated when
164    reception is complete, instead of at the start of reception. For messages
165    that take a long time to come in, this changes the meaning of the timestamp.
166    There are several side-effects of this change:
167
168     (a) If a message is rejected by a DATA or non-SMTP ACL, or by local_scan(),
169         the logged header lines no longer include the local Received: line,
170         because it has not yet been created. If the message is a non-SMTP one,
171         and the error is processed by sending a message to the sender, the copy
172         of the original message that is returned does not have an added
173         Received: line.
174
175     (b) When a filter file is tested using -bf, no additional Received: header
176         is added to the test message. After some thought, I decided that this
177         is a bug fix.
178
179     The contents of $received_for are not affected by this change. This
180     variable still contains the single recipient of a message, copied after
181     addresses have been rewritten, but before local_scan() is run.
182
183 2. Recipient callout verification, like sender verification, was using <> in
184    the MAIL FROM command. This isn't really the right thing, since the actual
185    sender may affect whether the remote host accepts the recipient or not. I
186    have changed it to use the actual sender in the callout; this means that
187    the cache record is now keyed on a recipient/sender pair, not just the
188    recipient address. There doesn't seem to be a real danger of callout loops,
189    since a callout by the remote host to check the sender would use <>.
190
191
192 Version 4.30
193 ------------
194
195 1. I have abolished timeout_DNS as an error that can be detected in retry
196    rules, because it has never worked. Despite the fact that it has been
197    documented since at least release 1.62, there was no code to support it.
198    If you have used it in your retry rules, you will now get a warning message
199    to the log and panic log. It is now treated as plain "timeout".
200
201 2. After discussion on the mailing list, Exim no longer adds From:, Date:, or
202    Message-Id: header lines to messages that do not originate locally, that is,
203    messages that have an associated sending host address.
204
205 3. When looking up a host name from an IP address, Exim now tries the DNS
206    first, and only if that fails does it use gethostbyaddr() (or equivalent).
207    This change was made because on some OS, not all the names are given for
208    addresses with multiple PTR records via the gethostbyaddr() interface. The
209    order of lookup can be changed by setting host_lookup_order.
210
211
212 Version 4.23
213 ------------
214
215 1. The new FIXED_NEVER_USERS build-time option creates a list of "never users"
216    that cannot be overridden. The default in the distributed EDITME is "root".
217    If for some reason you were (against advice) running deliveries as root, you
218    will have to ensure that FIXED_NEVER_USERS is not set in your
219    Local/Makefile.
220
221 2. The ${quote: operator now quotes an empty string, which it did not before.
222
223 3. Version 4.23 saves the contents of the ACL variables with the message, so
224    that they can be used later. If one of these variables contains a newline,
225    there will be a newline character in the spool that will not be interpreted
226    correctely by a previous version of Exim. (Exim ignores keyed spool file
227    items that it doesn't understand - precisely for this kind of problem - but
228    it expects them all to be on one line.)
229
230    So the bottom line is: if you have newlines in your ACL variables, you
231    cannot retreat from 4.23.
232
233
234 Version 4.21
235 ------------
236
237 1. The idea of the "warn" ACL verb is that it adds a header or writes to the
238    log only when "message" or "log_message" are set. However, if one of the
239    conditions was an address verification, or a call to a nested ACL, the
240    messages generated by the underlying test were being passed through. This
241    no longer happens. The underlying message is available in $acl_verify_
242    message for both "message" and "log_message" expansions, so it can be
243    passed through if needed.
244
245 2. The way that the $h_ (and $header_) expansions work has been changed by the
246    addition of RFC 2047 decoding. See the main documentation (the NewStuff file
247    until release 4.30, then the manual) for full details. Briefly, there are
248    now three forms:
249
250      $rh_xxx: and $rheader_xxx: give the original content of the header
251        line(s), with no processing at all.
252
253      $bh_xxx: and $bheader_xxx: remove leading and trailing white space, and
254        then decode base64 or quoted-printable "words" within the header text,
255        but do not do charset translation.
256
257      $h_xxx: and $header_xxx: attempt to translate the $bh_ string to a
258        standard character set.
259
260    If you have previously been using $h_ expansions to access the raw
261    characters, you should change to $rh_ instead.
262
263 3. When Exim creates an RFC 2047 encoded word in a header line, it labels it
264    with the default character set from the headers_charset option instead of
265    always using iso-8859-1.
266
267 4. If TMPDIR is defined in Local/Makefile (default in src/EDITME is
268    TMPDIR="/tmp"), Exim checks for the presence of an environment variable
269    called TMPDIR, and if it finds it is different, it changes its value.
270
271 5. Following a discussion on the list, the rules by which Exim recognises line
272    endings on incoming messages have been changed. The -dropcr and drop_cr
273    options are now no-ops, retained only for backwards compatibility. The
274    following line terminators are recognized: LF CRLF CR. However, special
275    processing applies to CR:
276
277    (i)  The sequence CR . CR does *not* terminate an incoming SMTP message,
278         nor a local message in the state where . is a terminator.
279
280    (ii) If a bare CR is encountered in a header line, an extra space is added
281         after the line terminator so as not to end the header. The reasoning
282         behind this is that bare CRs in header lines are most likely either
283         to be mistakes, or people trying to play silly games.
284
285 6. The code for using daemon_smtp_port, local_interfaces, and the -oX options
286    has been reorganized. It is supposed to be backwards compatible, but it is
287    mentioned here just in case I've screwed up.
288
289
290
291 Version 4.20
292 ------------
293
294 1. I have tidied and re-organized the code that uses alarm() for imposing time
295    limits on various things. It shouldn't affect anything, but if you notice
296    processes getting stuck, it may be that I've broken something.
297
298 2. The "arguments" log selector now also logs the current working directory
299    when Exim is called.
300
301 3. An incompatible change has been made to the appendfile transport. This
302    affects the case when it is used for file deliveries that are set up by
303    .forward and filter files. Previously, any settings of the "file" or
304    "directory" options were ignored. It is hoped that, like the address_file
305    transport in the default configuration, these options were never in fact set
306    on such transports, because they were of no use.
307
308    Now, if either of these options is set, it is used. The path that is passed
309    by the router is in $address_file (this is not new), so it can be used as
310    part of a longer path, or modified in any other way that expansion permits.
311
312    If neither "file" nor "directory" is set, the behaviour is unchanged.
313
314 4. Related to the above: in a filter, if a "save" command specifies a non-
315    absolute path, the value of $home/ is pre-pended. This no longer happens if
316    $home is unset or is set to an empty string.
317
318 5. Multiple file deliveries from a filter or .forward file can never be
319    batched; the value of batch_max on the transport is ignored for file
320    deliveries. I'm assuming that nobody ever actually set batch_max on the
321    address_file transport - it would have had odd effects previously.
322
323 6. DESTDIR is the more common variable that ROOT for use when installing
324    software under a different root filing system. The Exim install script now
325    recognizes DESTDIR first; if it is not set, ROOT is used.
326
327 7. If DESTDIR is set when installing Exim, it no longer prepends its value to
328    the path of the system aliases file that appears in the default
329    configuration (when a default configuration is installed). If an aliases
330    file is actually created, its name *does* use the prefix.
331
332
333 Version 4.14
334 ------------
335
336 1. The default for the maximum number of unknown SMTP commands that Exim will
337 accept before dropping a connection has been reduced from 5 to 3. However, you
338 can now change the value by setting smtp_max_unknown_commands.
339
340 2. The ${quote: operator has been changed so that it turns newline and carriage
341 return characters into \n and \r, respectively.
342
343 3. The file names used for maildir messages now include the microsecond time
344 fraction as well as the time in seconds, to cope with systems where the process
345 id can be re-used within the same second. The format is now
346
347   <time>.H<microsec>P<pid>.<host>
348
349 This should be a compatible change, but is noted here just in case.
350
351 4. The rules for creating message ids have changed, to cope with systems where
352 the process id can be re-used within the same second. The format, however, is
353 unchanged, so this should not cause any problems, except as noted in the next
354 item.
355
356 5. The maximum value for localhost_number has been reduced from 255 to 16, in
357 order to implement the new message id rules. For operating systems that have
358 case-insensitive file systems (Cygwin and Darwin), the limit is 10.
359
360 6. verify = header_syntax was allowing unqualified addresses in all cases. Now
361 it allows them only for locally generated messages and from hosts that match
362 sender_unqualified_hosts or recipient_unqualified_hosts, respectively.
363
364 7. For reasons lost in the mists of time, when a pipe transport was run, the
365 environment variable MESSAGE_ID was set to the message ID preceded by 'E' (the
366 form used in Message-ID: header lines). The 'E' has been removed.
367
368
369 Version 4.11
370 ------------
371
372 1. The handling of lines in the configuration file has changed. Previously,
373 macro expansion was applied to logical lines, after continuations had been
374 joined on. This meant that it could not be used in .include lines, which are
375 handled as physical rather than logical lines. Macro expansion is now done on
376 physical lines rather than logical lines. This means there are two
377 incompatibilities:
378
379   (a) A macro that expands to # to turn a line into a comment now applies only
380       to the physical line where it appears. Previously, it would have caused
381       any following continuations also to be ignored.
382
383   (b) A macro name can no longer be split over the boundary between a line and
384       its continuation. Actually, this is more of a bug fix. :-)
385
386 2. The -D command line option must now all be within one command line item.
387 This makes it possible to use -D to set a macro to the empty string by commands
388 such as
389
390   exim -DABC  ...
391   exim -DABC= ...
392
393 Previously, these items would have moved on to the next item on the command
394 line. To include spaces in a macro definition item, quotes must be used, in
395 which case you can also have spaces after -D and surrounding the equals. For
396 example:
397
398   exim '-D ABC = something' ...
399
400 3. The way that addresses that redirect to themselves are handled has been
401 changed, in order to fix an obscure bug. This should not cause any problems
402 except in the case of wanting to go back from a 4.11 (or later) release to an
403 earlier release. If there are undelivered messages on the spool that contain
404 addresses which redirect to themselves, and the redirected addresses have
405 already been delivered, you might get a duplicate delivery if you revert to an
406 earlier Exim.
407
408 4. The default way of looking up IP addresses for hosts in the manualroute and
409 queryprogram routers has been changed. If "byname" or "bydns" is explicitly
410 specified, there is no change, but if no method is specified, Exim now behaves
411 as follows:
412
413   First, a DNS lookup is done. If this yields anything other than
414   HOST_NOT_FOUND, that result is used. Otherwise, Exim goes on to try a call to
415   getipnodebyname() (or gethostbyname() on older systems) and the result of the
416   lookup is the result of that call.
417
418 This change has been made because it has been discovered that on some systems,
419 if a DNS lookup called via getipnodebyname() times out, HOST_NOT_FOUND is
420 returned instead of TRY_AGAIN. Thus, it is safest to try a DNS lookup directly
421 first, and only if that gives a definite "no such host" to try the local
422 function.
423
424 5. In fixing the minor security problem with pid_file_path, I have removed some
425 backwards-compatible (undocumented) code which was present to ease conversion
426 from Exim 3. In Exim 4, pid_file_path is a literal; in Exim 3 it was allowed to
427 contain "%s", which was replaced by the port number for daemons listening on
428 non-standard ports. In Exim 4, such daemons do not write a pid file. The
429 backwards compatibility feature was to replace "%s" by nothing if it occurred
430 in an Exim 4 setting of pid_file_path. The bug was in this code. I have solved
431 the problem by removing the backwards compatibility feature. Thus, if you still
432 have "%s" somewhere in a setting of pid_file_path, you should remove it.
433
434 6. There has been an extension to lsearch files. The keys in these files may
435 now be quoted in order to allow for whitespace and colons in them. This means
436 that if you were previously using keys that began with a doublequote, you will
437 now have to wrap them with extra quotes and escape the internal quotes. The
438 possibility that anybody is actually doing this seems extremely remote, but it
439 is documented just in case.
440
441
442 Version 4.10
443 ------------
444
445 The build-time parameter EXIWHAT_KILL_ARG has been renamed EXIWHAT_KILL_SIGNAL
446 to better reflect its function. The OS-specific files have been updated. Only
447 if you have explicitly set this in your Makefile (highly unlikely) do you need
448 to change anything.
449
450 ****