Skip to content

DeliverabilityTestReport

Source code in docs_src/capo_pinpoint_email/types/deliverability_test_report.py
class DeliverabilityTestReport(TypedDict, closed=True):
    report_id: NotRequired["capo_pinpoint_email.types.report_id.ReportId"]
    """<p>A unique string that identifies the predictive inbox placement test.</p>"""
    report_name: NotRequired["capo_pinpoint_email.types.report_name.ReportName"]
    """<p>A name that helps you identify a predictive inbox placement test report.</p>"""
    subject: NotRequired[
        "capo_pinpoint_email.types.deliverability_test_subject.DeliverabilityTestSubject"
    ]
    """<p>The subject line for an email that you submitted in a predictive inbox placement test.</p>"""
    from_email_address: NotRequired[
        "capo_pinpoint_email.types.email_address.EmailAddress"
    ]
    """<p>The sender address that you specified for the predictive inbox placement test.</p>"""
    create_date: NotRequired["capo_pinpoint_email.types.timestamp.Timestamp"]
    """<p>The date and time when the predictive inbox placement test was created, in Unix time format.</p>"""
    deliverability_test_status: NotRequired[
        "capo_pinpoint_email.types.deliverability_test_status.DeliverabilityTestStatus"
    ]
    """<p>The status of the predictive inbox placement test. If the status is <code>IN_PROGRESS</code>, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is <code>COMPLETE</code>, then the test is finished, and you can use the <code>GetDeliverabilityTestReport</code> to view the results of the test.</p>"""

create_date instance-attribute

create_date: NotRequired[Timestamp]

The date and time when the predictive inbox placement test was created, in Unix time format.

deliverability_test_status instance-attribute

deliverability_test_status: NotRequired[DeliverabilityTestStatus]

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

from_email_address instance-attribute

from_email_address: NotRequired[EmailAddress]

The sender address that you specified for the predictive inbox placement test.

report_id instance-attribute

report_id: NotRequired[ReportId]

A unique string that identifies the predictive inbox placement test.

report_name instance-attribute

report_name: NotRequired[ReportName]

A name that helps you identify a predictive inbox placement test report.

subject instance-attribute

subject: NotRequired[DeliverabilityTestSubject]

The subject line for an email that you submitted in a predictive inbox placement test.