Class MessageEventsQueryBuilder

java.lang.Object
com.sparkpost.model.MessageEventsQueryBuilder

public class MessageEventsQueryBuilder
extends Object
  • Constructor Details

    • MessageEventsQueryBuilder

      public MessageEventsQueryBuilder()
  • Method Details

    • addBounceClass

      public void addBounceClass​(MessageEventsQueryBuilder.BounceClass bounceClass)
      bounce_classes - delimited list of bounce classification codes to search. See Bounce Classification Codes: https://www.sparkpost.com/docs/deliverability/bounce-classification-codes
    • addCampaignId

      public void addCampaignId​(String cid)
      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

      public void addEventType​(MessageEventsQueryBuilder.EventType type)
      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

      public void addFriendlyFrom​(String from)
      friendly_froms - delimited list of friendly from emails to search. Notes: Not available for sms_status type. Example: sender@mail.example.com
    • setFromDateTime

      public void setFromDateTime​(String dateTime)
      From Datetime in format of YYYY-MM-DDTHH:MM. Default: 24 hours ago Example: 2014-07-20T08:00
    • setToDateTime

      public void setToDateTime​(String dateTime)
    • addMessageId

      public void addMessageId​(String messageId)
      message_ids - delimited list of message ID’s to search. Example: 0e0d94b7-9085-4e3c-ab30-e3f2cd9c273e
    • setReason

      public void setReason​(String reason)
      reason - Bounce/failure/rejection reason that will be matched using a wildcard (e.g., %reason%). Example: bounce
    • addRecipient

      public void addRecipient​(String recipient)
      recipients - delimited list of recipients to search. Example: recipient@example.com
    • addSubAccount

      public void addSubAccount​(String subaccount)
      subaccounts - delimited list of subaccount ID’s to search. Example: 101
    • addTemplateId

      public void addTemplateId​(String tid)
      template_ids - delimited list of template ID’s to search. Example: templ-1234
    • setTimezone

      public void setTimezone​(String timeZone)
      timezone - Standard timezone identification string. Default: UTC Example: America/New_York
    • addTransmissionId

      public void addTransmissionId​(String tid)
      transmission_ids - delimited list of transmission ID’s to search (i.e. id generated during creation of a transmission). Example: 65832150921904138
    • buildQuery

      public void buildQuery​(Endpoint endpoint)
    • setSortOutput

      public void setSortOutput​(boolean sortOutput)