Skip to content

DomainDeliverabilityCampaign

Source code in docs_src/capo_sesv2/types/domain_deliverability_campaign.py
class DomainDeliverabilityCampaign(TypedDict, closed=True):
    campaign_id: NotRequired["capo_sesv2.types.campaign_id.CampaignId"]
    """<p>The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.</p>"""
    image_url: NotRequired["capo_sesv2.types.image_url.ImageUrl"]
    """<p>The URL of an image that contains a snapshot of the email message that was sent.</p>"""
    subject: NotRequired["capo_sesv2.types.subject.Subject"]
    """<p>The subject line, or title, of the email message.</p>"""
    from_address: NotRequired["capo_sesv2.types.identity.Identity"]
    """<p>The verified email address that the email message was sent from.</p>"""
    sending_ips: NotRequired["capo_sesv2.types.ip_list.IpList"]
    """<p>The IP addresses that were used to send the email message.</p>"""
    first_seen_date_time: NotRequired["capo_sesv2.types.timestamp.Timestamp"]
    """<p>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.</p>"""
    last_seen_date_time: NotRequired["capo_sesv2.types.timestamp.Timestamp"]
    """<p>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.</p>"""
    inbox_count: NotRequired["capo_sesv2.types.volume.Volume"]
    """<p>The number of email messages that were delivered to recipients’ inboxes.</p>"""
    spam_count: NotRequired["capo_sesv2.types.volume.Volume"]
    """<p>The number of email messages that were delivered to recipients' spam or junk mail folders.</p>"""
    read_rate: NotRequired["capo_sesv2.types.percentage.Percentage"]
    """<p>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.</p>"""
    delete_rate: NotRequired["capo_sesv2.types.percentage.Percentage"]
    """<p>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.</p>"""
    read_delete_rate: NotRequired["capo_sesv2.types.percentage.Percentage"]
    """<p>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.</p>"""
    projected_volume: NotRequired["capo_sesv2.types.volume.Volume"]
    """<p>The projected number of recipients that the email message was sent to.</p>"""
    esps: NotRequired["capo_sesv2.types.esps.Esps"]
    """<p>The major email providers who handled the email message.</p>"""

campaign_id instance-attribute

campaign_id: NotRequired[CampaignId]

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

delete_rate instance-attribute

delete_rate: NotRequired[Percentage]

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.

esps instance-attribute

esps: NotRequired[Esps]

The major email providers who handled the email message.

first_seen_date_time instance-attribute

first_seen_date_time: NotRequired[Timestamp]

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.

from_address instance-attribute

from_address: NotRequired[Identity]

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

image_url instance-attribute

image_url: NotRequired[ImageUrl]

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

inbox_count instance-attribute

inbox_count: NotRequired[Volume]

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

last_seen_date_time instance-attribute

last_seen_date_time: NotRequired[Timestamp]

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.

projected_volume instance-attribute

projected_volume: NotRequired[Volume]

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

read_delete_rate instance-attribute

read_delete_rate: NotRequired[Percentage]

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.

read_rate instance-attribute

read_rate: NotRequired[Percentage]

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.

sending_ips instance-attribute

sending_ips: NotRequired[IpList]

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

spam_count instance-attribute

spam_count: NotRequired[Volume]

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

subject instance-attribute

subject: NotRequired[Subject]

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