Interface DomainDeliverabilityCampaign.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DomainDeliverabilityCampaign.Builder,DomainDeliverabilityCampaign>, SdkBuilder<DomainDeliverabilityCampaign.Builder,DomainDeliverabilityCampaign>, SdkPojo
Enclosing class:
DomainDeliverabilityCampaign
public static interface DomainDeliverabilityCampaign.Builder extends SdkPojo, CopyableBuilder<DomainDeliverabilityCampaign.Builder,DomainDeliverabilityCampaign>

  • Method Details

    • campaignId

      DomainDeliverabilityCampaign.Builder campaignId(String campaignId)

      The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.

      Parameters:
      campaignId - The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageUrl

      DomainDeliverabilityCampaign.Builder imageUrl(String imageUrl)

      The URL of an image that contains a snapshot of the email message that was sent.

      Parameters:
      imageUrl - The URL of an image that contains a snapshot of the email message that was sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subject

      DomainDeliverabilityCampaign.Builder subject(String subject)

      The subject line, or title, of the email message.

      Parameters:
      subject - The subject line, or title, of the email message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fromAddress

      DomainDeliverabilityCampaign.Builder fromAddress(String fromAddress)

      The verified email address that the email message was sent from.

      Parameters:
      fromAddress - The verified email address that the email message was sent from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sendingIps

      DomainDeliverabilityCampaign.Builder sendingIps(Collection<String> sendingIps)

      The IP addresses that were used to send the email message.

      Parameters:
      sendingIps - The IP addresses that were used to send the email message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sendingIps

      DomainDeliverabilityCampaign.Builder sendingIps(String... sendingIps)

      The IP addresses that were used to send the email message.

      Parameters:
      sendingIps - The IP addresses that were used to send the email message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firstSeenDateTime

      DomainDeliverabilityCampaign.Builder firstSeenDateTime(Instant firstSeenDateTime)

      The first time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

      Parameters:
      firstSeenDateTime - The first time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastSeenDateTime

      DomainDeliverabilityCampaign.Builder lastSeenDateTime(Instant lastSeenDateTime)

      The last time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

      Parameters:
      lastSeenDateTime - The last time when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inboxCount

      DomainDeliverabilityCampaign.Builder inboxCount(Long inboxCount)

      The number of email messages that were delivered to recipients’ inboxes.

      Parameters:
      inboxCount - The number of email messages that were delivered to recipients’ inboxes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spamCount

      DomainDeliverabilityCampaign.Builder spamCount(Long spamCount)

      The number of email messages that were delivered to recipients' spam or junk mail folders.

      Parameters:
      spamCount - The number of email messages that were delivered to recipients' spam or junk mail folders.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readRate

      DomainDeliverabilityCampaign.Builder readRate(Double readRate)

      The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

      Parameters:
      readRate - The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deleteRate

      DomainDeliverabilityCampaign.Builder deleteRate(Double deleteRate)

      The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

      Parameters:
      deleteRate - The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readDeleteRate

      DomainDeliverabilityCampaign.Builder readDeleteRate(Double readDeleteRate)

      The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

      Parameters:
      readDeleteRate - The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • projectedVolume

      DomainDeliverabilityCampaign.Builder projectedVolume(Long projectedVolume)

      The projected number of recipients that the email message was sent to.

      Parameters:
      projectedVolume - The projected number of recipients that the email message was sent to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • esps

      DomainDeliverabilityCampaign.Builder esps(Collection<String> esps)

      The major email providers who handled the email message.

      Parameters:
      esps - The major email providers who handled the email message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • esps

      DomainDeliverabilityCampaign.Builder esps(String... esps)

      The major email providers who handled the email message.

      Parameters:
      esps - The major email providers who handled the email message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.