Rivet.Ident.Example.Mailer (rivet_ident v3.5.0)

View Source

This is an example of how to deploy Rivet Email, and is included so other projects may include it in their tests.

Summary

Types

email_model()

@type email_model() :: Rivet.Ident.Email.t()

email_recipient()

@type email_recipient() :: email_model() | user_model() | user_id()

user_id()

@type user_id() :: String.t()

user_model()

@type user_model() :: Rivet.Ident.User.t()

Functions

deliver(recipient, template, assigns)

@spec deliver(recipient :: any(), template :: atom(), assigns :: map()) ::
  {:ok, Swoosh.Email.t()} | {:error, term()}

generate_assigns(assigns, configs)

get_email(email)

@spec get_email(email_recipient()) :: {:ok, email_model()} | {:error, reason :: any()}

get_emails(recip, out \\ [])

log_email(email)

send_email(email)

sendto(recips, template, assigns \\ [], configs \\ [])