antikythera

v0.2.0

antikythera v0.2.0 AntikytheraEal.AlertMailer.Mail View Source

Link to this section Summary

Types

t()

Functions

body(mail)

Type-aware getter for body

body(s, field)

Type-aware setter for body

from(mail)

Type-aware getter for from

from(s, field)

Type-aware setter for from

new(dict)

Creates a new instance of AntikytheraEal.AlertMailer.Mail by using the given dict

new!(dict)

A variant of new/1 which returns t or raise if validation fails

subject(mail)

Type-aware getter for subject

subject(s, field)

Type-aware setter for subject

to(mail)

Type-aware getter for to

to(s, field)

Type-aware setter for to

update(s, dict)

Updates an existing instance of AntikytheraEal.AlertMailer.Mail with the given dict. The values in the dict are validated by each field’s valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}

update!(s, dict)

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1

valid?(value)

Checks if the given value belongs to t/0 or not

Link to this section Types

Link to this type t() View Source 
t() :: %AntikytheraEal.AlertMailer.Mail{body: Croma.String.t(), from: Croma.String.t(), subject: Croma.String.t(), to: Croma.TypeGen.ListOf.Croma.String.t()}

Link to this section Functions

Link to this function body(mail) View Source 
body(t()) :: Croma.String.t()

Type-aware getter for body.

Link to this function body(s, field) View Source 
body(t(), Croma.String.t()) :: t()

Type-aware setter for body.

Link to this function from(mail) View Source 
from(t()) :: Croma.String.t()

Type-aware getter for from.

Link to this function from(s, field) View Source 
from(t(), Croma.String.t()) :: t()

Type-aware setter for from.

Link to this function new(dict) View Source 
new(term()) :: Croma.Result.t(t())

Creates a new instance of AntikytheraEal.AlertMailer.Mail by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field’s valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

  • default/0 of each field type
  • new/1 of each field type, with empty map as input
Link to this function new!(dict) View Source 
new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

Link to this function subject(mail) View Source 
subject(t()) :: Croma.String.t()

Type-aware getter for subject.

Link to this function subject(s, field) View Source 
subject(t(), Croma.String.t()) :: t()

Type-aware setter for subject.

Link to this function to(s, field) View Source 
to(t(), Croma.TypeGen.ListOf.Croma.String.t()) :: t()

Type-aware setter for to.

Link to this function update(s, dict) View Source 
update(t(), Dict.t()) :: Croma.Result.t(t())

Updates an existing instance of AntikytheraEal.AlertMailer.Mail with the given dict. The values in the dict are validated by each field’s valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

Link to this function update!(s, dict) View Source 
update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

Link to this function valid?(value) View Source 
valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.