StrawHat.Mailer

v2.0.0

StrawHat.Mailer v2.0.0 StrawHat.Mailer View Source

This module is an extension of Swoosh.Mailer, please read more about Swoosh.Mailer documentation.

You can swap the adapter doing the following config:

config :straw_hat_mailer, StrawHat.Mailer,
  adapter: Swoosh.Adapters.Sendgrid,
  api_key: "SG.x.x"

Link to this section Summary

Types

owner_id()

The identifier of the owner. We recommend to use combinations of system + resource id. For example: "system_name:resource_id" or any other combination. The reason behind is that if you use just some resource id, example just "1", you can't use more than one resource that owns the template with the same id

Functions

deliver(email, config \\ [])
deliver!(email, config \\ [])
deliver_later(email, config \\ [])

Send an email asynchronous

Link to this section Types

Link to this type

owner_id() View Source 
owner_id() :: String.t()

The identifier of the owner. We recommend to use combinations of system + resource id. For example: "system_name:resource_id" or any other combination. The reason behind is that if you use just some resource id, example just "1", you can't use more than one resource that owns the template with the same id.

Link to this section Functions

Link to this function

deliver(email, config \\ []) View Source 
deliver(Swoosh.Email.t(), Keyword.t()) :: {:ok, term()} | {:error, term()}

Link to this function

deliver!(email, config \\ []) View Source 
deliver!(Swoosh.Email.t(), Keyword.t()) :: term() | no_return()

Link to this function

deliver_later(email, config \\ []) View Source 
deliver_later(Swoosh.Email.t(), keyword()) :: {:ok, pid()}

Send an email asynchronous.