Rivet.Email.Template behaviour (rivet_email v2.5.0)

View Source

Summary

Types

ecto_p_result()
id()
model_p_result()
t()

Callbacks

generate(recipient, attributes)
sendto(recipients, assigns)

Functions

aggregate(x, y)
all(clauses \\ [], args \\ [])
all!(clauses \\ [], args \\ [])
associate(item, var, value)
build(params \\ %{})
change_post(item, params)

change_post for side effects; should return the item

change_prep(item, params)

change_prep alters the params only, and may only return {:ok, params}

change_validate(chgset)

change_validate is only run for changing existing records

changeset(item, attrs)
count!()
count!(claims)
count_by_inserted!()
count_by_inserted!(since)
count_by_updated!()
count_by_updated!(since)
create(attrs \\ %{})
create_post(item, params)

create_post for side effects; should return the item

create_prep(item, params)

create_prep alters the params only, and may only return {:ok, params}

create_validate(chgset)

create_validate is only run for creating new records

delete(item)
delete_all(clauses, opts \\ [])
delete_all_ids(ids, opts \\ [])
drop_replace(attrs, clauses)
exists?(clauses)
full_table_scan(clauses, func)
html2text(html)

iex> html2text("<b>an html doc</b><p><h1>Header</h1>") "an html doc \n# Header"

insert(a, b)
latest(claims \\ [], x \\ 1)
latest!(claims \\ [], x \\ 1)
one(x, preload \\ [])
one!(x, preload \\ [])
preload(item, preloads, opts \\ [])
preload!(item, preloads, opts \\ [])
reload(item)
replace(attrs, clauses)
replace_fill(attrs, clauses)

Similar to replace, but it doesn't remove existing values if the attrs has nil

stream(clauses, args)
stream_all!(args, func)
touch(this_id)

Update our updated_at but only if it hasn't changed within a minute (less load)

unload(item)
unload(item, assoc)
update(item, attrs)
update!(item, attrs)
update_all(clauses, set)
update_fill(item, attrs)
upsert(attrs, on_conflict \\ :nothing)
validate(chgset)
validate_post(chgset)

a hook if you just want to extend validate

Types

ecto_p_result()

@type ecto_p_result() :: {:ok | :error, Ecto.Changeset.t()}

id()

@type id() :: Ecto.UUID.t()

model_p_result()

@type model_p_result() :: {:ok, Rivet.Email.Template.t()}

t()

@type t() :: %Rivet.Email.Template{
  __meta__: Ecto.Schema.Metadata.t(),
  data: String.t() | nil,
  id: binary() | nil,
  inserted_at: DateTime.t() | nil,
  name: Rivet.Utils.Ecto.Atom.t() | nil,
  updated_at: DateTime.t() | nil
}

Callbacks

generate(recipient, attributes)

@callback generate(recipient :: map(), attributes :: map()) ::
  {:ok, subject :: String.t(), html_body :: String.t()}

sendto(recipients, assigns)

@callback sendto(recipients :: any(), assigns :: list()) :: :ok

Functions

aggregate(x, y)

all(clauses \\ [], args \\ [])

@spec all(keyword() | Ecto.Query.t(), list()) ::
  {:error, ecto_p_result()} | {:ok, [Rivet.Email.Template.t()]}

all!(clauses \\ [], args \\ [])

@spec all!(keyword() | Ecto.Query.t(), list()) :: [Rivet.Email.Template.t()]

associate(item, var, value)

build(params \\ %{})

change_post(item, params)

change_post for side effects; should return the item

Note: BE VERY CAREFUL on large impact effects. This can quickly become a performance bottleneck.

change_prep(item, params)

change_prep alters the params only, and may only return {:ok, params}

change_validate(chgset)

change_validate is only run for changing existing records

changeset(item, attrs)

count!()

count!(claims)

count_by_inserted!()

count_by_inserted!(since)

count_by_updated!()

count_by_updated!(since)

create(attrs \\ %{})

@spec create(map()) :: model_p_result() | ecto_p_result()

create_post(item, params)

create_post for side effects; should return the item

Note: BE VERY CAREFUL on large impact effects. This can quickly become a performance bottleneck.

create_prep(item, params)

create_prep alters the params only, and may only return {:ok, params}

create_validate(chgset)

create_validate is only run for creating new records

delete(item)

@spec delete(Rivet.Email.Template.t()) :: model_p_result() | ecto_p_result()

delete_all(clauses, opts \\ [])

delete_all_ids(ids, opts \\ [])

drop_replace(attrs, clauses)

@spec drop_replace(map(), Keyword.t()) :: model_p_result() | ecto_p_result()

exists?(clauses)

@spec exists?(claims_or_query :: keyword() | term()) :: true | false

full_table_scan(clauses, func)

html2text(html)

@spec html2text(html :: String.t()) :: text :: String.t()

iex> html2text("<b>an html doc</b><p><h1>Header</h1>") "an html doc \n# Header"

insert(a, b)

latest(claims \\ [], x \\ 1)

latest!(claims \\ [], x \\ 1)

one(x, preload \\ [])

@spec one(id() | keyword() | Ecto.Query.t(), preload :: list()) ::
  {:ok, Rivet.Email.Template.t()} | {:error, String.t()}

one!(x, preload \\ [])

@spec one!(id() | keyword() | Ecto.Query.t(), preload :: list()) ::
  nil | Rivet.Email.Template.t()

preload(item, preloads, opts \\ [])

@spec preload(Rivet.Email.Template.t(), preloads :: term(), opts :: Keyword.t()) ::
  model_p_result() | ecto_p_result()

preload!(item, preloads, opts \\ [])

@spec preload!(Rivet.Email.Template.t(), preloads :: term(), opts :: Keyword.t()) ::
  Rivet.Email.Template.t()

reload(item)

replace(attrs, clauses)

@spec replace(map(), Keyword.t()) :: model_p_result() | ecto_p_result()

replace_fill(attrs, clauses)

@spec replace_fill(map(), Keyword.t()) :: model_p_result() | ecto_p_result()

Similar to replace, but it doesn't remove existing values if the attrs has nil

stream(clauses, args)

stream_all!(args, func)

touch(this_id)

Update our updated_at but only if it hasn't changed within a minute (less load)

unload(item)

unload(item, assoc)

update(item, attrs)

@spec update(Rivet.Email.Template.t(), map()) :: model_p_result() | ecto_p_result()

update!(item, attrs)

update_all(clauses, set)

update_fill(item, attrs)

@spec update_fill(Rivet.Email.Template.t(), attrs :: map()) ::
  model_p_result() | ecto_p_result()

upsert(attrs, on_conflict \\ :nothing)

validate(chgset)

validate_post(chgset)

a hook if you just want to extend validate