Sent and received messages. Needs :team_token; reschedule/4 and
cancel/3 also accept the sending token when no team token is configured.
Every function takes the options timeout: (milliseconds) last.
Summary
Functions
Cancels a scheduled message. Uses the team token when configured, otherwise the sending token.
Lists the events of a message, one page at a time.
The HTML body.
Streams every message, following next_cursor. Raises the error of a failed page request.
Streams every event of a message, following next_cursor. Raises the error of a failed page request.
Lists messages, one page at a time. query: Lettermint.Types.ListMessagesQuery.t/0.
Releases one quarantined inbound message for webhook delivery. Options:
:idempotency_key and :timeout.
Moves a scheduled message to another delivery time. Uses the team token when configured, otherwise the sending token.
Retrieves a message.
The raw RFC 822 source.
The plain-text body.
Types
@type result(value) :: {:ok, value} | {:error, Lettermint.Error.t()}
Functions
@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 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.