Lettermint.Types.SendBatchMailItem (Lettermint v2.2.0)

Copy Markdown View Source

schema:SendBatchMailItem.

Fields

  • route (optional)
  • from (required)
  • to (required)
  • cc (optional)
  • bcc (optional)
  • reply_to (optional)
  • subject (required)
  • scheduled_at (optional): ISO 8601 or English delivery time. A time without a timezone uses UTC.
  • sandbox_result (optional): The result that a Sandbox project simulates for every recipient.
  • headers (optional): Custom headers to include in the email. To preserve a submitted RFC Message-ID, include both Message-ID and X-LM-Preserve-Message-ID with a string value of true or 1. Header names and control values are case-insensitive; false or 0 retains replacement. Send values as plain text: Lettermint encodes non-ASCII characters and repairs small formatting errors, such as line breaks, control characters and missing angle brackets. Header names must be printable ASCII without a colon.
  • metadata (optional): Metadata to track with the email (not added as email headers).
  • tag (optional, nullable): Tag to categorize and filter emails (alphanumeric, underscores, hyphens, spaces allowed).
  • tags (optional): Reusable exact-match tags. Names must be unique and are case-sensitive.
  • settings (optional): Per-email settings that override the selected route settings for this email only.
  • html (optional, nullable)
  • text (optional, nullable)
  • attachments (optional)
  • idempotency_key (optional): Optional key (1-255 characters) that makes this email safe to send again, in this or a later batch. If an email with the same key and content was accepted in the last 24 hours, its original result is returned and it is not sent again. Keys must be unique within a batch. Reusing a key with different content, or while the email with that key is still being processed, rejects the whole batch with 409 Conflict and sends nothing.

Absent fields are :unset; nil is JSON null. extra holds response fields that this version of the SDK does not know.

Summary

Types

t()

Types

t()

@type t() :: %Lettermint.Types.SendBatchMailItem{
  attachments: [Lettermint.Types.MessageAttachmentInput.t()] | :unset,
  bcc: [String.t()] | :unset,
  cc: [String.t()] | :unset,
  extra: %{optional(String.t()) => term()},
  from: String.t(),
  headers: %{optional(String.t()) => String.t()} | :unset,
  html: String.t() | nil | :unset,
  idempotency_key: String.t() | :unset,
  metadata: %{optional(String.t()) => String.t()} | :unset,
  reply_to: [String.t()] | :unset,
  route: String.t() | :unset,
  sandbox_result: Lettermint.Types.SandboxResult.t() | :unset,
  scheduled_at: String.t() | :unset,
  settings: Lettermint.Types.SendMailRequestSettings.t() | :unset,
  subject: String.t(),
  tag: String.t() | nil | :unset,
  tags: [Lettermint.Types.MessageTagInput.t()] | :unset,
  text: String.t() | nil | :unset,
  to: [String.t()]
}