Class: Aws::PinpointEmail::Types::CreateDeliverabilityTestReportRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb

Overview

Note:

When making an API call, you may pass CreateDeliverabilityTestReportRequest data as a hash:

{
  report_name: "ReportName",
  from_email_address: "EmailAddress", # required
  content: { # required
    simple: {
      subject: { # required
        data: "MessageData", # required
        charset: "Charset",
      },
      body: { # required
        text: {
          data: "MessageData", # required
          charset: "Charset",
        },
        html: {
          data: "MessageData", # required
          charset: "Charset",
        },
      },
    },
    raw: {
      data: "data", # required
    },
    template: {
      template_arn: "TemplateArn",
      template_data: "TemplateData",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#contentTypes::EmailContent

The HTML body of the message that you sent when you performed the predictive inbox placement test.

Returns:



472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 472

class CreateDeliverabilityTestReportRequest < Struct.new(
  :report_name,
  :from_email_address,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#from_email_addressString

The email address that the predictive inbox placement test email was sent from.

Returns:

  • (String)


472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 472

class CreateDeliverabilityTestReportRequest < Struct.new(
  :report_name,
  :from_email_address,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#report_nameString

A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

Returns:

  • (String)


472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 472

class CreateDeliverabilityTestReportRequest < Struct.new(
  :report_name,
  :from_email_address,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Returns:



472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 472

class CreateDeliverabilityTestReportRequest < Struct.new(
  :report_name,
  :from_email_address,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end