Index
All Classes|All Packages
A
- AbstractWebhookEvent - Class in com.sparkpost.model.webhook.event
- AbstractWebhookEvent() - Constructor for class com.sparkpost.model.webhook.event.AbstractWebhookEvent
- ABTestCancellationEvent - Class in com.sparkpost.model.webhook.event
-
Details of a canceled A/B test
- ABTestCancellationEvent() - Constructor for class com.sparkpost.model.webhook.event.ABTestCancellationEvent
- ABTestCompletionEvent - Class in com.sparkpost.model.webhook.event
-
Results of an A/B test
- ABTestCompletionEvent() - Constructor for class com.sparkpost.model.webhook.event.ABTestCompletionEvent
- addBounceClass(MessageEventsQueryBuilder.BounceClass) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
bounce_classes - delimited list of bounce classification codes to search.
- addCampaignId(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
campaign_ids - delimited list of campaign ID’s to search (i.e.
- addCommonParams(String, String, String, String, String, String, String, String, String) - Method in class com.sparkpost.resources.Endpoint
- addEventType(MessageEventsQueryBuilder.EventType) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
events - delimited list of event types to search.
- addFriendlyFrom(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
friendly_froms - delimited list of friendly from emails to search.
- addHeader(String, String) - Method in interface com.sparkpost.transport.IRestConnection
- addHeader(String, String) - Method in class com.sparkpost.transport.RestConnection
- addKeyGrant(String) - Method in class com.sparkpost.model.SubaccountInfo
-
key_valid_ips array List of IP's that the initial subaccount API key can be used from.
- addMessageId(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
message_ids - delimited list of message ID’s to search.
- addParam(String, Boolean) - Method in class com.sparkpost.resources.Endpoint
- addParam(String, Integer) - Method in class com.sparkpost.resources.Endpoint
- addParam(String, String) - Method in class com.sparkpost.resources.Endpoint
- addRecipient(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
recipients - delimited list of recipients to search.
- AddressAttributes - Class in com.sparkpost.model
-
DTO for storing an address (email, name, header_to)
- AddressAttributes() - Constructor for class com.sparkpost.model.AddressAttributes
- AddressAttributes(String) - Constructor for class com.sparkpost.model.AddressAttributes
- AddressAttributes(String, String, String) - Constructor for class com.sparkpost.model.AddressAttributes
- addSubAccount(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
subaccounts - delimited list of subaccount ID’s to search.
- addTemplateId(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
template_ids - delimited list of template ID’s to search.
- addTransmissionId(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
transmission_ids - delimited list of transmission ID’s to search (i.e.
- ADMIN_FAILURE - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- ALL_FIELDS - Static variable in class com.sparkpost.model.MetricsBounceFields
-
These are all the fields that can be used in a request
- ALL_FIELDS - Static variable in class com.sparkpost.model.MetricsEngagementFields
- ALL_FIELDS - Static variable in class com.sparkpost.model.MetricsFields
-
All Deliverability Fields
- ALL_FIELDS_ARRAY - Static variable in class com.sparkpost.model.MetricsBounceFields
-
This is all the fields available in a response
- ALL_FIELDS_ARRAY - Static variable in class com.sparkpost.model.MetricsDelayReasonFields
- ALL_FIELDS_ARRAY - Static variable in class com.sparkpost.model.MetricsDeliveriesFields
- ALL_FIELDS_ARRAY - Static variable in class com.sparkpost.model.MetricsEngagementFields
- ALL_FIELDS_ARRAY - Static variable in class com.sparkpost.model.MetricsFields
- ALL_FIELDS_ARRAY - Static variable in class com.sparkpost.model.MetricsRejectFields
- AmpClickEvent - Class in com.sparkpost.model.webhook.event
-
Recipient clicked a tracked link in an AMP message, thus prompting a redirect through the SparkPost click-tracking server to the link's destination.
- AmpClickEvent() - Constructor for class com.sparkpost.model.webhook.event.AmpClickEvent
- AmpInitialOpenEvent - Class in com.sparkpost.model.webhook.event
-
Recipient opened an AMP message in a mail client, thus rendering a tracking pixel at the top of the message.
- AmpInitialOpenEvent() - Constructor for class com.sparkpost.model.webhook.event.AmpInitialOpenEvent
- AmpOpenEvent - Class in com.sparkpost.model.webhook.event
-
Recipient opened an AMP message in a mail client, thus rendering a tracking pixel at the bottom of the message.
- AmpOpenEvent() - Constructor for class com.sparkpost.model.webhook.event.AmpOpenEvent
- asStoredRecipientList() - Method in class com.sparkpost.model.RecipientList
-
Returns object that can be used to create transmission.
- AttachmentAttributes - Class in com.sparkpost.model
-
DTO for a transmission of attachments.
- AttachmentAttributes() - Constructor for class com.sparkpost.model.AttachmentAttributes
- ATTEMPT - Static variable in class com.sparkpost.model.MetricsDeliveriesFields
- AuthCredentials - Class in com.sparkpost.model
- AuthCredentials() - Constructor for class com.sparkpost.model.AuthCredentials
- AuthRequestClientDetails() - Constructor for class com.sparkpost.model.AuthRequestDetails.AuthRequestClientDetails
- AuthRequestDetails - Class in com.sparkpost.model
- AuthRequestDetails() - Constructor for class com.sparkpost.model.AuthRequestDetails
- AuthRequestDetails.AuthRequestClientDetails - Class in com.sparkpost.model
- AUTO_REPLY - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
B
- Base - Class in com.sparkpost.model
-
Base class for all DTOs.
- Base() - Constructor for class com.sparkpost.model.Base
- BOUNCE_CATEGORY_NAME - Static variable in class com.sparkpost.model.MetricsBounceFields
- BOUNCE_CLASS_DESCRIPTION - Static variable in class com.sparkpost.model.MetricsBounceFields
- BOUNCE_CLASS_NAME - Static variable in class com.sparkpost.model.MetricsBounceFields
- BOUNCE_DELAY - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- BOUNCE_RULE - Static variable in class com.sparkpost.model.SuppressionListEntry.StatusTypes
- BounceEvent - Class in com.sparkpost.model.webhook.event
-
Remote MTA has permanently rejected a message.
- BounceEvent() - Constructor for class com.sparkpost.model.webhook.event.BounceEvent
- bounceName() - Method in enum com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- Build - Class in com.sparkpost
- Build() - Constructor for class com.sparkpost.Build
- BUILD_DATE - Static variable in class com.sparkpost.Build
- BUILD_VERSION - Static variable in class com.sparkpost.Build
- buildQuery(Endpoint) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
C
- CAMPAIGN_ID - Static variable in class com.sparkpost.model.MetricsFields
- CampaignListResponse - Class in com.sparkpost.model.responses
- CampaignListResponse() - Constructor for class com.sparkpost.model.responses.CampaignListResponse
- CANCELED - Static variable in class com.sparkpost.model.TransmissionBase.TransmissionStates
- CHALLENGE_RESPONSE - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- check(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceSuppressionList
- classification() - Method in enum com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- CLASSIFICATION_ID - Static variable in class com.sparkpost.model.MetricsBounceFields
- ClickEvent - Class in com.sparkpost.model.webhook.event
-
Recipient clicked a tracked link in a message, thus prompting a redirect through the SparkPost click-tracking server to the link's destination.
- ClickEvent() - Constructor for class com.sparkpost.model.webhook.event.ClickEvent
- Client - Class in com.sparkpost
-
The Client class stores everything specific to the SparkPost client:
The Authorization Key The "From:" email address - Client() - Constructor for class com.sparkpost.Client
- Client(String) - Constructor for class com.sparkpost.Client
- Client(String, String) - Constructor for class com.sparkpost.Client
- com.sparkpost - package com.sparkpost
-
com.sparkpost provides an interface to the SparkPost REST API.
This java API is designed to follow closely the design of the SparkPost REST API. - com.sparkpost.exception - package com.sparkpost.exception
- com.sparkpost.model - package com.sparkpost.model
- com.sparkpost.model.responses - package com.sparkpost.model.responses
- com.sparkpost.model.webhook.event - package com.sparkpost.model.webhook.event
- com.sparkpost.resources - package com.sparkpost.resources
- com.sparkpost.transport - package com.sparkpost.transport
- COMPLIANCE - Static variable in class com.sparkpost.model.SuppressionListEntry.StatusTypes
- COUNT_ACCEPTED - Static variable in class com.sparkpost.model.MetricsFields
-
Messages an ISP or other remote domain accepted (less Out-of-Band Bounces)
- COUNT_ADMIN_BOUNCE - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of Bounced messages due to admin bounce classification reasons, also includes Rejected
- COUNT_BLOCK_BOUNCE - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of Bounced messages due to an IP block
- COUNT_BOUNCE - Static variable in class com.sparkpost.model.MetricsBounceFields
- COUNT_BOUNCE - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of bounced messages, which includes both In-Band and Out-of-Band bounces
- COUNT_CLICKED - Static variable in class com.sparkpost.model.MetricsEngagementFields
- COUNT_CLICKED - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of times that links were selected across all messages
- COUNT_DELAYED - Static variable in class com.sparkpost.model.MetricsDelayReasonFields
- COUNT_DELAYED - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of delays due to any temporary failure
- COUNT_DELAYED_FIRST - Static variable in class com.sparkpost.model.MetricsDelayReasonFields
- COUNT_DELAYED_FIRST - Static variable in class com.sparkpost.model.MetricsFields
-
Messages delayed on the first delivery attempt
- COUNT_DELIVERED - Static variable in class com.sparkpost.model.MetricsDeliveriesFields
- COUNT_DELIVERED_FIRST - Static variable in class com.sparkpost.model.MetricsFields
-
Messages delivered on the first attempt
- COUNT_DELIVERED_SUBSEQUENT - Static variable in class com.sparkpost.model.MetricsFields
-
Messages delivered that required more than one delivery attempt
- COUNT_GENERATION_FAILED - Static variable in class com.sparkpost.model.MetricsFields
-
Message generation failed for an intended recipient
- COUNT_GENERATION_REJECTION - Static variable in class com.sparkpost.model.MetricsFields
-
Messages rejected by SparkPost and SparkPost Elite due to policy
- COUNT_HARD_BOUNCE - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of Bounced messages due to hard bounce classification reasons
- COUNT_INBAND_BOUNCE - Static variable in class com.sparkpost.model.MetricsBounceFields
- COUNT_INBAND_BOUNCE - Static variable in class com.sparkpost.model.MetricsFields
-
Messages that bounced on delivery attempt during the SMTP session
- COUNT_INJECTED - Static variable in class com.sparkpost.model.MetricsFields
-
Messages injected to or received by SparkPost and SparkPost Elite
- COUNT_OUTOFBAND_BOUNCE - Static variable in class com.sparkpost.model.MetricsBounceFields
- COUNT_OUTOFBAND_BOUNCE - Static variable in class com.sparkpost.model.MetricsFields
-
Messages that the ISP bounced subsequent to a successful delivery
- COUNT_POLICY_REJECTED - Static variable in class com.sparkpost.model.MetricsFields
-
Messages rejected by SparkPost and SparkPost Elite due to policy
- COUNT_REJECTED - Static variable in class com.sparkpost.model.MetricsFields
-
Messages rejected due to policy or that failed to generate
- COUNT_REJECTED - Static variable in class com.sparkpost.model.MetricsRejectFields
- COUNT_RENDERED - Static variable in class com.sparkpost.model.MetricsFields
-
Total renderings of a message
- COUNT_ROW_CLICKED - Static variable in class com.sparkpost.model.MetricsEngagementFields
- COUNT_SENT - Static variable in class com.sparkpost.model.MetricsFields
-
Messages that SparkPost and SparkPost Elite attempted to deliver, which includes both Deliveries and In-Band Bounces
- COUNT_SOFT_BOUNCE - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of Bounced messages due to soft bounce classification reasons
- COUNT_SPAM_COMPLAINT - Static variable in class com.sparkpost.model.MetricsFields
-
Number of spam complaints received from an ISP
- COUNT_TARGETED - Static variable in class com.sparkpost.model.MetricsFields
-
Messages successfully injected into SparkPost and SparkPost Elite as well as rejected by it
- COUNT_UNDERTERMINED_BOUNCE - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of Bounced messages due to undetermined bounce reasons
- COUNT_UNIQUE_CLICKED - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of messages which had at least one link selected one or more times
- COUNT_UNIQUE_CONFIRMED_OPENED - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of messages that were rendered or had at least one link selected
- COUNT_UNIQUE_RENDERED - Static variable in class com.sparkpost.model.MetricsFields
-
Total number of messages that were rendered at least once
- create(IRestConnection, SendingDomain) - Static method in class com.sparkpost.resources.ResourceSendingDomains
- create(IRestConnection, SubaccountInfo) - Static method in class com.sparkpost.resources.ResourceSubAccountCrud
- create(IRestConnection, TemplateAttributes) - Static method in class com.sparkpost.resources.ResourceTemplates
- create(IRestConnection, Webhook) - Static method in class com.sparkpost.resources.ResourceWebhooks
- create(IRestConnection, Integer, RecipientList) - Static method in class com.sparkpost.resources.ResourceRecipientLists
- create(IRestConnection, Integer, TransmissionWithRecipientArray) - Static method in class com.sparkpost.resources.ResourceTransmissions
- create(IRestConnection, Integer, TransmissionWithRecipientList) - Static method in class com.sparkpost.resources.ResourceTransmissions
- CreateResult() - Constructor for class com.sparkpost.model.responses.SubaccountCreateResponse.CreateResult
- CreateResult() - Constructor for class com.sparkpost.model.responses.TemplateCreateResponse.CreateResult
D
- decode(Response, Type) - Static method in class com.sparkpost.model.responses.Response
- defaultApiEndpoint - Static variable in interface com.sparkpost.transport.IRestConnection
-
Default endpoint to use for connections : https://api.sparkpost.com/api/v1
- DelayEvent - Class in com.sparkpost.model.webhook.event
-
Remote MTA has temporarily rejected a message.
- DelayEvent() - Constructor for class com.sparkpost.model.webhook.event.DelayEvent
- delete(Endpoint) - Method in interface com.sparkpost.transport.IRestConnection
-
Perform an HTTP DELETE request.
- delete(Endpoint) - Method in class com.sparkpost.transport.RestConnection
- delete(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceRecipientLists
- delete(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceTemplates
- delete(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceTransmissions
- delete(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceWebhooks
- DELETE - com.sparkpost.transport.RestConnection.Method
- DeliverabiltyMetricsResponse - Class in com.sparkpost.model.responses
- DeliverabiltyMetricsResponse() - Constructor for class com.sparkpost.model.responses.DeliverabiltyMetricsResponse
- DELIVERY - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- DeliveryEvent - Class in com.sparkpost.model.webhook.event
-
Remote MTA acknowledged receipt of a message.
- DeliveryEvent() - Constructor for class com.sparkpost.model.webhook.event.DeliveryEvent
- describe(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceWebhooks
- describe(IRestConnection, String, String) - Static method in class com.sparkpost.resources.ResourceWebhooks
- description() - Method in enum com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- DKIM - Class in com.sparkpost.model
-
DKIM uses a pair of public and private keys to authenticate your emails.
- DKIM() - Constructor for class com.sparkpost.model.DKIM
- DKIMResults - Class in com.sparkpost.model
- DKIMResults() - Constructor for class com.sparkpost.model.DKIMResults
- DNS_FAILURE - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- DNSAttributes - Class in com.sparkpost.model
- DNSAttributes() - Constructor for class com.sparkpost.model.DNSAttributes
- Domain() - Constructor for class com.sparkpost.model.responses.ListAllSendingDomiansResponse.Domain
- DOMAIN - Static variable in class com.sparkpost.model.MetricsBounceFields
- DOMAIN - Static variable in class com.sparkpost.model.MetricsFields
- DomainListResponse - Class in com.sparkpost.model.responses
- DomainListResponse() - Constructor for class com.sparkpost.model.responses.DomainListResponse
E
- Endpoint - Class in com.sparkpost.resources
-
Used internally to the SparkPost Library to write URL queries.
- Endpoint(String) - Constructor for class com.sparkpost.resources.Endpoint
- eventType() - Method in enum com.sparkpost.model.MessageEventsQueryBuilder.EventType
F
- FBL - Static variable in class com.sparkpost.model.SuppressionListEntry.StatusTypes
- FileAttributes - Class in com.sparkpost.model
-
DTO for attachments and inline images
- FileAttributes() - Constructor for class com.sparkpost.model.FileAttributes
G
- GENERATION_FAILURE - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- GENERATION_REJECTION - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- GenerationFailureEvent - Class in com.sparkpost.model.webhook.event
-
Message generation failed for an intended recipient.
- GenerationFailureEvent() - Constructor for class com.sparkpost.model.webhook.event.GenerationFailureEvent
- GenerationRejectionEvent - Class in com.sparkpost.model.webhook.event
-
SparkPost rejected message generation due to policy.
- GenerationRejectionEvent() - Constructor for class com.sparkpost.model.webhook.event.GenerationRejectionEvent
- GENERIC_BOUCNE - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- get(Endpoint) - Method in interface com.sparkpost.transport.IRestConnection
-
Perform an HTTP GET request.
- get(Endpoint) - Method in class com.sparkpost.transport.RestConnection
- get(IRestConnection, int) - Static method in class com.sparkpost.resources.ResourceSubAccountCrud
- GET - com.sparkpost.transport.RestConnection.Method
- getAuthKey() - Method in class com.sparkpost.Client
- getBaseUrl() - Method in class com.sparkpost.Client
- getBounceClassificationMetrics(IRestConnection, String, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getBounceReasonMetrics(IRestConnection, String, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getBounceReasonMetricsByDomain(IRestConnection, String, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getCampaignList() - Method in class com.sparkpost.model.responses.CampaignListResponse
- getCampaignsList(IRestConnection, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getCategory() - Method in enum com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- getDelayReasonMetrics(IRestConnection, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getDelayReasonMetricsByDomain(IRestConnection, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getDeliverabilityMetricsByCampaign(IRestConnection, String, String, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getDeliverabilityMetricsByDomain(IRestConnection, String, String, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getDeliverabilityMetricsByTemplate(IRestConnection, String, String, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getDeliverabilityMetricsByWatchedDomain(IRestConnection, String, String, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getDeliverabilityMetricsSummary(IRestConnection, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getDeliveriesByAttempt(IRestConnection, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getDiscoverabilityLinks(IRestConnection) - Static method in class com.sparkpost.resources.ResourceMetrics
- getDomainList() - Method in class com.sparkpost.model.responses.DomainListResponse
- getDomainsList(IRestConnection, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getEngagementDetails(IRestConnection, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getFromEmail() - Method in class com.sparkpost.Client
- getHttpConnectTimeout() - Method in class com.sparkpost.Client
- getHttpReadTimeout() - Method in class com.sparkpost.Client
- getPassword() - Method in class com.sparkpost.Client
- getProxy() - Method in class com.sparkpost.Client
- getRejectionReasonMetrics(IRestConnection, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getRejectionReasonMetricsByDomain(IRestConnection, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getSamplePayloadForEvents(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceWebhooks
- getServerErrorResponses() - Method in exception com.sparkpost.exception.SparkPostException
- getServerMessage() - Method in exception com.sparkpost.exception.SparkPostAccessForbiddenException
- getServerMessage() - Method in exception com.sparkpost.exception.SparkPostAuthorizationFailedException
- getTimeSeriesMetrics(IRestConnection, String, String, String, String, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceMetrics
- getType() - Method in class com.sparkpost.model.webhook.event.AbstractWebhookEvent
- getUsername() - Method in class com.sparkpost.Client
- GIT_HASH - Static variable in class com.sparkpost.Build
- GIT_SHORT_HASH - Static variable in class com.sparkpost.Build
- GREETING - Static variable in class com.sparkpost.model.TransmissionBase.TransmissionStates
H
- hasNext() - Method in class com.sparkpost.model.responses.MessageEventsResponse
- hasNext() - Method in class com.sparkpost.model.responses.SupressionListResponse
I
- IngestEventErrorEvent - Class in com.sparkpost.model.webhook.event
-
Details of an Ingest API processing error
- IngestEventErrorEvent() - Constructor for class com.sparkpost.model.webhook.event.IngestEventErrorEvent
- IngestEventSuccessEvent - Class in com.sparkpost.model.webhook.event
-
Details of an Ingest API processing success
- IngestEventSuccessEvent() - Constructor for class com.sparkpost.model.webhook.event.IngestEventSuccessEvent
- InitialOpenEvent - Class in com.sparkpost.model.webhook.event
-
Recipient opened a message in a mail client, thus rendering a tracking pixel at the top of the message.
- InitialOpenEvent() - Constructor for class com.sparkpost.model.webhook.event.InitialOpenEvent
- INJECTION - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- InjectionEvent - Class in com.sparkpost.model.webhook.event
-
Message is received by or injected into SparkPost.
- InjectionEvent() - Constructor for class com.sparkpost.model.webhook.event.InjectionEvent
- InlineImageAttributes - Class in com.sparkpost.model
-
DTO for a transmission of inline images.
- InlineImageAttributes() - Constructor for class com.sparkpost.model.InlineImageAttributes
- insertOrUpdate(IRestConnection, String, SuppressionListEntry) - Static method in class com.sparkpost.resources.ResourceSuppressionList
- insertOrUpdateBulk(IRestConnection, SuppressionList) - Static method in class com.sparkpost.resources.ResourceSuppressionList
- INVALID_RECIPIENT - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- IRestConnection - Interface in com.sparkpost.transport
- isDisconnectAfterRequest() - Method in class com.sparkpost.Client
-
If true will be more aggressive about disconnecting idle HTTP connections
L
- LINK_NAME - Static variable in class com.sparkpost.model.MetricsEngagementFields
- LINK_UNSUBSCRIBE - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- LinkUnsubscribeEvent - Class in com.sparkpost.model.webhook.event
-
User clicked a hyperlink in a received email.
- LinkUnsubscribeEvent() - Constructor for class com.sparkpost.model.webhook.event.LinkUnsubscribeEvent
- list(IRestConnection) - Static method in class com.sparkpost.resources.ResourceSendingDomains
- list(IRestConnection) - Static method in class com.sparkpost.resources.ResourceSubAccountCrud
- list(IRestConnection, String, String) - Static method in class com.sparkpost.resources.ResourceTransmissions
- LIST_UNSUBSCRIBE - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- LIST_UNSUBSCRIBE - Static variable in class com.sparkpost.model.SuppressionListEntry.StatusTypes
- listAll(IRestConnection) - Static method in class com.sparkpost.resources.ResourceRecipientLists
- listAll(IRestConnection) - Static method in class com.sparkpost.resources.ResourceTemplates
- listAll(IRestConnection) - Static method in class com.sparkpost.resources.ResourceWebhooks
- listAll(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceWebhooks
- ListAllSendingDomiansResponse - Class in com.sparkpost.model.responses
- ListAllSendingDomiansResponse() - Constructor for class com.sparkpost.model.responses.ListAllSendingDomiansResponse
- ListAllSendingDomiansResponse.Domain - Class in com.sparkpost.model.responses
- listSampleValuesAndEvents(IRestConnection) - Static method in class com.sparkpost.resources.ResourceWebhooks
- ListUnsubscribeEvent - Class in com.sparkpost.model.webhook.event
-
User clicked the 'unsubscribe' button on an email client.
- ListUnsubscribeEvent() - Constructor for class com.sparkpost.model.webhook.event.ListUnsubscribeEvent
M
- MAIL_BLOCK - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- MAILBOX_FULL - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- MANUALLY_ADDED - Static variable in class com.sparkpost.model.SuppressionListEntry.StatusTypes
- Match - Class in com.sparkpost.model
- Match() - Constructor for class com.sparkpost.model.Match
- MESSAGE_EVENTS_VIEW_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
- MessageEventsQueryBuilder - Class in com.sparkpost.model
- MessageEventsQueryBuilder() - Constructor for class com.sparkpost.model.MessageEventsQueryBuilder
- MessageEventsQueryBuilder.BounceClass - Enum in com.sparkpost.model
-
Bounce Classification Codes: https://www.sparkpost.com/docs/deliverability/bounce-classification-codes
- MessageEventsQueryBuilder.EventType - Enum in com.sparkpost.model
- MessageEventsResponse - Class in com.sparkpost.model.responses
- MessageEventsResponse() - Constructor for class com.sparkpost.model.responses.MessageEventsResponse
- MetricLinkResponse - Class in com.sparkpost.model.responses
-
child endpoints that contain aggregate data, which can be used as "group by" qualifiers.
- MetricLinkResponse() - Constructor for class com.sparkpost.model.responses.MetricLinkResponse
- MetricsBounceFields - Class in com.sparkpost.model
- MetricsBounceFields() - Constructor for class com.sparkpost.model.MetricsBounceFields
- MetricsDelayReasonFields - Class in com.sparkpost.model
- MetricsDelayReasonFields() - Constructor for class com.sparkpost.model.MetricsDelayReasonFields
- MetricsDeliveriesFields - Class in com.sparkpost.model
- MetricsDeliveriesFields() - Constructor for class com.sparkpost.model.MetricsDeliveriesFields
- MetricsEngagementFields - Class in com.sparkpost.model
- MetricsEngagementFields() - Constructor for class com.sparkpost.model.MetricsEngagementFields
- MetricsFields - Class in com.sparkpost.model
-
Deliverability Metrics Fields See: https://developers.sparkpost.com/api/#/reference/metrics
- MetricsFields() - Constructor for class com.sparkpost.model.MetricsFields
- MetricsRejectFields - Class in com.sparkpost.model
- MetricsRejectFields() - Constructor for class com.sparkpost.model.MetricsRejectFields
N
- nextMessageEvents(IRestConnection, MessageEventsResponse) - Static method in class com.sparkpost.resources.ResourceMessageEvents
- nextPageUrl() - Method in class com.sparkpost.model.responses.MessageEventsResponse
- nextPageUrl() - Method in class com.sparkpost.model.responses.SupressionListResponse
- NO_RCPT - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- NON_TRANSACTIONAL_TYPE - Static variable in class com.sparkpost.model.SuppressionListEntry.TypeTypes
O
- OPEN_CLICK - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- OpenEvent - Class in com.sparkpost.model.webhook.event
-
Recipient opened a message in a mail client, thus rendering a tracking pixel at the bottom of the message.
- OpenEvent() - Constructor for class com.sparkpost.model.webhook.event.OpenEvent
- OptionsAttributes - Class in com.sparkpost.model
-
DTO for storing the 'options' field in a template.
- OptionsAttributes() - Constructor for class com.sparkpost.model.OptionsAttributes
- OUT_OF_BAND - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- OutOfBandEvent - Class in com.sparkpost.model.webhook.event
-
Remote MTA initially reported acceptance of a message, but it has since asynchronously reported that the message was not delivered.
- OutOfBandEvent() - Constructor for class com.sparkpost.model.webhook.event.OutOfBandEvent
P
- POLICY_REJECTION - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- PolicyRejectionEvent - Class in com.sparkpost.model.webhook.event
-
Due to policy, SparkPost rejected a message or failed to generate a message.
- PolicyRejectionEvent() - Constructor for class com.sparkpost.model.webhook.event.PolicyRejectionEvent
- post(Endpoint, String) - Method in interface com.sparkpost.transport.IRestConnection
-
Perform an HTTP POST request.
- post(Endpoint, String) - Method in class com.sparkpost.transport.RestConnection
- POST - com.sparkpost.transport.RestConnection.Method
- preview(IRestConnection, String, Boolean, TemplateSubstitutionData) - Static method in class com.sparkpost.resources.ResourceTemplates
- PROHIBITED_ATTACHMENT - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- put(Endpoint, String) - Method in interface com.sparkpost.transport.IRestConnection
-
Perform an HTTP PUT request.
- put(Endpoint, String) - Method in class com.sparkpost.transport.RestConnection
- PUT - com.sparkpost.transport.RestConnection.Method
R
- REASON - Static variable in class com.sparkpost.model.MetricsBounceFields
- REASON - Static variable in class com.sparkpost.model.MetricsDelayReasonFields
- REASON - Static variable in class com.sparkpost.model.MetricsRejectFields
- RecipientAttributes - Class in com.sparkpost.model
-
DTO for storing a recipient.
- RecipientAttributes() - Constructor for class com.sparkpost.model.RecipientAttributes
- RecipientList - Class in com.sparkpost.model
-
A recipient list is a collection of recipients that can be used in a transmission.
- RecipientList() - Constructor for class com.sparkpost.model.RecipientList
- RecipientListRetrieveResponse - Class in com.sparkpost.model.responses
- RecipientListRetrieveResponse() - Constructor for class com.sparkpost.model.responses.RecipientListRetrieveResponse
- RecipientListsListAllResponse - Class in com.sparkpost.model.responses
- RecipientListsListAllResponse() - Constructor for class com.sparkpost.model.responses.RecipientListsListAllResponse
- REJECTION_CATEGORY_ID - Static variable in class com.sparkpost.model.MetricsRejectFields
- REJECTION_CATEGORY_NAME - Static variable in class com.sparkpost.model.MetricsRejectFields
- RelayDeliveryEvent - Class in com.sparkpost.model.webhook.event
-
Remote HTTP Endpoint acknowledged receipt of a relayed message.
- RelayDeliveryEvent() - Constructor for class com.sparkpost.model.webhook.event.RelayDeliveryEvent
- RELAYING_DENIED - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- RelayInjectionEvent - Class in com.sparkpost.model.webhook.event
-
Relayed message is received by or injected into SparkPost.
- RelayInjectionEvent() - Constructor for class com.sparkpost.model.webhook.event.RelayInjectionEvent
- RelayPermanentFailureEvent - Class in com.sparkpost.model.webhook.event
-
Relayed message has reached the maximum retry threshold and will be removed from the system.
- RelayPermanentFailureEvent() - Constructor for class com.sparkpost.model.webhook.event.RelayPermanentFailureEvent
- RelayRejectionEvent - Class in com.sparkpost.model.webhook.event
-
SparkPost rejected a relayed message or failed to generate a relayed message.
- RelayRejectionEvent() - Constructor for class com.sparkpost.model.webhook.event.RelayRejectionEvent
- RelayTemporaryFailureEvent - Class in com.sparkpost.model.webhook.event
-
Remote HTTP Endpoint has failed to accept a relayed message.
- RelayTemporaryFailureEvent() - Constructor for class com.sparkpost.model.webhook.event.RelayTemporaryFailureEvent
- remove(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceSuppressionList
- ResourceMessageEvents - Class in com.sparkpost.resources
- ResourceMessageEvents() - Constructor for class com.sparkpost.resources.ResourceMessageEvents
- ResourceMetrics - Class in com.sparkpost.resources
- ResourceMetrics() - Constructor for class com.sparkpost.resources.ResourceMetrics
- ResourceRecipientLists - Class in com.sparkpost.resources
-
Resource collection that is a 1-to-1 match to the Recipient Lists SparkPost API.
See Recipient Lists API - ResourceRecipientLists() - Constructor for class com.sparkpost.resources.ResourceRecipientLists
- ResourceSendingDomains - Class in com.sparkpost.resources
-
Resource collection that is a 1-to-1 match to the Sending Domains SparkPost API.
See Sending Domains API - ResourceSendingDomains() - Constructor for class com.sparkpost.resources.ResourceSendingDomains
- ResourceSubAccountCrud - Class in com.sparkpost.resources
- ResourceSubAccountCrud() - Constructor for class com.sparkpost.resources.ResourceSubAccountCrud
- ResourceSuppressionList - Class in com.sparkpost.resources
-
Resource collection that is a 1-to-1 match to the Suppression List SparkPost API.
See Suppression List API - ResourceSuppressionList() - Constructor for class com.sparkpost.resources.ResourceSuppressionList
- ResourceTemplates - Class in com.sparkpost.resources
-
Resource collection that is a 1-to-1 match to the Templates SparkPost API.
- ResourceTemplates() - Constructor for class com.sparkpost.resources.ResourceTemplates
- ResourceTransmissions - Class in com.sparkpost.resources
-
Resource collection that is a 1-to-1 match to the Transmissions SparkPost API.
See Transmissions API - ResourceTransmissions() - Constructor for class com.sparkpost.resources.ResourceTransmissions
- ResourceWebhooks - Class in com.sparkpost.resources
- ResourceWebhooks() - Constructor for class com.sparkpost.resources.ResourceWebhooks
- Response - Class in com.sparkpost.model.responses
-
The response for the SparkPost server, as returned by @a RestConnection
- Response() - Constructor for class com.sparkpost.model.responses.Response
- RestConnection - Class in com.sparkpost.transport
-
The REST connection class wraps HTTP requests to the SparkPost API.
- RestConnection(Client) - Constructor for class com.sparkpost.transport.RestConnection
-
Create a REST connection object.
- RestConnection(Client, String) - Constructor for class com.sparkpost.transport.RestConnection
-
Create a REST connection object.
- RestConnection.Method - Enum in com.sparkpost.transport
-
Supported HTTP methods
- retrieve(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceSendingDomains
- retrieve(IRestConnection, String) - Static method in class com.sparkpost.resources.ResourceTransmissions
- retrieve(IRestConnection, String, Boolean) - Static method in class com.sparkpost.resources.ResourceRecipientLists
- retrieve(IRestConnection, String, Boolean) - Static method in class com.sparkpost.resources.ResourceTemplates
S
- search(IRestConnection, String, String, String, String) - Static method in class com.sparkpost.resources.ResourceSuppressionList
- searchMessageEvents(IRestConnection) - Static method in class com.sparkpost.resources.ResourceMessageEvents
- searchMessageEvents(IRestConnection, int) - Static method in class com.sparkpost.resources.ResourceMessageEvents
- searchMessageEvents(IRestConnection, int, MessageEventsQueryBuilder) - Static method in class com.sparkpost.resources.ResourceMessageEvents
- searchMessageEvents(IRestConnection, MessageEventsQueryBuilder) - Static method in class com.sparkpost.resources.ResourceMessageEvents
- SENDING_DOMAIN_MANAGE_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
- SendingDomain - Class in com.sparkpost.model
-
Note: The Sending Domains API is available for SparkPost only.
- SendingDomain() - Constructor for class com.sparkpost.model.SendingDomain
- sendMessage(String, String, String, String, String) - Method in class com.sparkpost.Client
- sendMessage(String, List<String>, String, String, String) - Method in class com.sparkpost.Client
- ServerErrorResponse - Class in com.sparkpost.model.responses
- ServerErrorResponse() - Constructor for class com.sparkpost.model.responses.ServerErrorResponse
- ServerErrorResponses - Class in com.sparkpost.model.responses
- ServerErrorResponses() - Constructor for class com.sparkpost.model.responses.ServerErrorResponses
- setAuthKey(String) - Method in class com.sparkpost.Client
-
You can create and API Key here SparkPost
- setBaseUrl(String) - Method in class com.sparkpost.Client
- setDisconnectAfterRequest(boolean) - Method in class com.sparkpost.Client
-
If true the underlying HTTP transport will be more aggressive about closing idle HTTP connection so may not resuse TCP sockets as much.
- setFromDateTime(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
From Datetime in format of YYYY-MM-DDTHH:MM.
- setFromEmail(String) - Method in class com.sparkpost.Client
- setHttpConnectTimeout(int) - Method in class com.sparkpost.Client
-
Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection.
- setHttpReadTimeout(int) - Method in class com.sparkpost.Client
- setPassword(String) - Method in class com.sparkpost.Client
- setProxy(String, int) - Method in class com.sparkpost.Client
- setReason(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
reason - Bounce/failure/rejection reason that will be matched using a wildcard (e.g., %reason%).
- setSortOutput(boolean) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
- setTimezone(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
-
timezone - Standard timezone identification string.
- setToDateTime(String) - Method in class com.sparkpost.model.MessageEventsQueryBuilder
- setUsername(String) - Method in class com.sparkpost.Client
- SmsStatusEvent - Class in com.sparkpost.model.webhook.event
-
SMPP/SMS message produced a status log output
- SmsStatusEvent() - Constructor for class com.sparkpost.model.webhook.event.SmsStatusEvent
- SMTP_INJECTION_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
-
Key Grants
- SOFT_BOUNCE - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- SPAM_BLOCK - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- SPAM_COMPLAING - Static variable in class com.sparkpost.model.SuppressionListEntry.StatusTypes
- SPAM_COMPLAINT - com.sparkpost.model.MessageEventsQueryBuilder.EventType
- SPAM_CONTENT - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- SpamComplaintEvent - Class in com.sparkpost.model.webhook.event
-
Message was classified as spam by the recipient.
- SpamComplaintEvent() - Constructor for class com.sparkpost.model.webhook.event.SpamComplaintEvent
- SparkPostAccessForbiddenException - Exception in com.sparkpost.exception
- SparkPostAccessForbiddenException() - Constructor for exception com.sparkpost.exception.SparkPostAccessForbiddenException
- SparkPostAccessForbiddenException(String) - Constructor for exception com.sparkpost.exception.SparkPostAccessForbiddenException
- SparkPostAccessForbiddenException(String, ServerErrorResponses) - Constructor for exception com.sparkpost.exception.SparkPostAccessForbiddenException
- SparkPostAuthorizationFailedException - Exception in com.sparkpost.exception
- SparkPostAuthorizationFailedException() - Constructor for exception com.sparkpost.exception.SparkPostAuthorizationFailedException
- SparkPostAuthorizationFailedException(String) - Constructor for exception com.sparkpost.exception.SparkPostAuthorizationFailedException
- SparkPostAuthorizationFailedException(String, ServerErrorResponses) - Constructor for exception com.sparkpost.exception.SparkPostAuthorizationFailedException
- SparkPostErrorServerResponseException - Exception in com.sparkpost.exception
- SparkPostErrorServerResponseException(String, int) - Constructor for exception com.sparkpost.exception.SparkPostErrorServerResponseException
- SparkPostErrorServerResponseException(String, int, ServerErrorResponses) - Constructor for exception com.sparkpost.exception.SparkPostErrorServerResponseException
- SparkPostException - Exception in com.sparkpost.exception
- SparkPostException() - Constructor for exception com.sparkpost.exception.SparkPostException
- SparkPostException(String) - Constructor for exception com.sparkpost.exception.SparkPostException
- SparkPostException(String, ServerErrorResponses) - Constructor for exception com.sparkpost.exception.SparkPostException
- SparkPostException(String, Throwable) - Constructor for exception com.sparkpost.exception.SparkPostException
- SparkPostException(String, Throwable, ServerErrorResponses) - Constructor for exception com.sparkpost.exception.SparkPostException
- SparkPostException(Throwable) - Constructor for exception com.sparkpost.exception.SparkPostException
- SparkPostException(Throwable, ServerErrorResponses) - Constructor for exception com.sparkpost.exception.SparkPostException
- SparkPostIllegalServerResponseException - Exception in com.sparkpost.exception
- SparkPostIllegalServerResponseException() - Constructor for exception com.sparkpost.exception.SparkPostIllegalServerResponseException
- SparkPostIllegalServerResponseException(String) - Constructor for exception com.sparkpost.exception.SparkPostIllegalServerResponseException
- SparkPostIllegalServerResponseException(String, Throwable) - Constructor for exception com.sparkpost.exception.SparkPostIllegalServerResponseException
- SparkPostIllegalServerResponseException(Throwable) - Constructor for exception com.sparkpost.exception.SparkPostIllegalServerResponseException
- SPC_EU_ENDPOINT - Static variable in interface com.sparkpost.transport.IRestConnection
- SPC_US_ENDPOINT - Static variable in interface com.sparkpost.transport.IRestConnection
- StatusAttributes - Class in com.sparkpost.model
- StatusAttributes() - Constructor for class com.sparkpost.model.StatusAttributes
- StatusTypes() - Constructor for class com.sparkpost.model.SuppressionListEntry.StatusTypes
- StoredRecipientList - Class in com.sparkpost.model
-
This is used when specifying a stored recipient list in the transmission.
- StoredRecipientList() - Constructor for class com.sparkpost.model.StoredRecipientList
- StoredTemplate - Class in com.sparkpost.model
-
DTO for storing a stored template.
- StoredTemplate() - Constructor for class com.sparkpost.model.StoredTemplate
- SUBACCOUNT_HEADER - Static variable in interface com.sparkpost.transport.IRestConnection
- SubaccountCreateResponse - Class in com.sparkpost.model.responses
- SubaccountCreateResponse() - Constructor for class com.sparkpost.model.responses.SubaccountCreateResponse
- SubaccountCreateResponse.CreateResult - Class in com.sparkpost.model.responses
- SubaccountInfo - Class in com.sparkpost.model
-
DTO for storing a subaccount.
- SubaccountInfo() - Constructor for class com.sparkpost.model.SubaccountInfo
- SUBMITTED - Static variable in class com.sparkpost.model.TransmissionBase.TransmissionStates
- SUBSCRIBE - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- SUCCESS - Static variable in class com.sparkpost.model.TransmissionBase.TransmissionStates
- SUPPRESSION_LISTS_MANAGE_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
- SuppressionList - Class in com.sparkpost.model
-
A suppression list - or exclusion list, as it is sometimes called - stores a recipient's opt-out preferences.
- SuppressionList() - Constructor for class com.sparkpost.model.SuppressionList
- SuppressionListEntry - Class in com.sparkpost.model
-
DTO for storing an entry in a suppression list.
- SuppressionListEntry() - Constructor for class com.sparkpost.model.SuppressionListEntry
- SuppressionListEntry(SuppressionListEntry) - Constructor for class com.sparkpost.model.SuppressionListEntry
- SuppressionListEntry.StatusTypes - Class in com.sparkpost.model
- SuppressionListEntry.TypeTypes - Class in com.sparkpost.model
- SupressionListResponse - Class in com.sparkpost.model.responses
- SupressionListResponse() - Constructor for class com.sparkpost.model.responses.SupressionListResponse
T
- TEMPLATE_ID - Static variable in class com.sparkpost.model.MetricsFields
- TemplateAttributes - Class in com.sparkpost.model
-
DTO for storing a template.
- TemplateAttributes() - Constructor for class com.sparkpost.model.TemplateAttributes
- TemplateContentAttributes - Class in com.sparkpost.model
-
DTO for storing the 'content' field in a template
- TemplateContentAttributes() - Constructor for class com.sparkpost.model.TemplateContentAttributes
- TemplateCreateResponse - Class in com.sparkpost.model.responses
- TemplateCreateResponse() - Constructor for class com.sparkpost.model.responses.TemplateCreateResponse
- TemplateCreateResponse.CreateResult - Class in com.sparkpost.model.responses
- TemplateItem - Class in com.sparkpost.model
- TemplateItem() - Constructor for class com.sparkpost.model.TemplateItem
- TemplateItemResponse - Class in com.sparkpost.model.responses
- TemplateItemResponse() - Constructor for class com.sparkpost.model.responses.TemplateItemResponse
- TemplateItemResponse.TemplateOptionsData - Class in com.sparkpost.model.responses
- TemplateListResponse - Class in com.sparkpost.model.responses
- TemplateListResponse() - Constructor for class com.sparkpost.model.responses.TemplateListResponse
- TemplateOptionsData() - Constructor for class com.sparkpost.model.responses.TemplateItemResponse.TemplateOptionsData
- TemplatePreviewData() - Constructor for class com.sparkpost.model.responses.TemplatePreviewResponse.TemplatePreviewData
- TemplatePreviewResponse - Class in com.sparkpost.model.responses
- TemplatePreviewResponse() - Constructor for class com.sparkpost.model.responses.TemplatePreviewResponse
- TemplatePreviewResponse.TemplatePreviewData - Class in com.sparkpost.model.responses
- TemplateRetrieveResponse - Class in com.sparkpost.model.responses
- TemplateRetrieveResponse() - Constructor for class com.sparkpost.model.responses.TemplateRetrieveResponse
- TemplateSubstitutionData - Class in com.sparkpost.model
-
DTO for storing substitution data (list of key=value).
- TemplateSubstitutionData() - Constructor for class com.sparkpost.model.TemplateSubstitutionData
- TIMEOUT - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- TIMESTAMP - Static variable in class com.sparkpost.model.MetricsFields
- toJson() - Method in class com.sparkpost.model.Base
-
Generate JSON for this request
- toJson(boolean) - Method in class com.sparkpost.model.Base
- toJson(Class) - Method in class com.sparkpost.model.Base
-
Generate JSON from this object for required type.
- TOO_LARGE - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- toString() - Method in class com.sparkpost.Client
- toString() - Method in enum com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- toString() - Method in enum com.sparkpost.model.MessageEventsQueryBuilder.EventType
- toString() - Method in class com.sparkpost.resources.Endpoint
- TOTAL_DELIVERY_TIME_FIRST - Static variable in class com.sparkpost.model.MetricsFields
- TOTAL_DELIVERY_TIME_SUBSEQUENT - Static variable in class com.sparkpost.model.MetricsFields
- TOTAL_MSG_VOLUME - Static variable in class com.sparkpost.model.MetricsFields
-
Total size of delivered messages, in bytes (including attachments)
- TRACKING_DOMAINS_MANAGE_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
- TRACKING_DOMAINS_VIEW_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
- TRANSACTIONAL_TYPE - Static variable in class com.sparkpost.model.SuppressionListEntry.TypeTypes
- TRANSIENT_FAILURE - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- TRANSMISSION_MODIFY_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
- TransmissionBase - Class in com.sparkpost.model
- TransmissionBase() - Constructor for class com.sparkpost.model.TransmissionBase
- TransmissionBase.TransmissionStates - Class in com.sparkpost.model
- TransmissionCreateItem - Class in com.sparkpost.model.responses
- TransmissionCreateItem() - Constructor for class com.sparkpost.model.responses.TransmissionCreateItem
- TransmissionCreateResponse - Class in com.sparkpost.model.responses
- TransmissionCreateResponse() - Constructor for class com.sparkpost.model.responses.TransmissionCreateResponse
- TransmissionListResponse - Class in com.sparkpost.model.responses
- TransmissionListResponse() - Constructor for class com.sparkpost.model.responses.TransmissionListResponse
- TransmissionResponseInfo - Class in com.sparkpost.model.responses
- TransmissionResponseInfo() - Constructor for class com.sparkpost.model.responses.TransmissionResponseInfo
- TransmissionRetrieveResponseContainer - Class in com.sparkpost.model.responses
- TransmissionRetrieveResponseContainer() - Constructor for class com.sparkpost.model.responses.TransmissionRetrieveResponseContainer
- TransmissionRetrieveResults - Class in com.sparkpost.model.responses
- TransmissionRetrieveResults() - Constructor for class com.sparkpost.model.responses.TransmissionRetrieveResults
- TRANSMISSIONS_VIEW_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
- TransmissionStates() - Constructor for class com.sparkpost.model.TransmissionBase.TransmissionStates
- TransmissionWithRecipientArray - Class in com.sparkpost.model
-
DTO for a transmission using an array of recipients.
- TransmissionWithRecipientArray() - Constructor for class com.sparkpost.model.TransmissionWithRecipientArray
- TransmissionWithRecipientList - Class in com.sparkpost.model
-
DTO for a transmission using a recipient list id (a recipient list stored at the server)
- TransmissionWithRecipientList() - Constructor for class com.sparkpost.model.TransmissionWithRecipientList
- TypeTypes() - Constructor for class com.sparkpost.model.SuppressionListEntry.TypeTypes
U
- UNDERTERMINED - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- UNSUBSCRIBE - com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
- UNSUBSCRIBE_LINK - Static variable in class com.sparkpost.model.SuppressionListEntry.StatusTypes
- update(IRestConnection, String, SendingDomain) - Static method in class com.sparkpost.resources.ResourceSendingDomains
- update(IRestConnection, String, WebhookDescription) - Static method in class com.sparkpost.resources.ResourceWebhooks
- update(IRestConnection, String, Boolean, TemplateAttributes) - Static method in class com.sparkpost.resources.ResourceTemplates
V
- valueOf(String) - Static method in enum com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sparkpost.model.MessageEventsQueryBuilder.EventType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.sparkpost.transport.RestConnection.Method
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.sparkpost.model.MessageEventsQueryBuilder.BounceClass
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.sparkpost.model.MessageEventsQueryBuilder.EventType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.sparkpost.transport.RestConnection.Method
-
Returns an array containing the constants of this enum type, in the order they are declared.
- verify(IRestConnection, String, VerifyAttributes) - Static method in class com.sparkpost.resources.ResourceSendingDomains
- VerifyAttributes - Class in com.sparkpost.model
-
DTO for storing a Sending Domain verification request.
- VerifyAttributes() - Constructor for class com.sparkpost.model.VerifyAttributes
- VerifyResponse - Class in com.sparkpost.model
-
The verify resource validates the specified verification field types.
- VerifyResponse() - Constructor for class com.sparkpost.model.VerifyResponse
- VERSION - Static variable in class com.sparkpost.Build
W
- WATCHED_DOMAIN - Static variable in class com.sparkpost.model.MetricsFields
- Webhook - Class in com.sparkpost.model
- Webhook() - Constructor for class com.sparkpost.model.Webhook
- WebhookDescribeResponse - Class in com.sparkpost.model.responses
- WebhookDescribeResponse() - Constructor for class com.sparkpost.model.responses.WebhookDescribeResponse
- WebhookDescription - Class in com.sparkpost.model
-
DTO for storing info about a webhook.
- WebhookDescription() - Constructor for class com.sparkpost.model.WebhookDescription
- WebhookIdContainerResponse - Class in com.sparkpost.model.responses
- WebhookIdContainerResponse() - Constructor for class com.sparkpost.model.responses.WebhookIdContainerResponse
- WebhookIdResponseEntry - Class in com.sparkpost.model
- WebhookIdResponseEntry() - Constructor for class com.sparkpost.model.WebhookIdResponseEntry
- WebhookListAllResponse - Class in com.sparkpost.model.responses
- WebhookListAllResponse() - Constructor for class com.sparkpost.model.responses.WebhookListAllResponse
- WEBHOOKS_MODIFY_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
- WEBHOOKS_VIEW_GRANT - Static variable in class com.sparkpost.model.SubaccountInfo
All Classes|All Packages