SESV2 / Client / send_email

send_email#

SESV2.Client.send_email(**kwargs)#

Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:

  • Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.

  • Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

  • Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.

See also: AWS API Documentation

Request Syntax

response = client.send_email(
    FromEmailAddress='string',
    FromEmailAddressIdentityArn='string',
    Destination={
        'ToAddresses': [
            'string',
        ],
        'CcAddresses': [
            'string',
        ],
        'BccAddresses': [
            'string',
        ]
    },
    ReplyToAddresses=[
        'string',
    ],
    FeedbackForwardingEmailAddress='string',
    FeedbackForwardingEmailAddressIdentityArn='string',
    Content={
        'Simple': {
            'Subject': {
                'Data': 'string',
                'Charset': 'string'
            },
            'Body': {
                'Text': {
                    'Data': 'string',
                    'Charset': 'string'
                },
                'Html': {
                    'Data': 'string',
                    'Charset': 'string'
                }
            },
            'Headers': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ]
        },
        'Raw': {
            'Data': b'bytes'
        },
        'Template': {
            'TemplateName': 'string',
            'TemplateArn': 'string',
            'TemplateContent': {
                'Subject': 'string',
                'Text': 'string',
                'Html': 'string'
            },
            'TemplateData': 'string',
            'Headers': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ]
        }
    },
    EmailTags=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    ConfigurationSetName='string',
    EndpointId='string',
    ListManagementOptions={
        'ContactListName': 'string',
        'TopicName': 'string'
    }
)
Parameters:

  • FromEmailAddress (string) – The email address to use as the “From” address for the email. The address that you specify has to be verified.

  • FromEmailAddressIdentityArn (string) –

    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 sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

    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.

  • Destination (dict) –

    An object that contains the recipients of the email message.

    • ToAddresses (list) –

      An array that contains the email addresses of the “To” recipients for the email.

      • (string) –

    • CcAddresses (list) –

      An array that contains the email addresses of the “CC” (carbon copy) recipients for the email.

      • (string) –

    • BccAddresses (list) –

      An array that contains the email addresses of the “BCC” (blind carbon copy) recipients for the email.

      • (string) –

  • ReplyToAddresses (list) –

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

    • (string) –

  • FeedbackForwardingEmailAddress (string) – The address that you want bounce and complaint notifications to be sent to.

  • FeedbackForwardingEmailAddressIdentityArn (string) –

    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 feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

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

  • Content (dict) –

    [REQUIRED]

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

    • Simple (dict) –

      The simple email message. The message consists of a subject and a message body.

      • Subject (dict) – [REQUIRED]

        The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.

        • Data (string) – [REQUIRED]

          The content of the message itself.

        • Charset (string) –

          The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

      • Body (dict) – [REQUIRED]

        The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.

        • Text (dict) –

          An object that represents the version of the message that is displayed in email clients that don’t support HTML, or clients where the recipient has disabled HTML rendering.

          • Data (string) – [REQUIRED]

            The content of the message itself.

          • Charset (string) –

            The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

        • Html (dict) –

          An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.

          • Data (string) – [REQUIRED]

            The content of the message itself.

          • Charset (string) –

            The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

      • Headers (list) –

        The list of message headers that will be added to the email message.

        • (dict) –

          Contains the name and value of a message header that you add to an email.

          • Name (string) – [REQUIRED]

            The name of the message header. The message header name has to meet the following criteria:

            • Can contain any printable ASCII character (33 - 126) except for colon (:).

            • Can contain no more than 126 characters.

          • Value (string) – [REQUIRED]

            The value of the message header. The message header value has to meet the following criteria:

            • Can contain any printable ASCII character.

            • Can contain no more than 870 characters.

    • Raw (dict) –

      The raw email message. The message has to meet the following criteria:

      • The message has to contain a header and a body, separated by one blank line.

      • All of the required header fields must be present in the message.

      • Each part of a multipart MIME message must be formatted properly.

      • If you include attachments, they must be in a file format that the Amazon SES API v2 supports.

      • The raw data of the message needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.

      • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients’ email clients render the message properly.

      • The length of any single line of text in the message can’t exceed 1,000 characters. This restriction is defined in RFC 5321.

      • Data (bytes) – [REQUIRED]

        The raw email message. The message has to meet the following criteria:

        • The message has to contain a header and a body, separated by one blank line.

        • All of the required header fields must be present in the message.

        • Each part of a multipart MIME message must be formatted properly.

        • Attachments must be in a file format that the Amazon SES supports.

        • The raw data of the message needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.

        • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients’ email clients render the message properly.

        • The length of any single line of text in the message can’t exceed 1,000 characters. This restriction is defined in RFC 5321.

    • Template (dict) –

      The template to use for the email message.

      • TemplateName (string) –

        The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

      • TemplateArn (string) –

        The Amazon Resource Name (ARN) of the template.

      • TemplateContent (dict) –

        The content of the template.

        Note

        Amazon SES supports only simple substitions when you send email using the SendEmail or SendBulkEmail operations and you provide the full template content in the request.

        • Subject (string) –

          The subject line of the email.

        • Text (string) –

          The email body that will be visible to recipients whose email clients do not display HTML.

        • Html (string) –

          The HTML body of the email.

      • TemplateData (string) –

        An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

      • Headers (list) –

        The list of message headers that will be added to the email message.

        • (dict) –

          Contains the name and value of a message header that you add to an email.

          • Name (string) – [REQUIRED]

            The name of the message header. The message header name has to meet the following criteria:

            • Can contain any printable ASCII character (33 - 126) except for colon (:).

            • Can contain no more than 126 characters.

          • Value (string) – [REQUIRED]

            The value of the message header. The message header value has to meet the following criteria:

            • Can contain any printable ASCII character.

            • Can contain no more than 870 characters.

  • EmailTags (list) –

    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.

    • (dict) –

      Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.

      • Name (string) – [REQUIRED]

        The name of the message tag. The message tag name has to meet the following criteria:

        • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

        • It can contain no more than 256 characters.

      • Value (string) – [REQUIRED]

        The value of the message tag. The message tag value has to meet the following criteria:

        • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

        • It can contain no more than 256 characters.

  • ConfigurationSetName (string) – The name of the configuration set to use when sending the email.

  • EndpointId (string) – The ID of the multi-region endpoint (global-endpoint).

  • ListManagementOptions (dict) –

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

    • ContactListName (string) – [REQUIRED]

      The name of the contact list.

    • TopicName (string) –

      The name of the topic.

Return type:

dict

Returns:

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

  • (dict) –

    A unique message ID that you receive when an email is accepted for sending.

    • MessageId (string) –

      A unique identifier for the message that is generated when the message is accepted.

      Note

      It’s possible for Amazon SES to accept a message without sending it. For example, this can happen when the message that you’re trying to send has an attachment that contains a virus, or when you send a templated email that contains invalid personalization content.

Exceptions