Class: Aws::SESV2::Types::DomainDeliverabilityCampaign

Inherits:

Struct

Object
Struct
Aws::SESV2::Types::DomainDeliverabilityCampaign

show all

Defined in:: gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#campaign_id ⇒ String
The unique identifier for the campaign.
#delete_rate ⇒ 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.
#first_seen_date_time ⇒ Time
The first time 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.
#image_url ⇒ 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.
#last_seen_date_time ⇒ Time
The last time 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.
#read_delete_rate ⇒ 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.
#sending_ips ⇒ 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.
#subject ⇒ String
The subject line, or title, of the email message.

Instance Attribute Details

#campaign_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#esps ⇒ `Array<String>`

The major email providers who handled the email message.

Returns:

(Array<String>)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#first_seen_date_time ⇒ `Time`

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:

(Time)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#from_address ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#image_url ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#inbox_count ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#last_seen_date_time ⇒ `Time`

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:

(Time)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#projected_volume ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#sending_ips ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#spam_count ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

#subject ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 2624

class DomainDeliverabilityCampaign < Struct.new(
  :campaign_id,
  :image_url,
  :subject,
  :from_address,
  :sending_ips,
  :first_seen_date_time,
  :last_seen_date_time,
  :inbox_count,
  :spam_count,
  :read_rate,
  :delete_rate,
  :read_delete_rate,
  :projected_volume,
  :esps)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SESV2::Types::DomainDeliverabilityCampaign

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_id ⇒ String

#delete_rate ⇒ Float

#esps ⇒ Array<String>

#first_seen_date_time ⇒ Time

#from_address ⇒ String

#image_url ⇒ String

#inbox_count ⇒ Integer

#last_seen_date_time ⇒ Time

#projected_volume ⇒ Integer

#read_delete_rate ⇒ Float

#read_rate ⇒ Float

#sending_ips ⇒ Array<String>

#spam_count ⇒ Integer

#subject ⇒ String

#campaign_id ⇒ `String`

#delete_rate ⇒ `Float`

#esps ⇒ `Array<String>`

#first_seen_date_time ⇒ `Time`

#from_address ⇒ `String`

#image_url ⇒ `String`

#inbox_count ⇒ `Integer`

#last_seen_date_time ⇒ `Time`

#projected_volume ⇒ `Integer`

#read_delete_rate ⇒ `Float`

#read_rate ⇒ `Float`

#sending_ips ⇒ `Array<String>`

#spam_count ⇒ `Integer`

#subject ⇒ `String`