sparkpost v0.1.0 API Reference
Modules
An long-form email address with both name and address parts
Various message content representations
File attachment
Inline message content
Raw message content, formatted as per RFC2822
Reference to a named SparkPost template
Base client for the SparkPost API, able to make requests and interpret responses. This module underpins the SparkPost.* modules
Error raised by SparkPost.Endpoint.request/3
when SparkPost returns a response
containing an ‘errors’ key
Response generated by SparkPost.Endpoint.request/3
after a successful API request
A single recipient
Reference to a stored recipient list
The SparkPost Transmission API endpoint for sending email. Use SparkPost.Transmission.send/1
to
send messages, SparkPost.Transmission.list/1 to list previous sends and SparkPost.Transmission.get/1 to
retrieve details on a given transmission
Transmission options
The response generated when SparkPost receives a Transmission request
Tools for verifying and pruning Elixir structs before JSON serialisation
Exceptions
Raised by Address.to_address/1 when an invalid email address is detected
Raised by Wash.verify/2 if a :required field is found