X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/d6be6b43a5ba49b4f1abe02a13673bc85f8ec2a7..d223e9344978ee88ad04a231f00f7540d2b841e2:/doc/doc-docbook/spec.xfpt?ds=sidebyside diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 3c26b7145..b670c1ff9 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -45,14 +45,14 @@ . Update the Copyright year (only) when changing content. . ///////////////////////////////////////////////////////////////////////////// -.set previousversion "4.85" +.set previousversion "4.87" .include ./local_params .set ACL "access control lists (ACLs)" .set I "    " .macro copyyear -2015 +2016 .endmacro . ///////////////////////////////////////////////////////////////////////////// @@ -1575,7 +1575,7 @@ If a host is unreachable for a period of time, a number of messages may be waiting for it by the time it recovers, and sending them in a single SMTP connection is clearly beneficial. Whenever a delivery to a remote host is deferred, -.cindex "hints database" +.cindex "hints database" "deferred deliveries" Exim makes a note in its hints database, and whenever a successful SMTP delivery has happened, it looks to see if any other messages are waiting for the same host. If any are found, they are sent over the same SMTP @@ -1860,7 +1860,7 @@ described RFC 2047. This makes it possible to transmit characters that are not in the ASCII character set, and to label them as being in a particular character set. When Exim is inspecting header lines by means of the &%$h_%& mechanism, it decodes them, and translates them into a specified character set -(default ISO-8859-1). The translation is possible only if the operating system +(default is set at build time). The translation is possible only if the operating system supports the &[iconv()]& function. However, some of the operating systems that supply &[iconv()]& do not support @@ -1986,11 +1986,9 @@ defined. AAAA records (analogous to A records for IPv4) are in use, and are currently seen as the mainstream. Another record type called A6 was proposed as better than AAAA because it had more flexibility. However, it was felt to be over-complex, and its status was reduced to &"experimental"&. -.new Exim used to have a compile option for including A6 record support but this has now been withdrawn. -.wen @@ -2034,9 +2032,6 @@ For example, on a Sun system running Solaris 8, the directory .cindex "symbolic link" "to source files" Symbolic links to relevant source files are installed in the build directory. -&*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the -building process fails if it is set. - If this is the first time &'make'& has been run, it calls a script that builds a make file inside the build directory, using the configuration files from the &_Local_& directory. The new make file is then passed to another instance of @@ -2793,7 +2788,7 @@ continuations. As in Exim's run time configuration, white space at the start of continuation lines is ignored. Each argument or data line is passed through the string expansion mechanism, and the result is output. Variable values from the configuration file (for example, &$qualify_domain$&) are available, but no -message-specific values (such as &$sender_domain$&) are set, because no message +message-specific values (such as &$message_exim_id$&) are set, because no message is being processed (but see &%-bem%& and &%-Mset%&). &*Note*&: If you use this mechanism to test lookups, and you change the data @@ -3112,8 +3107,12 @@ users, the output is as in this example: .code mysql_servers = .endd -If &%configure_file%& is given as an argument, the name of the run time -configuration file is output. +If &%config%& is given as an argument, the config is +output, as it was parsed, any include file resolved, any comment removed. + +If &%config_file%& is given as an argument, the name of the run time +configuration file is output. (&%configure_file%& works too, for +backward compatibility.) If a list of configuration files was supplied, the value that is output here is the name of the file that was actually used. @@ -3152,6 +3151,11 @@ using one of the words &%router_list%&, &%transport_list%&, or settings can be obtained by using &%routers%&, &%transports%&, or &%authenticators%&. +.cindex "environment" +If &%environment%& is given as an argument, the set of environment +variables is output, line by line. Using the &%-n%& flag suppresses the value of the +variables. + .cindex "options" "macro &-- extracting" If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%& are available, similarly to the drivers. Because macros are sometimes used @@ -3553,6 +3557,7 @@ example: exim '-D ABC = something' ... .endd &%-D%& may be repeated up to 10 times on a command line. +Only macro names up to 22 letters long can be set. .vitem &%-d%&<&'debug&~options'&> @@ -3813,13 +3818,11 @@ This option is not intended for use by external callers. It is used internally by Exim in conjunction with the &%-MC%& option. It signifies that the connection to the remote host has been authenticated. -.new .vitem &%-MCD%& .oindex "&%-MCD%&" This option is not intended for use by external callers. It is used internally by Exim in conjunction with the &%-MC%& option. It signifies that the remote host supports the ESMTP &_DSN_& extension. -.wen .vitem &%-MCP%& .oindex "&%-MCP%&" @@ -4012,7 +4015,8 @@ for that message. .oindex "&%-n%&" This option is interpreted by Sendmail to mean &"no aliasing"&. For normal modes of operation, it is ignored by Exim. -When combined with &%-bP%& it suppresses the name of an option from being output. +When combined with &%-bP%& it makes the output more terse (suppresses +option names, environment values and config pretty printing). .vitem &%-O%&&~<&'data'&> .oindex "&%-O%&" @@ -4651,14 +4655,12 @@ this option. This option is interpreted by Sendmail to cause debug information to be sent to the named file. It is ignored by Exim. -.new .vitem &%-z%&&~<&'log-line'&> .oindex "&%-z%&" This option writes its argument to Exim's logfile. Use is restricted to administrators; the intent is for operational notes. Quotes should be used to maintain a multi-word item as a single argument, under most shells. -.wen .endlist .ecindex IIDclo1 @@ -4809,8 +4811,8 @@ help with this. See the comments in &_src/EDITME_& for details. Exim's configuration file is divided into a number of different parts. General option settings must always appear at the start of the file. The other parts are all optional, and may appear in any order. Each part other than the first -is introduced by the word &"begin"& followed by the name of the part. The -optional parts are: +is introduced by the word &"begin"& followed by at least one literal +space, and the name of the part. The optional parts are: .ilist &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter @@ -5604,14 +5606,12 @@ find that they send unqualified addresses. The two commented-out options: show how you can specify hosts that are permitted to send unqualified sender and recipient addresses, respectively. -.new The &%log_selector%& option is used to increase the detail of logging over the default: .code log_selector = +smtp_protocol_error +smtp_syntax_error \ +tls_certificate_verified .endd -.wen The &%percent_hack_domains%& option is also commented out: .code @@ -5621,7 +5621,7 @@ It provides a list of domains for which the &"percent hack"& is to operate. This is an almost obsolete form of explicit email routing. If you do not know anything about it, you can safely ignore this topic. -The last two settings in the main part of the default configuration are +The next two settings in the main part of the default configuration are concerned with messages that have been &"frozen"& on Exim's queue. When a message is frozen, Exim no longer continues to try to deliver it. Freezing occurs when a bounce message encounters a permanent failure because the sender @@ -5639,6 +5639,44 @@ message (whether a bounce message or not) is to be timed out (and discarded) after a week. In this configuration, the first setting ensures that no failing bounce message ever lasts a week. +Exim queues it's messages in a spool directory. If you expect to have +large queues, you may consider using this option. It splits the spool +directory into subdirectories to avoid file system degradation from +many files in a single directory, resulting in better performance. +Manual manipulation of queued messages becomes more complex (though fortunately +not often needed). +.code +# split_spool_directory = true +.endd + +In an ideal world everybody follows the standards. For non-ASCII +messages RFC 2047 is a standard, allowing a maximum line length of 76 +characters. Exim adheres that standard and won't process messages which +violate this standard. (Even ${rfc2047:...} expansions will fail.) +In particular, the Exim maintainers have had multiple reports of +problems from Russian administrators of issues until they disable this +check, because of some popular, yet buggy, mail composition software. +.code +# check_rfc2047_length = false +.endd + +If you need to be strictly RFC compliant you may wish to disable the +8BITMIME advertisement. Use this, if you exchange mails with systems +that are not 8-bit clean. +.code +# accept_8bitmime = false +.endd + +Libraries you use may depend on specific environment settings. This +imposes a security risk (e.g. PATH). There are two lists: +&%keep_environment%& for the variables to import as they are, and +&%add_environment%& for variables we want to set to a fixed value. +Note that TZ is handled separately, by the $%timezone%$ runtime +option and by the TIMEZONE_DEFAULT buildtime option. +.code +# keep_environment = ^LDAP +# add_environment = PATH=/usr/bin::/bin +.endd .section "ACL configuration" "SECID54" @@ -6071,8 +6109,8 @@ address_pipe: .endd This transport is used for handling deliveries to pipes that are generated by redirection (aliasing or users' &_.forward_& files). The &%return_output%& -option specifies that any output generated by the pipe is to be returned to the -sender. +option specifies that any output on stdout or stderr generated by the pipe is to +be returned to the sender. .code address_file: driver = appendfile @@ -6254,12 +6292,14 @@ cause parts of the string to be replaced by data that is obtained from the lookup. Lookups of this type are conditional expansion items. Different results can be defined for the cases of lookup success and failure. See chapter &<>&, where string expansions are described in detail. +The key for the lookup is specified as part of the string expansion. .next Lists of domains, hosts, and email addresses can contain lookup requests as a way of avoiding excessively long linear lists. In this case, the data that is returned by the lookup is often (but not always) discarded; whether the lookup succeeds or fails is what really counts. These kinds of list are described in chapter &<>&. +The key for the lookup is given by the context in which the list is expanded. .endlist String expansions, lists, and lookups interact with each other in such a way @@ -6626,6 +6666,12 @@ password value. For example: &(pgsql)&: The format of the query is an SQL statement that is passed to a PostgreSQL database. See section &<>&. +.next +.cindex "Redis lookup type" +.cindex lookup Redis +&(redis)&: The format of the query is an SQL statement that is passed to a +Redis database. See section &<>&. + .next .cindex "sqlite lookup type" .cindex "lookup" "sqlite" @@ -6893,11 +6939,9 @@ is used on its own as the result. If the lookup does not succeed, the &`fail`& keyword causes a &'forced expansion failure'& &-- see section &<>& for an explanation of what this means. -.new The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA and TXT, and, when Exim is compiled with IPv6 support, AAAA. If no type is given, TXT is assumed. -.wen For any record type, if multiple records are found, the data is returned as a concatenation, with newline as the default separator. The order, of course, @@ -6945,7 +6989,6 @@ ${lookup dnsdb{spf=example.org}} It is permitted to specify a space as the separator character. Further white space is ignored. -.new .cindex "SOA record" "in &(dnsdb)& lookup" For an SOA lookup, while no result is obtained the lookup is redone with successively more leading components dropped from the given domain. @@ -6954,13 +6997,12 @@ specified. .code ${lookup dnsdb{>:,; soa=a.b.example.com}} .endd -.wen .section "Dnsdb lookup modifiers" "SECTdnsdb_mod" .cindex "dnsdb modifiers" .cindex "modifiers" "dnsdb" .cindex "options" "dnsdb" -Modifiers for &(dnsdb)& lookups are givien by optional keywords, +Modifiers for &(dnsdb)& lookups are given by optional keywords, each followed by a comma, that may appear before the record type. @@ -6995,18 +7037,23 @@ The default is &"never"&. See also the &$lookup_dnssec_authenticated$& variable. -.new .cindex timeout "dns lookup" .cindex "DNS" timeout Timeout for the dnsdb lookup can be controlled by a retrans modifier. The form is &"retrans_VAL"& where VAL is an Exim time specification -(eg &"5s"&). +(e.g. &"5s"&). The default value is set by the main configuration option &%dns_retrans%&. Retries for the dnsdb lookup can be controlled by a retry modifier. The form if &"retry_VAL"& where VAL is an integer. The default count is set by the main configuration option &%dns_retry%&. -.wen + +.cindex cacheing "of dns lookup" +.cindex TTL "of dns lookup" +.cindex DNS TTL +Dnsdb lookup results are cached within a single process (and its children). +The cache entry lifetime is limited to the smallest time-to-live (TTL) +value of the set of returned DNS records. .section "Pseudo dnsdb record types" "SECID66" @@ -7313,6 +7360,8 @@ The value of the DEREFERENCE parameter must be one of the words &"never"&, must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP library from trying to follow referrals issued by the LDAP server. +.cindex LDAP timeout +.cindex timeout "LDAP lookup" The name CONNECT is an obsolete name for NETTIME, retained for backwards compatibility. This timeout (specified as a number of seconds) is enforced from the client end for operations that can be carried out over a @@ -7327,7 +7376,7 @@ The TIME parameter (also a number of seconds) is passed to the server to set a server-side limit on the time taken to complete a search. The SERVERS parameter allows you to specify an alternate list of ldap servers -to use for an individual lookup. The global ldap_servers option provides a +to use for an individual lookup. The global &%ldap_default_servers%& option provides a default list of ldap servers, and a single lookup can specify a single ldap server to use. But when you need to do a lookup with a list of servers that is different than the default list (maybe different order, maybe a completely @@ -7387,7 +7436,7 @@ SMTP authentication. See the &%ldapauth%& expansion string condition in chapter The &(ldapdn)& lookup type returns the Distinguished Name from a single entry as a sequence of values, for example .code -cn=manager, o=University of Cambridge, c=UK +cn=manager,o=University of Cambridge,c=UK .endd The &(ldap)& lookup type generates an error if more than one entry matches the search filter, whereas &(ldapm)& permits this case, and inserts a newline in @@ -7398,7 +7447,8 @@ directory. In the common case where you specify a single attribute in your LDAP query, the result is not quoted, and does not contain the attribute name. If the attribute -has multiple values, they are separated by commas. +has multiple values, they are separated by commas. Any comma that is +part of an attribute's value is doubled. If you specify multiple attributes, the result contains space-separated, quoted strings, each preceded by the attribute name and an equals sign. Within the @@ -7413,7 +7463,9 @@ same as specifying all of an entry's attributes. Here are some examples of the output format. The first line of each pair is an LDAP query, and the second is the data that is returned. The attribute called &%attr1%& has two values, one of them with an embedded comma, whereas -&%attr2%& has only one value: +&%attr2%& has only one value. Both attributes are derived from &%attr%& +(they have SUP &%attr%& in their schema definitions). + .code ldap:///o=base?attr1?sub?(uid=fred) value1.1,value1,,2 @@ -7421,6 +7473,9 @@ value1.1,value1,,2 ldap:///o=base?attr2?sub?(uid=fred) value two +ldap:///o=base?attr?sub?(uid=fred) +value1.1,value1,,2,value two + ldap:///o=base?attr1,attr2?sub?(uid=fred) attr1="value1.1,value1,,2" attr2="value two" @@ -7480,7 +7535,10 @@ operator is to double any quote characters within the text. .cindex "lookup" "Oracle" .cindex "InterBase lookup type" .cindex "lookup" "InterBase" -Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite +.cindex "Redis lookup type" +.cindex lookup Redis +Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis, +and SQLite databases. Queries for these databases contain SQL statements, so an example might be .code @@ -7507,7 +7565,7 @@ If the result of the query yields more than one row, it is all concatenated, with a newline between the data for each row. -.section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72" +.section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72" .cindex "MySQL" "lookup type" .cindex "PostgreSQL lookup type" .cindex "lookup" "MySQL" @@ -7516,13 +7574,18 @@ with a newline between the data for each row. .cindex "lookup" "Oracle" .cindex "InterBase lookup type" .cindex "lookup" "InterBase" -If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the -&%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%& +.cindex "Redis lookup type" +.cindex lookup Redis +If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the +&%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&, +or &%redis_servers%& option (as appropriate) must be set to a colon-separated list of server information. -(For MySQL and PostgreSQL only, the global option need not be set if all +(For MySQL and PostgreSQL, the global option need not be set if all queries contain their own server information &-- see section -&<>&.) Each item in the list is a slash-separated list of four +&<>&.) +For all but Redis +each item in the list is a slash-separated list of four items: host name, database name, user name, and password. In the case of Oracle, the host name field is used for the &"service name"&, and the database name field is not used and should be empty. For example: @@ -7543,16 +7606,32 @@ a query is successfully processed. The result of a query may be that no data is found, but that is still a successful query. In other words, the list of servers provides a backup facility, not a list of different places to look. +For Redis the global option need not be specified if all queries contain their +own server information &-- see section &<>&. +If specified, the option must be set to a colon-separated list of server +information. +Each item in the list is a slash-separated list of three items: +host, database number, and password. +.olist +The host is required and may be either an IPv4 address and optional +port number (separated by a colon, which needs doubling due to the +higher-level list), or a Unix socket pathname enclosed in parentheses +.next +The database number is optional; if present that number is selected in the backend +.next +The password is optional; if present it is used to authenticate to the backend +.endlist + The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b respectively, and the characters single-quote, double-quote, and backslash -itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in -addition, escapes the percent and underscore characters. This cannot be done -for MySQL because these escapes are not recognized in contexts where these -characters are not special. +itself are escaped with backslashes. + +The &%quote_redis%& expansion operator +escapes whitespace and backslash characters with a backslash. .section "Specifying the server in the query" "SECTspeserque" -For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase), +For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase), it is possible to specify a list of servers with an individual query. This is done by starting the query with .display @@ -7595,13 +7674,15 @@ ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} } .section "Special MySQL features" "SECID73" For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%& causes a connection to the server on the local host by means of a Unix domain -socket. An alternate socket can be specified in parentheses. The full syntax of -each item in &%mysql_servers%& is: +socket. An alternate socket can be specified in parentheses. +An option group name for MySQL option files can be specified in square brackets; +the default value is &"exim"&. +The full syntax of each item in &%mysql_servers%& is: .display -<&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&& - <&'user'&>/<&'password'&> +<&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&& + <&'database'&>/<&'user'&>/<&'password'&> .endd -Any of the three sub-parts of the first field can be omitted. For normal use on +Any of the four sub-parts of the first field can be omitted. For normal use on the local host it can be left blank or set to just &"localhost"&. No database need be supplied &-- but if it is absent here, it must be given in @@ -7653,6 +7734,8 @@ domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \ The only character affected by the &%quote_sqlite%& operator is a single quote, which it doubles. +.cindex timeout SQLite +.cindex sqlite "lookup timeout" The SQLite library handles multiple simultaneous accesses to the database internally. Multiple readers are permitted, but only one process can update at once. Attempts to access the database while it is being updated @@ -7682,9 +7765,13 @@ host, email address, or local part, respectively. In the sections below, the different types of pattern for each case are described, but first we cover some general facilities that apply to all four kinds of list. +Note that other parts of Exim use a &'string list'& which does not +support all the complexity available in +domain, host, address and local part lists. -.section "Expansion of lists" "SECID75" + +.section "Expansion of lists" "SECTlistexpand" .cindex "expansion" "of lists" Each list is expanded as a single string before it is used. The result of expansion must be a list, possibly containing empty items, which is split up @@ -8464,7 +8551,7 @@ this section. .cindex "&`+ignore_defer`&" A temporary DNS lookup failure normally causes a defer action (except when &%dns_again_means_nonexist%& converts it into a permanent error). However, -host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to +host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous section. These options should be used with care, probably only in non-critical host lists such as whitelists. @@ -8955,7 +9042,7 @@ If the ACL returns defer the result is a forced-fail. Otherwise the expansion f .cindex "&%certextract%&" "certificate fields" .cindex "certificate" "extracting fields" The <&'certificate'&> must be a variable of type certificate. -The field name is expanded and used to retrive the relevant field from +The field name is expanded and used to retrieve the relevant field from the certificate. Supported fields are: .display &`version `& @@ -8990,7 +9077,7 @@ parseable by Exim as a comma-separated tagged list RDN elements of a single type may be selected by a modifier of the type label; if so the expansion result is a list (newline-separated by default). -The separator may be changed by another modifer of +The separator may be changed by another modifier of a right angle-bracket followed immediately by the new separator. Recognised RDN type labels include "CN", "O", "OU" and "DC". @@ -9010,7 +9097,7 @@ The field selectors marked as "tagged" above prefix each list element with a type string and an equals sign. Elements of only one type may be selected by a modifier which is one of "dns", "uri" or "mail"; -if so the elenment tags are omitted. +if so the element tags are omitted. If not otherwise noted field values are presented in human-readable form. @@ -9053,10 +9140,9 @@ you need to add &%-shared%& to the gcc command. Also, in the Exim build-time configuration, you must add &%-export-dynamic%& to EXTRALIBS. -.new .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&" .cindex "expansion" "extracting value from environment" -.cindex "environment" "value from" +.cindex "environment" "values from" The key is first expanded separately, and leading and trailing white space removed. This is then searched for as a name in the environment. @@ -9075,7 +9161,9 @@ If {<&'string2'&>} is omitted an empty string is substituted on search failure. If {<&'string1'&>} is omitted the search result is substituted on search success. -.wen + +The environment is adjusted by the &%keep_environment%& and +&%add_environment%& main section options. .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&& @@ -9277,10 +9365,11 @@ by earlier ACLs are visible. Upper case and lower case letters are synonymous in header names. If the following character is white space, the terminating colon may be omitted, but this is not recommended, because you may then forget it when it is needed. When -white space terminates the header name, it is included in the expanded string. -If the message does not contain the given header, the expansion item is -replaced by an empty string. (See the &%def%& condition in section -&<>& for a means of testing for the existence of a header.) +white space terminates the header name, this white space is included in the +expanded string. If the message does not contain the given header, the +expansion item is replaced by an empty string. (See the &%def%& condition in +section &<>& for a means of testing for the existence of a +header.) If there is more than one header with the same name, they are all concatenated to form the substitution string, up to a maximum length of 64K. Unless @@ -9356,6 +9445,17 @@ you can use condition = ${if >{$acl_m4}{3}} .endd + + +.vitem &*${imapfolder{*&<&'foldername'&>&*}}*& +.cindex expansion "imap folder" +.cindex "&%imapfolder%& expansion item" +This item converts a (possibly multilevel, or with non-ASCII characters) +folder specification to a Maildir name for filesystem use. +For information on internationalisation support see &<>&. + + + .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*& .cindex "expansion" "string truncation" .cindex "&%length%& expansion item" @@ -9402,7 +9502,7 @@ yields &"42"&, and .code ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}} .endd -yields &"result: 99"&. +yields &"result: 42"&. If {<&'string3'&>} is omitted, an empty string is used for string3. If {<&'string2'&>} is also omitted, the value that was @@ -9610,7 +9710,8 @@ ${readsocket{inet:[::1]:1234}{request string}} Only a single host name may be given, but if looking it up yields more than one IP address, they are each tried in turn until a connection is made. For both kinds of socket, Exim makes a connection, writes the request string -(unless it is an empty string) and reads from the socket until an end-of-file +unless it is an empty string; and no terminating NUL is ever sent) +and reads from the socket until an end-of-file is read. A timeout of 5 seconds is applied. Additional, optional arguments extend what can be done. Firstly, you can vary the timeout. For example: .code @@ -9927,7 +10028,7 @@ processing lists. To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows a strict interpretation of header line formatting. Exim parses the bare, unquoted portion of an email address and if it finds a comma, treats it as an -email address seperator. For the example header line: +email address separator. For the example header line: .code From: =?iso-8859-2?Q?Last=2C_First?= .endd @@ -9966,6 +10067,23 @@ environments where Exim uses base 36 instead of base 62 for its message identifiers, base-36 digits. The number is converted to decimal and output as a string. +.vitem &*${base64:*&<&'string'&>&*}*& +.cindex "expansion" "base64 encoding" +.cindex "base64 encoding" "in string expansion" +.cindex "&%base64%& expansion item" +.cindex certificate "base64 of DER" +This operator converts a string into one that is base64 encoded. + +If the string is a single variable of type certificate, +returns the base64 encoding of the DER form of the certificate. + + +.vitem &*${base64d:*&<&'string'&>&*}*& +.cindex "expansion" "base64 decoding" +.cindex "base64 decoding" "in string expansion" +.cindex "&%base64d%& expansion item" +This operator converts a base64-encoded string into the un-coded form. + .vitem &*${domain:*&<&'string'&>&*}*& .cindex "domain" "extraction" @@ -10111,6 +10229,25 @@ as is, and other byte values are converted to &`\xNN`&, for example a byte value 127 is converted to &`\x7f`&. +.vitem &*${ipv6denorm:*&<&'string'&>&*}*& +.cindex "&%ipv6denorm%& expansion item" +.cindex "IP address" normalisation +This expands an IPv6 address to a full eight-element colon-separated set +of hex digits including leading zeroes. +A trailing ipv4-style dotted-decimal set is converted to hex. +Pure IPv4 addresses are converted to IPv4-mapped IPv6. + +.vitem &*${ipv6norm:*&<&'string'&>&*}*& +.cindex "&%ipv6norm%& expansion item" +.cindex "IP address" normalisation +.cindex "IP address" "canonical form" +This converts an IPv6 address to canonical form. +Leading zeroes of groups are omitted, and the longest +set of zero-valued groups is replaced with a double colon. +A trailing ipv4-style dotted-decimal set is converted to hex. +Pure IPv4 addresses are converted to IPv4-mapped IPv6. + + .vitem &*${lc:*&<&'string'&>&*}*& .cindex "case forcing in strings" .cindex "string" "case forcing" @@ -10194,11 +10331,14 @@ Letters in IPv6 addresses are always output in lower case. .vitem &*${md5:*&<&'string'&>&*}*& .cindex "MD5 hash" .cindex "expansion" "MD5 hash" -.cindex "certificate fingerprint" +.cindex certificate fingerprint .cindex "&%md5%& expansion item" The &%md5%& operator computes the MD5 hash value of the string, and returns it as a 32-digit hexadecimal number, in which any letters are in lower case. +If the string is a single variable of type certificate, +returns the MD5 hash fingerprint of the certificate. + .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*& .cindex "expansion" "numeric hash" @@ -10273,7 +10413,7 @@ random(). .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*& .cindex "expansion" "IP address" This operator reverses an IP address; for IPv4 addresses, the result is in -dotted-quad decimal form, while for IPv6 addreses the result is in +dotted-quad decimal form, while for IPv6 addresses the result is in dotted-nibble hexadecimal form. In both cases, this is the "natural" form for DNS. For example, .code @@ -10294,7 +10434,7 @@ f.7.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 This operator encodes text according to the rules of RFC 2047. This is an encoding that is used in header lines to encode non-ASCII characters. It is assumed that the input string is in the encoding specified by the -&%headers_charset%& option, which defaults to ISO-8859-1. If the string +&%headers_charset%& option, which gets its default at build time. If the string contains only characters in the range 33&--126, and no instances of the characters .code @@ -10332,15 +10472,18 @@ variables or headers inside regular expressions. .vitem &*${sha1:*&<&'string'&>&*}*& .cindex "SHA-1 hash" .cindex "expansion" "SHA-1 hashing" -.cindex "certificate fingerprint" +.cindex certificate fingerprint .cindex "&%sha2%& expansion item" The &%sha1%& operator computes the SHA-1 hash value of the string, and returns it as a 40-digit hexadecimal number, in which any letters are in upper case. +If the string is a single variable of type certificate, +returns the SHA-1 hash fingerprint of the certificate. + .vitem &*${sha256:*&<&'certificate'&>&*}*& .cindex "SHA-256 hash" -.cindex "certificate fingerprint" +.cindex certificate fingerprint .cindex "expansion" "SHA-256 hashing" .cindex "&%sha256%& expansion item" The &%sha256%& operator computes the SHA-256 hash fingerprint of the @@ -10369,10 +10512,8 @@ the system administrator. &*Warning*&: The file size may be incorrect on 32-bit systems for files larger than 2GB. .vitem &*${str2b64:*&<&'string'&>&*}*& -.cindex "expansion" "base64 encoding" -.cindex "base64 encoding" "in string expansion" .cindex "&%str2b64%& expansion item" -This operator converts a string into one that is base64 encoded. +Now deprecated, a synonym for the &%base64%& expansion operator. @@ -10426,6 +10567,21 @@ This forces the letters in the string into upper-case. .cindex "expansion" "utf-8 forcing" .cindex "&%utf8clean%& expansion item" This replaces any invalid utf-8 sequence in the string by the character &`?`&. + +.vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&& + "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&& + "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&& + "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&" +.cindex expansion UTF-8 +.cindex UTF-8 expansion +.cindex EAI +.cindex internationalisation +.cindex "&%utf8_domain_to_alabel%& expansion item" +.cindex "&%utf8_domain_from_alabel%& expansion item" +.cindex "&%utf8_localpart_to_alabel%& expansion item" +.cindex "&%utf8_localpart_from_alabel%& expansion item" +These convert EAI mail name components between UTF-8 and a-label forms. +For information on internationalisation support see &<>&. .endlist @@ -11122,7 +11278,8 @@ support for TLS or the content scanning extension. When a &%match%& expansion condition succeeds, these variables contain the captured substrings identified by the regular expression during subsequent processing of the success string of the containing &%if%& expansion item. -However, they do not retain their values afterwards; in fact, their previous +In the expansion condition case +they do not retain their values afterwards; in fact, their previous values are restored at the end of processing an &%if%& item. The numerical variables may also be set externally by some other matching process which precedes the expansion of the string. For example, the commands available in @@ -11221,7 +11378,7 @@ this variable holds the pipe command when the transport is running. .vitem "&$auth1$& &-- &$auth3$&" .vindex "&$auth1$&, &$auth2$&, etc" These variables are used in SMTP authenticators (see chapters -&<>&&--&<>&). Elsewhere, they are empty. +&<>&&--&<>&). Elsewhere, they are empty. .vitem &$authenticated_id$& .cindex "authentication" "id" @@ -11330,9 +11487,10 @@ not the same as the user id of the originator of a message (see &$originator_uid$&). If Exim re-execs itself, this variable in the new incarnation normally contains the Exim uid. -.vitem &$compile_date$& -.vindex "&$compile_date$&" -The date on which the Exim binary was compiled. +.vitem &$callout_address$& +.vindex "&$callout_address$&" +After a callout for verification, spamd or malware daemon service, the +address that was connected to. .vitem &$compile_number$& .vindex "&$compile_number$&" @@ -11340,7 +11498,6 @@ The building process for Exim keeps a count of the number of times it has been compiled. This serves to distinguish different compilations of the same version of the program. -.new .vitem &$config_dir$& .vindex "&$config_dir$&" The directory name of the main configuration file. That is, the content of @@ -11351,21 +11508,7 @@ contain the trailing slash. If &$config_file$& does not contain a slash, .vitem &$config_file$& .vindex "&$config_file$&" The name of the main configuration file Exim is using. -.wen - -.vitem &$demime_errorlevel$& -.vindex "&$demime_errorlevel$&" -This variable is available when Exim is compiled with -the content-scanning extension and the obsolete &%demime%& condition. For -details, see section &<>&. - -.vitem &$demime_reason$& -.vindex "&$demime_reason$&" -This variable is available when Exim is compiled with the -content-scanning extension and the obsolete &%demime%& condition. For details, -see section &<>&. -.new .vitem &$dkim_cur_signer$& &&& &$dkim_verify_status$& &&& &$dkim_verify_reason$& &&& @@ -11384,7 +11527,8 @@ see section &<>&. &$dkim_key_nosubdomains$& &&& &$dkim_key_srvtype$& &&& &$dkim_key_granularity$& &&& - &$dkim_key_notes$& + &$dkim_key_notes$& &&& + &$dkim_key_length$& These variables are only available within the DKIM ACL. For details see chapter &<>&. @@ -11393,7 +11537,6 @@ For details see chapter &<>&. When a message has been received this variable contains a colon-separated list of signer domains and identities for the message. For details see chapter &<>&. -.wen .vitem &$dnslist_domain$& &&& &$dnslist_matched$& &&& @@ -11490,20 +11633,12 @@ This variable contains the path to the Exim binary. .vindex "&$exim_uid$&" This variable contains the numerical value of the Exim user id. -.new .vitem &$exim_version$& .vindex "&$exim_version$&" This variable contains the version string of the Exim build. The first character is a major version number, currently 4. Then after a dot, the next group of digits is a minor version number. There may be other characters following the minor version. -.wen - -.vitem &$found_extension$& -.vindex "&$found_extension$&" -This variable is available when Exim is compiled with the -content-scanning extension and the obsolete &%demime%& condition. For details, -see section &<>&. .vitem &$header_$&<&'name'&> This is not strictly an expansion variable. It is expansion syntax for @@ -11526,7 +11661,8 @@ explicitly set a home directory for use by a transport; this can be overridden by a setting on the transport itself. When running a filter test via the &%-bf%& option, &$home$& is set to the value -of the environment variable HOME. +of the environment variable HOME, which is subject to the +&%keep_environment%& and &%add_environment%& main config options. .vitem &$host$& .vindex "&$host$&" @@ -11602,6 +11738,12 @@ See &$host_lookup_deferred$&. This variable is set to the remote host's TCP port whenever &$host$& is set for an outbound connection. +.vitem &$initial_cwd$& +.vindex "&$initial_cwd$& +This variable contains the full path name of the initial working +directory of the current Exim process. This may differ from the current +working directory, as Exim changes this to "/" during early startup, and +to &$spool_directory$& later. .vitem &$inode$& .vindex "&$inode$&" @@ -11762,11 +11904,9 @@ a dnsdb lookup expansion, dnslookup router or smtp transport. It will be empty if &(DNSSEC)& was not requested, &"no"& if the result was not labelled as authenticated data and &"yes"& if it was. -.new -Results that are labelled as authoritive answer that match +Results that are labelled as authoritative answer that match the &%dns_trust_aa%& configuration variable count also as authenticated data. -.wen .vitem &$mailstore_basename$& .vindex "&$mailstore_basename$&" @@ -11999,6 +12139,20 @@ a single-component name, Exim calls &[gethostbyname()]& (or qualified host name. See also &$smtp_active_hostname$&. +.vitem &$proxy_external_address$& &&& + &$proxy_external_port$& &&& + &$proxy_local_address$& &&& + &$proxy_local_port$& &&& + &$proxy_session$& +These variables are only available when built with Proxy Protocol +or Socks5 support +For details see chapter &<>&. + +.vitem &$prdr_requested$& +.cindex "PRDR" "variable for" +This variable is set to &"yes"& if PRDR was requested by the client for the +current message, otherwise &"no"&. + .vitem &$prvscheck_address$& This variable is used in conjunction with the &%prvscheck%& expansion item, which is described in sections &<>& and @@ -12177,6 +12331,12 @@ increases for each accepted recipient. It can be referenced in an ACL. This variable is set to contain the matching regular expression after a &%regex%& ACL condition has matched (see section &<>&). +.vitem "&$regex1$&, &$regex2$&, etc" +.cindex "regex submatch variables (&$1regex$& &$2regex$& etc)" +When a &%regex%& or &%mime_regex%& ACL condition succeeds, +these variables contain the +captured substrings identified by the regular expression. + .vitem &$reply_address$& .vindex "&$reply_address$&" @@ -12281,13 +12441,11 @@ verification either failed or was not requested. A host name in parentheses is the argument of a HELO or EHLO command. This is omitted if it is identical to the verified host name or to the host's IP address in square brackets. -.new .vitem &$sender_helo_dnssec$& .vindex "&$sender_helo_dnssec$&" This boolean variable is true if a successful HELO verification was .cindex "DNS" "DNSSEC" -done using DNS information the resolver library stated was authenticatied data. -.wen +done using DNS information the resolver library stated was authenticated data. .vitem &$sender_helo_name$& .vindex "&$sender_helo_name$&" @@ -12326,7 +12484,7 @@ dns_dnssec_ok = 1 .endd Exim does not perform DNSSEC validation itself, instead leaving that to a -validating resolver (eg, unbound, or bind with suitable configuration). +validating resolver (e.g. unbound, or bind with suitable configuration). If you have changed &%host_lookup_order%& so that &`bydns`& is not the first mechanism in the list, then this variable will be false. @@ -12552,6 +12710,7 @@ If TLS has not been negotiated, the value will be 0. .vitem &$tls_in_ourcert$& .vindex "&$tls_in_ourcert$&" +.cindex certificate veriables This variable refers to the certificate presented to the peer of an inbound connection when the message was received. It is only useful as the argument of a @@ -12565,10 +12724,8 @@ inbound connection when the message was received. It is only useful as the argument of a &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator, or a &%def%& condition. -.new If certificate verification fails it may refer to a failing chain element which is not the leaf. -.wen .vitem &$tls_out_ourcert$& .vindex "&$tls_out_ourcert$&" @@ -12583,17 +12740,15 @@ This variable refers to the certificate presented by the peer of an outbound connection. It is only useful as the argument of a &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator, or a &%def%& condition. -.new If certificate verification fails it may refer to a failing chain element which is not the leaf. -.wen .vitem &$tls_in_certificate_verified$& .vindex "&$tls_in_certificate_verified$&" This variable is set to &"1"& if a TLS certificate was verified when the message was received, and &"0"& otherwise. -The deprecated &$tls_certificate_verfied$& variable refers to the inbound side +The deprecated &$tls_certificate_verified$& variable refers to the inbound side except when used in the context of an outbound SMTP delivery, when it refers to the outbound. @@ -12646,14 +12801,13 @@ See &$tls_in_ocsp$& for values. .vitem &$tls_in_peerdn$& .vindex "&$tls_in_peerdn$&" .vindex "&$tls_peerdn$&" +.cindex certificate "extracting fields" When a message is received from a remote host over an encrypted SMTP connection, and Exim is configured to request a certificate from the client, the value of the Distinguished Name of the certificate is made available in the &$tls_in_peerdn$& during subsequent processing. -.new If certificate verification fails it may refer to a failing chain element which is not the leaf. -.wen The deprecated &$tls_peerdn$& variable refers to the inbound side except when used in the context of an outbound SMTP delivery, when it refers to @@ -12665,10 +12819,8 @@ When a message is being delivered to a remote host over an encrypted SMTP connection, and Exim is configured to request a certificate from the server, the value of the Distinguished Name of the certificate is made available in the &$tls_out_peerdn$& during subsequent processing. -.new If certificate verification fails it may refer to a failing chain element which is not the leaf. -.wen .vitem &$tls_in_sni$& .vindex "&$tls_in_sni$&" @@ -12825,6 +12977,17 @@ overriding the setting of &%perl_at_start%&. There is also a command line option &%-pd%& (for delay) which suppresses the initial startup, even if &%perl_at_start%& is set. +.new +.ilist +.oindex "&%perl_taintmode%&" +.cindex "Perl" "taintmode" +To provide more security executing Perl code via the embedded Perl +interpeter, the &%perl_taintmode%& option can be set. This enables the +taint mode of the Perl interpreter. You are encouraged to set this +option to a true value. To avoid breaking existing installations, it +defaults to false. +.wen + .section "Calling Perl subroutines" "SECID86" When the configuration file includes a &%perl_startup%& option you can make use @@ -13292,6 +13455,7 @@ listed in more than one group. .section "Logging" "SECID99" .table2 +.row &%event_action%& "custom logging" .row &%hosts_connection_nolog%& "exemption from connect logging" .row &%log_file_path%& "override compiled-in value" .row &%log_selector%& "set/unset optional logging" @@ -13352,6 +13516,7 @@ listed in more than one group. .table2 .row &%perl_at_start%& "always start the interpreter" .row &%perl_startup%& "code to obey when starting Perl" +.row &%perl_taintmode%& "enable taint mode in Perl" .endtable @@ -13433,6 +13598,7 @@ listed in more than one group. .row &%helo_verify_hosts%& "HELO hard-checked for these hosts" .row &%host_lookup%& "host name looked up for these hosts" .row &%host_lookup_order%& "order of DNS and local name lookups" +.row &%hosts_proxy%& "use proxy protocol for these hosts" .row &%host_reject_connection%& "reject connection from these hosts" .row &%hosts_treat_as_local%& "useful in some cluster configurations" .row &%local_scan_timeout%& "timeout for &[local_scan()]&" @@ -13567,6 +13733,7 @@ See also the &'Policy controls'& section above. .row &%ignore_fromline_local%& "allow &""From ""& from local SMTP" .row &%pipelining_advertise_hosts%& "advertise pipelining to these hosts" .row &%prdr_enable%& "advertise PRDR to all hosts" +.row &%smtputf8_advertise_hosts%& "advertise SMTPUTF8 to these hosts" .row &%tls_advertise_hosts%& "advertise TLS to these hosts" .endtable @@ -13642,6 +13809,7 @@ See also the &'Policy controls'& section above. .row &%bounce_message_file%& "content of bounce" .row &%bounce_message_text%& "content of bounce" .row &%bounce_return_body%& "include body if returning message" +.row &%bounce_return_linesize_limit%& "limit on returned message line length" .row &%bounce_return_message%& "include original message in bounce" .row &%bounce_return_size_limit%& "limit on returned message" .row &%bounce_sender_authentication%& "send authenticated sender with bounce" @@ -13719,26 +13887,22 @@ This option defines the ACL that is run after an SMTP DATA command has been processed and the message itself has been received, but before the final acknowledgment is sent. See chapter &<>& for further details. -.new .option acl_smtp_data_prdr main string&!! accept .cindex "PRDR" "ACL for" .cindex "DATA" "PRDR ACL for" .cindex "&ACL;" "PRDR-related" .cindex "&ACL;" "per-user data processing" -.wen This option defines the ACL that, if the PRDR feature has been negotiated, is run for each recipient after an SMTP DATA command has been processed and the message itself has been received, but before the acknowledgment is sent. See chapter &<>& for further details. -.new .option acl_smtp_dkim main string&!! unset .cindex DKIM "ACL for" This option defines the ACL that is run for each DKIM signature of a received message. See chapter &<>& for further details. -.wen .option acl_smtp_etrn main string&!! unset .cindex "ETRN" "ACL for" @@ -13774,13 +13938,11 @@ This option is available when Exim is built with the content-scanning extension. It defines the ACL that is run for each MIME part in a message. See section &<>& for details. -.new .option acl_smtp_notquit main string&!! unset .cindex "not-QUIT, ACL for" This option defines the ACL that is run when an SMTP session ends without a QUIT command being received. See chapter &<>& for further details. -.wen .option acl_smtp_predata main string&!! unset This option defines the ACL that is run when an SMTP DATA command is @@ -13807,6 +13969,12 @@ received. See chapter &<>& for further details. This option defines the ACL that is run when an SMTP VRFY command is received. See chapter &<>& for further details. +.option add_environment main "string list" empty +.cindex "environment" "set values" +This option allows to set individual environment variables that the +currently linked libraries and programs in child processes use. +See &<>& for the environment of &(pipe)& transports. + .option admin_groups main "string list&!!" unset .cindex "admin user" This option is expanded just once, at the start of Exim's processing. If the @@ -13838,7 +14006,7 @@ the local host's IP addresses. It appears that more and more DNS zone administrators are breaking the rules and putting domain names that look like IP addresses on the right hand side of MX records. Exim follows the rules and rejects this, giving an error message -that explains the mis-configuration. However, some other MTAs support this +that explains the misconfiguration. However, some other MTAs support this practice, so to avoid &"Why can't Exim do this?"& complaints, &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not recommended, except when you have no other choice. @@ -13956,6 +14124,24 @@ error that is detected during reception, only those header lines preceding the point at which the error was detected are returned. .cindex "bounce message" "including original" +.option bounce_return_linesize_limit main integer 998 +.cindex "size" "of bounce lines, limit" +.cindex "bounce message" "line length limit" +.cindex "limit" "bounce message line length" +This option sets a limit in bytes on the line length of messages +that are returned to senders due to delivery problems, +when &%bounce_return_message%& is true. +The default value corresponds to RFC limits. +If the message being returned has lines longer than this value it is +treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded. + +The option also applies to bounces returned when an error is detected +during reception of a message. +In this case lines from the original are truncated. + +The option does not apply to messages generated by an &(autoreply)& transport. + + .option bounce_return_message main boolean true If this option is set false, none of the original message is included in bounce messages generated by Exim. See also &%bounce_return_size_limit%& and @@ -14217,14 +14403,12 @@ etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines to handle IPv6 literal addresses. -.new .option dkim_verify_signers main "domain list&!!" $dkim_signers .cindex DKIM "controlling calls to the ACL" This option gives a list of DKIM domains for which the DKIM ACL is run. It is expanded after the message is received; by default it runs the ACL once for each signature in the message. See chapter &<>&. -.wen .option dns_again_means_nonexist main "domain list&!!" unset @@ -14313,16 +14497,13 @@ take. I haven't found any documentation about timeouts on DNS lookups; these parameter values are available in the external resolver interface structure, but nowhere does it seem to describe how they are used or what you might want to set in them. -.new See also the &%slow_lookup_log%& option. -.wen .option dns_retry main integer 0 See &%dns_retrans%& above. -.new .option dns_trust_aa main "domain list&!!" unset .cindex "DNS" "resolver options" .cindex "DNS" "DNSSEC" @@ -14332,22 +14513,21 @@ DNSSEC-verified. The authority section's name of the answer must match with this expanded domain list. Use this option only if you talk directly to a resolver that is -authoritive for some zones and does not set the AD (Authentic Data) +authoritative for some zones and does not set the AD (Authentic Data) bit in the answer. Some DNS servers may have an configuration option to mark the answers from their own zones as verified (they set the AD bit). Others do not have this option. It is considered as poor practice using -a resolver that is an authoritive server for some zones. +a resolver that is an authoritative server for some zones. Use this option only if you really have to (e.g. if you want to use DANE for remote delivery to a server that is listed in the DNS -zones that your resolver is authoritive for). +zones that your resolver is authoritative for). If the DNS answer packet has the AA bit set and contains resource record in the answer section, the name of the first NS record appearing in the authority section is compared against the list. If the answer packet is -authoritive but the answer section is empty, the name of the first SOA -record in the authoritive section is used instead. -.wen +authoritative but the answer section is empty, the name of the first SOA +record in the authoritative section is used instead. .cindex "DNS" "resolver options" .option dns_use_edns0 main integer -1 @@ -14366,7 +14546,6 @@ This is an obsolete option that is now a no-op. It used to affect the way Exim handled CR and LF characters in incoming messages. What happens now is described in section &<>&. -.new .option dsn_advertise_hosts main "host list&!!" unset .cindex "bounce messages" "success" .cindex "DSN" "success" @@ -14378,7 +14557,6 @@ and RET and ORCPT options on MAIL FROM commands. A NOTIFY=SUCCESS option requests success-DSN messages. A NOTIFY= option with no argument requests that no delay or failure DSNs are sent. -.wen .option dsn_from main "string&!!" "see below" .cindex "&'From:'& header line" "in bounces" @@ -14397,7 +14575,7 @@ panic is logged, and the default value is used. Exim's transports have an option for adding an &'Envelope-to:'& header to a message when it is delivered, in exactly the same way as &'Return-path:'& is handled. &'Envelope-to:'& records the original recipient address from the -messages's envelope that caused the delivery to happen. Such headers should not +message's envelope that caused the delivery to happen. Such headers should not be present in incoming messages, and this option causes them to be removed at the time the message is received, to avoid any problems that might occur when a delivered message is subsequently sent on to some other recipient. @@ -14457,6 +14635,12 @@ own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is not used. +.option event_action main string&!! unset +.cindex events +This option declares a string to be expanded for Exim's events mechanism. +For details see &<>&. + + .option exim_group main string "compile-time configured" .cindex "gid (group id)" "Exim's own" .cindex "Exim group" @@ -14504,7 +14688,7 @@ routing, but which are not used for listening by the daemon. See section . Allow this long option name to split; give it unsplit as a fifth argument . for the automatic .oindex that is generated by .option. -.option "extract_addresses_remove_ &~&~arguments" main boolean true &&& +.option "extract_addresses_remove_arguments" main boolean true &&& extract_addresses_remove_arguments .oindex "&%-t%&" .cindex "command line" "addresses with &%-t%&" @@ -14802,6 +14986,12 @@ If the &%smtp_connection%& log selector is not set, this option has no effect. +.option hosts_proxy main "host list&!!" unset +.cindex proxy "proxy protocol" +This option enables use of Proxy Protocol proxies for incoming +connections. For details see &<>&. + + .option hosts_treat_as_local main "domain list&!!" unset .cindex "local host" "domains treated as" .cindex "host" "treated as local" @@ -14868,6 +15058,34 @@ process rather than a remote host, and is using &%-bs%& to inject the messages, .option ignore_fromline_local main boolean false See &%ignore_fromline_hosts%& above. +.option keep_environment main "string list" unset +.cindex "environment" "values from" +This option contains a string list of environment variables to keep. +You have to trust these variables or you have to be sure that +these variables do not impose any security risk. Keep in mind that +during the startup phase Exim is running with an effective UID 0 in most +installations. As the default value is an empty list, the default +environment for using libraries, running embedded Perl code, or running +external binaries is empty, and does not not even contain PATH or HOME. + +Actually the list is interpreted as a list of patterns +(&<>&), except that it is not expanded first. + +WARNING: Macro substitution is still done first, so having a macro +FOO and having FOO_HOME in your &%keep_environment%& option may have +unexpected results. You may work around this using a regular expression +that does not match the macro name: ^[F]OO_HOME$. + +Current versions of Exim issue a warning during startup if you do not mention +&%keep_environment%& in your runtime configuration file and if your +current environment is not empty. Future versions may not issue that warning +anymore. + +See the &%add_environment%& main config option for a way to set +environment variables to a fixed value. The environment for &(pipe)& +transports is handled separately, see section &<>& for +details. + .option keep_malformed main time 4d This option specifies the length of time to keep messages whose spool files @@ -14878,6 +15096,7 @@ logged. .option ldap_ca_cert_dir main string unset .cindex "LDAP", "TLS CA certificate directory" +.cindex certificate "directory for LDAP" This option indicates which directory contains CA certificates for verifying a TLS certificate presented by an LDAP server. While Exim does not provide a default value, your SSL library may. @@ -14887,6 +15106,7 @@ and constrained to be a directory. .option ldap_ca_cert_file main string unset .cindex "LDAP", "TLS CA certificate file" +.cindex certificate "file for LDAP" This option indicates which file contains CA certificates for verifying a TLS certificate presented by an LDAP server. While Exim does not provide a default value, your SSL library may. @@ -14896,6 +15116,7 @@ and constrained to be a file. .option ldap_cert_file main string unset .cindex "LDAP" "TLS client certificate file" +.cindex certificate "file for LDAP" This option indicates which file contains an TLS client certificate which Exim should present to the LDAP server during TLS negotiation. Should be used together with &%ldap_cert_key%&. @@ -14903,6 +15124,7 @@ Should be used together with &%ldap_cert_key%&. .option ldap_cert_key main string unset .cindex "LDAP" "TLS client key file" +.cindex certificate "key for LDAP" This option indicates which file contains the secret/private key to use to prove identity to the LDAP server during TLS negotiation. Should be used together with &%ldap_cert_file%&, which contains the @@ -15221,7 +15443,7 @@ If you use a virus-scanner and set this option to to a value larger than the maximum size that your virus-scanner is configured to support, you may get failures triggered by large mails. The right size to configure for the virus-scanner depends upon what data is passed and the options in use but it's -probably safest to just set it to a little larger than this value. Eg, with a +probably safest to just set it to a little larger than this value. E.g., with a default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M, some problems may result. @@ -15281,7 +15503,7 @@ harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)& transport driver. -.option openssl_options main "string list" "+no_sslv2" +.option openssl_options main "string list" "+no_sslv2 +single_dh_use" .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, @@ -15412,14 +15634,20 @@ local parts. Exim's default configuration does this. .option perl_at_start main boolean false +.cindex "Perl" This option is available only when Exim is built with an embedded Perl interpreter. See chapter &<>& for details of its use. .option perl_startup main string unset +.cindex "Perl" This option is available only when Exim is built with an embedded Perl interpreter. See chapter &<>& for details of its use. +.option perl_startup main boolean false +.cindex "Perl" +This Option enables the taint mode of the embedded Perl interpreter. + .option pgsql_servers main "string list" unset .cindex "PostgreSQL lookup type" "server list" @@ -15463,7 +15691,7 @@ to SMTP, defined by Eric Hall. If the option is set, PRDR is advertised by Exim when operating as a server. If the client requests PRDR, and more than one recipient, for a message an additional ACL is called for each recipient after the message content -is recieved. See section &<>&. +is received. See section &<>&. .option preserve_message_logs main boolean false .cindex "message logs" "preserving" @@ -15876,7 +16104,6 @@ the time of delivery. They are normally used only for final local deliveries. This option is an obsolete synonym for &%bounce_return_size_limit%&. -.new .option rfc1413_hosts main "host list&!!" @[] .cindex "RFC 1413" .cindex "host" "for RFC 1413 calls" @@ -15884,11 +16111,8 @@ RFC 1413 identification calls are made to any client host which matches an item in the list. The default value specifies just this host, being any local interface for the system. -.wen -.new .option rfc1413_query_timeout main time 0s -.wen .cindex "RFC 1413" "query timeout" .cindex "timeout" "for RFC 1413 call" This sets the timeout on RFC 1413 identification calls. If it is set to zero, @@ -15906,8 +16130,13 @@ it qualifies them only if the message came from a host that matches &%sender_unqualified_hosts%&, or if the message was submitted locally (not using TCP/IP), and the &%-bnq%& option was not set. +.option set_environment main "string list" empty +.cindex "environment" +This option allows to set individual environment variables that the +currently linked libraries and programs in child processes use. The +default list is empty, + -.new .option slow_lookup_log main integer 0 .cindex "logging" "slow lookups" .cindex "dns" "logging slow lookups" @@ -15915,7 +16144,6 @@ This option controls logging of slow lookups. If the value is nonzero it is taken as a number of milliseconds and lookups taking longer than this are logged. Currently this applies only to DNS lookups. -.wen @@ -16309,11 +16537,9 @@ SMTP data timeout on connection from... The former means that Exim was expecting to read an SMTP command; the latter means that it was in the DATA phase, reading the contents of a message. -.new If the first character of the option is a &"$"& the option is expanded before use and may depend on &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&. -.wen .oindex "&%-os%&" @@ -16344,6 +16570,15 @@ example, instead of &"Administrative prohibition"&, it might give: 550 failing address in "From" header is: >& for details of Exim's support for internationalisation. + + .option spamd_address main string "see below" This option is available when Exim is compiled with the content-scanning extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon. @@ -16572,6 +16807,7 @@ messages that are released by &%ignore_bounce_errors_after%&). .option timezone main string unset .cindex "timezone, setting" +.cindex "environment" "values from" The value of &%timezone%& is used to set the environment variable TZ while running Exim (if it is different on entry). This ensures that all timestamps created by Exim are in the required timezone. If you want all your timestamps @@ -16587,7 +16823,7 @@ runs. This is appropriate behaviour for obtaining wall-clock time on some, but unfortunately not all, operating systems. -.option tls_advertise_hosts main "host list&!!" unset +.option tls_advertise_hosts main "host list&!!" * .cindex "TLS" "advertising" .cindex "encryption" "on SMTP connection" .cindex "SMTP" "encrypted connection" @@ -16595,6 +16831,9 @@ When Exim is built with support for TLS encrypted connections, the availability of the STARTTLS command to set up an encrypted session is advertised in response to EHLO only to those client hosts that match this option. See chapter &<>& for details of Exim's support for TLS. +Note that the default value requires that a certificate be supplied +using the &%tls_certificate%& option. If no certificate is available then +the &%tls_advertise_hosts%& option should be set empty. .option tls_certificate main string&!! unset @@ -16700,7 +16939,6 @@ prior to the 4.80 release, as Debian used to patch Exim to raise the minimum acceptable bound from 1024 to 2048. -.new .option tls_eccurve main string&!! prime256v1 .cindex TLS "EC cryptography" If built with a recent-enough version of OpenSSL, @@ -16709,10 +16947,9 @@ this option selects a EC curve for use by Exim. Curve names of the form &'prime256v1'& are accepted. For even more-recent library versions, names of the form &'P-512'& are also accepted, plus the special value &'auto'& -which tell the library to choose. +which tells the library to choose. If the option is set to an empty string, no EC curves will be enabled. -.wen .option tls_ocsp_file main string&!! unset @@ -16723,6 +16960,8 @@ must if set expand to the absolute path to a file which contains a current status proof for the server's certificate, as obtained from the Certificate Authority. +Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later). + .option tls_on_connect_ports main "string list" unset .cindex SSMTP @@ -16773,7 +17012,6 @@ preference order of the available ciphers. Details are given in sections See &%tls_verify_hosts%& below. -.new .option tls_verify_certificates main string&!! system .cindex "TLS" "client certificate verification" .cindex "certificate" "verification of client" @@ -16789,14 +17027,13 @@ This is not available for GnuTLS versions preceding 3.0.20, and will be taken as empty; an explicit location must be specified. -The use of a directory for the option value is not avilable for GnuTLS versions +The use of a directory for the option value is not available for GnuTLS versions preceding 3.3.6 and a single file must be used. With OpenSSL the certificates specified explicitly either by file or directory are added to those given by the system default location. -.wen These certificates should be for the certificate authorities trusted, rather than the public cert of individual clients. With both OpenSSL and GnuTLS, if @@ -17236,7 +17473,6 @@ or for any deliveries caused by this router. You should not set this option unless you really, really know what you are doing. See also the generic transport option of the same name. -.new .option dnssec_request_domains routers "domain list&!!" unset .cindex "MX record" "security" .cindex "DNSSEC" "MX lookup" @@ -17255,7 +17491,6 @@ DNS lookups for domains matching &%dnssec_request_domains%& will be done with the dnssec request bit set. Any returns not having the Authenticated Data bit (AD bit) set will be ignored and logged as a host-lookup failure. This applies to all of the SRV, MX, AAAA, A lookup sequence. -.wen .option domains routers&!? "domain list&!!" unset @@ -17274,7 +17509,6 @@ This option must always be set. It specifies which of the available routers is to be used. -.new .option dsn_lasthop routers boolean false .cindex "DSN" "success" .cindex "Delivery Status Notification" "success" @@ -17282,7 +17516,6 @@ If this option is set true, and extended DSN (RFC3461) processing is in effect, Exim will not pass on DSN requests to downstream DSN-aware hosts but will instead send a success DSN as if the next hop does not support DSN. Not effective on redirect routers. -.wen @@ -17407,9 +17640,7 @@ and the discussion in chapter &<>&. .cindex "header lines" "adding" .cindex "router" "adding header lines" This option specifies a list of text headers, -.new newline-separated (by default, changeable in the usual way), -.wen 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 @@ -17447,9 +17678,7 @@ avoided. The &%repeat_use%& option of the &%redirect%& router may be of help. .cindex "header lines" "removing" .cindex "router" "removing header lines" This option specifies a list of text headers, -.new colon-separated (by default, changeable in the usual way), -.wen 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 @@ -17475,11 +17704,9 @@ removal requests are deleted when the address is passed on to subsequent routers, and this can lead to problems with duplicates -- see the similar warning for &%headers_add%& above. -.new &*Warning 3*&: Because of the separate expansion of the list items, items that contain a list separator must have it doubled. To avoid this, change the list separator (&<>&). -.wen @@ -18213,7 +18440,7 @@ happens is controlled by the generic &%self%& option. .section "Problems with DNS lookups" "SECTprowitdnsloo" There have been problems with DNS servers when SRV records are looked up. -Some mis-behaving servers return a DNS error or timeout when a non-existent +Some misbehaving servers return a DNS error or timeout when a non-existent SRV record is sought. Similar problems have in the past been reported for MX records. The global &%dns_again_means_nonexist%& option can help with this problem, but it is heavy-handed because it is a global option. @@ -18235,10 +18462,8 @@ There are a few cases where a &(dnslookup)& router will decline to accept an address; if such a router is expected to handle "all remaining non-local domains", then it is important to set &%no_more%&. -.new The router will defer rather than decline if the domain is found in the &%fail_defer_domains%& router option. -.wen Reasons for a &(dnslookup)& router to decline currently include: .ilist @@ -18319,7 +18544,6 @@ when there is a DNS lookup error. -.new .option fail_defer_domains dnslookup "domain list&!!" unset .cindex "MX record" "not found" DNS lookups for domains matching &%fail_defer_domains%& @@ -18329,7 +18553,6 @@ This maybe be useful for queueing messages for a newly created domain while the DNS configuration is not ready. However, it will result in any message with mistyped domains also being queued. -.wen .option mx_domains dnslookup "domain list&!!" unset @@ -19300,12 +19523,10 @@ However, there are some private options which define transports for delivery to files and pipes, and for generating autoreplies. See the &%file_transport%&, &%pipe_transport%& and &%reply_transport%& descriptions below. -.new If success DSNs have been requested .cindex "DSN" "success" .cindex "Delivery Status Notification" "success" redirection triggers one and the DSN options are not passed any further. -.wen @@ -19573,7 +19794,7 @@ the router to decline. Instead, the alias item .cindex "black hole" .cindex "abandoning mail" &':blackhole:'& can be used. It does what its name implies. No delivery is -done, and no error message is generated. This has the same effect as specifing +done, and no error message is generated. This has the same effect as specifying &_/dev/null_& as a destination, but it can be independently disabled. &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no @@ -20227,7 +20448,7 @@ See &%skip_syntax_errors%& above. .chapter "Environment for running local transports" "CHAPenvironment" &&& "Environment for local transports" .scindex IIDenvlotra1 "local transports" "environment for" -.scindex IIDenvlotra2 "environment for local transports" +.scindex IIDenvlotra2 "environment" "local transports" .scindex IIDenvlotra3 "transport" "local; environment for" Local transports handle deliveries to files and pipes. (The &(autoreply)& transport can be thought of as similar to a pipe.) Exim always runs transports @@ -20489,6 +20710,12 @@ its removal from incoming messages, so that delivered messages can safely be resent to other recipients. +.option event_action transports string&!! unset +.cindex events +This option declares a string to be expanded for Exim's events mechanism. +For details see &<>&. + + .option group transports string&!! "Exim group" .cindex "transport" "group; specifying" This option specifies a gid for running the transport process, overriding any @@ -20500,9 +20727,7 @@ value that the router supplies, and also overriding any value associated with .cindex "header lines" "adding in transport" .cindex "transport" "header lines; adding" This option specifies a list of text headers, -.new newline-separated (by default, changeable in the usual way), -.wen which are (separately) expanded and added to the header portion of a message as it is transported, as described in section &<>&. Additional header lines can also be specified by @@ -20528,9 +20753,7 @@ checked, since this option does not automatically suppress them. .cindex "header lines" "removing" .cindex "transport" "header lines; removing" This option specifies a list of header names, -.new colon-separated (by default, changeable in the usual way); -.wen these headers are omitted from the message as it is transported, as described in section &<>&. Header removal can also be specified by routers. @@ -20594,6 +20817,30 @@ transport, the &[initgroups()]& function is called when running the transport to ensure that any additional groups associated with the uid are set up. +.option max_parallel transports integer&!! unset +.cindex limit "transport parallelism" +.cindex transport "parallel processes" +.cindex transport "concurrency limit" +.cindex "delivery" "parallelism for transport" +If this option is set and expands to an integer greater than zero +it limits the number of concurrent runs of the transport. +The control does not apply to shadow transports. + +.cindex "hints database" "transport concurrency control" +Exim implements this control by means of a hints database in which a record is +incremented whenever a transport process is beaing created. The record +is decremented and possibly removed when the process terminates. +Obviously there is scope for +records to get left lying around if there is a system or program crash. To +guard against this, Exim ignores any records that are more than six hours old. + +If you use this option, you should also arrange to delete the +relevant hints database whenever your system reboots. The names of the files +start with &_misc_& and they are kept in the &_spool/db_& directory. There +may be one or two files, depending on the type of DBM in use. The same files +are used for ETRN and smtp transport serialization. + + .option message_size_limit transports string&!! 0 .cindex "limit" "message size per transport" .cindex "size" "of message, limit" @@ -20740,6 +20987,7 @@ headers that some sites insist on. This option sets up a filtering (in the Unix shell sense) process for messages at transport time. It should not be confused with mail filtering as set up by individual users or via a system filter. +If unset, or expanding to an empty string, no filtering is done. When the message is about to be written out, the command specified by &%transport_filter%& is started up in a separate, parallel process, and @@ -22491,6 +22739,8 @@ If two messages arrive at almost the same time, and both are routed to a pipe delivery, the two pipe transports may be run concurrently. You must ensure that any pipe commands you set up are robust against this happening. If the commands write to a file, the &%exim_lock%& utility might be of use. +Alternatively the &%max_parallel%& option could be used with a value +of "1" to enforce serialization. @@ -22610,11 +22860,12 @@ with &%use_shell%&, and the whole mechanism is inherently less secure. .section "Environment variables" "SECTpipeenv" .cindex "&(pipe)& transport" "environment for command" -.cindex "environment for pipe transport" +.cindex "environment" "&(pipe)& transport" The environment variables listed below are set up when the command is invoked. This list is a compromise for maximum compatibility with other MTAs. Note that the &%environment%& option can be used to add additional variables to this -environment. +environment. The environment for the &(pipe)& transport is not subject +to the &%add_environment%& and &%keep_environment%& main config options. .display &`DOMAIN `& the domain of the address &`HOME `& the home directory, if set @@ -22709,7 +22960,7 @@ Exim, and each argument is separately expanded, as described in section .option environment pipe string&!! unset .cindex "&(pipe)& transport" "environment for command" -.cindex "environment for &(pipe)& transport" +.cindex "environment" "&(pipe)& transport" This option is used to add additional variables to the environment in which the command runs (see section &<>& for the default list). Its value is a string which is expanded, and then interpreted as a colon-separated list of @@ -22755,6 +23006,7 @@ Note that &$address_pipe$& is handled specially in &%command%& when &%force_command%& is set, expanding out to the original argument vector as separate items, similarly to a Unix shell &`"$@"`& construct. + .option ignore_status pipe boolean false If this option is true, the status returned by the subprocess that is set up to run the command is ignored, and Exim behaves as if zero had been returned. @@ -22765,27 +23017,29 @@ from the transport unless the status value is one of those listed in &*Note*&: This option does not apply to timeouts, which do not return a status. See the &%timeout_defer%& option for how timeouts are handled. + .option log_defer_output pipe boolean false .cindex "&(pipe)& transport" "logging output" If this option is set, and the status returned by the command is one of the codes listed in &%temp_errors%& (that is, delivery was deferred), -and any output was produced, the first line of it is written to the main log. +and any output was produced on stdout or stderr, the first line of it is +written to the main log. .option log_fail_output pipe boolean false -If this option is set, and the command returns any output, and also ends with a -return code that is neither zero nor one of the return codes listed in -&%temp_errors%& (that is, the delivery failed), the first line of output is -written to the main log. This option and &%log_output%& are mutually exclusive. -Only one of them may be set. - +If this option is set, and the command returns any output on stdout or +stderr, and also ends with a return code that is neither zero nor one of +the return codes listed in &%temp_errors%& (that is, the delivery +failed), the first line of output is written to the main log. This +option and &%log_output%& are mutually exclusive. Only one of them may +be set. .option log_output pipe boolean false -If this option is set and the command returns any output, the first line of -output is written to the main log, whatever the return code. This option and -&%log_fail_output%& are mutually exclusive. Only one of them may be set. - +If this option is set and the command returns any output on stdout or +stderr, the first line of output is written to the main log, whatever +the return code. This option and &%log_fail_output%& are mutually +exclusive. Only one of them may be set. .option max_output pipe integer 20K @@ -23215,6 +23469,15 @@ 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_selector smtp string&!! unset +.option dkim_private_key smtp string&!! unset +.option dkim_canon smtp string&!! unset +.option dkim_strict smtp string&!! unset +.option dkim_sign_headers smtp string&!! unset +DKIM signing options. For details see &<>&. + + .option delay_after_cutoff smtp boolean true This option controls what happens when all remote IP addresses for a given domain have been inaccessible for so long that they have passed their retry @@ -23270,7 +23533,7 @@ This applies to all of the SRV, MX, AAAA, A lookup sequence. .cindex "DNS" "DNSSEC" DNS lookups for domains matching &%dnssec_request_domains%& will be done with the dnssec request bit set. Any returns not having the Authenticated Data bit -(AD bit) set wil be ignored and logged as a host-lookup failure. +(AD bit) set will be ignored and logged as a host-lookup failure. This applies to all of the SRV, MX, AAAA, A lookup sequence. @@ -23422,13 +23685,11 @@ that matches this list, even if the server host advertises PIPELINING support. Exim will not try to start a TLS session when delivering to any host that matches this list. See chapter &<>& for details of TLS. -.new .option hosts_verify_avoid_tls smtp "host list&!!" unset .cindex "TLS" "avoiding for certain hosts" Exim will not try to start a TLS session for a verify callout, or when delivering in cutthrough mode, to any host that matches this list. -.wen .option hosts_max_try smtp integer 5 @@ -23525,14 +23786,12 @@ connects. If authentication fails, Exim will try to transfer the message unauthenticated. See also &%hosts_require_auth%&, and chapter &<>& for details of authentication. -.new .option hosts_try_prdr smtp "host list&!!" * .cindex "PRDR" "enabling, optional in client" This option provides a list of servers to which, provided they announce PRDR support, Exim will attempt to negotiate PRDR for multi-recipient messages. The option can usually be left as default. -.wen .option interface smtp "string list&!!" unset .cindex "bind IP address" @@ -23599,11 +23858,9 @@ handling only one domain at a time. This is useful if you want to use &$domain$& in an expansion for the transport, because it is set only when there is a single domain involved in a remote delivery. -.new It is expanded per-address and can depend on any of &$address_data$&, &$domain_data$&, &$local_part_data$&, &$host$&, &$host_address$& and &$host_port$&. -.wen .option port smtp string&!! "see below" .cindex "port" "sending TCP/IP" @@ -23633,7 +23890,7 @@ protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local deliveries into closed message stores. Exim also has support for running LMTP over a pipe to a local process &-- see chapter &<>&. -If this option is set to &"smtps"&, the default vaule for the &%port%& option +If this option is set to &"smtps"&, the default value for the &%port%& option changes to &"smtps"&, and the transport initiates TLS immediately after connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade. The Internet standards bodies strongly discourage use of this mode. @@ -23650,9 +23907,7 @@ However, in some dialup environments hosts are assigned a different IP address each time they connect. In this situation the use of the IP address as part of the retry key leads to undesirable behaviour. Setting this option false causes Exim to use only the host name. -.new Since it is expanded it can be made to depend on the host or domain. -.wen .option serialize_hosts smtp "host list&!!" unset @@ -23678,6 +23933,8 @@ start with &_misc_& and they are kept in the &_spool/db_& directory. There may be one or two files, depending on the type of DBM in use. The same files are used for ETRN serialization. +See also the &%max_parallel%& generic transport option. + .option size_addition smtp integer 1024 .cindex "SMTP" "SIZE" @@ -23696,6 +23953,12 @@ Alternatively, if the value of &%size_addition%& is set negative, it disables the use of the SIZE option altogether. +.option socks_proxy smtp string&!! unset +.cindex proxy SOCKS +This option enables use of SOCKS proxies for connections made by the +transport. For details see &<>&. + + .option tls_certificate smtp string&!! unset .cindex "TLS" "client certificate, location of" .cindex "certificate" "client, location of" @@ -23790,9 +24053,7 @@ unknown state), opens a new one to the same host, and then tries the delivery in clear. -.new .option tls_try_verify_hosts smtp "host list&!!" * -.wen .cindex "TLS" "server certificate verification" .cindex "certificate" "verification of server" This option gives a list of hosts for which, on encrypted connections, @@ -23805,7 +24066,6 @@ The &$tls_out_certificate_verified$& variable is set when certificate verification succeeds. -.new .option tls_verify_cert_hostnames smtp "host list&!!" * .cindex "TLS" "server certificate hostname verification" .cindex "certificate" "verification of server" @@ -23817,10 +24077,8 @@ versus Subject and Subject-Alternate-Name fields. Wildcard names are permitted limited to being the initial component of a 3-or-more component FQDN. There is no equivalent checking on client certificates. -.wen -.new .option tls_verify_certificates smtp string&!! system .cindex "TLS" "server certificate verification" .cindex "certificate" "verification of server" @@ -23837,9 +24095,8 @@ This is not available for GnuTLS versions preceding 3.0.20; a value of "system" is taken as empty and an explicit location must be specified. -The use of a directory for the option value is not avilable for GnuTLS versions +The use of a directory for the option value is not available for GnuTLS versions preceding 3.3.6 and a single file must be used. -.wen With OpenSSL the certificates specified explicitly @@ -23850,7 +24107,7 @@ The values of &$host$& and &$host_address$& are set to the name and address of the server during the expansion of this option. See chapter &<>& for details of TLS. -For back-compatability, +For back-compatibility, if neither tls_verify_hosts nor tls_try_verify_hosts are set (a single-colon empty list counts as being set) and certificate verification fails the TLS connection is closed. @@ -23859,7 +24116,7 @@ and certificate verification fails the TLS connection is closed. .option tls_verify_hosts smtp "host list&!!" unset .cindex "TLS" "server certificate verification" .cindex "certificate" "verification of server" -This option gives a list of hosts for which. on encrypted connections, +This option gives a list of hosts for which, on encrypted connections, certificate verification must succeed. The &%tls_verify_certificates%& option must also be set. If both this option and &%tls_try_verify_hosts%& are unset @@ -24335,7 +24592,7 @@ replaced, not just the working part. The replacement must be a complete RFC 2822 address, including the angle brackets if necessary. If text outside angle brackets contains a character whose value is greater than 126 or less than 32 (except for tab), the text is encoded according to RFC 2047. The character set -is taken from &%headers_charset%&, which defaults to ISO-8859-1. +is taken from &%headers_charset%&, which gets its default at build time. When the &"w"& flag is set on a rule that causes an envelope address to be rewritten, all but the working part of the replacement address is discarded. @@ -24607,14 +24864,12 @@ A server unexpectedly closed the SMTP connection. There may, of course, legitimate reasons for this (host died, network died), but if it repeats a lot for the same host, it indicates something odd. -.new .vitem &%lookup%& A DNS lookup for a host failed. Note that a &%dnslookup%& router will need to have matched its &%fail_defer_domains%& option for this retry type to be usable. Also note that a &%manualroute%& router will probably need its &%host_find_failed%& option set to &%defer%&. -.wen .vitem &%refused_MX%& A connection to a host obtained from an MX record was refused. @@ -25042,10 +25297,8 @@ The sixth can be configured to support the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is not formally documented, but used by several MUAs. The seventh authenticator supports Microsoft's &'Secure Password Authentication'& mechanism. -.new The eighth is an Exim authenticator but not an SMTP one; instead it can use information from a TLS negotiation. -.wen The authenticators are configured using the same syntax as other drivers (see section &<>&). If no authenticators are required, no @@ -25117,7 +25370,7 @@ client_condition = ${if !eq{$tls_out_cipher}{}} .option client_set_id authenticators string&!! unset When client authentication succeeds, this condition is expanded; the -result is used in the log lines for outbound messasges. +result is used in the log lines for outbound messages. Typically it will be the user name used for authentication. @@ -26135,7 +26388,7 @@ The value should be a pathname, with no &"file:"& prefix. .option server_service heimdal_gssapi string&!! "smtp" This option specifies the service identifier used, in conjunction with -&%server_hostname%&, for building the identifer for finding credentials +&%server_hostname%&, for building the identifier for finding credentials from the keytab. @@ -26255,7 +26508,6 @@ msn: . //////////////////////////////////////////////////////////////////////////// . //////////////////////////////////////////////////////////////////////////// -.new .chapter "The tls authenticator" "CHAPtlsauth" .scindex IIDtlsauth1 "&(tls)& authenticator" .scindex IIDtlsauth2 "authenticators" "&(tls)&" @@ -26280,7 +26532,7 @@ for which it must have been requested via the If an authenticator of this type is configured it is run before any SMTP-level communication is done, and can authenticate the connection. -If it does, SMTP suthentication is not offered. +If it does, SMTP authentication is not offered. A maximum of one authenticator of this type may be present. @@ -26316,9 +26568,26 @@ tls: } } } } server_set_id = ${if = {1}{${listcount:$auth1}} {$auth1}{}} .endd +This accepts a client certificate that is verifiable against any +of your configured trust-anchors +which usually means the full set of public CAs) +and which has a SAN with a good account name. +Note that the client cert is on the wire in-clear, including the SAN, +whereas a plaintext SMTP AUTH done inside TLS is not. + +. An alternative might use +. .code +. server_param1 = ${sha256:$tls_in_peercert} +. .endd +. to require one of a set of specific certs that define a given account +. (the verification is still required, but mostly irrelevant). +. This would help for per-device use. +. +. However, for the future we really need support for checking a +. user cert in LDAP - which probably wants a base-64 DER. + .ecindex IIDtlsauth1 .ecindex IIDtlsauth2 -.wen Note that because authentication is traditionally an SMTP operation, @@ -26772,9 +27041,7 @@ apply to all TLS connections. For any host that matches one of these options, Exim requests a certificate as part of the setup of the TLS session. The contents of the certificate are verified by comparing it with a list of expected certificates. -.new These may be the system default set (depending on library version), -.wen an explicit file or, depending on library version, a directory, identified by &%tls_verify_certificates%&. @@ -26850,7 +27117,7 @@ starts retrying to fetch an OCSP proof some time before its current proof expires. The downside is that it requires server support. Unless Exim is built with the support disabled, -or with GnuTLS earlier than version 3.1.3, +or with GnuTLS earlier than version 3.3.16 / 3.4.8 support for OCSP stapling is included. There is a global option called &%tls_ocsp_file%&. @@ -26937,11 +27204,9 @@ if it requests it. If the server is Exim, it will request a certificate only if If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it specifies a collection of expected server certificates. -.new These may be the system default set (depending on library version), -.wen a file or, -depnding on liibrary version, a directory, +depending on library version, a directory, must name a file or, for OpenSSL only (not GnuTLS), a directory. The client verifies the server's certificate @@ -27011,7 +27276,7 @@ client in the initial handshake, so that the server can examine the servername within and possibly choose to use different certificates and keys (and more) for this session. -This is analagous to HTTP's &"Host:"& header, and is the main mechanism by +This is analogous to HTTP's &"Host:"& header, and is the main mechanism by which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP address. @@ -27065,7 +27330,7 @@ arbitrary unverified data provided prior to authentication. The Exim developers are proceeding cautiously and so far no other TLS options are re-expanded. -When Exim is built againt OpenSSL, OpenSSL must have been built with support +When Exim is built against OpenSSL, OpenSSL must have been built with support for TLS Extensions. This holds true for OpenSSL 1.0.0+ and 0.9.8+ with enable-tlsext in EXTRACONFIGURE. If you invoke &(openssl s_client -h)& and see &`-servername`& in the output, then OpenSSL has support. @@ -27240,9 +27505,6 @@ a realistic ACL for checking RCPT commands. This is discussed in chapter .section "Testing ACLs" "SECID188" The &%-bh%& command line option provides a way of testing your ACL configuration locally by running a fake SMTP session with which you interact. -The host &'relay-test.mail-abuse.org'& provides a service for checking your -relaying configuration (see section &<>& for more details). - .section "Specifying when ACLs are used" "SECID189" @@ -27357,6 +27619,10 @@ Note that a client may issue more than one EHLO or HELO command in an SMTP session, and indeed is required to issue a new EHLO or HELO after successfully setting up encryption following a STARTTLS command. +Note also that a deny neither forces the client to go away nor means that +mail will be refused on the connection. Consider checking for +&$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that. + If the command is accepted by an &%accept%& verb that has a &%message%& modifier, the message may not contain more than one line (it will be truncated at the first newline and a panic logged if it does). Such a message cannot @@ -27423,10 +27689,10 @@ It becomes active only when the PRDR feature is negotiated between client and server for a message, and more than one recipient has been accepted. -The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message -has been recieved, and is executed once for each recipient of the message +The ACL test specified by &%acl_smtp_data_prdr%& happens after a message +has been received, and is executed once for each recipient of the message with &$local_part$& and &$domain$& valid. -The test may accept, defer or deny for inividual recipients. +The test may accept, defer or deny for individual recipients. The &%acl_smtp_data%& will still be called after this ACL and can reject the message overall, even if this ACL has accepted it for some or all recipients. @@ -27434,10 +27700,12 @@ for some or all recipients. PRDR may be used to support per-user content filtering. Without it one must defer any recipient after the first that has a different content-filter configuration. With PRDR, the RCPT-time check -for this can be disabled when the MAIL-time $smtp_command included -"PRDR". Any required difference in behaviour of the main DATA-time +.cindex "PRDR" "variable for" +for this can be disabled when the variable &$prdr_requested$& +is &"yes"&. +Any required difference in behaviour of the main DATA-time ACL should however depend on the PRDR-time ACL having run, as Exim -will avoid doing so in some situations (eg. single-recipient mails). +will avoid doing so in some situations (e.g. single-recipient mails). See also the &%prdr_enable%& global option and the &%hosts_try_prdr%& smtp transport option. @@ -27451,10 +27719,8 @@ the feature was not requested by the client. The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL does not affect the response code to QUIT, which is always 221. Thus, the ACL does not in fact control any access. -.new For this reason, it may only accept or warn as its final result. -.wen This ACL can be used for tasks such as custom logging at the end of an SMTP session. For example, you can use ACL variables in other ACLs to count @@ -28370,21 +28636,19 @@ is what is wanted for subsequent tests. This option requests delivery be attempted while the item is being received. The option is usable in the RCPT ACL. -If enabled for a message recieved via smtp and routed to an smtp transport, -.new +If enabled for a message received via smtp and routed to an smtp transport, and only one transport, interface, destination host and port combination is used for all recipients of the message, -.wen then the delivery connection is made while the receiving connection is open and data is copied from one to the other. An attempt to set this option for any recipient but the first for a mail will be quietly ignored. -If a recipient-verify callout connection is subsequently +If a recipient-verify callout +(with use_sender) +connection is subsequently requested in the same ACL it is held open and used for -.new -any subsequent receipients and the data, -.wen +any subsequent recipients and the data, otherwise one is made after the initial RCPT ACL completes. Note that routers are used in verify mode, @@ -28393,12 +28657,16 @@ Note also that headers cannot be modified by any of the post-data ACLs (DATA, MIME and DKIM). Headers may be modified by routers (subject to the above) and transports. +All the usual ACLs are called; if one results in the message being +rejected, all effort spent in delivery (including the costs on +the ultimate destination) will be wasted. +Note that in the case of data-time ACLs this includes the entire +message body. + Cutthrough delivery is not supported via transport-filters or when DKIM signing of outgoing messages is done, because it sends data to the ultimate destination before the entire message has been received from the source. -.new -It is not supported for messages recieved with the SMTP PRDR option in use. -.wen +It is not supported for messages received with the SMTP PRDR option in use. Should the ultimate destination system positively accept or reject the mail, a corresponding indication is given to the source system and nothing is queued. @@ -28622,6 +28890,11 @@ data is read. &*Note:*& This control applies only to the current message, not to any others that are being submitted at the same time using &%-bs%& or &%-bS%&. + +.vitem &*control&~=&~utf8_downconvert*& +This control enables conversion of UTF-8 in message addresses +to a-label form. +For details see &<>&. .endlist vlist @@ -28900,12 +29173,6 @@ If all goes well, the condition is true. It is false only if there are problems such as a syntax error or a memory shortage. For more details, see chapter &<>&. -.vitem &*demime&~=&~*&<&'extension&~list'&> -.cindex "&%demime%& ACL condition" -This condition is available only when Exim is compiled with the -content-scanning extension. Its use is described in section -&<>&. - .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&> .cindex "&%dnslists%& ACL condition" .cindex "DNS list" "in ACL" @@ -29136,7 +29403,8 @@ This condition is relevant only in an ACL that is run after a message has been received, that is, in an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&. It checks the syntax of all header lines that can contain lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&, -and &'Bcc:'&). Unqualified addresses (local parts without domains) are +and &'Bcc:'&), returning true if there are no problems. +Unqualified addresses (local parts without domains) are permitted only in locally generated messages and from hosts that match &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as appropriate. @@ -29207,10 +29475,8 @@ Verification ensures that the host name obtained from a reverse DNS lookup, or one of its aliases, does, when it is itself looked up in the DNS, yield the original IP address. -.new There is one possible option, &`defer_ok`&. If this is present and a DNS operation returns a temporary error, the verify condition succeeds. -.wen If this condition is used for a locally generated message (that is, when there is no client host involved), it always succeeds. @@ -29300,9 +29566,13 @@ deny dnslists = blackholes.mail-abuse.org warn message = X-Warn: sending host is on dialups list dnslists = dialups.mail-abuse.org .endd -DNS list lookups are cached by Exim for the duration of the SMTP session, +.cindex cacheing "of dns lookup" +.cindex DNS TTL +DNS list lookups are cached by Exim for the duration of the SMTP session +(but limited by the DNS return TTL value), so a lookup based on the IP address is done at most once for any incoming -connection. Exim does not share information between multiple incoming +connection (assuming long-enough TTL). +Exim does not share information between multiple incoming connections (but your local name server cache should be active). @@ -30671,14 +30941,6 @@ in chapter &<>&. You can check the relay characteristics of your configuration in the same way that you can test any ACL behaviour for an incoming SMTP connection, by using the &%-bh%& option to run a fake SMTP session with which you interact. - -For specifically testing for unwanted relaying, the host -&'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this -host from the host on which Exim is running, using the normal telnet port, you -will see a normal telnet connection message and then quite a long delay. Be -patient. The remote host is making an SMTP connection back to your host, and -trying a number of common probes to test for open relay vulnerability. The -results of the tests will eventually appear on your terminal. .ecindex IIDacl @@ -30721,10 +30983,6 @@ conditions. Two new main configuration options: &%av_scanner%& and &%spamd_address%&. .endlist -There is another content-scanning configuration option for &_Local/Makefile_&, -called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL -condition is compiled, in addition to all the other content-scanning features. - Content-scanning is continually evolving, and new features are still being added. While such features are still unstable and liable to incompatible changes, they are made available in Exim by setting options whose names begin @@ -30759,10 +31017,8 @@ It supports a &"generic"& interface to scanners called via the shell, and specialized interfaces for &"daemon"& type virus scanners, which are resident in memory and thus are much faster. -.new A timeout of 2 minutes is applied to a scanner call (by default); if it expires then a defer action is taken. -.wen .oindex "&%av_scanner%&" You can set the &%av_scanner%& option in the main part of the configuration @@ -30781,11 +31037,10 @@ The usual list-parsing of the content (see &<>&) applies. The following scanner types are supported in this release: .vlist -.new .vitem &%avast%& .cindex "virus scanners" "avast" This is the scanner daemon of Avast. It has been tested with Avast Core -Security (currenty at version 1.1.7). +Security (currently at version 1.1.7). You can get a trial version at &url(http://www.avast.com) or for Linux at &url(http://www.avast.com/linux-server-antivirus). This scanner type takes one option, @@ -30813,7 +31068,6 @@ $ socat UNIX:/var/run/avast/scan.sock STDIO: SENSITIVITY PACK .endd -.wen .vitem &%aveserver%& @@ -30978,7 +31232,7 @@ This is a daemon type scanner that is aimed mainly at Polish users, though some parts of documentation are now available in English. You can get it at &url(http://linux.mks.com.pl/). The only option for this scanner type is the maximum number of processes used simultaneously to scan the attachments, -provided that the demime facility is employed and also provided that mksd has +provided that mksd has been run with at least the same number of child processes. For example: .code av_scanner = mksd:2 @@ -30990,7 +31244,7 @@ You can safely omit this option (the default value is 1). This is a general-purpose way of talking to simple scanner daemons running on the local machine. There are four options: -an address (which may be an IP addres and port, or the path of a Unix socket), +an address (which may be an IP address and port, or the path of a Unix socket), a commandline to send (may include a single %s which will be replaced with the path to the mail file to be scanned), an RE to trigger on from the returned data, @@ -31029,9 +31283,7 @@ which case each use of the &%malware%& condition causes a new scan of the message. The &%malware%& condition takes a right-hand argument that is expanded before -.new use and taken as a list, slash-separated by default. -.wen The first element can then be one of .ilist @@ -31045,17 +31297,14 @@ the condition fails immediately. A regular expression, in which case the message is scanned for viruses. The condition succeeds if a virus is found and its name matches the regular expression. This allows you to take special actions on certain types of virus. -.new Note that &"/"& characters in the RE must be doubled due to the list-processing, unless the separator is changed (in the usual way). -.wen .endlist You can append a &`defer_ok`& element to the &%malware%& argument list to accept messages even if there is a problem with the virus scanner. Otherwise, such a problem causes the ACL to defer. -.new You can append a &`tmo=`& element to the &%malware%& argument list to specify a non-default timeout. The default is two minutes. For example: @@ -31063,7 +31312,10 @@ For example: malware = * / defer_ok / tmo=10s .endd A timeout causes the ACL to defer. -.wen + +.vindex "&$callout_address$&" +When a connection is made to the scanner the expansion variable &$callout_address$& +is set to record the actual address used. .vindex "&$malware_name$&" When a virus is found, the condition sets up an expansion variable called @@ -31071,23 +31323,17 @@ When a virus is found, the condition sets up an expansion variable called &%message%& modifier that specifies the error returned to the sender, and/or in logging data. -If your virus scanner cannot unpack MIME and TNEF containers itself, you should -use the &%demime%& condition (see section &<>&) before the -&%malware%& condition. - Beware the interaction of Exim's &%message_size_limit%& with any size limits imposed by your anti-virus scanner. Here is a very simple scanning example: .code deny message = This message contains malware ($malware_name) - demime = * malware = * .endd The next example accepts messages when there is a problem with the scanner: .code deny message = This message contains malware ($malware_name) - demime = * malware = */defer_ok .endd The next example shows how to use an ACL variable to scan with both sophie and @@ -31114,13 +31360,11 @@ deny message = This message contains malware ($malware_name) .cindex "Rspamd" The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam score and a report for the message. -.new Support is also provided for Rspamd. For more information about installation and configuration of SpamAssassin or Rspamd refer to their respective websites at &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com) -.wen SpamAssassin can be installed with CPAN by running: .code @@ -31140,14 +31384,12 @@ configuration as follows (example): spamd_address = 192.168.99.45 387 .endd -.new To use Rspamd (which by default listens on all local addresses on TCP port 11333) you should add &%variant=rspamd%& after the address/port pair, for example: .code spamd_address = 127.0.0.1 11333 variant=rspamd .endd -.wen As of version 2.60, &%SpamAssassin%& also supports communication over UNIX sockets. If you want to us these, supply &%spamd_address%& with an absolute @@ -31169,7 +31411,6 @@ When a server fails to respond to the connection attempt, all other servers are tried until one succeeds. If no server responds, the &%spam%& condition defers. -.new Unix and TCP socket specifications may be mixed in any order. Each element of the list is a list itself, space-separated by default and changeable in the usual way. @@ -31181,7 +31422,7 @@ In the latter case, the range is tried in strict order. Elements after the first for Unix sockets, or second for TCP socket, are options. -The supported option are: +The supported options are: .code pri= Selection priority weight= Selection bias @@ -31193,7 +31434,7 @@ variant=rspamd Use Rspamd rather than SpamAssassin protocol The &`pri`& option specifies a priority for the server within the list, higher values being tried first. -The deafult priority is 1. +The default priority is 1. The &`weight`& option specifies a selection bias. Within a priority set @@ -31206,7 +31447,7 @@ Either the seconds or both minutes and seconds, plus the leading &`.`& characters, may be omitted and will be taken as zero. Timeout specifications for the &`retry`& and &`tmo`& options -are the usual Exim time interval standard, eg. &`20s`& or &`1m`&. +are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&. The &`tmo`& option specifies an overall timeout for communication. The default value is two minutes. @@ -31214,13 +31455,16 @@ The default value is two minutes. The &`retry`& option specifies a time after which a single retry for a failed connect is made. The default is to not retry. -.wen The &%spamd_address%& variable is expanded before use if it starts with a dollar sign. In this case, the expansion may return a string that is used as the list so that multiple spamd servers can be the result of an expansion. +.vindex "&$callout_address$&" +When a connection is made to the server the expansion variable &$callout_address$& +is set to record the actual address used. + .section "Calling SpamAssassin from an Exim ACL" "SECID206" Here is a simple example of the use of the &%spam%& condition in a DATA ACL: .code @@ -31231,10 +31475,8 @@ The right-hand side of the &%spam%& condition specifies a name. This is relevant if you have set up multiple SpamAssassin profiles. If you do not want to scan using a specific profile, but rather use the SpamAssassin system-wide default profile, you can scan for an unknown name, or simply use &"nobody"&. -.new Rspamd does not use this setting. However, you must put something on the right-hand side. -.wen The name allows you to use per-domain or per-user antispam profiles in principle, but this is not straightforward in practice, because a message may @@ -31242,14 +31484,12 @@ have multiple recipients, not necessarily all in the same domain. Because the &%spam%& condition has to be called from a DATA-time ACL in order to be able to read the contents of the message, the variables &$local_part$& and &$domain$& are not set. -.new Careful enforcement of single-recipient messages -(eg. by responding with defer in the recipient ACL for all recipients +(e.g. by responding with defer in the recipient ACL for all recipients after the first), or the use of PRDR, .cindex "PRDR" "use for per-user SpamAssassin profiles" are needed to use this feature. -.wen The right-hand side of the &%spam%& condition is expanded before being used, so you can put lookups or conditions there. When the right-hand side evaluates to @@ -31274,9 +31514,7 @@ it always return &"true"& by appending &`:true`& to the username. .cindex "spam scanning" "returned variables" When the &%spam%& condition is run, it sets up a number of expansion variables. -.new Except for &$spam_report$&, -.wen these variables are saved with the received message so are available for use at delivery time. @@ -31295,21 +31533,18 @@ The integer value is useful for numeric comparisons in conditions. A string consisting of a number of &"+"& or &"-"& characters, representing the integer part of the spam score value. A spam score of 4.4 would have a &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning -headers, since MUAs can match on such strings. +headers, since MUAs can match on such strings. The maximum length of the +spam bar is 50 characters. .vitem &$spam_report$& A multiline text table, containing the full SpamAssassin report for the message. Useful for inclusion in headers or reject messages. -.new This variable is only usable in a DATA-time ACL. -.wen -.new .vitem &$spam_action$& For SpamAssassin either 'reject' or 'no action' depending on the spam score versus threshold. For Rspamd, the recommended action. -.wen .endlist @@ -31497,9 +31732,7 @@ 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 RFC2047 -.new or RFC2231 -.wen decoded, but no additional sanity checks are done. If no filename was found, this variable contains the empty string. @@ -31590,94 +31823,12 @@ deny message = contains blacklisted regex ($regex_match_string) The conditions returns true if any one of the regular expressions matches. The &$regex_match_string$& expansion variable is then set up and contains the matching regular expression. +The expansion variables &$regex1$& &$regex2$& etc +are set to any substrings captured by the regular expression. &*Warning*&: With large messages, these conditions can be fairly CPU-intensive. - - - -.section "The demime condition" "SECTdemimecond" -.cindex "content scanning" "MIME checking" -.cindex "MIME content scanning" -The &%demime%& ACL condition provides MIME unpacking, sanity checking and file -extension blocking. It is usable only in the DATA and non-SMTP ACLs. The -&%demime%& condition uses a simpler interface to MIME decoding than the MIME -ACL functionality, but provides no additional facilities. Please note that this -condition is deprecated and kept only for backward compatibility. You must set -the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to -use the &%demime%& condition. - -The &%demime%& condition unpacks MIME containers in the message. It detects -errors in MIME containers and can match file extensions found in the message -against a list. Using this facility produces files containing the unpacked MIME -parts of the message in the temporary scan directory. If you do antivirus -scanning, it is recommended that you use the &%demime%& condition before the -antivirus (&%malware%&) condition. - -On the right-hand side of the &%demime%& condition you can pass a -colon-separated list of file extensions that it should match against. For -example: -.code -deny message = Found blacklisted file attachment - demime = vbs:com:bat:pif:prf:lnk -.endd -If one of the file extensions is found, the condition is true, otherwise it is -false. If there is a temporary error while demimeing (for example, &"disk -full"&), the condition defers, and the message is temporarily rejected (unless -the condition is on a &%warn%& verb). - -The right-hand side is expanded before being treated as a list, so you can have -conditions and lookups there. If it expands to an empty string, &"false"&, or -zero (&"0"&), no demimeing is done and the condition is false. - -The &%demime%& condition set the following variables: - -.vlist -.vitem &$demime_errorlevel$& -.vindex "&$demime_errorlevel$&" -When an error is detected in a MIME container, this variable contains the -severity of the error, as an integer number. The higher the value, the more -severe the error (the current maximum value is 3). If this variable is unset or -zero, no error occurred. - -.vitem &$demime_reason$& -.vindex "&$demime_reason$&" -When &$demime_errorlevel$& is greater than zero, this variable contains a -human-readable text string describing the MIME error that occurred. -.endlist - -.vlist -.vitem &$found_extension$& -.vindex "&$found_extension$&" -When the &%demime%& condition is true, this variable contains the file -extension it found. -.endlist - -Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of -the &%demime%& condition, and are not changed on subsequent calls. - -If you do not want to check for file extensions, but rather use the &%demime%& -condition for unpacking or error checking purposes, pass &"*"& as the -right-hand side value. Here is a more elaborate example of how to use this -facility: -.code -# Reject messages with serious MIME container errors -deny message = Found MIME error ($demime_reason). - demime = * - condition = ${if >{$demime_errorlevel}{2}{1}{0}} - -# Reject known virus spreading file extensions. -# Accepting these is pretty much braindead. -deny message = contains $found_extension file (blacklisted). - demime = com:vbs:bat:pif:scr - -# Freeze .exe and .doc files. Postmaster can -# examine them and eventually thaw them. -deny log_message = Another $found_extension file. - demime = exe:doc - control = freeze -.endd .ecindex IIDcosca @@ -33858,13 +34009,18 @@ specific badly-behaved hosts that you have to live with. When Exim receives a VRFY or EXPN command on a TCP/IP connection, it runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as appropriate) in order to decide whether the command should be accepted or not. -If no ACL is defined, the command is rejected. .cindex "VRFY" "processing" +When no ACL is defined for VRFY, or if it rejects without +setting an explicit response code, the command is accepted +(with a 252 SMTP response code) +in order to support awkward clients that do a VRFY before every RCPT. When VRFY is accepted, it runs exactly the same code as when Exim is -called with the &%-bv%& option. +called with the &%-bv%& option, and returns 250/451/550 +SMTP response codes. .cindex "EXPN" "processing" +If no ACL for EXPN is defined, the command is rejected. When EXPN is accepted, a single-level expansion of the address is done. EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather than a verification (the &%-bv%& option). If an unqualified local part is given @@ -34099,10 +34255,8 @@ failing addresses with their error messages. The third item is used to introduce any text from pipe transports that is to be returned to the sender. It is omitted if there is no such text. .next -.new The fourth, fifth and sixth items will be ignored and may be empty. The fields exist for back-compatibility -.wen .endlist The default state (&%bounce_message_file%& unset) is equivalent to the @@ -35186,6 +35340,7 @@ extensions (ESMTP), encryption, or authentication were used. If the SMTP session was encrypted, there is an additional X field that records the cipher suite that was used. +.cindex log protocol The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from hosts that have authenticated themselves using the SMTP AUTH command. The first value is used when the SMTP connection was encrypted (&"secure"&). In this case @@ -35210,7 +35365,7 @@ data when a message is received. See section &<>& below. .cindex "log" "delivery line" The format of the single-line entry in the main log that is written for every delivery is shown in one of the examples below, for local and remote -deliveries, respectively. Each example has been split into two lines in order +deliveries, respectively. Each example has been split into multiple lines in order to fit it on the page: .code 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv @@ -35356,11 +35511,12 @@ the following table: &`id `& message id for incoming message &`P `& on &`<=`& lines: protocol used &` `& on &`=>`& and &`**`& lines: return path +&`PRX `& on &'<='& and&`=>`& lines: proxy address &`QT `& on &`=>`& lines: time spent on queue so far &` `& on &"Completed"& lines: time spent on queue &`R `& on &`<=`& lines: reference for local bounce -&` `& on &`=>`& &`**`& and &`==`& lines: router name -&`S `& size of message +&` `& on &`=>`& &`>>`& &`**`& and &`==`& lines: router name +&`S `& size of message in bytes &`SNI `& server name indication from TLS client hello &`ST `& shadow transport name &`T `& on &`<=`& lines: message subject (topic) @@ -35441,16 +35597,16 @@ selection marked by asterisks: &`*etrn `& ETRN commands &`*host_lookup_failed `& as it says &` ident_timeout `& timeout for ident connection -.new &` incoming_interface `& local interface on <= and => lines -.wen &` incoming_port `& remote port on <= lines &`*lost_incoming_connection `& as it says (includes timeouts) +&` outgoing_interface `& local interface on => lines &` outgoing_port `& add remote port to => lines &`*queue_run `& start and end queue runs &` queue_time `& time on queue for one recipient &` queue_time_overall `& time on queue for whole message &` pid `& Exim process id +&` proxy `& proxy address on <= and => lines &` received_recipients `& recipients on <= lines &` received_sender `& sender on <= lines &`*rejected_header `& header contents on reject log @@ -35461,16 +35617,14 @@ selection marked by asterisks: &`*size_reject `& rejection because too big &`*skip_delivery `& delivery skipped in a queue run &`*smtp_confirmation `& SMTP confirmation on => lines -&` smtp_connection `& SMTP connections +&` smtp_connection `& incoming SMTP connections &` smtp_incomplete_transaction`& incomplete SMTP transactions &` smtp_mailauth `& AUTH argument to MAIL commands &` smtp_no_mail `& session with no MAIL commands &` smtp_protocol_error `& SMTP protocol errors &` smtp_syntax_error `& SMTP syntax errors &` subject `& contents of &'Subject:'& on <= lines -.new &`*tls_certificate_verified `& certificate verification status -.wen &`*tls_cipher `& TLS cipher suite on <= and => lines &` tls_peerdn `& TLS peer DN on <= and => lines &` tls_sni `& TLS SNI on <= lines @@ -35478,6 +35632,9 @@ selection marked by asterisks: &` all `& all of the above .endd +See also the &%slow_lookup_log%& main configuration option, +section &<>& + More details on each of these items follows: .ilist @@ -35570,11 +35727,18 @@ client's ident port times out. &%incoming_interface%&: The interface on which a message was received is added to the &"<="& line as an IP address in square brackets, tagged by I= and followed by a colon and the port number. The local interface and port are also -added to other SMTP log lines, for example &"SMTP connection from"& and to -rejection lines -.new -and (despite the name) the local interface is added to &"=>"& lines.. -.wen +added to other SMTP log lines, for example &"SMTP connection from"&, to +rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines. +The latter can be disabled by turning off the &%outgoing_interface%& option. +.next +.cindex log "incoming proxy address" +.cindex proxy "logging proxy address" +.cindex "TCP/IP" "logging proxy address" +&%proxy%&: The internal (closest to the system running Exim) IP address +of the proxy, tagged by PRX=, on the &"<="& line for a message accepted +on a proxied connection +or the &"=>"& line for a message delivered on a proxied connection.. +See &<>& for more information. .next .cindex "log" "incoming remote port" .cindex "port" "logging remote" @@ -35592,13 +35756,26 @@ important with the widening use of NAT (see RFC 2505). &%lost_incoming_connection%&: A log line is written when an incoming SMTP connection is unexpectedly dropped. .next +.cindex "log" "outgoing interface" +.cindex "log" "local interface" +.cindex "log" "local address and port" +.cindex "TCP/IP" "logging local address and port" +.cindex "interface" "logging" +&%outgoing_interface%&: If &%incoming_interface%& is turned on, then the +interface on which a message was sent is added to delivery lines as an I= tag +followed by IP address in square brackets. You can disable this by turning +off the &%outgoing_interface%& option. +.next .cindex "log" "outgoing remote port" .cindex "port" "logging outgoint remote" .cindex "TCP/IP" "logging ougtoing remote port" &%outgoing_port%&: The remote port number is added to delivery log lines (those -containing => tags) following the IP address. This option is not included in -the default setting, because for most ordinary configurations, the remote port -number is always 25 (the SMTP port). +containing => tags) following the IP address. +The local port is also added if &%incoming_interface%& and +&%outgoing_interface%& are both enabled. +This option is not included in the default setting, because for most ordinary +configurations, the remote port number is always 25 (the SMTP port), and the +local port is a random ephemeral port. .next .cindex "log" "process ids in" .cindex "pid (process id)" "in log lines" @@ -35689,7 +35866,7 @@ response. .next .cindex "log" "SMTP connections" .cindex "SMTP" "logging connections" -&%smtp_connection%&: A log line is written whenever an SMTP connection is +&%smtp_connection%&: A log line is written whenever an incoming SMTP connection is established or closed, unless the connection is from a host that matches &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies only when the closure is unexpected.) This applies to connections from local @@ -35738,7 +35915,7 @@ C=EHLO,QUIT shows that the client issued QUIT straight after EHLO. If there were fewer than 20 commands, they are all listed. If there were more than 20 commands, the last 20 are listed, preceded by &"..."&. However, with the default -setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case +setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case have been aborted before 20 non-mail commands are processed. .next &%smtp_mailauth%&: A third subfield with the authenticated sender, @@ -35929,7 +36106,7 @@ tested is enclosed in angle brackets, so you can test for bounce messages with exiqgrep -f '^<>$' .endd .vitem &*-r*&&~<&'regex'&> -Match a recipient address using a case-insensitve search. The field that is +Match a recipient address using a case-insensitive search. The field that is tested is not enclosed in angle brackets. .vitem &*-s*&&~<&'regex'&> @@ -36342,6 +36519,9 @@ Serializing ETRN runs (when &%smtp_etrn_serialize%& is set) .next Serializing delivery to a specific host (when &%serialize_hosts%& is set in an &(smtp)& transport) +.next +Limiting the concurrency of specific transports (when &%max_parallel%& is set +in a transport) .endlist @@ -37202,7 +37382,7 @@ Such invocations should be viewed with prejudicial suspicion. Administrators who use embedded Perl are advised to explore how Perl's taint checking might apply to their usage. .next -Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and +Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and administrators are well advised to view its use with suspicion, in case (for instance) it allows a local-part to contain embedded Exim directives. .next @@ -37717,8 +37897,8 @@ linked to a domain which that entity controls. It permits reputation to be tracked on a per-domain basis, rather than merely upon source IP address. DKIM is documented in RFC 4871. -Since version 4.70, DKIM support is compiled into Exim by default. It can be -disabled by setting DISABLE_DKIM=yes in Local/Makefile. +DKIM support is compiled into Exim by default if TLS support is present. +It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&. Exim's DKIM implementation allows to .olist @@ -37753,7 +37933,7 @@ where you accept mail from relay sources (internal hosts or authenticated senders). -.section "Signing outgoing messages" "SECID513" +.section "Signing outgoing messages" "SECDKIMSIGN" .cindex "DKIM" "signing" Signing is implemented by setting private options on the SMTP transport. @@ -37768,7 +37948,7 @@ option is put into the &%$dkim_domain%& expansion variable. 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 -variable &%$dkim_selector%& which should be used in the &%dkim_private_key%& +variable &%$dkim_selector%& which may be used in the &%dkim_private_key%& option along with &%$dkim_domain%&. .option dkim_private_key smtp string&!! unset @@ -37817,7 +37997,7 @@ Verification of DKIM signatures in incoming email is implemented via the &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each syntactically(!) correct signature in the incoming message. A missing ACL definition defaults to accept. -If any ACL call does not acccept, the message is not accepted. +If any ACL call does not accept, the message is not accepted. If a cutthrough delivery was in progress for the message it is summarily dropped (having wasted the transmission effort). @@ -37881,7 +38061,7 @@ available in &%$dkim_verify_reason%&. &%pass%&: The signature passed verification. It is valid. .endlist .vitem &%$dkim_verify_reason%& -A string giving a litte bit more detail when &%$dkim_verify_status%& is either +A string giving a little bit more detail when &%$dkim_verify_status%& is either "fail" or "invalid". One of .ilist &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public @@ -37944,6 +38124,8 @@ Key granularity (tag g=) from the key record. Defaults to "*" if not specified in the key record. .vitem &%$dkim_key_notes%& Notes from the key record (tag n=). +.vitem &%$dkim_key_length%& +Number of bits in the key. .endlist In addition, two ACL conditions are provided: @@ -37983,6 +38165,384 @@ for more information of what they mean. . //////////////////////////////////////////////////////////////////////////// . //////////////////////////////////////////////////////////////////////////// +.chapter "Proxies" "CHAPproxies" &&& + "Proxy support" +.cindex "proxy support" +.cindex "proxy" "access via" + +A proxy is an intermediate system through which communication is passed. +Proxies may provide a security, availability or load-distribution function. + + +.section "Inbound proxies" SECTproxyInbound +.cindex proxy inbound +.cindex proxy "server side" +.cindex proxy "Proxy protocol" +.cindex "Proxy protocol" proxy + +Exim has support for receiving inbound SMTP connections via a proxy +that uses &"Proxy Protocol"& to speak to it. +To include this support, include &"SUPPORT_PROXY=yes"& +in Local/Makefile. + +It was built on specifications from: +http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt +That URL was revised in May 2014 to version 2 spec: +http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e + +The purpose of this facility is so that an application load balancer, +such as HAProxy, can sit in front of several Exim servers +to distribute load. +Exim uses the local protocol communication with the proxy to obtain +the remote SMTP system IP address and port information. +There is no logging if a host passes or +fails Proxy Protocol negotiation, but it can easily be determined and +recorded in an ACL (example is below). + +Use of a proxy is enabled by setting the &%hosts_proxy%& +main configuration option to a hostlist; connections from these +hosts will use Proxy Protocol. + +The following expansion variables are usable +(&"internal"& and &"external"& here refer to the interfaces +of the proxy): +.display +&'proxy_external_address '& IP of host being proxied or IP of remote interface of proxy +&'proxy_external_port '& Port of host being proxied or Port on remote interface of proxy +&'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy +&'proxy_local_port '& Port of proxy server inbound or Port on local interface of proxy +&'proxy_session '& boolean: SMTP connection via proxy +.endd +If &$proxy_session$& is set but &$proxy_external_address$& is empty +there was a protocol error. + +Since the real connections are all coming from the proxy, and the +per host connection tracking is done before Proxy Protocol is +evaluated, &%smtp_accept_max_per_host%& must be set high enough to +handle all of the parallel volume you expect per inbound proxy. +With the option set so high, you lose the ability +to protect your server from many connections from one IP. +In order to prevent your server from overload, you +need to add a per connection ratelimit to your connect ACL. +A possible solution is: +.display + # Set max number of connections per host + LIMIT = 5 + # Or do some kind of IP lookup in a flat file or database + # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}} + + defer message = Too many connections from this IP right now + ratelimit = LIMIT / 5s / per_conn / strict +.endd + + + +.section "Outbound proxies" SECTproxySOCKS +.cindex proxy outbound +.cindex proxy "client side" +.cindex proxy SOCKS +.cindex SOCKS proxy +Exim has support for sending outbound SMTP via a proxy +using a protocol called SOCKS5 (defined by RFC1928). +The support can be optionally included by defining SUPPORT_SOCKS=yes in +Local/Makefile. + +Use of a proxy is enabled by setting the &%socks_proxy%& option +on an smtp transport. +The option value is expanded and should then be a list +(colon-separated by default) of proxy specifiers. +Each proxy specifier is a list +(space-separated by default) where the initial element +is an IP address and any subsequent elements are options. + +Options are a string =. +The list of options is in the following table: +.display +&'auth '& authentication method +&'name '& authentication username +&'pass '& authentication password +&'port '& tcp port +&'tmo '& connection timeout +&'pri '& priority +&'weight '& selection bias +.endd + +More details on each of these options follows: + +.ilist +.cindex authentication "to proxy" +.cindex proxy authentication +&%auth%&: Either &"none"& (default) or &"name"&. +Using &"name"& selects username/password authentication per RFC 1929 +for access to the proxy. +Default is &"none"&. +.next +&%name%&: sets the username for the &"name"& authentication method. +Default is empty. +.next +&%pass%&: sets the password for the &"name"& authentication method. +Default is empty. +.next +&%port%&: the TCP port number to use for the connection to the proxy. +Default is 1080. +.next +&%tmo%&: sets a connection timeout in seconds for this proxy. +Default is 5. +.next +&%pri%&: specifies a priority for the proxy within the list, +higher values being tried first. +The default priority is 1. +.next +&%weight%&: specifies a selection bias. +Within a priority set servers are queried in a random fashion, +weighted by this value. +The default value for selection bias is 1. +.endlist + +Proxies from the list are tried according to their priority +and weight settings until one responds. The timeout for the +overall connection applies to the set of proxied attempts. + +.section Logging SECTproxyLog +To log the (local) IP of a proxy in the incoming or delivery logline, +add &"+proxy"& to the &%log_selector%& option. +This will add a component tagged with &"PRX="& to the line. + +. //////////////////////////////////////////////////////////////////////////// +. //////////////////////////////////////////////////////////////////////////// + +.chapter "Internationalisation" "CHAPi18n" &&& + "Internationalisation"" +.cindex internationalisation "email address" +.cindex EAI +.cindex i18n +.cindex UTF-8 "mail name handling" + +Exim has support for Internationalised mail names. +To include this it must be built with SUPPORT_I18N and the libidn library. +Standards supported are RFCs 2060, 5890, 6530 and 6533. + +.section "MTA operations" SECTi18nMTA +.cindex SMTPUTF8 "ESMTP option" +The main configuration option &%smtputf8_advertise_hosts%& specifies +a host list. If this matches the sending host and +accept_8bitmime is true (the default) then the ESMTP option +SMTPUTF8 will be advertised. + +If the sender specifies the SMTPUTF8 option on a MAIL command +international handling for the message is enabled and +the expansion variable &$message_smtputf8$& will have value TRUE. + +The option &%allow_utf8_domains%& is set to true for this +message. All DNS lookups are converted to a-label form +whatever the setting of &%allow_utf8_domains%& +when Exim is built with SUPPORT_I18N. + +Both localparts and domain are maintained as the original +UTF-8 form internally; any comparison or regular-expression use will +require appropriate care. Filenames created, eg. by +the appendfile transport, will have UTF-8 names. + +HELO names sent by the smtp transport will have any UTF-8 +components expanded to a-label form, +and any certificate name checks will be done using the a-label +form of the name. + +.cindex log protocol +.cindex SMTPUTF8 logging +Log lines and Received-by: header lines will acquire a "utf8" +prefix on the protocol element, eg. utf8esmtp. + +The following expansion operator can be used: +.code +${utf8_domain_to_alabel:str} +${utf8_domain_from_alabel:str} +${utf8_localpart_to_alabel:str} +${utf8_localpart_from_alabel:str} +.endd + +ACLs may use the following modifier: +.display +control = utf8_downconvert +control = utf8_downconvert/ +.endd +This sets a flag requiring that addresses are converted to +a-label form before smtp delivery, for use in a +Message Submission Agent context. +If a value is appended it may be: +.display +&`1 `& (default) mandatory downconversion +&`0 `& no downconversion +&`-1 `& if SMTPUTF8 not supported by destination host +.endd + +If mua_wrapper is set, the utf8_downconvert control +is initially set to -1. + + +There is no explicit support for VRFY and EXPN. +Configurations supporting these should inspect +&$smtp_command_argument$& for an SMTPUTF8 argument. + +There is no support for LMTP on Unix sockets. +Using the "lmtp" protocol option on an smtp transport, +for LMTP over TCP, should work as expected. + +There is no support for DSN unitext handling, +and no provision for converting logging from or to UTF-8. + + + +.section "MDA operations" SECTi18nMDA +To aid in constructing names suitable for IMAP folders +the following expansion operator can be used: +.code +${imapfolder {} {} {}} +.endd + +The string is converted from the charset specified by +the "headers charset" command (in a filter file) +or &%headers_charset%& main configuration option (otherwise), +to the +modified UTF-7 encoding specified by RFC 2060, +with the following exception: All occurences of +(which has to be a single character) +are replaced with periods ("."), and all periods and slashes that are not + and are not in the string are BASE64 encoded. + +The third argument can be omitted, defaulting to an empty string. +The second argument can be omitted, defaulting to "/". + +This is the encoding used by Courier for Maildir names on disk, and followed +by many other IMAP servers. + +Examples: +.display +&`${imapfolder {Foo/Bar}} `& yields &`Foo.Bar`& +&`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`& +&`${imapfolder {RäksmörgÃ¥s}} `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`& +.endd + +Note that the source charset setting is vital, and also that characters +must be representable in UTF-16. + + +. //////////////////////////////////////////////////////////////////////////// +. //////////////////////////////////////////////////////////////////////////// + +.chapter "Events" "CHAPevents" &&& + "Events" +.cindex events + +The events mechanism in Exim can be used to intercept processing at a number +of points. It was originally invented to giave a way to do customised logging +actions (for example, to a database) but can also be used to modify some +processing actions. + +Most installations will never need to use Events. +The support can be left out of a build by defining DISABLE_EVENT=yes +in &_Local/Makefile_&. + +There are two major classes of events: main and transport. +The main configuration option &%event_action%& controls reception events; +a transport option &%event_action%& controls delivery events. + +Both options are a string which is expanded when the event fires. +An example might look like: +.cindex logging custom +.code +event_action = ${if eq {msg:delivery}{$event_name} \ +{${lookup pgsql {SELECT * FROM record_Delivery( \ + '${quote_pgsql:$sender_address_domain}',\ + '${quote_pgsql:${lc:$sender_address_local_part}}', \ + '${quote_pgsql:$domain}', \ + '${quote_pgsql:${lc:$local_part}}', \ + '${quote_pgsql:$host_address}', \ + '${quote_pgsql:${lc:$host}}', \ + '${quote_pgsql:$message_exim_id}')}} \ +} {}} +.endd + +Events have names which correspond to the point in process at which they fire. +The name is placed in the variable &$event_name$& and the event action +expansion must check this, as it will be called for every possible event type. + +The current list of events is: +.display +&`msg:complete after main `& per message +&`msg:delivery after transport `& per recipient +&`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:internal after main `& per recipient +&`tcp:connect before transport `& per connection +&`tcp:close after transport `& per connection +&`tls:cert before both `& per certificate in verification chain +&`smtp:connect after transport `& per connection +.endd +New event types may be added in future. + +The event name is a colon-separated list, defining the type of +event in a tree of possibilities. It may be used as a list +or just matched on as a whole. There will be no spaces in the name. + +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). + +An additional variable, &$event_data$&, is filled with information varying +with the event type: +.display +&`msg:delivery `& smtp confirmation mssage +&`msg:rcpt:host:defer `& error string +&`msg:rcpt:defer `& error string +&`msg:host:defer `& error string +&`tls:cert `& verification chain depth +&`smtp:connect `& smtp banner +.endd + +The :defer events populate one extra variable: &$event_defer_errno$&. + +For complex operations an ACL expansion can be used in &%event_action%& +however due to the multiple contextx that Exim operates in during +the course of its processing: +.ilist +variables set in transport events will not be visible outside that +transport call +.next +acl_m variables in a server context are lost on a new connection, +and after smtp helo/ehlo/mail/starttls/rset commands +.endlist +Using an ACL expansion with the logwrite modifier can be +a useful way of writing to the main log. + +The expansion of the event_action option should normally +return an empty string. Should it return anything else the +following will be forced: +.display +&`msg:delivery `& (ignored) +&`msg:host:defer `& (ignored) +&`msg:fail:delivery`& (ignored) +&`tcp:connect `& do not connect +&`tcp:close `& (ignored) +&`tls:cert `& refuse verification +&`smtp:connect `& close connection +.endd +No other use is made of the result string. + +For a tcp:connect event, if the connection is being made to a proxy +then the address and port variables will be that of the proxy and not +the target system. + +For tls:cert events, if GnuTLS is in use this will trigger only per +chain element received on the connection. +For OpenSSL it will trigger for every chain element including those +loaded locally. + +. //////////////////////////////////////////////////////////////////////////// +. //////////////////////////////////////////////////////////////////////////// + .chapter "Adding new drivers or lookup types" "CHID13" &&& "Adding drivers or lookups" .cindex "adding drivers"