cdist-type__root_mail_dma(7)
============================

NAME
----
cdist-type__root_mail_dma - Setup root email with the DragonFly Mail Agent


DESCRIPTION
-----------
This (singleton) type uses dma, a small Mail Transport Agent (MTA), to accept
mails from locally installed Mail User Agents (MUA) and deliver the mails
to a remote destination.

Remote delivery happens over TLS to one or more mailboxes that are local to the
email server configured in the `smart-host` parameter.


REQUIRED PARAMETERS
-------------------
smart-host
    The destination email server. The addresses passed in `root-email` must be
    either local to the `smart-host` or it must be configured to act as a relay
    for the host being configured by this type.


REQUIRED MULTIPLE PARAMETERS
----------------------------
root-email
    Destination email address. Can be specified multiple times or just once
    with each address separated by commas.
    This will be setup in `/etc/aliases` as the destination for the local
    root mailbox.


BOOLEAN PARAMETERS
------------------
send-test-email
    If present, after setup this type will send an email to root, to allow you
    to easily test your setup.


OPTIONAL PARAMETERS
-------------------
mailname
    If present, this will be the hostname used to identify this host and the
    remote part of the from addresses.
    If not defined, it defaults to `/etc/mailname` on Debian-derived Operating
    Systems and to `__target_host` otherwise.
    See `dma(8)` for more information.


EXAMPLES
--------

.. code-block:: sh

    # Send root email to both our BOFH and the nice-admin.
    # That way they can figure things out together.
    __root_mail_dma \
      --root-email bofh@domain.tld \
      --root-email nice-admin@domain.tld \
      --smart-host mx1.domain.tld \
      --send-test-email


SEE ALSO
--------
- `DragonFly Mail Agent <https://github.com/corecode/dma>`_
- `DragonFly Handbook MTA <https://www.dragonflybsd.org/handbook/mta/>`_


AUTHORS
-------
Evilham <contact@evilham.com>


COPYING
-------
Copyright \(C) 2020 Evilham. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.