All Classes

Class Description
AbstractWebhookEvent  
ABTestCancellationEvent
Details of a canceled A/B test
ABTestCompletionEvent
Results of an A/B test
AddressAttributes
DTO for storing an address (email, name, header_to)
AmpClickEvent
Recipient clicked a tracked link in an AMP message, thus prompting a redirect through the SparkPost click-tracking server to the link's destination.
AmpInitialOpenEvent
Recipient opened an AMP message in a mail client, thus rendering a tracking pixel at the top of the message.
AmpOpenEvent
Recipient opened an AMP message in a mail client, thus rendering a tracking pixel at the bottom of the message.
AttachmentAttributes
DTO for a transmission of attachments.
AuthCredentials  
AuthRequestDetails  
AuthRequestDetails.AuthRequestClientDetails  
Base
Base class for all DTOs.
BounceEvent
Remote MTA has permanently rejected a message.
Build  
CampaignListResponse  
ClickEvent
Recipient clicked a tracked link in a message, thus prompting a redirect through the SparkPost click-tracking server to the link's destination.
Client
The Client class stores everything specific to the SparkPost client:
The Authorization Key The "From:" email address
DelayEvent
Remote MTA has temporarily rejected a message.
DeliverabiltyMetricsResponse  
DeliveryEvent
Remote MTA acknowledged receipt of a message.
DKIM
DKIM uses a pair of public and private keys to authenticate your emails.
DKIMResults  
DNSAttributes  
DomainListResponse  
Endpoint
Used internally to the SparkPost Library to write URL queries.
FileAttributes
DTO for attachments and inline images
GenerationFailureEvent
Message generation failed for an intended recipient.
GenerationRejectionEvent
SparkPost rejected message generation due to policy.
IngestEventErrorEvent
Details of an Ingest API processing error
IngestEventSuccessEvent
Details of an Ingest API processing success
InitialOpenEvent
Recipient opened a message in a mail client, thus rendering a tracking pixel at the top of the message.
InjectionEvent
Message is received by or injected into SparkPost.
InlineImageAttributes
DTO for a transmission of inline images.
IRestConnection  
LinkUnsubscribeEvent
User clicked a hyperlink in a received email.
ListAllSendingDomiansResponse  
ListAllSendingDomiansResponse.Domain  
ListUnsubscribeEvent
User clicked the 'unsubscribe' button on an email client.
Match  
MessageEventsQueryBuilder  
MessageEventsQueryBuilder.BounceClass
Bounce Classification Codes: https://www.sparkpost.com/docs/deliverability/bounce-classification-codes
MessageEventsQueryBuilder.EventType  
MessageEventsResponse  
MetricLinkResponse
child endpoints that contain aggregate data, which can be used as "group by" qualifiers.
MetricsBounceFields  
MetricsDelayReasonFields  
MetricsDeliveriesFields  
MetricsEngagementFields  
MetricsFields
Deliverability Metrics Fields See: https://developers.sparkpost.com/api/#/reference/metrics
MetricsRejectFields  
OpenEvent
Recipient opened a message in a mail client, thus rendering a tracking pixel at the bottom of the message.
OptionsAttributes
DTO for storing the 'options' field in a template.
OutOfBandEvent
Remote MTA initially reported acceptance of a message, but it has since asynchronously reported that the message was not delivered.
PolicyRejectionEvent
Due to policy, SparkPost rejected a message or failed to generate a message.
RecipientAttributes
DTO for storing a recipient.
RecipientList
A recipient list is a collection of recipients that can be used in a transmission.
RecipientListRetrieveResponse  
RecipientListsListAllResponse  
RelayDeliveryEvent
Remote HTTP Endpoint acknowledged receipt of a relayed message.
RelayInjectionEvent
Relayed message is received by or injected into SparkPost.
RelayPermanentFailureEvent
Relayed message has reached the maximum retry threshold and will be removed from the system.
RelayRejectionEvent
SparkPost rejected a relayed message or failed to generate a relayed message.
RelayTemporaryFailureEvent
Remote HTTP Endpoint has failed to accept a relayed message.
ResourceMessageEvents
Resource collection that is a 1-to-1 match to the Metrics SparkPost API.

See Message Events API
ResourceMetrics
Resource collection that is a 1-to-1 match to the Metrics SparkPost API.

See Metrics API
ResourceRecipientLists
Resource collection that is a 1-to-1 match to the Recipient Lists SparkPost API.

See Recipient Lists API
ResourceSendingDomains
Resource collection that is a 1-to-1 match to the Sending Domains SparkPost API.

See Sending Domains API
ResourceSubAccountCrud
ResourceSuppressionList
Resource collection that is a 1-to-1 match to the Suppression List SparkPost API.

See Suppression List API
ResourceTemplates
Resource collection that is a 1-to-1 match to the Templates SparkPost API.
ResourceTransmissions
Resource collection that is a 1-to-1 match to the Transmissions SparkPost API.

See Transmissions API
ResourceWebhooks
Resource collection that is a 1-to-1 match to the Webhooks SparkPost API.

See Webhooks API
Response
The response for the SparkPost server, as returned by @a RestConnection
RestConnection
The REST connection class wraps HTTP requests to the SparkPost API.
RestConnection.Method
Supported HTTP methods
SendingDomain
Note: The Sending Domains API is available for SparkPost only.
ServerErrorResponse  
ServerErrorResponses  
SmsStatusEvent
SMPP/SMS message produced a status log output
SpamComplaintEvent
Message was classified as spam by the recipient.
SparkPostAccessForbiddenException  
SparkPostAuthorizationFailedException  
SparkPostErrorServerResponseException  
SparkPostException  
SparkPostIllegalServerResponseException  
StatusAttributes  
StoredRecipientList
This is used when specifying a stored recipient list in the transmission.
StoredTemplate
DTO for storing a stored template.
SubaccountCreateResponse  
SubaccountCreateResponse.CreateResult  
SubaccountInfo
DTO for storing a subaccount.
SuppressionList
A suppression list - or exclusion list, as it is sometimes called - stores a recipient's opt-out preferences.
SuppressionListEntry
DTO for storing an entry in a suppression list.
SuppressionListEntry.StatusTypes  
SuppressionListEntry.TypeTypes  
SupressionListResponse  
TemplateAttributes
DTO for storing a template.
TemplateContentAttributes
DTO for storing the 'content' field in a template
TemplateCreateResponse  
TemplateCreateResponse.CreateResult  
TemplateItem  
TemplateItemResponse  
TemplateItemResponse.TemplateOptionsData  
TemplateListResponse  
TemplatePreviewResponse  
TemplatePreviewResponse.TemplatePreviewData  
TemplateRetrieveResponse  
TemplateSubstitutionData
DTO for storing substitution data (list of key=value).
TransmissionBase  
TransmissionBase.TransmissionStates  
TransmissionCreateItem  
TransmissionCreateResponse  
TransmissionListResponse  
TransmissionResponseInfo  
TransmissionRetrieveResponseContainer  
TransmissionRetrieveResults  
TransmissionWithRecipientArray
DTO for a transmission using an array of recipients.
TransmissionWithRecipientList
DTO for a transmission using a recipient list id (a recipient list stored at the server)
VerifyAttributes
DTO for storing a Sending Domain verification request.
VerifyResponse
The verify resource validates the specified verification field types.
Webhook  
WebhookDescribeResponse  
WebhookDescription
DTO for storing info about a webhook.
WebhookIdContainerResponse  
WebhookIdResponseEntry  
WebhookListAllResponse