View Source AntikytheraEal.AlertMailer.Mail (antikythera v0.5.1)
Summary
Functions
Type-aware getter for body.
Type-aware setter for body.
Type-aware getter for from.
Type-aware setter for from.
Creates a new instance of AntikytheraEal.AlertMailer.Mail by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Type-aware getter for subject.
Type-aware setter for subject.
Type-aware getter for to.
Type-aware setter for to.
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}.
A variant of update/2 which returns t or raise if validation fails.
In other words, update/2 followed by Croma.Result.get!/1.
Checks if the given value belongs to t/0 or not.
Types
@type t() :: %AntikytheraEal.AlertMailer.Mail{ body: Croma.String.t(), from: Croma.String.t(), subject: Croma.String.t(), to: Croma.TypeGen.ListOf.Croma.String.t() }
Functions
@spec body(t()) :: Croma.String.t()
Type-aware getter for body.
@spec body(t(), Croma.String.t()) :: t()
Type-aware setter for body.
@spec from(t()) :: Croma.String.t()
Type-aware getter for from.
@spec from(t(), Croma.String.t()) :: t()
Type-aware setter for from.
@spec 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/0of each field typenew/1of each field type, with empty map as input
A variant of new/1 which returns t or raise if validation fails.
In other words, new/1 followed by Croma.Result.get!/1.
@spec subject(t()) :: Croma.String.t()
Type-aware getter for subject.
@spec subject(t(), Croma.String.t()) :: t()
Type-aware setter for subject.
@spec to(t()) :: Croma.TypeGen.ListOf.Croma.String.t()
Type-aware getter for to.
Type-aware setter for to.
@spec 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}.
A variant of update/2 which returns t or raise if validation fails.
In other words, update/2 followed by Croma.Result.get!/1.
Checks if the given value belongs to t/0 or not.