contrib/dma/dma.8

   1 .\"
   2 .\" Copyright (c) 2008-2014, Simon Schubert <2@0x2c.org>.
   3 .\" Copyright (c) 2008
   4 .\"     The DragonFly Project.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\"
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. Neither the name of The DragonFly Project nor the names of its
  17 .\"    contributors may be used to endorse or promote products derived
  18 .\"    from this software without specific, prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .Dd May 20, 2017
  34 .Dt DMA 8
  35 .Os
  36 .Sh NAME
  37 .Nm dma
  38 .Nd DragonFly Mail Agent
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl DiOt
  42 .Op Fl A Ns Ar mode
  43 .Op Fl b Ns Ar mode
  44 .Op Fl f Ar sender
  45 .Op Fl L Ar tag
  46 .Op Fl o Ns Ar option
  47 .Op Fl r Ar sender
  48 .Op Fl q Ns Op Ar arg
  49 .Op Ar recipient ...
  50 .Sh DESCRIPTION
  51 .Nm
  52 is a small Mail Transport Agent (MTA), designed for home and office use.
  53 It accepts mails from locally installed Mail User Agents (MUA) and
  54 delivers the mails either locally or to a remote destination.
  55 Remote delivery includes several features like TLS/SSL support and SMTP
  56 authentication.
  57 .Pp
  58 .Nm
  59 is not intended as a replacement for real, big MTAs like
  60 .Xr sendmail 8
  61 or
  62 .Xr postfix 1 .
  63 Consequently,
  64 .Nm
  65 does not listen on port 25 for incoming connections.
  66 .Pp
  67 The options are as follows:
  68 .Bl -tag -width indent
  69 .It Fl A Ns Ar mode
  70 .Fl \&Ac
  71 acts as a compatibility option for sendmail.
  72 .It Fl b Ns Ar mode
  73 .Bl -tag -width indent
  74 .It Fl bp
  75 List all mails currently stored in the mail queue.
  76 .It Fl bq
  77 Queue the mail, but do not attempt to deliver it.
  78 See also the
  79 .Sq DEFER
  80 config file setting below.
  81 .El
  82 .Pp
  83 All other
  84 .Ar mode Ns
  85 s are ignored.
  86 .It Fl D
  87 Do not run in the background.
  88 Useful for debugging.
  89 .It Fl f Ar sender
  90 Set sender address (envelope-from) to
  91 .Ar sender .
  92 This overrides the value of the
  93 .Ev EMAIL
  94 environment variable, but is overridden by the
  95 .Sq MASQUERADE
  96 config file setting.
  97 .It Fl i
  98 Ignore dots alone on lines by themselves in incoming messages.
  99 This should be set if you are reading data from a file.
 100 .It Fl L Ar tag
 101 Set the identifier used in syslog messages to the supplied
 102 .Ar tag .
 103 This is a compatibility option for sendmail.
 104 .It Fl O
 105 This is a compatibility option for sendmail.
 106 .It Fl o Ns Ar option
 107 Specifying
 108 .Fl oi
 109 is synonymous to
 110 .Fl i .
 111 All other options are ignored.
 112 .It Fl q Ns Op Ar arg
 113 Process saved messages in the queue.
 114 The argument is optional and ignored.
 115 .It Fl r Ar sender
 116 Same as
 117 .Fl f .
 118 .It Fl t
 119 Obtain recipient addresses from the message header.
 120 .Nm
 121 will parse the
 122 .Li To: ,
 123 .Li Cc: ,
 124 and
 125 .Li Bcc:
 126 headers.
 127 The
 128 .Li Bcc:
 129 header will be removed independent of whether
 130 .Fl t
 131 is specified or not.
 132 .El
 133 .Sh CONFIGURATION
 134 .Nm
 135 can be configured with two config files:
 136 .Pp
 137 .Bl -bullet -compact
 138 .It
 139 auth.conf
 140 .It
 141 dma.conf
 142 .El
 143 .Pp
 144 These two files are stored per default in
 145 .Pa /etc/dma .
 146 .Sh FILE FORMAT
 147 Every file contains parameters of the form
 148 .Sq name value .
 149 Lines containing boolean values are set to
 150 .Sq NO
 151 if the line is commented and to
 152 .Sq YES
 153 if the line is uncommented.
 154 Empty lines or lines beginning with a
 155 .Sq #
 156 are ignored.
 157 Parameter names and their values are case sensitive.
 158 .Sh PARAMETERS
 159 .Ss auth.conf
 160 SMTP authentication can be configured in
 161 .Pa auth.conf .
 162 Each line has the format
 163 .Dq Li user|smarthost:password .
 164 .Ss dma.conf
 165 Most of the behaviour of
 166 .Nm
 167 can be configured in
 168 .Pa dma.conf .
 169 .Bl -tag -width 4n
 170 .It Ic SMARTHOST Xo
 171 (string, default=empty)
 172 .Xc
 173 If you want to send outgoing mails via a smarthost, set this variable to
 174 your smarthosts address.
 175 .It Ic PORT Xo
 176 (numeric, default=25)
 177 .Xc
 178 Use this port to deliver remote emails.
 179 Only useful together with the
 180 .Sq SMARTHOST
 181 option, because
 182 .Nm
 183 will deliver all mails to this port, regardless of whether a smarthost is set
 184 or not.
 185 .It Ic ALIASES Xo
 186 (string, default=/etc/aliases)
 187 .Xc
 188 Path to the local aliases file.
 189 Just stick with the default.
 190 The aliases file is of the format
 191 .Dl nam: dest1 dest2 ...
 192 In this case, mails to
 193 .Li nam
 194 will instead be delivered to
 195 .Li dest1
 196 and
 197 .Li dest2 ,
 198 which in turn could be entries in
 199 .Pa /etc/aliases .
 200 The special name
 201 .Ql *
 202 can be used to create a catch-all alias, which gets used if no other
 203 matching alias is found.
 204 Use the catch-all alias only if you do not want any local mail to be
 205 delivered.
 206 .It Ic SPOOLDIR Xo
 207 (string, default=/var/spool/dma)
 208 .Xc
 209 Path to
 210 .Nm Ap s
 211 spool directory.
 212 Just stick with the default.
 213 .It Ic AUTHPATH Xo
 214 (string, default=not set)
 215 .Xc
 216 Path to the
 217 .Sq auth.conf
 218 file.
 219 .It Ic SECURETRANSFER Xo
 220 (boolean, default=commented)
 221 .Xc
 222 Uncomment if you want TLS/SSL secured transfer.
 223 .It Ic STARTTLS Xo
 224 (boolean, default=commented)
 225 .Xc
 226 Uncomment if you want to use STARTTLS.
 227 Only useful together with
 228 .Sq SECURETRANSFER .
 229 .It Ic FINGERPRINT Xo
 230 (string, default=empty)
 231 .Xc
 232 Pin the server certificate by specifying its SHA256 fingerprint.
 233 Only makes sense if you use a smarthost.
 234 .It Ic OPPORTUNISTIC_TLS Xo
 235 (boolean, default=commented)
 236 .Xc
 237 Uncomment if you want to allow the STARTTLS negotiation to fail.
 238 Most useful when
 239 .Nm
 240 is used without a smarthost, delivering remote messages directly to
 241 the outside mail exchangers; in opportunistic TLS mode, the connection will
 242 be encrypted if the remote server supports STARTTLS, but an unencrypted
 243 delivery will still be made if the negotiation fails.
 244 Only useful together with
 245 .Sq SECURETRANSFER
 246 and
 247 .Sq STARTTLS .
 248 .It Ic CERTFILE Xo
 249 (string, default=empty)
 250 .Xc
 251 Path to your SSL certificate file.
 252 .It Ic SECURE Xo
 253 (boolean, default=commented)
 254 .Xc
 255 Uncomment this entry and change it to
 256 .Sq INSECURE
 257 to use plain text SMTP login over an insecure connection.
 258 You have to rename this variable manually to prevent that you send your
 259 password accidentally over an insecure connection.
 260 .It Ic DEFER Xo
 261 (boolean, default=commented)
 262 .Xc
 263 Uncomment if you want that
 264 .Nm
 265 defers your mail.
 266 You have to flush your mail queue manually with the
 267 .Fl q
 268 option.
 269 This option is handy if you are behind a dialup line.
 270 .It Ic FULLBOUNCE Xo
 271 (boolean, default=commented)
 272 .Xc
 273 Uncomment if you want the bounce message to include the complete original
 274 message, not just the headers.
 275 .It Ic MAILNAME Xo
 276 (string, default=empty)
 277 .Xc
 278 The internet hostname
 279 .Nm
 280 uses to identify the host.
 281 If not set or empty, the result of
 282 .Xr gethostname 3
 283 is used.
 284 If
 285 .Sq MAILNAME
 286 is an absolute path to a file, the first line of this file will be used
 287 as the hostname.
 288 .It Ic MASQUERADE Xo
 289 (string, default=empty)
 290 .Xc
 291 Masquerade the envelope-from addresses with this address/hostname.
 292 Use this setting if mails are not accepted by destination mail servers
 293 because your sender domain is invalid.
 294 This setting overrides the
 295 .Fl f
 296 flag and the
 297 .Ev EMAIL
 298 environment variable.
 299 .Pp
 300 If
 301 .Sq MASQUERADE
 302 does not contain a
 303 .Li @
 304 sign, the string is interpreted as a host name.
 305 For example, setting
 306 .Sq MASQUERADE
 307 to
 308 .Ql john@
 309 on host
 310 .Ql hamlet
 311 will send all mails as
 312 .Ql john@hamlet ;
 313 setting it to
 314 .Ql percolator
 315 will send all mails as
 316 .Sm off
 317 .Ql Va username @percolator .
 318 .Sm on
 319 .It Ic NULLCLIENT Xo
 320 (boolean, default=commented)
 321 .Xc
 322 Bypass aliases and local delivery, and instead forward all mails to
 323 the defined
 324 .Sq SMARTHOST .
 325 .Sq NULLCLIENT
 326 requires
 327 .Sq SMARTHOST
 328 to be set.
 329 .El
 330 .Ss Environment variables
 331 The behavior of
 332 .Nm
 333 can be influenced by some environment variables.
 334 .Bl -tag -width 4n
 335 .It Ev EMAIL Xo
 336 .Xc
 337 Used to set the sender address (envelope-from).
 338 Use a plain address, in the form of
 339 .Li user@example.com .
 340 This value will be overridden when the
 341 .Sq MASQUERADE
 342 config file setting or the
 343 .Fl f
 344 flag is used.
 345 .El
 346 .Sh SEE ALSO
 347 .Xr mailaddr 7 ,
 348 .Xr mailwrapper 8 ,
 349 .Xr sendmail 8
 350 .Rs
 351 .%A "J. B. Postel"
 352 .%T "Simple Mail Transfer Protocol"
 353 .%O RFC 821
 354 .Re
 355 .Rs
 356 .%A "J. Myers"
 357 .%T "SMTP Service Extension for Authentication"
 358 .%O RFC 2554
 359 .Re
 360 .Rs
 361 .%A "P. Hoffman"
 362 .%T "SMTP Service Extension for Secure SMTP over TLS"
 363 .%O RFC 2487
 364 .Re
 365 .Sh HISTORY
 366 The
 367 .Nm
 368 utility first appeared in
 369 .Dx 1.11 .
 370 .Sh AUTHORS
 371 .An -nosplit
 372 .Nm
 373 was written by
 374 .An Matthias Schmidt Aq Mt matthias@dragonflybsd.org
 375 and
 376 .An Simon Schubert Aq Mt 2@0x2c.org .