Accrue.Mailer.Swoosh (accrue v0.3.0)

Copy Markdown View Source

Swoosh-backed delivery module for Accrue's transactional emails.

This module is NOT the Accrue.Mailer behaviour adapter — it is the thin Swoosh shim used by Accrue.Workers.Mailer to actually deliver a %Swoosh.Email{} after the template pipeline has built it. The env-specific Swoosh adapter (Local in dev, Test in test, SMTP/SendGrid in prod) is wired via config :accrue, Accrue.Mailer.Swoosh, adapter: ... in the host application's config.

Summary

Functions

deliver(email, config \\ [])

Delivers an email.

deliver!(email, config \\ [])

Delivers an email, raises on error.

deliver_many(emails, config \\ [])

Delivers a list of emails.

Functions

deliver(email, config \\ [])

@spec deliver(Swoosh.Email.t(), Keyword.t()) :: {:ok, term()} | {:error, term()}

Delivers an email.

If the email is delivered it returns an {:ok, result} tuple. If it fails, returns an {:error, error} tuple.

deliver!(email, config \\ [])

@spec deliver!(Swoosh.Email.t(), Keyword.t()) :: term() | no_return()

Delivers an email, raises on error.

If the email is delivered, it returns the result. If it fails, it raises a DeliveryError.

deliver_many(emails, config \\ [])

@spec deliver_many(
  [
    %Swoosh.Email{
      assigns: term(),
      attachments: term(),
      bcc: term(),
      cc: term(),
      from: term(),
      headers: term(),
      html_body: term(),
      private: term(),
      provider_options: term(),
      reply_to: term(),
      subject: term(),
      text_body: term(),
      to: term()
    }
  ],
  Keyword.t()
) :: {:ok, term()} | {:error, term()}

Delivers a list of emails.

It accepts a list of %Swoosh.Email{} as its first parameter.