Package com.sparkpost.model
Class MessageEventsQueryBuilder
java.lang.Object
com.sparkpost.model.MessageEventsQueryBuilder
public class MessageEventsQueryBuilder extends Object
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMessageEventsQueryBuilder.BounceClassBounce Classification Codes: https://www.sparkpost.com/docs/deliverability/bounce-classification-codesstatic classMessageEventsQueryBuilder.EventType -
Constructor Summary
Constructors Constructor Description MessageEventsQueryBuilder() -
Method Summary
Modifier and Type Method Description voidaddBounceClass(MessageEventsQueryBuilder.BounceClass bounceClass)bounce_classes - delimited list of bounce classification codes to search.voidaddCampaignId(String cid)campaign_ids - delimited list of campaign ID’s to search (i.e.voidaddEventType(MessageEventsQueryBuilder.EventType type)events - delimited list of event types to search.voidaddFriendlyFrom(String from)friendly_froms - delimited list of friendly from emails to search.voidaddMessageId(String messageId)message_ids - delimited list of message ID’s to search.voidaddRecipient(String recipient)recipients - delimited list of recipients to search.voidaddSubAccount(String subaccount)subaccounts - delimited list of subaccount ID’s to search.voidaddTemplateId(String tid)template_ids - delimited list of template ID’s to search.voidaddTransmissionId(String tid)transmission_ids - delimited list of transmission ID’s to search (i.e.voidbuildQuery(Endpoint endpoint)voidsetFromDateTime(String dateTime)From Datetime in format of YYYY-MM-DDTHH:MM.voidsetReason(String reason)reason - Bounce/failure/rejection reason that will be matched using a wildcard (e.g., %reason%).voidsetSortOutput(boolean sortOutput)voidsetTimezone(String timeZone)timezone - Standard timezone identification string.voidsetToDateTime(String dateTime)
-
Constructor Details
-
MessageEventsQueryBuilder
public MessageEventsQueryBuilder()
-
-
Method Details
-
addBounceClass
bounce_classes - delimited list of bounce classification codes to search. See Bounce Classification Codes: https://www.sparkpost.com/docs/deliverability/bounce-classification-codes -
addCampaignId
campaign_ids - delimited list of campaign ID’s to search (i.e. the campaign id used during creation of a transmission). Notes: Not available for sms_status type. -
addEventType
events - delimited list of event types to search. Defaults to all event types. Example: delivery,injection,bounce,delay,policy_rejection,out_of_band,open,click,generation_failure,generation_rejection,spam_complaint,list_unsubscribe,link_unsubscribe -
addFriendlyFrom
friendly_froms - delimited list of friendly from emails to search. Notes: Not available for sms_status type. Example: sender@mail.example.com -
setFromDateTime
From Datetime in format of YYYY-MM-DDTHH:MM. Default: 24 hours ago Example: 2014-07-20T08:00 -
setToDateTime
-
addMessageId
message_ids - delimited list of message ID’s to search. Example: 0e0d94b7-9085-4e3c-ab30-e3f2cd9c273e -
setReason
reason - Bounce/failure/rejection reason that will be matched using a wildcard (e.g., %reason%). Example: bounce -
addRecipient
recipients - delimited list of recipients to search. Example: recipient@example.com -
addSubAccount
subaccounts - delimited list of subaccount ID’s to search. Example: 101 -
addTemplateId
template_ids - delimited list of template ID’s to search. Example: templ-1234 -
setTimezone
timezone - Standard timezone identification string. Default: UTC Example: America/New_York -
addTransmissionId
transmission_ids - delimited list of transmission ID’s to search (i.e. id generated during creation of a transmission). Example: 65832150921904138 -
buildQuery
-
setSortOutput
public void setSortOutput(boolean sortOutput)
-