mailer/README.md

1.3 KiB

USAGE

As all programs from Baguette repositories, a -h option is available for the program.

mailer -h

Sending a mail

# One-shot email transfer.
# mailer send <template> <email>
login=mypseudo token=aabbccdd  mailer send activation-email test@example.com

Configuration

As all programs from Baguette repositories, a configuration file either in the $XDG_CONFIG_HOME/baguette/ (first guess) or in the /etc/baguette/ directory can be used.

Here an exhaustive example:

# ~/.config/baguette/mailer.yml

# SMTPd configuration.
smtpd_host: localhost
smtpd_port: 25

# Where to find templates, if not in the defaut directory (/etc/baguette/mailer/templates/).
template_directory: /path/to/mailer/templates

# Configuration for each template.
templates:
    # Template name, associated to the mail configuration: "from" and "subject" headers.
    mail-activation-fr:
        from: no-reply@example.com
        subject: Account activation on the example.com website
    mail-recovery-fr:
        from: no-reply@example.com
        subject: Mail recovery for the example.com website

Templates

Templates:

  • are in the Crinja format (a Jinja derivative)
  • located by default in /etc/baguette/mailer/templates