1ESMTPRC(5) File Formats Manual ESMTPRC(5)
2
6 esmtprc - esmtp configuration file.
7
10 A esmtp configuration file consists of several options. The options
11 format is:
12 keyword=value
14 The equal sign is optional and can be replaced by whitespace. The
16 value may be enclosed in simple or double quotes, in which case special
17 characters can be escaped as in normal C strings.
18 Comments are delimited by the '#' character up to the newline charac‐
20 ter.
21
24 hostname
25 Set SMTP host and service (port).
26 The format is:
28 host.example.org[:service]
30 With no whitespace surrounding the colon if service is speci‐
32 fied. service may be a name from /etc/services or a decimal port
33 number. If not specified the port defaults to 587.
34 Note (from libESMTP documentation): the default port number is
36 set to 587 since this is the port that should be used for mail
37 submission, see RFC 2476. By choosing this default now, the API
38 does not change behavior unexpectedly in the future as use of
39 the new standard becomes commonplace. The host-port notation
40 simplifies things for the application, the user can type "local‐
41 host:smtp" or "localhost:25" where the application expects a
42 host name.
43 username
46 Set the username for authentication with the SMTP server.
47 Do NOT set the username and password in the system configuration
49 file unless you are the only user of this machine. Esmtp is not
50 run with suid privileges therefore the system configuration file
51 must be readable by everyone. If your SMTP server requires
52 authentication and you are not the only user then specify your
53 personal SMTP account details in the user configuration file.
54 password
57 Set the password for authentication with the SMTP server.
58 starttls
61 Whether to use the StartTLS extension.
62 It can be one of enabled, disabled or required. It defaults to
64 disabled.
65 certificate_passphrase
68 Set the certificate passphrase for the StartTLS extension.
69 helo Set the hostname to identify as when sending HELO or EHLO com‐
72 mands. (This is a per identity option, as it should be the name
73 you are seen as from the connected host, which may very with
74 host to host due to NAT or different naming schemes).
75 qualifydomain
78 Make all local addresses to remote ones by adding @ and this
79 name.
80 force sender
83 Set a "Sender:" header and ignore those in the message. "%u"
84 will be replaced with the username. "%%" by "%".
85 force reverse_path
88 Set the envelope from address. The address given to -f will only
89 be used as "From:" when the message contains none. "%u" will be
90 replaced with the username. "%%" by "%".
91 message_id
94 Whether to set the Message-ID field of the message before send‐
95 ing. Normally the receiving MTA sets the Message-ID if missing,
96 so you can turn this off if your sending host does not have a
97 fully qualified domain name.
98 Allowed values are either enabled or disabled. It defaults to
100 enabled
101 preconnect
104 Shell command to execute prior to opening an SMTP connection.
105 This may be useful in conjunction with application-level trans‐
107 ports (e.g. ssh with its port-forwarding functionality) to
108 secure the SMTP connection. Esmtp will wait for the command to
109 exit before proceeding. If the command returns a non-zero sta‐
110 tus, delivery will be aborted.
111 identity
114 Define an identity.
115 An identity is a set of options associated with a given address.
117 For example:
118 identity = myself@somewhere.com
120 hostname = smtp.somewhere.com:25
121 username = "myself"
122 password = "secret"
123 Identities are be selected by the address specified in the -f
125 flag. You can have as many you like.
126 The options in the global section (up to the first identity
128 option) constitute the default identity. If no options in the
129 global section are given then the first defined identity is
130 taken as the default one.
131 Note that the default identity settings are not shared by the
133 other identities. Everything (username, password, etc.) must be
134 specified for every identity even if they don't differ from the
135 default identity.
136 mda Set the Mail Delivery Agent (MDA).
139 Esmtp relies upon a MDA for local mail delivery, i.e., addresses
141 without a '@' character. A non-zero error status tells esmtp
142 that delivery failed.
143 The local delivery addresses will be inserted into the MDA com‐
145 mand wherever you place a %T. The mail message's From address
146 will be inserted where you place an %F.
147 Some common MDAs are "/usr/bin/procmail -d %T",
149 "/usr/bin/deliver" and "/usr/lib/mail.local %T".
150
153 esmtp(1)
154
157 José Fonseca
158 ESMTPRC(5)