software.amazon.awssdk.services.pinpointemail.model

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 Summary

Modifier and Type	Method and Description
DomainDeliverabilityCampaign.Builder	campaignId(String campaignId) The unique identifier for the campaign.
DomainDeliverabilityCampaign.Builder	deleteRate(Double deleteRate) The percentage of email messages that were deleted by recipients, without being opened first.
DomainDeliverabilityCampaign.Builder	esps(Collection<String> esps) The major email providers who handled the email message.
DomainDeliverabilityCampaign.Builder	esps(String... esps) The major email providers who handled the email message.
DomainDeliverabilityCampaign.Builder	firstSeenDateTime(Instant firstSeenDateTime) The first time, in Unix time format, when the email message was delivered to any recipient's inbox.
DomainDeliverabilityCampaign.Builder	fromAddress(String fromAddress) The verified email address that the email message was sent from.
DomainDeliverabilityCampaign.Builder	imageUrl(String imageUrl) The URL of an image that contains a snapshot of the email message that was sent.
DomainDeliverabilityCampaign.Builder	inboxCount(Long inboxCount) The number of email messages that were delivered to recipients’ inboxes.
DomainDeliverabilityCampaign.Builder	lastSeenDateTime(Instant lastSeenDateTime) The last time, in Unix time format, when the email message was delivered to any recipient's inbox.
DomainDeliverabilityCampaign.Builder	projectedVolume(Long projectedVolume) The projected number of recipients that the email message was sent to.
DomainDeliverabilityCampaign.Builder	readDeleteRate(Double readDeleteRate) The percentage of email messages that were opened and then deleted by recipients.
DomainDeliverabilityCampaign.Builder	readRate(Double readRate) The percentage of email messages that were opened by recipients.
DomainDeliverabilityCampaign.Builder	sendingIps(Collection<String> sendingIps) The IP addresses that were used to send the email message.
DomainDeliverabilityCampaign.Builder	sendingIps(String... sendingIps) The IP addresses that were used to send the email message.
DomainDeliverabilityCampaign.Builder	spamCount(Long spamCount) The number of email messages that were delivered to recipients' spam or junk mail folders.
DomainDeliverabilityCampaign.Builder	subject(String subject) The subject line, or title, of the email message.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

campaignId

DomainDeliverabilityCampaign.Builder campaignId(String campaignId)

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

Parameters:

campaignId - The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

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, in Unix time format, 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, in Unix time format, 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, in Unix time format, 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, in Unix time format, 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.