Inttegro.Chimes.EmailMessage (inttegro v0.2.0)

Copy Markdown View Source

Represents Email Message data in the Chimes API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Sends and schedules transactional messages.

Chimes deliver email or SMS content to inline recipients, saved customers, or template-defined recipients. A returned chime records rendering, safety, and transmission results; delivery may continue asynchronously after the API call succeeds.

Summary

Types

t()

The decoded email message value.

Functions

Builds a Inttegro.Chimes.EmailMessage and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Chimes.EmailMessage{
  from_: Inttegro.Chimes.EmailMailbox.t() | nil,
  headers: %{optional(String.t()) => String.t()} | nil,
  html: String.t() | nil,
  reply_to: Inttegro.Chimes.EmailMailbox.t() | nil,
  safety: Inttegro.Chimes.EmailSafetyResult.t() | nil,
  schema: Inttegro.Chimes.EmailSchemaMarkup.t() | nil,
  subject: String.t() | nil,
  text: String.t() | nil
}

The decoded email message value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Chimes.EmailMessage and raises KeyError when a required field is missing.