@spec cancel(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.ScheduledMessage.t())

Cancels a scheduled message. Uses the team token when configured, otherwise the sending token.

@spec events(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.ListMessageEventsQuery.t(),
  keyword()
) ::
  result(Lettermint.Types.ListMessageEventsResponse.t())

Lists the events of a message, one page at a time.

@spec html(Lettermint.Client.t(), String.t(), keyword()) :: result(String.t())

The HTML body.

@spec iterate(
  Lettermint.Client.t(),
  Lettermint.Types.ListMessagesQuery.t(),
  keyword()
) ::
  Enumerable.t(Lettermint.Types.MessageListData.t())

Streams every message, following next_cursor. Raises the error of a failed page request.

@spec iterate_events(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.ListMessageEventsQuery.t(),
  keyword()
) :: Enumerable.t(Lettermint.Types.MessageEventData.t())

Streams every event of a message, following next_cursor. Raises the error of a failed page request.

@spec list(Lettermint.Client.t(), Lettermint.Types.ListMessagesQuery.t(), keyword()) ::
  result(Lettermint.Types.ListMessagesResponse.t())

Lists messages, one page at a time. query: Lettermint.Types.ListMessagesQuery.t/0.

@spec process(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.ProcessInboundMessageResponse.t())

Releases one quarantined inbound message for webhook delivery. Options: :idempotency_key and :timeout.

@spec reschedule(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.RescheduleMessageRequest.t() | map(),
  keyword()
) :: result(Lettermint.Types.ScheduledMessage.t())

Moves a scheduled message to another delivery time. Uses the team token when configured, otherwise the sending token.

@spec resend(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.ResendMessageRequest.t() | map(),
  keyword()
) :: result(Lettermint.Types.PendingSendMailResponse.t())

Sends the stored content of a message again, as a new message with its own ID that links to the original through resent_from_message_id. Uses the team token when configured, otherwise the sending token.

body: Lettermint.Types.ResendMessageRequest.t/0. Pass %{recipients: [...]} to resend to some of the original recipients only; omit it to resend to all of them. Options: :idempotency_key and :timeout.

A message can be resent while its content is retained (otherwise Lettermint.APIError with status 410), and at most 5 times in 24 hours (otherwise Lettermint.RateLimitError).

@spec retrieve(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.MessageData.t())

Retrieves a message.

@spec source(Lettermint.Client.t(), String.t(), keyword()) :: result(String.t())

The raw RFC 822 source.

@spec text(Lettermint.Client.t(), String.t(), keyword()) :: result(String.t())

The plain-text body.