Skip to content

SendEmailRequest

Source code in docs_src/capo_sesv2/types/send_email_request.py
class SendEmailRequest(TypedDict, closed=True):
    from_email_address: NotRequired["capo_sesv2.types.email_address.EmailAddress"]
    """<p>The email address to use as the "From" address for the email. The address that you specify has to be verified. </p>"""
    from_email_address_identity_arn: NotRequired[
        "capo_sesv2.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>FromEmailAddress</code> parameter.</p> <p>For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the <code>FromEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FromEmailAddress</code> to be [email protected].</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p> <p>For Raw emails, the <code>FromEmailAddressIdentityArn</code> value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.</p>"""
    destination: NotRequired["capo_sesv2.types.destination.Destination"]
    """<p>An object that contains the recipients of the email message.</p>"""
    reply_to_addresses: NotRequired[
        "capo_sesv2.types.email_address_list.EmailAddressList"
    ]
    """<p>The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.</p>"""
    feedback_forwarding_email_address: NotRequired[
        "capo_sesv2.types.email_address.EmailAddress"
    ]
    """<p>The address that you want bounce and complaint notifications to be sent to.</p>"""
    feedback_forwarding_email_address_identity_arn: NotRequired[
        "capo_sesv2.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>FeedbackForwardingEmailAddress</code> parameter.</p> <p>For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the <code>FeedbackForwardingEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FeedbackForwardingEmailAddress</code> to be [email protected].</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p>"""
    content: "capo_sesv2.types.email_content.EmailContent"
    """<p>An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.</p>"""
    email_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>SendEmail</code> operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events. </p>"""
    configuration_set_name: NotRequired[
        "capo_sesv2.types.configuration_set_name.ConfigurationSetName"
    ]
    """<p>The name of the configuration set to use when sending the email.</p>"""
    endpoint_id: NotRequired["capo_sesv2.types.endpoint_id.EndpointId"]
    """<p>The ID of the multi-region endpoint (global-endpoint).</p>"""
    tenant_name: NotRequired["capo_sesv2.types.tenant_name.TenantName"]
    """<p>The name of the tenant through which this email will be sent.</p> <note> <p>The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant. </p> </note>"""
    list_management_options: NotRequired[
        "capo_sesv2.types.list_management_options.ListManagementOptions"
    ]
    """<p>An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.</p>"""
    configuration_overrides: NotRequired[
        "capo_sesv2.types.configuration_overrides.ConfigurationOverrides"
    ]
    """<p>An object that overrides, for this message only, settings that would otherwise apply to it. Each setting that you don't override keeps the value that already applies.</p>"""

configuration_overrides instance-attribute

configuration_overrides: NotRequired[ConfigurationOverrides]

An object that overrides, for this message only, settings that would otherwise apply to it. Each setting that you don't override keeps the value that already applies.

configuration_set_name instance-attribute

configuration_set_name: NotRequired[ConfigurationSetName]

The name of the configuration set to use when sending the email.

content instance-attribute

content: EmailContent

An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

destination instance-attribute

destination: NotRequired[Destination]

An object that contains the recipients of the email message.

email_tags instance-attribute

email_tags: NotRequired[MessageTagList]

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

endpoint_id instance-attribute

endpoint_id: NotRequired[EndpointId]

The ID of the multi-region endpoint (global-endpoint).

feedback_forwarding_email_address instance-attribute

feedback_forwarding_email_address: NotRequired[EmailAddress]

The address that you want bounce and complaint notifications to be sent to.

feedback_forwarding_email_address_identity_arn instance-attribute

feedback_forwarding_email_address_identity_arn: NotRequired[AmazonResourceName]

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be [email protected].

For more information about sending authorization, see the Amazon SES Developer Guide.

from_email_address instance-attribute

from_email_address: NotRequired[EmailAddress]

The email address to use as the "From" address for the email. The address that you specify has to be verified.

from_email_address_identity_arn instance-attribute

from_email_address_identity_arn: NotRequired[AmazonResourceName]

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be [email protected].

For more information about sending authorization, see the Amazon SES Developer Guide.

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

list_management_options instance-attribute

list_management_options: NotRequired[ListManagementOptions]

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

reply_to_addresses instance-attribute

reply_to_addresses: NotRequired[EmailAddressList]

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

tenant_name instance-attribute

tenant_name: NotRequired[TenantName]

The name of the tenant through which this email will be sent.

The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.