SendEmailRequest
¶
Source code in docs_src/capo_sesv2/types/send_email_request.py
|
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.