mailer

README

mailer

Mailer is a service for rendering and sending email based on Golang Template with the help of MJML and Mailjet.

Getting Started

Docker

Docker image is available, vibioh/mailer and a sample docker-compose.yml. Everything is almost configured, you only have to tweak domain's name, mainly configured for being used with traefik, and adjust some secrets.

Mailjet

In order to use the Mailjet sender, you need to register to Mailjet for having credentials.

MJML

In order to use the MJML converter, you need to register to MJML API for having credentials or provided a compliant API like mjml-api.

CLI Usage

Usage of mailer:
  -address string
        [http] Listen address {MAILER_ADDRESS}
  -cert string
        [http] Certificate file {MAILER_CERT}
  -corsCredentials
        [cors] Access-Control-Allow-Credentials {MAILER_CORS_CREDENTIALS}
  -corsExpose string
        [cors] Access-Control-Expose-Headers {MAILER_CORS_EXPOSE}
  -corsHeaders string
        [cors] Access-Control-Allow-Headers {MAILER_CORS_HEADERS} (default "Content-Type")
  -corsMethods string
        [cors] Access-Control-Allow-Methods {MAILER_CORS_METHODS} (default "GET")
  -corsOrigin string
        [cors] Access-Control-Allow-Origin {MAILER_CORS_ORIGIN} (default "*")
  -csp string
        [owasp] Content-Security-Policy {MAILER_CSP} (default "default-src 'self'; base-uri 'self'")
  -frameOptions string
        [owasp] X-Frame-Options {MAILER_FRAME_OPTIONS} (default "deny")
  -hsts
        [owasp] Indicate Strict Transport Security {MAILER_HSTS} (default true)
  -key string
        [http] Key file {MAILER_KEY}
  -mailjetPrivateKey string
        [mailjet] Private Key {MAILER_MAILJET_PRIVATE_KEY}
  -mailjetPublicKey string
        [mailjet] Public Key {MAILER_MAILJET_PUBLIC_KEY}
  -mjmlPass string
        [mjml] Secret Key or Basic Auth pass {MAILER_MJML_PASS}
  -mjmlURL string
        [mjml] MJML API Converter URL {MAILER_MJML_URL} (default "https://api.mjml.io/v1/render")
  -mjmlUser string
        [mjml] Application ID or Basic Auth user {MAILER_MJML_USER}
  -port int
        [http] Listen port {MAILER_PORT} (default 1080)
  -prometheusPath string
        [prometheus] Path for exposing metrics {MAILER_PROMETHEUS_PATH} (default "/metrics")
  -url string
        [alcotest] URL to check {MAILER_URL}
  -userAgent string
        [alcotest] User-Agent for check {MAILER_USER_AGENT} (default "Alcotest")