X-Git-Url: https://git.exim.org/users/jgh/exim.git/blobdiff_plain/8d909960c69378a54d9493586d74ba361948bf49..d76bbff79fc5b1d9bf0e3cf9130f87b5632f7497:/doc/doc-docbook/spec.xfpt diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 128ee8004..c9f841ad0 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -464,7 +464,7 @@ which contains what used to be a separate FAQ, as well as various other examples, tips, and know-how that have been contributed by Exim users. .cindex Bugzilla -An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use +An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use this to report bugs, and also to add items to the wish list. Please search first to check that you are not duplicating a previous entry. @@ -493,18 +493,11 @@ via this web page: Please ask Debian-specific questions on this list and not on the general Exim lists. -.section "Exim training" "SECID4" -.cindex "training courses" -Training courses in Cambridge (UK) used to be run annually by the author of -Exim, before he retired. At the time of writing, there are no plans to run -further Exim courses in Cambridge. However, if that changes, relevant -information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/). - .section "Bug reports" "SECID5" .cindex "bug reports" .cindex "reporting bugs" Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported -via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure +via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure whether some behaviour is a bug or not, the best thing to do is to post a message to the &'exim-dev'& mailing list and have it discussed. @@ -515,10 +508,6 @@ message to the &'exim-dev'& mailing list and have it discussed. .cindex "distribution" "ftp site" The master ftp site for the Exim distribution is .display -&*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*& -.endd -This is mirrored by -.display &*ftp://ftp.exim.org/pub/exim*& .endd The file references that follow are relative to the &_exim_& directories at @@ -3869,12 +3858,12 @@ by Exim in conjunction with the &%-MC%& option, and passes on the fact that the host to which Exim is connected supports TLS encryption. .new -.vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&> +.vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&> .oindex "&%-MCt%&" This option is not intended for use by external callers. It is used internally by Exim in conjunction with the &%-MC%& option, and passes on the fact that the connection is being proxied by a parent process for handling TLS encryption. -The pair of arguments give the local address and port being proxied. +The arguments give the local address and port being proxied, and the TLS cipher. .wen .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~... @@ -15690,7 +15679,7 @@ harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)& transport driver. -.option openssl_options main "string list" "+no_sslv2 +single_dh_use" +.option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket" .cindex "OpenSSL "compatibility options" This option allows an administrator to adjust the SSL options applied by OpenSSL to connections. It is given as a space-separated list of items, @@ -23700,7 +23689,7 @@ the message. As a result, the overall timeout for a message depends on the size of the message. Its value must not be zero. See also &%final_timeout%&. -.option dkim_domain smtp string&!! unset +.option dkim_domain smtp string list&!! unset .option dkim_selector smtp string&!! unset .option dkim_private_key smtp string&!! unset .option dkim_canon smtp string&!! unset @@ -29013,12 +29002,14 @@ sender when the destination system is doing content-scan based rejection. .cindex "&ACL;" "enabling debug logging" .cindex "debugging" "enabling from an ACL" This control turns on debug logging, almost as though Exim had been invoked -with &`-d`&, with the output going to a new logfile, by default called -&'debuglog'&. The filename can be adjusted with the &'tag'& option, which +with &`-d`&, with the output going to a new logfile in the usual logs directory, +by default called &'debuglog'&. +The filename can be adjusted with the &'tag'& option, which may access any variables already defined. The logging may be adjusted with the &'opts'& option, which takes the same values as the &`-d`& command-line option. -Logging may be stopped, and the file removed, with the &'kill'& option. +Logging started this way may be stopped, and the file removed, +with the &'kill'& option. Some examples (which depend on variables that don't exist in all contexts): .code @@ -30908,6 +30899,23 @@ command when performing the callout, instead of an empty address. There is no need to use this option unless you know that the called hosts make use of the sender when checking recipients. If used indiscriminately, it reduces the usefulness of callout caching. + +.new +.vitem &*hold*& +This option applies to recipient callouts only. For example: +.code +require verify = recipient/callout=use_sender,hold +.endd +It causes the connection to be helod open and used for any further recipients +and for eventual delivery (should that be done quickly). +Doing this saves on TCP and SMTP startup costs, and TLS costs also +when that is used for the connections. +The advantage is only gained if there are no callout cache hits +(which could be enforced by the no_cache option), +if the use_sender option is used, +if neither the random nor the use_postmaster option is used, +and if no other callouts intervene. +.wen .endlist If you use any of the parameters that set a non-empty sender for the MAIL @@ -35774,10 +35782,9 @@ down a single SMTP connection, an asterisk follows the IP address in the log lines for the second and subsequent messages. .new When two or more messages are delivered down a single TLS connection, the -DNS and TLS-related information logged for the first message delivered +DNS and some TLS-related information logged for the first message delivered will not be present in the log lines for the second and subsequent messages. -A TLS-marker indication of &'X=*'& is added to the log line instead of -cipher information. +TLS cipher information is still available. .wen .cindex "delivery" "cutthrough; logging" @@ -35906,7 +35913,7 @@ the following table: &`T `& on &`<=`& lines: message subject (topic) &` `& on &`=>`& &`**`& and &`==`& lines: transport name &`U `& local user or RFC 1413 identity -&`X `& TLS cipher suite, or TLS usage mark +&`X `& TLS cipher suite .endd @@ -36639,8 +36646,7 @@ autodetection of some well known compression extensions. .cindex "&'exipick'&" John Jetmore's &'exipick'& utility is included in the Exim distribution. It lists messages from the queue according to a variety of criteria. For details -of &'exipick'&'s facilities, visit the web page at -&url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with +of &'exipick'&'s facilities, run &'exipick'& with the &%--help%& option. @@ -38331,22 +38337,26 @@ senders). Signing is enabled by setting private options on the SMTP transport. These options take (expandable) strings as arguments. -.option dkim_domain smtp string&!! unset -MANDATORY: -The domain you want to sign with. The result of this expanded -option is put into the &%$dkim_domain%& expansion variable. +.option dkim_domain smtp string list&!! unset +The domain(s) you want to sign with. +.new +After expansion, this can be a list. +Each element in turn is put into the &%$dkim_domain%& expansion variable +while expanding the remaining signing options. +.wen If it is empty after expansion, DKIM signing is not done. .option dkim_selector smtp string&!! unset -MANDATORY: -This sets the key selector string. You can use the &%$dkim_domain%& expansion -variable to look up a matching selector. The result is put in the expansion +This sets the key selector string. +You can use the &%$dkim_domain%& expansion variable to look up a matching selector. +The result is put in the expansion variable &%$dkim_selector%& which may be used in the &%dkim_private_key%& option along with &%$dkim_domain%&. +If the option is empty after expansion, DKIM signing is not done. .option dkim_private_key smtp string&!! unset -MANDATORY: -This sets the private key to use. You can use the &%$dkim_domain%& and +This sets the private key to use. +You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion variables to determine the private key to use. The result can either .ilist @@ -38359,16 +38369,15 @@ be "0", "false" or the empty string, in which case the message will not be signed. This case will not result in an error, even if &%dkim_strict%& is set. .endlist +If the option is empty after expansion, DKIM signing is not done. .option dkim_canon smtp string&!! unset -OPTIONAL: This option sets the canonicalization method used when signing a message. The DKIM RFC currently supports two methods: "simple" and "relaxed". The option defaults to "relaxed" when unset. Note: the current implementation only supports using the same canonicalization method for both headers and body. .option dkim_strict smtp string&!! unset -OPTIONAL: This option defines how Exim behaves when signing a message that should be signed fails for some reason. When the expansion evaluates to either "1" or "true", Exim will defer. Otherwise Exim will send the message @@ -38376,11 +38385,10 @@ unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion variables here. .option dkim_sign_headers smtp string&!! unset -OPTIONAL: -When set, this option must expand to (or be specified as) a colon-separated +If set, this option must expand to (or be specified as) a colon-separated list of header names. Headers with these names will be included in the message -signature. When unspecified, the header names recommended in RFC4871 will be -used. +signature. +When unspecified, the header names recommended in RFC4871 will be used. .section "Verifying DKIM signatures in incoming mail" "SECID514" @@ -38903,7 +38911,7 @@ The current list of events is: &`msg:rcpt:host:defer after transport `& per recipient per host &`msg:rcpt:defer after transport `& per recipient &`msg:host:defer after transport `& per attempt -&`msg:fail:delivery after main `& per recipient +&`msg:fail:delivery after transport `& per recipient &`msg:fail:internal after main `& per recipient &`tcp:connect before transport `& per connection &`tcp:close after transport `& per connection @@ -38920,6 +38928,11 @@ The second column in the table above describes whether the event fires before or after the action is associates with. Those which fire before can be used to affect that action (more on this below). +.new +The third column in the table above says what section of the configumration +should define the event action. +.wen + An additional variable, &$event_data$&, is filled with information varying with the event type: .display