Create Deliverability Test Report

pinpointemail_create_deliverability_test_report

R Documentation

Create a new predictive inbox placement test¶

Description¶

Create a new 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 get_deliverability_test_report operation to view the results of the test.

Usage¶

pinpointemail_create_deliverability_test_report(ReportName,
  FromEmailAddress, Content, Tags)

Arguments¶

ReportName: A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
FromEmailAddress: [required] The email address that the predictive inbox placement test email was sent from.
Content: [required] The HTML body of the message that you sent when you performed the predictive inbox placement test.
Tags: An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Value¶

A list with the following syntax:

list(
  ReportId = "string",
  DeliverabilityTestStatus = "IN_PROGRESS"|"COMPLETED"
)

Request syntax¶

svc$create_deliverability_test_report(
  ReportName = "string",
  FromEmailAddress = "string",
  Content = list(
    Simple = list(
      Subject = list(
        Data = "string",
        Charset = "string"
      ),
      Body = list(
        Text = list(
          Data = "string",
          Charset = "string"
        ),
        Html = list(
          Data = "string",
          Charset = "string"
        )
      )
    ),
    Raw = list(
      Data = raw
    ),
    Template = list(
      TemplateArn = "string",
      TemplateData = "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)