1ESMTPRC(5)                    File Formats Manual                   ESMTPRC(5)
2
3
4

NAME

6       esmtprc - esmtp configuration file.
7
8

DESCRIPTION

10       A  esmtp  configuration  file consists of several options.  The options
11       format is:
12
13           keyword=value
14
15       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
19       Comments are delimited by the '#' character upto the newline character.
20
21

OPTIONS

23       hostname
24              Set SMTP host and service (port).
25
26              The format is:
27
28                  host.example.org[:service]
29
30              With no whitespace surrounding the colon if  service  is  speci‐
31              fied. service may be a name from /etc/services or a decimal port
32              number.  If not specified the port defaults to 587.
33
34              Note (from libESMTP documentation): the default port  number  is
35              set  to  587 since this is the port that should be used for mail
36              submission, see RFC 2476.  By choosing this default now, the API
37              does  not  change  behavior unexpectedly in the future as use of
38              the new standard becomes  commonplace.   The  hostport  notation
39              simplifies things for the application, the user can type "local‐
40              host:smtp" or "localhost:25" where  the  application  expects  a
41              host name.
42
43
44       username
45              Set the username for authentication with the SMTP server.
46
47              Do NOT set the username and password in the system configuration
48              file unless you are the only user of this machine.  Esmtp is not
49              run with suid privileges therefore the system configuration file
50              must be readable by everyone.  If  your  SMTP  server  reuquires
51              authentication  and  you are not the only user then specify your
52              personal SMTP account details in the user configuration file.
53
54
55       password
56              Set the password for authentication with the SMTP server.
57
58
59       starttls
60              Whether to use the StartTLS extension.
61
62              It can be one of enabled, disabled or required. It  defaults  to
63              disabled.
64
65
66       certificate_passphrase
67              Set the certificate passphrase for the StartTLS extension.
68
69
70       helo   Set  the  hostname to identify as when sending HELO or EHLO com‐
71              mands.  (This is a per identity option, as it should be the name
72              you  are  seen  as  from the connected host, which may very with
73              host to host due to NAT or different naming schemes).
74
75
76       qualifydomain
77              Make all local addresses to remote ones by  adding  @  and  this
78              name.
79
80
81       force sender
82              Set  a  "Sender:"  header  and ignore those in the message. "%u"
83              will be replaced with the username. "%%" by "%".
84
85
86       force reverse_path
87              Set the envelope from address. The address given to -f will only
88              be  used as "From:" when the message contains none. "%u" will be
89              repalced with the username. "%%" by "%".
90
91
92       preconnect
93              Shell command to execute prior to opening an SMTP connection.
94
95              This may be useful in conjunction with application-level  trans‐
96              ports  (e.g.   ssh  with  its  port-forwarding functionality) to
97              secure the SMTP connection. Esmtp will wait for the  command  to
98              exit  before proceeding.  If the command returns a non-zero sta‐
99              tus, delivery will be aborted.
100
101
102       identity
103              Define an identity.
104
105              An identity is a set of options associated with a given address.
106              For example:
107
108                  identity = myself@somewhere.com
109                      hostname = smtp.somewhere.com:25
110                      username = "myself"
111                      password = "secret"
112
113              Identities  are  be  selected by the address specified in the -f
114              flag.  You can have as many you like.
115
116              The options in the global section  (up  to  the  first  identity
117              option)  constitute  the  default identity. If no options in the
118              global section are given then  the  first  defined  identity  is
119              taken as the default one.
120
121              Note  that  the  default identity settings are not shared by the
122              other identities.  Everything (username, password, etc.) must be
123              specified  for every identity even if they don't differ from the
124              default identity.
125
126
127       mda    Set the Mail Delivery Agent (MDA).
128
129              Esmtp relies upon a MDA for local mail delivery, i.e., addresses
130              without  a  '@'  character.  A non-zero error status tells esmtp
131              that delivery failed.
132
133              The local delivery addresses will be inserted into the MDA  com‐
134              mand  wherever  you place a %T.  The mail message's From address
135              will be inserted where you place an %F.
136
137              Some   common    MDAs    are    "/usr/bin/procmail    -d    %T",
138              "/usr/bin/deliver" and "/usr/lib/mail.local %T".
139
140

SEE ALSO

142       esmtp(1)
143
144

AUTHOR

146       José Fonseca
147
148
149
150                                                                    ESMTPRC(5)