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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/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).

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 813

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