Class DomainDeliverabilityCampaign
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DomainDeliverabilityCampaign.Builder,
DomainDeliverabilityCampaign>
An object that contains the deliverability data for a specific campaign. This data is available for a campaign only
if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (
PutDeliverabilityDashboardOption
operation).
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The unique identifier for the campaign.final Double
The percentage of email messages that were deleted by recipients, without being opened first.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.esps()
The major email providers who handled the email message.final Instant
The first time when the email message was delivered to any recipient's inbox.final String
The verified email address that the email message was sent from.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
hasEsps()
For responses, this returns true if the service returned a value for the Esps property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SendingIps property.final String
imageUrl()
The URL of an image that contains a snapshot of the email message that was sent.final Long
The number of email messages that were delivered to recipients’ inboxes.final Instant
The last time when the email message was delivered to any recipient's inbox.final Long
The projected number of recipients that the email message was sent to.final Double
The percentage of email messages that were opened and then deleted by recipients.final Double
readRate()
The percentage of email messages that were opened by recipients.The IP addresses that were used to send the email message.static Class
<? extends DomainDeliverabilityCampaign.Builder> final Long
The number of email messages that were delivered to recipients' spam or junk mail folders.final String
subject()
The subject line, or title, of the email message.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
campaignId
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
- Returns:
- The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
-
imageUrl
The URL of an image that contains a snapshot of the email message that was sent.
- Returns:
- The URL of an image that contains a snapshot of the email message that was sent.
-
subject
The subject line, or title, of the email message.
- Returns:
- The subject line, or title, of the email message.
-
fromAddress
The verified email address that the email message was sent from.
- Returns:
- The verified email address that the email message was sent from.
-
hasSendingIps
public final boolean hasSendingIps()For responses, this returns true if the service returned a value for the SendingIps property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
sendingIps
The IP addresses that were used to send the email message.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSendingIps()
method.- Returns:
- The IP addresses that were used to send the email message.
-
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:
- 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.
-
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:
- 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.
-
inboxCount
The number of email messages that were delivered to recipients’ inboxes.
- Returns:
- The number of email messages that were delivered to recipients’ inboxes.
-
spamCount
The number of email messages that were delivered to recipients' spam or junk mail folders.
- Returns:
- The number of email messages that were delivered to recipients' spam or junk mail folders.
-
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:
- 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.
-
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:
- 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.
-
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:
- 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.
-
projectedVolume
The projected number of recipients that the email message was sent to.
- Returns:
- The projected number of recipients that the email message was sent to.
-
hasEsps
public final boolean hasEsps()For responses, this returns true if the service returned a value for the Esps property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
esps
The major email providers who handled the email message.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEsps()
method.- Returns:
- The major email providers who handled the email message.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DomainDeliverabilityCampaign.Builder,
DomainDeliverabilityCampaign> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-