sparkpost v0.1.0 SparkPost.Recipient

A single recipient.

Designed for use in SparkPost.Transmission{recipients: ...}.

Fields

  • return_path: Return-Path address (email string)
  • tags: user-specified per-recipient tags (list of string)
  • metadata: user-specified per-recipient metadata (map)
  • substitution_data: personalisation fields for use in the message body (map)

Summary

Functions

Convenience conversions to %SparkPost.Recipient{} from:

  • short form email string (e.g. “you@there.com”)
  • long form email string (e.g. “You There you@there.com”)
  • %{address: ...}
  • %SparkPost.Address{}

Convenience conversions to [ %SparkPost.Recipient{} ] from:

  • %{list_id: ...}
  • mixed list of email strings, %SparkPost.Address structs, %{address: …} and %{name: …, email: …}

Functions

to_recipient(addr)

Convenience conversions to %SparkPost.Recipient{} from:

  • short form email string (e.g. “you@there.com”)
  • long form email string (e.g. “You There you@there.com”)
  • %{address: ...}
  • %SparkPost.Address{}
to_recipient_list(email_list)

Convenience conversions to [ %SparkPost.Recipient{} ] from:

  • %{list_id: ...}
  • mixed list of email strings, %SparkPost.Address structs, %{address: …} and %{name: …, email: …}