Lettermint.Types.MessageData (Lettermint v2.0.0)

Copy Markdown View Source

schema:MessageData.

Fields

  • id (required)
  • type (required)
  • status (required)
  • delivery_mode (required)
  • sandbox_result (required, nullable)
  • status_changed_at (required, nullable)
  • scheduled_at (required, nullable)
  • tag (required, nullable)
  • tags (required)
  • from_email (required)
  • from_name (required, nullable)
  • reply_to (required, nullable)
  • subject (required, nullable)
  • to (required, nullable)
  • cc (required, nullable)
  • bcc (required, nullable)
  • attachments (required, nullable)
  • metadata (required, nullable)
  • spam_score (optional, nullable): Overall spam assessment score. Scores below 5 are clean, 5 through 10 indicate potential spam, scores above 10 and below 15 are likely spam, and 15 or higher is definite spam. Null means no assessment is available. Available on plans with Spam Insights
  • spam_symbols (optional): Detailed rules that contributed to the spam assessment. Available on plans with Spam Insights in individual-message responses
  • route_id (required)
  • created_at (required)

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.MessageData{
  attachments: [Lettermint.Types.MessageAttachmentData.t()] | nil,
  bcc: [Lettermint.Types.MessageRecipientData.t()] | nil,
  cc: [Lettermint.Types.MessageRecipientData.t()] | nil,
  created_at: String.t(),
  delivery_mode: Lettermint.Types.DeliveryMode.t(),
  extra: %{optional(String.t()) => term()},
  from_email: String.t(),
  from_name: String.t() | nil,
  id: String.t(),
  metadata: %{optional(String.t()) => String.t()} | nil,
  reply_to: [String.t()] | nil,
  route_id: String.t(),
  sandbox_result: Lettermint.Types.SandboxResult.t() | nil,
  scheduled_at: String.t() | nil,
  spam_score: number() | nil | :unset,
  spam_symbols: [Lettermint.Types.SpamSymbol.t()] | :unset,
  status: Lettermint.Types.MessageStatus.t(),
  status_changed_at: String.t() | nil,
  subject: String.t() | nil,
  tag: String.t() | nil,
  tags: [Lettermint.Types.MessageTag.t()],
  to: [Lettermint.Types.MessageRecipientData.t()] | nil,
  type: Lettermint.Types.MessageType.t()
}