Swoosh

v0.23.2

Swoosh v0.23.2 Swoosh.Adapter behaviour View Source

Specification of the email delivery adapter.

Link to this section Summary

Types

config()
email()
t()

Functions

validate_config(required_config, config)
validate_dependency(required_deps)

Callbacks

deliver(email, config)

Delivers an email with the given config.

validate_config(config)
validate_dependency()

Link to this section Types

Link to this type

config() View Source 
config() :: Keyword.t()

Link to this type

email() View Source 
email() :: Email.t()

Link to this type

t() View Source 
t() :: module()

Link to this section Functions

Link to this function

validate_config(required_config, config) View Source 
validate_config([atom()], Keyword.t()) :: :ok | no_return()

Link to this function

validate_dependency(required_deps) View Source 
validate_dependency([module() | {atom(), module()}]) ::
  :ok | {:error, [module() | {:atom | module()}]}

Link to this section Callbacks

Link to this callback

deliver(email, config) View Source 
deliver(email(), config()) :: {:ok, term()} | {:error, term()}

Delivers an email with the given config.

Link to this callback

validate_config(config) View Source 
validate_config(config()) :: :ok | no_return()

Link to this callback

validate_dependency() View Source (optional) 
validate_dependency() :: :ok | [module() | {atom(), module()}]