# Exim Internet Mailer

<-previous next->

## Chapter 30 - The smtp transport

The smtp transport delivers messages over TCP/IP connections using the SMTP or LMTP protocol. The list of hosts to try can either be taken from the address that is being processed (having been set up by the router), or specified explicitly for the transport. Timeout and retry processing (see chapter 32) is applied to each IP address independently.

### 1. Multiple messages on a single connection

The sending of multiple messages over a single TCP/IP connection can arise in two ways:

- If a message contains more than max_rcpt (see below) addresses that are routed to the same host, more than one copy of the message has to be sent to that host. In this situation, multiple copies may be sent in a single run of the smtp transport over a single TCP/IP connection. (What Exim actually does when it has too many addresses to send in one message also depends on the value of the global remote_max_parallel option. Details are given in section 49.1.)

- When a message has been successfully delivered over a TCP/IP connection, Exim looks in its hints database to see if there are any other messages awaiting a connection to the same host. If there are, a new delivery process is started for one of them, and the current TCP/IP connection is passed on to it. The new process may in turn send multiple copies and possibly create yet another process.

For each copy sent over the same TCP/IP connection, a sequence counter is incremented, and if it ever gets to the value of connection_max_messages, no further messages are sent over that connection.

### 2. Use of the $host and $host_address variables

At the start of a run of the smtp transport, the values of $host and $host_address are the name and IP address of the first host on the host list passed by the router. However, when the transport is about to connect to a specific host, and while it is connected to that host, $host and $host_address are set to the values for that host. These are the values that are in force when the helo_data, hosts_try_auth, interface, serialize_hosts, and the various TLS options are expanded.

### 3. Use of $tls_cipher and $tls_peerdn

At the start of a run of the smtp transport, the values of $tls_bits, $tls_cipher, $tls_peerdn and $tls_sni are the values that were set when the message was received. These are the values that are used for options that are expanded before any SMTP connections are made. Just before each connection is made, these four variables are emptied. If TLS is subsequently started, they are set to the appropriate values for the outgoing connection, and these are the values that are in force when any authenticators are run and when the authenticated_sender option is expanded.

These variables are deprecated in favour of $tls_in_cipher et. al. and will be removed in a future release.

### 4. Private options for smtp

The private options of the smtp transport are as follows:

address_retry_include_sender | Use: smtp | Type: boolean | Default: true

When an address is delayed because of a 4xx response to a RCPT command, it is the combination of sender and recipient that is delayed in subsequent queue runs until the retry time is reached. You can delay the recipient without reference to the sender (which is what earlier versions of Exim did), by setting address_retry_include_sender false. However, this can lead to problems with servers that regularly issue 4xx responses to RCPT commands.

allow_localhost | Use: smtp | Type: boolean | Default: false

When a host specified in hosts or fallback_hosts (see below) turns out to be the local host, or is listed in hosts_treat_as_local, delivery is deferred by default. However, if allow_localhost is set, Exim goes on to do the delivery anyway. This should be used only in special cases when the configuration ensures that no looping will result (for example, a differently configured Exim is listening on the port to which the message is sent).

authenticated_sender | Use: smtp | Type: string† | Default: unset

When Exim has authenticated as a client, or if authenticated_sender_force is true, this option sets a value for the AUTH= item on outgoing MAIL commands, overriding any existing authenticated sender value. If the string expansion is forced to fail, the option is ignored. Other expansion failures cause delivery to be deferred. If the result of expansion is an empty string, that is also ignored.

The expansion happens after the outgoing connection has been made and TLS started, if required. This means that the $host, $host_address, $tls_out_cipher, and $tls_out_peerdn variables are set according to the particular connection.

If the SMTP session is not authenticated, the expansion of authenticated_sender still happens (and can cause the delivery to be deferred if it fails), but no AUTH= item is added to MAIL commands unless authenticated_sender_force is true.

This option allows you to use the smtp transport in LMTP mode to deliver mail to Cyrus IMAP and provide the proper local part as the “authenticated sender”, via a setting such as:

    authenticated_sender = $local_part

This removes the need for IMAP subfolders to be assigned special ACLs to allow direct delivery to those subfolders.

Because of expected uses such as that just described for Cyrus (when no domain is involved), there is no checking on the syntax of the provided value.

authenticated_sender_force | Use: smtp | Type: boolean | Default: false

If this option is set true, the authenticated_sender option’s value is used for the AUTH= item on outgoing MAIL commands, even if Exim has not authenticated as a client.

command_timeout | Use: smtp | Type: time | Default: 5m

This sets a timeout for receiving a response to an SMTP command that has been sent out. It is also used when waiting for the initial banner line from the remote host. Its value must not be zero.

connect_timeout | Use: smtp | Type: time | Default: 5m

This sets a timeout for the connect() function, which sets up a TCP/IP call to a remote host. A setting of zero allows the system timeout (typically several minutes) to act. To have any effect, the value of this option must be less than the system timeout. However, it has been observed that on some systems there is no system timeout, which is why the default value for this option is 5 minutes, a value recommended by RFC 1123.

connection_max_messages | Use: smtp | Type: integer | Default: 500

This controls the maximum number of separate message deliveries that are sent over a single TCP/IP connection. If the value is zero, there is no limit. For testing purposes, this value can be overridden by the -oB command line option.

dane_require_tls_ciphers | Use: smtp | Type: string† | Default: unset

This option may be used to override tls_require_ciphers for connections where DANE has been determined to be in effect. If not set, then tls_require_ciphers will be used. Normal SMTP delivery is not able to make strong demands of TLS cipher configuration, because delivery will fall back to plaintext. Once DANE has been determined to be in effect, there is no plaintext fallback and making the TLS cipherlist configuration stronger will increase security, rather than counter-intuitively decreasing it. If the option expands to be empty or is forced to fail, then it will be treated as unset and tls_require_ciphers will be used instead.

data_timeout | Use: smtp | Type: time | Default: 5m

This sets a timeout for the transmission of each block in the data portion of 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.

dkim_canon | Use: smtp | Type: string† | Default: unset

DKIM signing option. For details see section 58.1.

dkim_domain | Use: smtp | Type: string list† | Default: unset

DKIM signing option. For details see section 58.1.

dkim_hash | Use: smtp | Type: string† | Default: sha256

DKIM signing option. For details see section 58.1.

dkim_identity | Use: smtp | Type: string† | Default: unset

DKIM signing option. For details see section 58.1.

dkim_private_key | Use: smtp | Type: string† | Default: unset

DKIM signing option. For details see section 58.1.

dkim_selector | Use: smtp | Type: string† | Default: unset

DKIM signing option. For details see section 58.1.

dkim_strict | Use: smtp | Type: string† | Default: unset

DKIM signing option. For details see section 58.1.

dkim_sign_headers | Use: smtp | Type: string† | Default: per RFC

DKIM signing option. For details see section 58.1.

dkim_timestamps | Use: smtp | Type: string† | Default: unset

DKIM signing option. For details see section 58.1.

delay_after_cutoff | Use: smtp | Type: boolean | Default: 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 cutoff times.

In the default state, if the next retry time has not been reached for any of them, the address is bounced without trying any deliveries. In other words, Exim delays retrying an IP address after the final cutoff time until a new retry time is reached, and can therefore bounce an address without ever trying a delivery, when machines have been down for a long time. Some people are unhappy at this prospect, so...

If delay_after_cutoff is set false, Exim behaves differently. If all IP addresses are past their final cutoff time, Exim tries to deliver to those IP addresses that have not been tried since the message arrived. If there are none, of if they all fail, the address is bounced. In other words, it does not delay when a new message arrives, but immediately tries those expired IP addresses that haven’t been tried since the message arrived. If there is a continuous stream of messages for the dead hosts, unsetting delay_after_cutoff means that there will be many more attempts to deliver to them.

dns_qualify_single | Use: smtp | Type: boolean | Default: true

If the hosts or fallback_hosts option is being used, and the gethostbyname option is false, the RES_DEFNAMES resolver option is set. See the qualify_single option in chapter 17 for more details.

dns_search_parents | Use: smtp | Type: boolean | Default: false

If the hosts or fallback_hosts option is being used, and the gethostbyname option is false, the RES_DNSRCH resolver option is set. See the search_parents option in chapter 17 for more details.

dnssec_request_domains | Use: smtp | Type: domain list† | Default: *

DNS lookups for domains matching dnssec_request_domains will be done with the DNSSEC request bit set. Setting this transport option is only useful if the transport overrides or sets the host names. See the dnssec_request_domains router option.

dnssec_require_domains | Use: smtp | Type: domain list† | Default: unset

DNS lookups for domains matching dnssec_require_domains will be done with the DNSSEC request bit set. Setting this transport option is only useful if the transport overrides or sets the host names. See the dnssec_require_domains router option.

dscp | Use: smtp | Type: string† | Default: unset

This option causes the DSCP value associated with a socket to be set to one of a number of fixed strings or to numeric value. The -bI:dscp option may be used to ask Exim which names it knows of. Common values include `throughput`, `mincost`, and on newer systems `ef`, `af41`, etc. Numeric values may be in the range 0 to 0x3F.

The outbound packets from Exim will be marked with this value in the header (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee that these values will have any effect, not be stripped by networking equipment, or do much of anything without cooperation with your Network Engineer and those of all network operators between the source and destination.

fallback_hosts | Use: smtp | Type: string list | Default: unset

String expansion is not applied to this option. The argument must be a colon-separated list of host names or IP addresses, optionally also including port numbers, though the separator can be changed, as described in section 6.20. Each individual item in the list is the same as an item in a route_list setting for the manualroute router, as described in section 20.5.

Fallback hosts can also be specified on routers, which associate them with the addresses they process. As for the hosts option without hosts_override, fallback_hosts specified on the transport is used only if the address does not have its own associated fallback host list. Unlike hosts, a setting of fallback_hosts on an address is not overridden by hosts_override. However, hosts_randomize does apply to fallback host lists.

If Exim is unable to deliver to any of the hosts for a particular address, and the errors are not permanent rejections, the address is put on a separate transport queue with its host list replaced by the fallback hosts, unless the address was routed via MX records and the current host was in the original MX list. In that situation, the fallback host list is not used.

Once normal deliveries are complete, the fallback queue is delivered by re-running the same transports with the new host lists. If several failing addresses have the same fallback hosts (and max_rcpt permits it), a single copy of the message is sent.

The resolution of the host names on the fallback list is controlled by the gethostbyname option, as for the hosts option. Fallback hosts apply both to cases when the host list comes with the address and when it is taken from hosts. This option provides a “use a smart host only if delivery fails” facility.

final_timeout | Use: smtp | Type: time | Default: 10m

This is the timeout that applies while waiting for the response to the final line containing just “.” that terminates a message. Its value must not be zero.

gethostbyname | Use: smtp | Type: boolean | Default: false

If this option is true when the hosts and/or fallback_hosts options are being used, names are looked up using gethostbyname() (or getipnodebyname() when available) instead of using the DNS. Of course, that function may in fact use the DNS, but it may also consult other sources of information such as /etc/hosts.

gnutls_compat_mode | Use: smtp | Type: boolean | Default: unset

This option controls whether GnuTLS is used in compatibility mode in an Exim server. This reduces security slightly, but improves interworking with older implementations of TLS.

helo_data | Use: smtp | Type: string† | Default: see below

The value of this option is expanded after a connection to a another host has been set up. The result is used as the argument for the EHLO, HELO, or LHLO command that starts the outgoing SMTP or LMTP session. The default value of the option is:

    $primary_hostname

During the expansion, the variables $host and $host_address are set to the identity of the remote host, and the variables $sending_ip_address and $sending_port are set to the local IP address and port number that are being used. These variables can be used to generate different values for different servers or different local IP addresses. For example, if you want the string that is used for helo_data to be obtained by a DNS lookup of the outgoing interface address, you could use this:

    helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
      {${listextract{1}{<\n $value}}} \
      {$primary_hostname}}

The use of helo_data applies both to sending messages and when doing callouts.

host_name_extract | Use: smtp | Type: string list† | Default: see below

Some mail-accepting sites (notably Microsoft) operate many servers behind a network load-balancer. When this is done, with separated TLS session caches, TLS session resuption becomes problematic. It will only succeed when the same server happens to be selected by the load-balancer, matching the session stored in the client’s cache.

Exim can pull out a server name, if there is one, from the response to the client’s SMTP EHLO command. The default value of this option:

        ${if and { {match {$host} {.outlook.com\$}} \
                   {match {$item} {\N^250-([\w.]+)\s\N}} \
    	     } {$1}}

suffices for one known case. During the expansion of this option the $item variable will have the server’s EHLO response. The result of the option expansion is included in the key used to store and retrieve the TLS session, for session resumption.

Operators of high-load sites may wish to evaluate their logs for indications of other destination sites operating load-balancers, and develop a suitable expression for this option. The smtp:ehlo event and the $tls_out_resumption variable will be useful for such work.

hosts | Use: smtp | Type: string list† | Default: unset

Hosts are associated with an address by a router such as dnslookup, which finds the hosts by looking up the address domain in the DNS, or by manualroute, which has lists of hosts in its configuration. However, email addresses can be passed to the smtp transport by any router, and not all of them can provide an associated list of hosts.

The hosts option specifies a list of hosts to be used if the address being processed does not have any hosts associated with it. The hosts specified by hosts are also used, whether or not the address has its own hosts, if hosts_override is set.

The string is first expanded, before being interpreted as a colon-separated list of host names or IP addresses, possibly including port numbers. The separator may be changed to something other than colon, as described in section 6.20. Each individual item in the list is the same as an item in a route_list setting for the manualroute router, as described in section 20.5. However, note that the `/MX` facility of the manualroute router is not available here.

If the expansion fails, delivery is deferred. Unless the failure was caused by the inability to complete a lookup, the error is logged to the panic log as well as the main log. Host names are looked up either by searching directly for address records in the DNS or by calling gethostbyname() (or getipnodebyname() when available), depending on the setting of the gethostbyname option. When Exim is compiled with IPv6 support, if a host that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of address are used.

During delivery, the hosts are tried in order, subject to their retry status, unless hosts_randomize is set.

hosts_avoid_esmtp | Use: smtp | Type: host list† | Default: unset

This option is for use with broken hosts that announce ESMTP facilities (for example, PIPELINING) and then fail to implement them properly. When a host matches hosts_avoid_esmtp, Exim sends HELO rather than EHLO at the start of the SMTP session. This means that it cannot use any of the ESMTP facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.

hosts_avoid_pipelining | Use: smtp | Type: host list† | Default: unset

Exim will not use the ESMTP PIPELINING extension when delivering to any host that matches this list, even if the server host advertises PIPELINING support.

hosts_pipe_connect | Use: smtp | Type: host list† | Default: unset

If Exim is built with the SUPPORT_PIPE_CONNECT build option this option controls which to hosts the facility watched for and recorded, and used for subsequent connections.

The retry hints database is used for the record, and records are subject to the retry_data_expire option. When used, the pipelining saves on roundtrip times. It also turns SMTP into a client-first protocol so combines well with TCP Fast Open.

See also the pipelining_connect_advertise_hosts main option.

Note: When the facility is used, if the transport interface option is unset the helo_data option will be expanded before the $sending_ip_address variable is filled in. A check is made for the use of that variable, without the presence of a “def:” test on it, but suitably complex coding can avoid the check and produce unexpected results. You have been warned.

hosts_avoid_tls | Use: smtp | Type: host list† | Default: unset

Exim will not try to start a TLS session when delivering to any host that matches this list. See chapter 43 for details of TLS.

hosts_verify_avoid_tls | Use: smtp | Type: host list† | Default: unset

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.

hosts_max_try | Use: smtp | Type: integer | Default: 5

This option limits the number of IP addresses that are tried for any one delivery in cases where there are temporary delivery errors. Section 30.5 describes in detail how the value of this option is used.

hosts_max_try_hardlimit | Use: smtp | Type: integer | Default: 50

This is an additional check on the maximum number of IP addresses that Exim tries for any one delivery. Section 30.5 describes its use and why it exists.

hosts_nopass_tls | Use: smtp | Type: host list† | Default: unset

For any host that matches this list, a connection on which a TLS session has been started will not be passed to a new delivery process for sending another message on the same connection. See section 43.9 for an explanation of when this might be needed.

hosts_noproxy_tls | Use: smtp | Type: host list† | Default: unset

For any host that matches this list, a TLS session which has been started will not be passed to a new delivery process for sending another message on the same session.

The traditional implementation closes down TLS and re-starts it in the new process, on the same open TCP connection, for each successive message sent. If permitted by this option a pipe to to the new process is set up instead, and the original process maintains the TLS connection and proxies the SMTP connection from and to the new process and any subsequents. The new process has no access to TLS information, so cannot include it in logging.

hosts_override | Use: smtp | Type: boolean | Default: false

If this option is set and the hosts option is also set, any hosts that are attached to the address are ignored, and instead the hosts specified by the hosts option are always used. This option does not apply to fallback_hosts.

hosts_randomize | Use: smtp | Type: boolean | Default: false

If this option is set, and either the list of hosts is taken from the hosts or the fallback_hosts option, or the hosts supplied by the router were not obtained from MX records (this includes fallback hosts from the router), and were not randomized by the router, the order of trying the hosts is randomized each time the transport runs. Randomizing the order of a host list can be used to do crude load sharing.

When hosts_randomize is true, a host list may be split into groups whose order is separately randomized. This makes it possible to set up MX-like behaviour. The boundaries between groups are indicated by an item that is just `+` in the host list. For example:

    hosts = host1:host2:host3:+:host4:host5

The order of the first three hosts and the order of the last two hosts is randomized for each use, but the first three always end up before the last two. If hosts_randomize is not set, a `+` item in the list is ignored.

hosts_require_auth | Use: smtp | Type: host list† | Default: unset

This option provides a list of servers for which authentication must succeed before Exim will try to transfer a message. If authentication fails for servers which are not in this list, Exim tries to send unauthenticated. If authentication fails for one of these servers, delivery is deferred. This temporary error is detectable in the retry rules, so it can be turned into a hard failure if required. See also hosts_try_auth, and chapter 33 for details of authentication.

hosts_request_ocsp | Use: smtp | Type: host list† | Default: see below

Exim will request a Certificate Status on a TLS session for any host that matches this list. tls_verify_certificates should also be set for the transport.

The default is “**” if DANE is not in use for the connection, or if DANE-TA us used. It is empty if DANE-EE is used.

hosts_require_alpn | Use: smtp | Type: host list† | Default: unset

If the TLS library supports ALPN then a successful negotiation of ALPN will be required for any host matching the list, for TLS to be used. See also the tls_alpn option.

Note: prevention of fallback to in-clear connection is not managed by this option; see hosts_require_tls.

hosts_require_dane | Use: smtp | Type: host list† | Default: unset

If built with DANE support, Exim will require that a DNSSEC-validated TLSA record is present for any host matching the list, and that a DANE-verified TLS connection is made. There will be no fallback to in-clear communication. See the dnssec_request_domains router and transport options. See section 43.12.

hosts_require_ocsp | Use: smtp | Type: host list† | Default: unset

Exim will request, and check for a valid Certificate Status being given, on a TLS session for any host that matches this list. tls_verify_certificates should also be set for the transport.

hosts_require_tls | Use: smtp | Type: host list† | Default: unset

Exim will insist on using a TLS session when delivering to any host that matches this list. See chapter 43 for details of TLS. Note: This option affects outgoing mail only. To insist on TLS for incoming messages, use an appropriate ACL.

hosts_try_auth | Use: smtp | Type: host list† | Default: unset

This option provides a list of servers to which, provided they announce authentication support, Exim will attempt to authenticate as a client when it connects. If authentication fails and hosts_require_auth permits, Exim will try to transfer the message unauthenticated. See also chapter 33 for details of authentication.

hosts_try_chunking | Use: smtp | Type: host list† | Default: *

This option provides a list of servers to which, provided they announce CHUNKING support, Exim will attempt to use BDAT commands rather than DATA. Unless DKIM signing is being done, BDAT will not be used in conjunction with a transport filter.

hosts_try_dane | Use: smtp | Type: host list† | Default: *

If built with DANE support, Exim will look up a TLSA record for any host matching the list, If one is found and that lookup was DNSSEC-validated, then Exim requires that a DANE-verified TLS connection is made for that host; there will be no fallback to in-clear communication. See the dnssec_request_domains router and transport options. See section 43.12.

hosts_try_fastopen | Use: smtp | Type: host list† | Default: *

This option provides a list of servers to which, provided the facility is supported by this system, Exim will attempt to perform a TCP Fast Open. No data is sent on the SYN segment but, if the remote server also supports the facility, it can send its SMTP banner immediately after the SYN,ACK segment. This can save up to one round-trip time.

The facility is only active for previously-contacted servers, as the initiator must present a cookie in the SYN segment.

On (at least some) current Linux distributions the facility must be enabled in the kernel by the sysadmin before the support is usable. There is no option for control of the server side; if the system supports it it is always enabled. Note that lengthy operations in the connect ACL, such as DNSBL lookups, will still delay the emission of the SMTP banner.

hosts_try_prdr | Use: smtp | Type: host list† | Default: *

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.

interface | Use: smtp | Type: string list† | Default: unset

This option specifies which interface to bind to when making an outgoing SMTP call. The value is an IP address, not an interface name such as `eth0`. Do not confuse this with the interface address that was used when a message was received, which is in $received_ip_address, formerly known as $interface_address. The name was changed to minimize confusion with the outgoing interface address. There is no variable that contains an outgoing interface address because, unless it is set by this option, its value is unknown.

During the expansion of the interface option the variables $host and $host_address refer to the host to which a connection is about to be made during the expansion of the string. Forced expansion failure, or an empty string result causes the option to be ignored. Otherwise, after expansion, the string must be a list of IP addresses, colon-separated by default, but the separator can be changed in the usual way (6.21). For example:

    interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061

The first interface of the correct type (IPv4 or IPv6) is used for the outgoing connection. If none of them are the correct type, the option is ignored. If interface is not set, or is ignored, the system’s IP functions choose which interface to use if the host has more than one.

keepalive | Use: smtp | Type: boolean | Default: true

This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket connections. When set, it causes the kernel to probe idle connections periodically, by sending packets with “old” sequence numbers. The other end of the connection should send a acknowledgment if the connection is still okay or a reset if the connection has been aborted. The reason for doing this is that it has the beneficial effect of freeing up certain types of connection that can get stuck when the remote host is disconnected without tidying up the TCP/IP call properly. The keepalive mechanism takes several hours to detect unreachable hosts.

lmtp_ignore_quota | Use: smtp | Type: boolean | Default: false

If this option is set true when the protocol option is set to “lmtp”, the string `IGNOREQUOTA` is added to RCPT commands, provided that the LMTP server has advertised support for IGNOREQUOTA in its response to the LHLO command.

max_rcpt | Use: smtp | Type: integer† | Default: 100

This option,

after expansion,

limits the number of RCPT commands that are sent in a single SMTP message transaction. A value setting of zero disables the limit.

If a constant is given,

each set of addresses is treated independently, and so can cause parallel connections to the same host if remote_max_parallel permits this.

message_linelength_limit | Use: smtp | Type: integer | Default: 998

This option sets the maximum line length, in bytes, that the transport will send. Any messages with lines exceeding the given value will fail and a failure-DSN ("bounce") message will if possible be returned to the sender. The default value is that defined by the SMTP standards.

It is generally wise to also check in the data ACL so that messages received via SMTP can be refused without producing a bounce.

multi_domain | Use: smtp | Type: boolean† | Default: true

When this option is set, the smtp transport can handle a number of addresses containing a mixture of different domains provided they all resolve to the same list of hosts. Turning the option off restricts the transport to 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.

It is expanded per-address and can depend on any of $address_data, $domain_data, $local_part_data, $host, $host_address and $host_port.

If the connection is DANE-enabled then this option is ignored; only messages having the domain used for the DANE TLSA lookup are sent on the connection.

port | Use: smtp | Type: string† | Default: see below

This option specifies the TCP/IP port on the server to which Exim connects. Note: Do not confuse this with the port that was used when a message was received, which is in $received_port, formerly known as $interface_port. The name was changed to minimize confusion with the outgoing port. There is no variable that contains an outgoing port.

If the value of this option begins with a digit it is taken as a port number; otherwise it is looked up using getservbyname(). The default value is normally “smtp”, but if protocol is set to “lmtp” the default is “lmtp” and if protocol is set to “smtps” the default is “smtps”. If the expansion fails, or if a port number cannot be found, delivery is deferred.

Note that at least one Linux distribution has been seen failing to put “smtps” in its “/etc/services” file, resulting is such deferrals.

protocol | Use: smtp | Type: string | Default: smtp

If this option is set to “lmtp” instead of “smtp”, the default value for the port option changes to “lmtp”, and the transport operates the LMTP 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 28.

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 used to strongly discourage use of this mode, but as of RFC 8314 it is preferred over STARTTLS for message submission (as distinct from MTA-MTA communication).

retry_include_ip_address | Use: smtp | Type: boolean† | Default: true

Exim normally includes both the host name and the IP address in the key it constructs for indexing retry data after a temporary delivery failure. This means that when one of several IP addresses for a host is failing, it gets tried periodically (controlled by the retry rules), but use of the other IP addresses is not affected.

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. Since it is expanded it can be made to depend on the host or domain.

serialize_hosts | Use: smtp | Type: host list† | Default: unset

Because Exim operates in a distributed manner, if several messages for the same host arrive at around the same time, more than one simultaneous connection to the remote host can occur. This is not usually a problem except when there is a slow link between the hosts. In that situation it may be helpful to restrict Exim to one connection at a time. This can be done by setting serialize_hosts to match the relevant hosts.

Exim implements serialization by means of a hints database in which a record is written whenever a process connects to one of the restricted hosts. The record is deleted when the connection is completed. 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 set up this kind of serialization, 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 serialization.

See also the max_parallel generic transport option.

size_addition | Use: smtp | Type: integer | Default: 1024

If a remote SMTP server indicates that it supports the SIZE option of the MAIL command, Exim uses this to pass over the message size at the start of an SMTP transaction. It adds the value of size_addition to the value it sends, to allow for headers and other text that may be added during delivery by configuration options or in a transport filter. It may be necessary to increase this if a lot of text is added to messages.

Alternatively, if the value of size_addition is set negative, it disables the use of the SIZE option altogether.

socks_proxy | Use: smtp | Type: string† | Default: unset

This option enables use of SOCKS proxies for connections made by the transport. For details see section 59.2.

tls_alpn | Use: smtp | Type: string† | Default: unset

If this option is set and the TLS library supports ALPN, the value given is used.

As of writing no value has been standardised for email use. The authors suggest using “smtp”.

tls_certificate | Use: smtp | Type: string† | Default: unset

The value of this option must be the absolute path to a file which contains the client’s certificate, for possible use when sending a message over an encrypted connection. The values of $host and $host_address are set to the name and address of the server during the expansion. See chapter 43 for details of TLS.

Note: This option must be set if you want Exim to be able to use a TLS certificate when sending messages as a client. The global option of the same name specifies the certificate for Exim as a server; it is not automatically assumed that the same certificate should be used when Exim is operating as a client.

tls_crl | Use: smtp | Type: string† | Default: unset

This option specifies a certificate revocation list. The expanded value must be the name of a file that contains a CRL in PEM format.

tls_dh_min_bits | Use: smtp | Type: integer | Default: 1024

When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman key agreement is negotiated, the server will provide a large prime number for use. This option establishes the minimum acceptable size of that number. If the parameter offered by the server is too small, then the TLS handshake will fail.

Only supported when using GnuTLS.

tls_privatekey | Use: smtp | Type: string† | Default: unset

The value of this option must be the absolute path to a file which contains the client’s private key. This is used when sending a message over an encrypted connection using a client certificate. The values of $host and $host_address are set to the name and address of the server during the expansion. If this option is unset, or the expansion is forced to fail, or the result is an empty string, the private key is assumed to be in the same file as the certificate. See chapter 43 for details of TLS.

tls_require_ciphers | Use: smtp | Type: string† | Default: unset

The value of this option must be a list of permitted cipher suites, for use when setting up an outgoing encrypted connection. (There is a global option of the same name for controlling incoming connections.) The values of $host and $host_address are set to the name and address of the server during the expansion. See chapter 43 for details of TLS; note that this option is used in different ways by OpenSSL and GnuTLS (see sections 43.4 and 43.5). For GnuTLS, the order of the ciphers is a preference order.

tls_resumption_hosts | Use: smtp | Type: host list† | Default: unset

This option controls which connections to use the TLS resumption feature. See 43.11 for details.

tls_sni | Use: smtp | Type: string† | Default: unset

If this option is set and the connection is not DANE-validated then it sets the $tls_out_sni variable and causes any TLS session to pass this value as the Server Name Indication extension to the remote side, which can be used by the remote side to select an appropriate certificate and private key for the session.

See 43.8 for more information.

Note that for OpenSSL, this feature requires a build of OpenSSL that supports TLS extensions.

tls_tempfail_tryclear | Use: smtp | Type: boolean | Default: true

When the server host is not in hosts_require_tls, and there is a problem in setting up a TLS session, this option determines whether or not Exim should try to deliver the message unencrypted. If it is set false, delivery to the current host is deferred; if there are other hosts, they are tried. If this option is set true, Exim attempts to deliver unencrypted after a 4xx response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent TLS negotiation fails, Exim closes the current connection (because it is in an unknown state), opens a new one to the same host, and then tries the delivery in clear.

tls_try_verify_hosts | Use: smtp | Type: host list† | Default: *

This option gives a list of hosts for which, on encrypted connections, certificate verification will be tried but need not succeed. The tls_verify_certificates option must also be set. Note that unless the host is in this list TLS connections will be denied to hosts using self-signed certificates when tls_verify_certificates is matched. The $tls_out_certificate_verified variable is set when certificate verification succeeds.

tls_verify_cert_hostnames | Use: smtp | Type: host list† | Default: *

This option give a list of hosts for which, while verifying the server certificate, checks will be included on the host name (note that this will generally be the result of a DNS MX lookup) versus the Subject-Alternate-Name (or, if none, Subject-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.

tls_verify_certificates | Use: smtp | Type: string† | Default: system

The value of this option must be either the word "system" or the absolute path to a file or directory containing permitted certificates for servers, for use when setting up an encrypted connection.

The "system" value for the option will use a location compiled into the SSL library. 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 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.

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 43 for details of TLS.

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.

tls_verify_hosts | Use: smtp | Type: host list† | Default: unset

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 operation is as if this option selected all hosts. Warning: Including a host in tls_verify_hosts does not require that connections use TLS. Fallback to in-clear communication will be done unless restricted by the hosts_require_tls option.

utf8_downconvert | Use: smtp | Type: integer† | Default: -1

If built with internationalization support, this option controls conversion of UTF-8 in message envelope addresses to a-label form. If, after expansion, the value is 1, 0, or -1 then this value overrides any value previously set for the message. Otherwise, any previously set value is used. To permit use of a previous value, set this option to an empty string. For details on the values see section 60.1.

### 5. How the limits for the number of hosts to try are used

There are two options that are concerned with the number of hosts that are tried when an SMTP delivery takes place. They are hosts_max_try and hosts_max_try_hardlimit.

The hosts_max_try option limits the number of hosts that are tried for a single delivery. However, despite the term “host” in its name, the option actually applies to each IP address independently. In other words, a multihomed host is treated as several independent hosts, just as it is for retrying.

Many of the larger ISPs have multiple MX records which often point to multihomed hosts. As a result, a list of a dozen or more IP addresses may be created as a result of routing one of these domains.

Trying every single IP address on such a long list does not seem sensible; if several at the top of the list fail, it is reasonable to assume there is some problem that is likely to affect all of them. Roughly speaking, the value of hosts_max_try is the maximum number that are tried before deferring the delivery. However, the logic cannot be quite that simple.

Firstly, IP addresses that are skipped because their retry times have not arrived do not count, and in addition, addresses that are past their retry limits are also not counted, even when they are tried. This means that when some IP addresses are past their retry limits, more than the value of hosts_max_retry may be tried. The reason for this behaviour is to ensure that all IP addresses are considered before timing out an email address (but see below for an exception).

Secondly, when the hosts_max_try limit is reached, Exim looks down the host list to see if there is a subsequent host with a different (higher valued) MX. If there is, that host is considered next, and the current IP address is used but not counted. This behaviour helps in the case of a domain with a retry rule that hardly ever delays any hosts, as is now explained:

Consider the case of a long list of hosts with one MX value, and a few with a higher MX value. If hosts_max_try is small (the default is 5) only a few hosts at the top of the list are tried at first. With the default retry rule, which specifies increasing retry times, the higher MX hosts are eventually tried when those at the top of the list are skipped because they have not reached their retry times.

However, it is common practice to put a fixed short retry time on domains for large ISPs, on the grounds that their servers are rarely down for very long. Unfortunately, these are exactly the domains that tend to resolve to long lists of hosts. The short retry time means that the lowest MX hosts are tried every time. The attempts may be in a different order because of random sorting, but without the special MX check, the higher MX hosts would never be tried until all the lower MX hosts had timed out (which might be several days), because there are always some lower MX hosts that have reached their retry times. With the special check, Exim considers at least one IP address from each MX value at every delivery attempt, even if the hosts_max_try limit has already been reached.

The above logic means that hosts_max_try is not a hard limit, and in particular, Exim normally eventually tries all the IP addresses before timing out an email address. When hosts_max_try was implemented, this seemed a reasonable thing to do. Recently, however, some lunatic DNS configurations have been set up with hundreds of IP addresses for some domains. It can take a very long time indeed for an address to time out in these cases.

The hosts_max_try_hardlimit option was added to help with this problem. Exim never tries more than this number of IP addresses; if it hits this limit and they are all timed out, the email address is bounced, even though not all possible IP addresses have been tried.

<-previous Table of Contents next->