You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::PinpointEmail::Types::DomainDeliverabilityCampaign

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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).

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_id ⇒ String

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:

  • (String) —

    The unique identifier for the campaign.

#delete_rate ⇒ Float

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:

  • (Float) —

    The percentage of email messages that were deleted by recipients, without being opened first.

#esps ⇒ Array<String>

The major email providers who handled the email message.

Returns:

  • (Array<String>) —

    The major email providers who handled the email message.

#first_seen_date_time ⇒ Time

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:

  • (Time) —

    The first time, in Unix time format, when the email message was delivered to any recipient\'s inbox.

#from_address ⇒ String

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

Returns:

  • (String) —

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

#image_url ⇒ String

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

Returns:

  • (String) —

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

#inbox_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#last_seen_date_time ⇒ Time

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:

  • (Time) —

    The last time, in Unix time format, when the email message was delivered to any recipient\'s inbox.

#projected_volume ⇒ Integer

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

Returns:

  • (Integer) —

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

#read_delete_rate ⇒ Float

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:

  • (Float) —

    The percentage of email messages that were opened and then deleted by recipients.

#read_rate ⇒ Float

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:

  • (Float) —

    The percentage of email messages that were opened by recipients.

#sending_ips ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#spam_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#subject ⇒ String

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

Returns:

  • (String) —

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