Skip to content

BulkEmailEntry

Source code in docs_src/capo_sesv2/types/bulk_email_entry.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class BulkEmailEntry(TypedDict, closed=True):
    destination: "capo_sesv2.types.destination.Destination"
    """<p>Represents the destination of the message, consisting of To:, CC:, and BCC: fields.</p> <note> <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href="https://tools.ietf.org/html/rfc6531">RFC6531</a>. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain <a href="https://en.wikipedia.org/wiki/Email_address#Local-part">7-bit ASCII characters</a>. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in <a href="https://tools.ietf.org/html/rfc3492.html">RFC3492</a>.</p> </note>"""
    replacement_tags: NotRequired["capo_sesv2.types.message_tag_list.MessageTagList"]
    """<p>A list of tags, in the form of name/value pairs, to apply to an email that you send using the <code>SendBulkTemplatedEmail</code> operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.</p>"""
    replacement_email_content: NotRequired[
        "capo_sesv2.types.replacement_email_content.ReplacementEmailContent"
    ]
    """<p>The <code>ReplacementEmailContent</code> associated with a <code>BulkEmailEntry</code>.</p>"""
    replacement_headers: NotRequired[
        "capo_sesv2.types.message_header_list.MessageHeaderList"
    ]
    """<p>The list of message headers associated with the <code>BulkEmailEntry</code> data type.</p> <ul> <li> <p>Headers Not Present in <code>BulkEmailEntry</code>: If a header is specified in <a href="https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html"> <code>Template</code> </a> but not in <code>BulkEmailEntry</code>, the header from <code>Template</code> will be added to the outgoing email.</p> </li> <li> <p>Headers Present in <code>BulkEmailEntry</code>: If a header is specified in <code>BulkEmailEntry</code>, it takes precedence over any header of the same name specified in <a href="https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html"> <code>Template</code> </a>:</p> <ul> <li> <p>If the header is also defined within <code>Template</code>, the value from <code>BulkEmailEntry</code> will replace the header's value in the email.</p> </li> <li> <p>If the header is not defined within <code>Template</code>, it will simply be added to the email as specified in <code>BulkEmailEntry</code>.</p> </li> </ul> </li> </ul>"""

destination instance-attribute 

destination: Destination

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.

replacement_email_content instance-attribute 

replacement_email_content: NotRequired[ReplacementEmailContent]

The ReplacementEmailContent associated with a BulkEmailEntry.

replacement_headers instance-attribute 

replacement_headers: NotRequired[MessageHeaderList]

The list of message headers associated with the BulkEmailEntry data type.

  • Headers Not Present in BulkEmailEntry: If a header is specified in Template but not in BulkEmailEntry, the header from Template will be added to the outgoing email.

  • Headers Present in BulkEmailEntry: If a header is specified in BulkEmailEntry, it takes precedence over any header of the same name specified in Template :

    • If the header is also defined within Template, the value from BulkEmailEntry will replace the header's value in the email.

    • If the header is not defined within Template, it will simply be added to the email as specified in BulkEmailEntry.

replacement_tags instance-attribute 

replacement_tags: NotRequired[MessageTagList]

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.