antikythera v0.2.0 AntikytheraEal.AlertMailer.Mail View Source

Link to this section 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

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

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.

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

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

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

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.

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}.

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.

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