/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.simpleemailv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* 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).
*
* The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this * identifier to a campaign. *
*/ private String campaignId; /** ** The URL of an image that contains a snapshot of the email message that was sent. *
*/ private String imageUrl; /** ** The subject line, or title, of the email message. *
*/ private String subject; /** ** The verified email address that the email message was sent from. *
*/ private String fromAddress; /** ** The IP addresses that were used to send the email message. *
*/ private java.util.List* 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. *
*/ private java.util.Date firstSeenDateTime; /** ** 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. *
*/ private java.util.Date lastSeenDateTime; /** ** The number of email messages that were delivered to recipients’ inboxes. *
*/ private Long inboxCount; /** ** The number of email messages that were delivered to recipients' spam or junk mail folders. *
*/ private Long spamCount; /** ** 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. *
*/ private Double readRate; /** ** 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. *
*/ private Double deleteRate; /** ** 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. *
*/ private Double readDeleteRate; /** ** The projected number of recipients that the email message was sent to. *
*/ private Long projectedVolume; /** ** The major email providers who handled the email message. *
*/ private java.util.List* The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this * identifier to a campaign. *
* * @param campaignId * The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns * this identifier to a campaign. */ public void setCampaignId(String campaignId) { this.campaignId = campaignId; } /** ** The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this * identifier to a campaign. *
* * @return The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns * this identifier to a campaign. */ public String getCampaignId() { return this.campaignId; } /** ** The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this * identifier to a campaign. *
* * @param campaignId * The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns * this identifier to a campaign. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withCampaignId(String campaignId) { setCampaignId(campaignId); return this; } /** ** The URL of an image that contains a snapshot of the email message that was sent. *
* * @param imageUrl * The URL of an image that contains a snapshot of the email message that was sent. */ public void setImageUrl(String imageUrl) { this.imageUrl = imageUrl; } /** ** The URL of an image that contains a snapshot of the email message that was sent. *
* * @return The URL of an image that contains a snapshot of the email message that was sent. */ public String getImageUrl() { return this.imageUrl; } /** ** The URL of an image that contains a snapshot of the email message that was sent. *
* * @param imageUrl * The URL of an image that contains a snapshot of the email message that was sent. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withImageUrl(String imageUrl) { setImageUrl(imageUrl); return this; } /** ** The subject line, or title, of the email message. *
* * @param subject * The subject line, or title, of the email message. */ public void setSubject(String subject) { this.subject = subject; } /** ** The subject line, or title, of the email message. *
* * @return The subject line, or title, of the email message. */ public String getSubject() { return this.subject; } /** ** The subject line, or title, of the email message. *
* * @param subject * The subject line, or title, of the email message. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withSubject(String subject) { setSubject(subject); return this; } /** ** The verified email address that the email message was sent from. *
* * @param fromAddress * The verified email address that the email message was sent from. */ public void setFromAddress(String fromAddress) { this.fromAddress = fromAddress; } /** ** The verified email address that the email message was sent from. *
* * @return The verified email address that the email message was sent from. */ public String getFromAddress() { return this.fromAddress; } /** ** The verified email address that the email message was sent from. *
* * @param fromAddress * The verified email address that the email message was sent from. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withFromAddress(String fromAddress) { setFromAddress(fromAddress); return this; } /** ** The IP addresses that were used to send the email message. *
* * @return The IP addresses that were used to send the email message. */ public java.util.List* The IP addresses that were used to send the email message. *
* * @param sendingIps * The IP addresses that were used to send the email message. */ public void setSendingIps(java.util.Collection* The IP addresses that were used to send the email message. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setSendingIps(java.util.Collection)} or {@link #withSendingIps(java.util.Collection)} if you want to * override the existing values. *
* * @param sendingIps * The IP addresses that were used to send the email message. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withSendingIps(String... sendingIps) { if (this.sendingIps == null) { setSendingIps(new java.util.ArrayList* The IP addresses that were used to send the email message. *
* * @param sendingIps * The IP addresses that were used to send the email message. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withSendingIps(java.util.Collection* 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. *
* * @param 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. */ public void setFirstSeenDateTime(java.util.Date firstSeenDateTime) { this.firstSeenDateTime = 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. *
* * @return 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. */ public java.util.Date getFirstSeenDateTime() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withFirstSeenDateTime(java.util.Date firstSeenDateTime) { setFirstSeenDateTime(firstSeenDateTime); return this; } /** ** 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. *
* * @param 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. */ public void setLastSeenDateTime(java.util.Date lastSeenDateTime) { this.lastSeenDateTime = 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. *
* * @return 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. */ public java.util.Date getLastSeenDateTime() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withLastSeenDateTime(java.util.Date lastSeenDateTime) { setLastSeenDateTime(lastSeenDateTime); return this; } /** ** The number of email messages that were delivered to recipients’ inboxes. *
* * @param inboxCount * The number of email messages that were delivered to recipients’ inboxes. */ public void setInboxCount(Long inboxCount) { this.inboxCount = inboxCount; } /** ** The number of email messages that were delivered to recipients’ inboxes. *
* * @return The number of email messages that were delivered to recipients’ inboxes. */ public Long getInboxCount() { return this.inboxCount; } /** ** The number of email messages that were delivered to recipients’ inboxes. *
* * @param inboxCount * The number of email messages that were delivered to recipients’ inboxes. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withInboxCount(Long inboxCount) { setInboxCount(inboxCount); return this; } /** ** The number of email messages that were delivered to recipients' spam or junk mail folders. *
* * @param spamCount * The number of email messages that were delivered to recipients' spam or junk mail folders. */ public void setSpamCount(Long spamCount) { this.spamCount = spamCount; } /** ** The number of email messages that were delivered to recipients' spam or junk mail folders. *
* * @return The number of email messages that were delivered to recipients' spam or junk mail folders. */ public Long getSpamCount() { return this.spamCount; } /** ** The number of email messages that were delivered to recipients' spam or junk mail folders. *
* * @param spamCount * The number of email messages that were delivered to recipients' spam or junk mail folders. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withSpamCount(Long spamCount) { setSpamCount(spamCount); return this; } /** ** 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. *
* * @param 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. */ public void setReadRate(Double readRate) { this.readRate = 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. *
* * @return 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. */ public Double getReadRate() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withReadRate(Double readRate) { setReadRate(readRate); return this; } /** ** 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. *
* * @param 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. */ public void setDeleteRate(Double deleteRate) { this.deleteRate = 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. *
* * @return 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. */ public Double getDeleteRate() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withDeleteRate(Double deleteRate) { setDeleteRate(deleteRate); return this; } /** ** 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. *
* * @param 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. */ public void setReadDeleteRate(Double readDeleteRate) { this.readDeleteRate = 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. *
* * @return 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. */ public Double getReadDeleteRate() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withReadDeleteRate(Double readDeleteRate) { setReadDeleteRate(readDeleteRate); return this; } /** ** The projected number of recipients that the email message was sent to. *
* * @param projectedVolume * The projected number of recipients that the email message was sent to. */ public void setProjectedVolume(Long projectedVolume) { this.projectedVolume = projectedVolume; } /** ** The projected number of recipients that the email message was sent to. *
* * @return The projected number of recipients that the email message was sent to. */ public Long getProjectedVolume() { return this.projectedVolume; } /** ** The projected number of recipients that the email message was sent to. *
* * @param projectedVolume * The projected number of recipients that the email message was sent to. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withProjectedVolume(Long projectedVolume) { setProjectedVolume(projectedVolume); return this; } /** ** The major email providers who handled the email message. *
* * @return The major email providers who handled the email message. */ public java.util.List* The major email providers who handled the email message. *
* * @param esps * The major email providers who handled the email message. */ public void setEsps(java.util.Collection* The major email providers who handled the email message. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setEsps(java.util.Collection)} or {@link #withEsps(java.util.Collection)} if you want to override the * existing values. *
* * @param esps * The major email providers who handled the email message. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withEsps(String... esps) { if (this.esps == null) { setEsps(new java.util.ArrayList* The major email providers who handled the email message. *
* * @param esps * The major email providers who handled the email message. * @return Returns a reference to this object so that method calls can be chained together. */ public DomainDeliverabilityCampaign withEsps(java.util.Collection