X-Git-Url: https://git.exim.org/users/heiko/exim.git/blobdiff_plain/92562f63be6fae2526d68171d60bf87027551f88..8cfc4d82fc84825b3a673aa140fc561042e32b70:/doc/doc-docbook/spec.xfpt?ds=sidebyside diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 410a166ab..25abda9e5 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -1399,16 +1399,21 @@ If the &%domains%& option is set, the domain of the address must be in the set of domains that it defines. .next .vindex "&$local_part_prefix$&" +.vindex "&$local_part_prefix_v$&" .vindex "&$local_part$&" .vindex "&$local_part_suffix$&" +.vindex "&$local_part_suffix_v$&" .cindex affix "router precondition" If the &%local_parts%& option is set, the local part of the address must be in the set of local parts that it defines. If &%local_part_prefix%& or &%local_part_suffix%& is in use, the prefix or suffix is removed from the local part before this check. If you want to do precondition tests on local parts that include affixes, you can do so by using a &%condition%& option (see below) -that uses the variables &$local_part$&, &$local_part_prefix$&, and -&$local_part_suffix$& as necessary. +.new +that uses the variables &$local_part$&, &$local_part_prefix$&, +&$local_part_prefix_v$&, &$local_part_suffix$& +and &$local_part_suffix_v$& as necessary. +.wen .next .vindex "&$local_user_uid$&" .vindex "&$local_user_gid$&" @@ -12447,12 +12452,19 @@ the retrieved data. .wen .vindex "&$local_part_prefix$&" +.vindex "&$local_part_prefix_v$&" .vindex "&$local_part_suffix$&" +.vindex "&$local_part_suffix_v$&" .cindex affix variables If a local part prefix or suffix has been recognized, it is not included in the value of &$local_part$& during routing and subsequent delivery. The values of any prefix or suffix are in &$local_part_prefix$& and &$local_part_suffix$&, respectively. +.new +If the affix specification included a wildcard then the portion of +the affix matched by the wildcard is in +&$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate. +.wen When a message is being delivered to a file, pipe, or autoreply transport as a result of aliasing or forwarding, &$local_part$& is set to the local part of @@ -12506,12 +12518,26 @@ When an address is being routed or delivered, and a specific prefix for the local part was recognized, it is available in this variable, having been removed from &$local_part$&. +.new +.vitem &$local_part_prefix_v$& +.vindex "&$local_part_prefix_v$&" +When &$local_part_prefix$& is valid and the prefix match used a wildcard, +the portion matching the wildcard is available in this variable. +.wen + .vitem &$local_part_suffix$& .vindex "&$local_part_suffix$&" When an address is being routed or delivered, and a specific suffix for the local part was recognized, it is available in this variable, having been removed from &$local_part$&. +.new +.vitem &$local_part_suffix_v$& +.vindex "&$local_part_suffix_v$&" +When &$local_part_suffix$& is valid and the suffix match used a wildcard, +the portion matching the wildcard is available in this variable. +.wen + .new .vitem &$local_part_verified$& .vindex "&$local_part_verified$&" @@ -12854,6 +12880,13 @@ or if not set, the value of &$qualify_domain$&. .cindex queues named The name of the spool queue in use; empty for the default queue. +.vitem &$queue_size$& +.vindex "&$queue_size$&" +.cindex "queue" "size of" +.cindex "spool" "number of messages" +This variable contains the number of messages queued. +It is evaluated on demand, but no more often than once every minute. + .vitem &$r_...$& .vindex &$r_...$& .cindex router variables @@ -17274,6 +17307,13 @@ example: smtp_etrn_command = /etc/etrn_command $domain \ $sender_host_address .endd +.new +If the option is not set, the argument for the ETRN command must +be a &'#'& followed by an address string. +In this case an &'exim -R '& command is used; +if the ETRN ACL has set up a named-queue then &'-MCG '& is appended. +.wen + A new process is created to run the command, but Exim does not wait for it to complete. Consequently, its status cannot be checked. If the command cannot be run, a line is written to the panic log, but the ETRN caller still receives @@ -18654,15 +18694,19 @@ avoided. The &%repeat_use%& option of the &%redirect%& router may be of help. This option specifies a list of text headers, colon-separated (by default, changeable in the usual way &<>&), that is associated with any addresses that are accepted by the router. -Each item is separately expanded, at routing time. However, this -option has no effect when an address is just being verified. The way in which +However, the option has no effect when an address is just being verified. +Each list item is separately expanded, at transport time. +.new +If an item ends in *, it will match any header with the given prefix. +.wen +The way in which the text is used to remove header lines at transport time is described in section &<>&. Header lines are not actually removed until the message is in the process of being transported. This means that references to header lines in string expansions in the transport's configuration still &"see"& the original header lines. -The &%headers_remove%& option is expanded after &%errors_to%& and +The &%headers_remove%& option is handled after &%errors_to%& and &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail, the item has no effect. Other expansion failures are treated as configuration errors. @@ -18767,6 +18811,12 @@ command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default. This behaviour can be overridden by setting &%rcpt_include_affixes%& true on the relevant transport. +.new +.vindex &$local_part_prefix_v$& +If wildcarding (above) was used then the part of the prefix matching the +wildcard is available in &$local_part_prefix_v$&. +.wen + When an address is being verified, &%local_part_prefix%& affects only the behaviour of the router. If the callout feature of verification is in use, this means that the full address, including the prefix, will be used during the @@ -20105,8 +20155,10 @@ semicolon is the default route list separator. .section "Format of one host item" "SECTformatonehostitem" -Each item in the list of hosts is either a host name or an IP address, -optionally with an attached port number. When no port is given, an IP address +Each item in the list of hosts can be either a host name or an IP address, +optionally with an attached port number, or it can be a single "+" +(see &%hosts_randomize%&). +When no port is given, an IP address is not enclosed in brackets. When a port is specified, it overrides the port specification on the transport. The port is separated from the name or address by a colon. This leads to some complications: @@ -21841,15 +21893,21 @@ checked, since this option does not automatically suppress them. .option headers_remove transports list&!! unset .cindex "header lines" "removing" .cindex "transport" "header lines; removing" -This option specifies a list of header names, -colon-separated (by default, changeable in the usual way &<>&); -these headers are omitted from the message as it is transported, as described -in section &<>&. Header removal can also be specified by -routers. +This option specifies a list of text headers, +colon-separated (by default, changeable in the usual way &<>&), +to be removed from the message. +However, the option has no effect when an address is just being verified. Each list item is separately expanded. If the result of the expansion is an empty string, or if the expansion is forced to fail, no action is taken. Other expansion failures are treated as errors and cause the delivery to be deferred. +.new +If an item ends in *, it will match any header with the given prefix. +.wen + +Matching headers are omitted from the message as it is transported, as described +in section &<>&. Header removal can also be specified by +routers. Unlike most options, &%headers_remove%& can be specified multiple times for a transport; all listed headers are removed. @@ -30141,7 +30199,7 @@ in several different ways. For example: It can be at the end of an &%accept%& statement: .code accept ...some conditions - control = queue_only + control = queue .endd In this case, the control is applied when this statement yields &"accept"&, in other words, when the conditions are all true. @@ -30150,7 +30208,7 @@ other words, when the conditions are all true. It can be in the middle of an &%accept%& statement: .code accept ...some conditions... - control = queue_only + control = queue ...some more conditions... .endd If the first set of conditions are true, the control is applied, even if the @@ -33648,13 +33706,22 @@ The following list describes all expansion variables that are available in the MIME ACL: .vlist +.vitem &$mime_anomaly_level$& &&& + &$mime_anomaly_text$& +.vindex &$mime_anomaly_level$& +.vindex &$mime_anomaly_text$& +If there are problems decoding, these variables contain information on +the detected issue. + .vitem &$mime_boundary$& -If the current part is a multipart (see &$mime_is_multipart$&) below, it should +.vindex &$mime_boundary$& +If the current part is a multipart (see &$mime_is_multipart$& below), it should have a boundary string, which is stored in this variable. If the current part has no boundary parameter in the &'Content-Type:'& header, this variable contains the empty string. .vitem &$mime_charset$& +.vindex &$mime_charset$& This variable contains the character set identifier, if one was found in the &'Content-Type:'& header. Examples for charset identifiers are: .code @@ -33666,31 +33733,37 @@ Please note that this value is not normalized, so you should do matches case-insensitively. .vitem &$mime_content_description$& +.vindex &$mime_content_description$& This variable contains the normalized content of the &'Content-Description:'& header. It can contain a human-readable description of the parts content. Some implementations repeat the filename for attachments here, but they are usually only used for display purposes. .vitem &$mime_content_disposition$& +.vindex &$mime_content_disposition$& This variable contains the normalized content of the &'Content-Disposition:'& header. You can expect strings like &"attachment"& or &"inline"& here. .vitem &$mime_content_id$& +.vindex &$mime_content_id$& This variable contains the normalized content of the &'Content-ID:'& header. This is a unique ID that can be used to reference a part from another part. .vitem &$mime_content_size$& +.vindex &$mime_content_size$& This variable is set only after the &%decode%& modifier (see above) has been successfully run. It contains the size of the decoded part in kilobytes. The size is always rounded up to full kilobytes, so only a completely empty part has a &$mime_content_size$& of zero. .vitem &$mime_content_transfer_encoding$& +.vindex &$mime_content_transfer_encoding$& This variable contains the normalized content of the &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding type. Typical values are &"base64"& and &"quoted-printable"&. .vitem &$mime_content_type$& +.vindex &$mime_content_type$& If the MIME part has a &'Content-Type:'& header, this variable contains its value, lowercased, and without any options (like &"name"& or &"charset"&). Here are some examples of popular MIME types, as they may appear in this variable: @@ -33705,6 +33778,7 @@ If the MIME part has no &'Content-Type:'& header, this variable contains the empty string. .vitem &$mime_decoded_filename$& +.vindex &$mime_decoded_filename$& This variable is set only after the &%decode%& modifier (see above) has been successfully run. It contains the full path and filename of the file containing the decoded data. @@ -33713,6 +33787,7 @@ containing the decoded data. .cindex "RFC 2047" .vlist .vitem &$mime_filename$& +.vindex &$mime_filename$& This is perhaps the most important of the MIME variables. It contains a proposed filename for an attachment, if one was found in either the &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be @@ -33723,6 +33798,7 @@ decoded, but no additional sanity checks are done. found, this variable contains the empty string. .vitem &$mime_is_coverletter$& +.vindex &$mime_is_coverletter$& This variable attempts to differentiate the &"cover letter"& of an e-mail from attached data. It can be used to clamp down on flashy or unnecessarily encoded content in the cover letter, while not restricting attachments at all. @@ -33755,18 +33831,22 @@ deny message = HTML mail is not accepted here condition = $mime_is_coverletter condition = ${if eq{$mime_content_type}{text/html}{1}{0}} .endd + .vitem &$mime_is_multipart$& +.vindex &$mime_is_multipart$& This variable has the value 1 (true) when the current part has the main type &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&. Since multipart entities only serve as containers for other parts, you may not want to carry out specific actions on them. .vitem &$mime_is_rfc822$& +.vindex &$mime_is_rfc822$& This variable has the value 1 (true) if the current part is not a part of the checked message itself, but part of an attached message. Attached message decoding is fully recursive. .vitem &$mime_part_count$& +.vindex &$mime_part_count$& This variable is a counter that is raised for each processed MIME part. It starts at zero for the very first part (which is usually a multipart). The counter is per-message, so it is reset when processing RFC822 attachments (see @@ -33897,13 +33977,14 @@ in &_Local/Makefile_& (see section &<>& below). .cindex &%dlfunc%& "API description" You must include this line near the start of your code: .code +#define LOCAL_SCAN #include "local_scan.h" .endd This header file defines a number of variables and other values, and the prototype for the function itself. Exim is coded to use unsigned char values almost exclusively, and one of the things this header defines is a shorthand for &`unsigned char`& called &`uschar`&. -It also contains the following macro definitions, to simplify casting character +It also makes available the following macro definitions, to simplify casting character strings and pointers to character strings: .code #define CS (char *) @@ -40157,6 +40238,8 @@ To generate keys under OpenSSL: openssl genrsa -out dkim_rsa.private 2048 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM .endd +The result file from the first command should be retained, and +this option set to use it. Take the base-64 lines from the output of the second command, concatenated, for the DNS TXT record. See section 3.6 of RFC6376 for the record specification.