diff --git a/.doc_gen/metadata/sesv2_metadata.yaml b/.doc_gen/metadata/sesv2_metadata.yaml index 313a51113c9..45b53bca279 100644 --- a/.doc_gen/metadata/sesv2_metadata.yaml +++ b/.doc_gen/metadata/sesv2_metadata.yaml @@ -101,6 +101,15 @@ sesv2_CreateContact: sesv2: {CreateContact} sesv2_GetEmailIdentity: languages: + Python: + versions: + - sdk_version: 3 + github: python/example_code/sesv2 + excerpts: + - description: + snippet_tags: + - python.example_code.sesv2.SESv2Wrapper.decl + - python.example_code.sesv2.GetEmailIdentity Rust: versions: - sdk_version: 1 @@ -248,6 +257,10 @@ sesv2_SendEmail: - python.example_code.sesv2.SESv2Workflow.main - python.example_code.sesv2.SESv2Workflow.decl - python.example_code.sesv2.SendEmail.template + - description: Sends a message with optional attachments. + snippet_tags: + - python.example_code.sesv2.SESv2Wrapper.decl + - python.example_code.sesv2.SendEmail services: sesv2: {SendEmail} sesv2_CreateEmailIdentity: @@ -290,6 +303,10 @@ sesv2_CreateEmailIdentity: - python.example_code.sesv2.SESv2Workflow.main - python.example_code.sesv2.SESv2Workflow.decl - python.example_code.sesv2.CreateEmailIdentity + - description: + snippet_tags: + - python.example_code.sesv2.SESv2Wrapper.decl + - python.example_code.sesv2.CreateEmailIdentity Rust: versions: - sdk_version: 1 @@ -341,6 +358,10 @@ sesv2_CreateEmailTemplate: - python.example_code.sesv2.SESv2Workflow.main - python.example_code.sesv2.SESv2Workflow.decl - python.example_code.sesv2.CreateEmailTemplate + - description: + snippet_tags: + - python.example_code.sesv2.SESv2Wrapper.decl + - python.example_code.sesv2.CreateEmailTemplate Rust: versions: - sdk_version: 1 @@ -443,6 +464,10 @@ sesv2_DeleteEmailIdentity: - python.example_code.sesv2.SESv2Workflow.main - python.example_code.sesv2.SESv2Workflow.decl - python.example_code.sesv2.DeleteEmailIdentity + - description: + snippet_tags: + - python.example_code.sesv2.SESv2Wrapper.decl + - python.example_code.sesv2.DeleteEmailIdentity Rust: versions: - sdk_version: 1 @@ -494,6 +519,10 @@ sesv2_DeleteEmailTemplate: - python.example_code.sesv2.SESv2Workflow.main - python.example_code.sesv2.SESv2Workflow.decl - python.example_code.sesv2.DeleteEmailTemplate + - description: + snippet_tags: + - python.example_code.sesv2.SESv2Wrapper.decl + - python.example_code.sesv2.DeleteEmailTemplate Rust: versions: - sdk_version: 1 @@ -581,3 +610,63 @@ sesv2_NewsletterWorkflow: services: sesv2: {CreateContactList, CreateContact, ListContacts, SendEmail.simple, SendEmail.template, CreateEmailIdentity, CreateEmailTemplate, DeleteContactList, DeleteEmailIdentity, DeleteEmailTemplate} + +sesv2_Hello: + title: Hello &SESv2; + title_abbrev: Hello &SESv2; + synopsis: get started using &SESv2;. + category: Hello + languages: + Python: + versions: + - sdk_version: 3 + github: python/example_code/sesv2 + excerpts: + - description: + snippet_tags: + - python.example_code.sesv2.Hello + services: + sesv2: {ListEmailIdentities} +sesv2_SendBulkEmail: + title: Send bulk email with &SESv2; + title_abbrev: Send bulk email + synopsis: send bulk email with &SESv2;. + category: Actions + languages: + Python: + versions: + - sdk_version: 3 + github: python/example_code/sesv2 + excerpts: + - description: + snippet_tags: + - python.example_code.sesv2.SESv2Wrapper.decl + - python.example_code.sesv2.SendBulkEmail + services: + sesv2: {SendBulkEmail} +sesv2_Scenario_EmailAttachments: + title: Send emails with attachments using &SESv2; + title_abbrev: Email Attachments Scenario + synopsis: send emails with attachments using &SESv2;. + synopsis_list: + - Verify sender email identity. + - Create an email template for bulk sends. + - Send a simple email with a file attachment. + - Send a simple email with an inline image. + - Send bulk templated emails with attachments. + - Clean up resources. + category: Scenarios + languages: + Python: + versions: + - sdk_version: 3 + github: python/example_code/sesv2 + excerpts: + - description: Create an SESv2 wrapper class to manage operations. + snippet_tags: + - python.example_code.sesv2.SESv2Wrapper.class + - description: Run an interactive scenario demonstrating email attachments. + snippet_tags: + - python.example_code.sesv2.Scenario_EmailAttachments + services: + sesv2: {SendEmail, SendBulkEmail, CreateEmailIdentity, CreateEmailTemplate, GetEmailIdentity, DeleteEmailTemplate, DeleteEmailIdentity} diff --git a/.gitignore b/.gitignore index 657ad41f507..f9318473e2b 100644 --- a/.gitignore +++ b/.gitignore @@ -41,3 +41,4 @@ kotlin/services/**/.kotlin/ .kiro/settings/ .kiro/steering/ +/codeloom_outputs diff --git a/.tools/base_requirements.txt b/.tools/base_requirements.txt index 07e44a90fcf..9a251cb9671 100644 --- a/.tools/base_requirements.txt +++ b/.tools/base_requirements.txt @@ -1,7 +1,7 @@ -black==26.3.1 +black==24.10.0 flake8==6.1.0 mypy-extensions==1.0.0 -pathspec==1.0.0 +pathspec==0.11.2 PyYAML==6.0.1 requests==2.33.0 typer==0.15.2 diff --git a/.tools/readmes/requirements_freeze.txt b/.tools/readmes/requirements_freeze.txt index dcb659f4610..90f55ef6e05 100644 --- a/.tools/readmes/requirements_freeze.txt +++ b/.tools/readmes/requirements_freeze.txt @@ -1,5 +1,5 @@ aws_doc_sdk_examples_tools @ git+https://github.com/awsdocs/aws-doc-sdk-examples-tools@2025.41.0 -black==26.3.1 +black==24.10.0 certifi==2025.1.31 charset-normalizer==3.4.1 click==8.1.8 diff --git a/python/example_code/sesv2/README.md b/python/example_code/sesv2/README.md index a35582ddd21..e03ec0a6da0 100644 --- a/python/example_code/sesv2/README.md +++ b/python/example_code/sesv2/README.md @@ -34,17 +34,23 @@ python -m pip install -r requirements.txt +### Get started + +- [Hello Amazon SES v2 API](sesv2_hello.py#L18) (`ListEmailIdentities`) + + ### Single actions Code excerpts that show you how to call individual service functions. - [CreateContact](newsletter.py#L155) - [CreateContactList](newsletter.py#L105) -- [CreateEmailIdentity](newsletter.py#L92) -- [CreateEmailTemplate](newsletter.py#L118) +- [CreateEmailIdentity](sesv2_wrapper.py#L73) +- [CreateEmailTemplate](sesv2_wrapper.py#L109) - [DeleteContactList](newsletter.py#L258) -- [DeleteEmailIdentity](newsletter.py#L286) -- [DeleteEmailTemplate](newsletter.py#L271) +- [DeleteEmailIdentity](sesv2_wrapper.py#L321) +- [DeleteEmailTemplate](sesv2_wrapper.py#L291) +- [GetEmailIdentity](sesv2_wrapper.py#L42) - [ListContacts](newsletter.py#L198) - [SendEmail](newsletter.py#L164) @@ -53,8 +59,14 @@ Code excerpts that show you how to call individual service functions. Code examples that show you how to accomplish a specific task by calling multiple functions within the same service. +- [Email Attachments Scenario](sesv2_wrapper.py) - [Newsletter scenario](newsletter.py) +### Actions +_Actions_ are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios. + +- [SendBulkEmail](sesv2_wrapper.py#L227) + @@ -74,7 +86,38 @@ To run the Newsletter example, copy the files from workflows/sesv2_weekly_mailer +#### Hello Amazon SES v2 API + +This example shows you how to get started using Amazon SES v2 API. + +``` +python sesv2_hello.py +``` + + +#### Email Attachments Scenario + +This example shows you how to send emails with attachments using Amazon SES v2 API. + +- Verify sender email identity. +- Create an email template for bulk sends. +- Send a simple email with a file attachment. +- Send a simple email with an inline image. +- Send bulk templated emails with attachments. +- Clean up resources. + + + + +Start the example by running the following at a command prompt: + +``` +python sesv2_wrapper.py +``` + + + #### Newsletter scenario diff --git a/python/example_code/sesv2/requirements.txt b/python/example_code/sesv2/requirements.txt index 621e276912d..1ce66d6ec91 100644 --- a/python/example_code/sesv2/requirements.txt +++ b/python/example_code/sesv2/requirements.txt @@ -1,2 +1,3 @@ -boto3>=1.26.79 +boto3>=1.35.0 +botocore>=1.35.0 pytest>=7.2.1 diff --git a/python/example_code/sesv2/scenario_sesv2_email_attachments.py b/python/example_code/sesv2/scenario_sesv2_email_attachments.py new file mode 100644 index 00000000000..198d35275e2 --- /dev/null +++ b/python/example_code/sesv2/scenario_sesv2_email_attachments.py @@ -0,0 +1,396 @@ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 + +""" +Purpose + Shows how to use the AWS SDK for Python (Boto3) with Amazon SESv2 to + send emails with attachments. This scenario demonstrates three use cases: + 1. Send a simple email with a file attachment. + 2. Send a simple email with an inline image rendered in the HTML body. + 3. Send bulk templated emails with attachments to multiple recipients. + + The new attachment support eliminates the need for developers to construct + raw MIME messages — SES handles the MIME assembly automatically. +""" + +import json +import logging +import sys + +import boto3 +from botocore.exceptions import ClientError + +from sesv2_wrapper import SESv2Wrapper + +# Add relative path to include demo_tools in this code example without need for setup. +sys.path.append("../..") +import demo_tools.question as q # noqa + +logger = logging.getLogger(__name__) + + +# snippet-start:[python.example_code.sesv2.Scenario_EmailAttachments] +class SESv2EmailAttachmentsScenario: + """ + Demonstrates sending emails with attachments using Amazon SESv2. + + This scenario walks through: + 1. Setting up an email identity and template. + 2. Sending a simple email with a file attachment. + 3. Sending a simple email with an inline image. + 4. Sending bulk templated emails with attachments. + 5. Cleaning up created resources. + """ + + TEMPLATE_NAME = "AttachmentDemoTemplate" + + def __init__(self, sesv2_wrapper: SESv2Wrapper) -> None: + """ + :param sesv2_wrapper: An instance of the SESv2Wrapper class. + """ + self.sesv2_wrapper = sesv2_wrapper + self.sender_email = "" + self.recipient_emails: list = [] + self.identity_was_created = False + + def run_scenario(self) -> None: + """Runs the SESv2 email attachments scenario.""" + print("-" * 88) + print("Welcome to the Amazon SESv2 Email Attachments Scenario!") + print("-" * 88) + print( + "This scenario demonstrates how to send emails with attachments\n" + "using the new SESv2 attachment support. SES handles MIME\n" + "construction automatically, so you don't need to build raw\n" + "MIME messages.\n" + ) + + try: + self._setup() + self._step1_send_email_with_attachment() + self._step2_send_email_with_inline_image() + self._step3_send_bulk_email_with_attachments() + except Exception as e: + logger.error("Scenario failed: %s", e) + print(f"\nThe scenario encountered an error: {e}") + finally: + self._cleanup() + + # ---------- Setup ---------- + + def _setup(self) -> None: + """ + Prompts for configuration, verifies the sender identity, prepares a + sample attachment, and creates an email template. + """ + print("\n--- Setup ---\n") + + # Prompt for sender and recipient addresses. + print( + "Both sender and recipient addresses must be verified if your\n" + "account is in the SES sandbox.\n" + ) + self.sender_email = q.ask( + "Enter a verified sender email address: " + ) + recipient_input = q.ask( + "Enter one or more recipient email addresses (comma-separated): " + ) + self.recipient_emails = [ + addr.strip() for addr in recipient_input.split(",") if addr.strip() + ] + + # Verify the sender identity. + print(f"\nChecking identity for {self.sender_email}...") + try: + identity_info = self.sesv2_wrapper.get_email_identity( + self.sender_email + ) + verified = identity_info.get("VerifiedForSendingStatus", False) + if verified: + print(f" ✓ {self.sender_email} is verified and ready to send.") + else: + print( + f" ⚠ {self.sender_email} exists but is not yet verified." + ) + except ClientError as err: + if err.response["Error"]["Code"] == "NotFoundException": + print( + f" Identity {self.sender_email} not found. " + "Creating it now..." + ) + result = self.sesv2_wrapper.create_email_identity( + self.sender_email + ) + self.identity_was_created = True + print( + f" Identity created. Verification status: " + f"{result.get('VerifiedForSendingStatus', False)}" + ) + print( + " Check your inbox and click the verification link " + "before continuing." + ) + q.ask("Press Enter when you have verified the address...") + else: + raise + + # Create the email template for the bulk-send step. + print("\nCreating email template for the bulk email step...") + try: + self.sesv2_wrapper.create_email_template( + template_name=self.TEMPLATE_NAME, + subject="Bulk Email with Attachment for {{name}}", + html_body=( + "

Hello {{name}}

" + "

Please find the attached document.

" + ), + text_body=( + "Hello {{name}}, Please find the attached document." + ), + ) + print(f" ✓ Template '{self.TEMPLATE_NAME}' created.\n") + except ClientError as err: + if err.response["Error"]["Code"] == "AlreadyExistsException": + print( + f" Template '{self.TEMPLATE_NAME}' already exists. " + "Using it.\n" + ) + else: + raise + + # ---------- Step 1: Simple email with file attachment ---------- + + def _step1_send_email_with_attachment(self) -> None: + """Sends a simple email with a text file attachment.""" + print("\n--- Step 1: Send a Simple Email with a File Attachment ---\n") + print( + "Creating a sample text file attachment and sending it with\n" + "the Simple email content type. SES constructs the MIME message\n" + "automatically.\n" + ) + + # Prepare a sample text file as bytes. + sample_content = b"This is a sample report attachment." + + attachment = { + "RawContent": sample_content, + "FileName": "sample-report.txt", + "ContentType": "text/plain", + "ContentDisposition": "ATTACHMENT", + "ContentDescription": "Sample report text file", + "ContentTransferEncoding": "BASE64", + } + + print( + "Note: When using an AWS SDK, the SDK handles base64 encoding\n" + "automatically. Direct API callers must encode content themselves.\n" + ) + + message_id = self.sesv2_wrapper.send_email( + from_address=self.sender_email, + to_addresses=self.recipient_emails, + subject="SESv2 Attachment Demo — Simple Email with Attachment", + html_body=( + "

Attachment Demo

" + "

Please see the attached report document.

" + ), + text_body="Please see the attached report document.", + attachments=[attachment], + ) + + print(f" ✓ Email sent! MessageId: {message_id}") + print( + " SES automatically constructed the MIME message with the " + "attachment.\n" + ) + + # ---------- Step 2: Simple email with inline image ---------- + + def _step2_send_email_with_inline_image(self) -> None: + """Sends a simple email with an inline image that renders in HTML.""" + print("\n--- Step 2: Send a Simple Email with an Inline Image ---\n") + print( + "This step demonstrates INLINE disposition. The image renders\n" + "directly in the HTML body using a 'cid:' reference instead of\n" + "appearing as a downloadable attachment.\n" + ) + + # Create a minimal 1x1 red PNG (valid PNG file). + sample_image = ( + b"\x89PNG\r\n\x1a\n" # PNG signature + b"\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01" + b"\x08\x02\x00\x00\x00\x90wS\xde" # 1x1 RGB + b"\x00\x00\x00\x0cIDATx\x9cc\xf8\x0f\x00\x00\x01\x01" + b"\x00\x05\x18\xd8N" # compressed data + b"\x00\x00\x00\x00IEND\xaeB`\x82" # IEND + ) + + attachment = { + "RawContent": sample_image, + "FileName": "logo.png", + "ContentType": "image/png", + "ContentDisposition": "INLINE", + "ContentId": "logo123", + "ContentDescription": "Company logo", + "ContentTransferEncoding": "BASE64", + } + + html_body = ( + "" + "

Inline Image Demo

" + "

Here is our logo:

" + 'Company Logo' + "" + ) + + message_id = self.sesv2_wrapper.send_email( + from_address=self.sender_email, + to_addresses=self.recipient_emails, + subject="SESv2 Attachment Demo — Inline Image", + html_body=html_body, + text_body=( + "Inline Image Demo — Please view this email in an " + "HTML-capable client to see the embedded image." + ), + attachments=[attachment], + ) + + print(f" ✓ Email sent! MessageId: {message_id}") + print( + " The ContentId 'logo123' is referenced in the HTML body via\n" + " 'cid:logo123', which lets the image render inline.\n" + ) + + # ---------- Step 3: Bulk templated email with attachments ---------- + + def _step3_send_bulk_email_with_attachments(self) -> None: + """Sends bulk templated emails with attachments to multiple recipients.""" + print("\n--- Step 3: Send Bulk Templated Emails with Attachments ---\n") + print( + "Using SendBulkEmail to send a templated email with an attachment\n" + "to multiple recipients in a single API call. Each recipient gets\n" + "personalized content via template data.\n" + ) + + sample_content = b"This is a sample report attachment." + + attachment = { + "RawContent": sample_content, + "FileName": "sample-report.txt", + "ContentType": "text/plain", + "ContentDisposition": "ATTACHMENT", + "ContentDescription": "Sample report for bulk recipients", + "ContentTransferEncoding": "BASE64", + } + + # Build one entry per recipient with personalized names. + names = ["Alice", "Bob", "Charlie", "Diana", "Eve"] + bulk_entries = [] + for i, email in enumerate(self.recipient_emails): + name = names[i] if i < len(names) else f"Recipient{i + 1}" + bulk_entries.append( + { + "Destination": {"ToAddresses": [email]}, + "ReplacementEmailContent": { + "ReplacementTemplate": { + "ReplacementTemplateData": json.dumps( + {"name": name} + ) + } + }, + } + ) + + results = self.sesv2_wrapper.send_bulk_email( + from_address=self.sender_email, + template_name=self.TEMPLATE_NAME, + default_template_data='{"name": "Valued Customer"}', + bulk_entries=bulk_entries, + attachments=[attachment], + ) + + print(" Bulk email results:") + for idx, result in enumerate(results): + status = result.get("Status", "Unknown") + msg_id = result.get("MessageId", "N/A") + error = result.get("Error", "") + recipient = ( + self.recipient_emails[idx] + if idx < len(self.recipient_emails) + else "Unknown" + ) + print(f" {recipient}: Status={status}, MessageId={msg_id}") + if error: + print(f" Error: {error}") + + print( + "\n All recipients receive the same attachment(s) defined in\n" + " DefaultContent. Template data is personalized per recipient.\n" + ) + + # ---------- Cleanup ---------- + + def _cleanup(self) -> None: + """Deletes the email template and optionally the email identity.""" + print("\n--- Cleanup ---\n") + + # Delete the email template. + try: + self.sesv2_wrapper.delete_email_template(self.TEMPLATE_NAME) + print(f" ✓ Template '{self.TEMPLATE_NAME}' deleted.") + except ClientError as err: + if err.response["Error"]["Code"] == "NotFoundException": + print( + f" Template '{self.TEMPLATE_NAME}' was already deleted." + ) + else: + logger.error("Failed to delete template: %s", err) + + # Optionally delete the email identity. + if self.identity_was_created and self.sender_email: + delete_identity = q.ask( + f"Delete the email identity '{self.sender_email}'? (y/n) ", + q.is_yesno, + ) + if delete_identity: + try: + self.sesv2_wrapper.delete_email_identity( + self.sender_email + ) + print( + f" ✓ Email identity '{self.sender_email}' deleted." + ) + except ClientError as err: + if err.response["Error"]["Code"] == "NotFoundException": + print( + f" Identity '{self.sender_email}' was " + "already deleted." + ) + else: + logger.error( + "Failed to delete identity: %s", err + ) + else: + print( + f" Skipping identity deletion for {self.sender_email}." + ) + else: + print( + " Sender identity was pre-existing. Skipping deletion." + ) + + print("\nAll resources have been cleaned up.") + print("-" * 88) + + +# snippet-end:[python.example_code.sesv2.Scenario_EmailAttachments] + + +if __name__ == "__main__": + logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s") + try: + scenario = SESv2EmailAttachmentsScenario(SESv2Wrapper.from_client()) + scenario.run_scenario() + except Exception: + logging.exception("Something went wrong with the scenario.") \ No newline at end of file diff --git a/python/example_code/sesv2/sesv2_hello.py b/python/example_code/sesv2/sesv2_hello.py new file mode 100644 index 00000000000..c707c92d3a9 --- /dev/null +++ b/python/example_code/sesv2/sesv2_hello.py @@ -0,0 +1,77 @@ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 + +""" +Purpose + Shows how to get started with Amazon SESv2 by listing email identities + associated with the account. +""" + +import logging + +import boto3 +from botocore.exceptions import ClientError + +logger = logging.getLogger(__name__) + + +# snippet-start:[python.example_code.sesv2.Hello] +def hello_sesv2(sesv2_client): + """ + Use the AWS SDK for Python (Boto3) to create an Amazon SESv2 client and + list the email identities in your account. This example uses the default + settings specified in your shared credentials and config files. + + :param sesv2_client: A Boto3 SESv2 client object. + """ + print("Hello, Amazon SESv2! Let's list your email identities:\n") + + identity_count = 0 + next_token = None + try: + while True: + kwargs = {"PageSize": 20} + if next_token: + kwargs["NextToken"] = next_token + response = sesv2_client.list_email_identities(**kwargs) + identities = response.get("EmailIdentities", []) + for identity in identities: + identity_count += 1 + identity_name = identity.get("IdentityName", "Unknown") + identity_type = identity.get("IdentityType", "Unknown") + verification_status = identity.get( + "VerificationStatus", "Unknown" + ) + sending_enabled = identity.get("SendingEnabled", False) + print( + f" Identity: {identity_name}" + f" Type: {identity_type}" + f" Status: {verification_status}" + f" Sending: {'Enabled' if sending_enabled else 'Disabled'}" + ) + next_token = response.get("NextToken") + if not next_token: + break + + if identity_count == 0: + print( + "No email identities found. " + "Use CreateEmailIdentity to add one." + ) + else: + print(f"\nFound {identity_count} email identity(ies).") + + except ClientError as err: + logger.error( + "Couldn't list email identities. Here's why: %s: %s", + err.response["Error"]["Code"], + err.response["Error"]["Message"], + ) + raise + + +# snippet-end:[python.example_code.sesv2.Hello] + + +if __name__ == "__main__": + hello_sesv2(boto3.client("sesv2")) diff --git a/python/example_code/sesv2/sesv2_wrapper.py b/python/example_code/sesv2/sesv2_wrapper.py new file mode 100644 index 00000000000..870314325b7 --- /dev/null +++ b/python/example_code/sesv2/sesv2_wrapper.py @@ -0,0 +1,352 @@ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 + +""" +Encapsulates Amazon SESv2 actions for sending emails with attachments. +""" + +import logging +from typing import Any, Dict, List, Optional + +import boto3 +from botocore.exceptions import ClientError + +logger = logging.getLogger(__name__) + + +# snippet-start:[python.example_code.sesv2.SESv2Wrapper.class] +# snippet-start:[python.example_code.sesv2.SESv2Wrapper.decl] +class SESv2Wrapper: + """Encapsulates Amazon SESv2 email sending actions.""" + + def __init__(self, sesv2_client: Any) -> None: + """ + Initializes the SESv2Wrapper with an SESv2 client. + + :param sesv2_client: A Boto3 SESv2 client. + """ + self.sesv2_client = sesv2_client + + @classmethod + def from_client(cls) -> "SESv2Wrapper": + """ + Creates an SESv2Wrapper instance with a default Boto3 SESv2 client. + + :return: A new SESv2Wrapper instance. + """ + sesv2_client = boto3.client("sesv2") + return cls(sesv2_client) + + # snippet-end:[python.example_code.sesv2.SESv2Wrapper.decl] + + # snippet-start:[python.example_code.sesv2.GetEmailIdentity] + def get_email_identity(self, email_address: str) -> Dict[str, Any]: + """ + Gets information about an email identity, including its verification status. + + :param email_address: The email address or domain to look up. + :return: A dictionary with identity information including verification status. + :raises ClientError: If the identity is not found (NotFoundException). + """ + try: + response = self.sesv2_client.get_email_identity( + EmailIdentity=email_address + ) + logger.info("Got email identity for %s.", email_address) + return response + except ClientError as err: + if err.response["Error"]["Code"] == "NotFoundException": + logger.info( + "Email identity %s not found.", email_address + ) + else: + logger.error( + "Couldn't get email identity %s. Here's why: %s: %s", + email_address, + err.response["Error"]["Code"], + err.response["Error"]["Message"], + ) + raise + + # snippet-end:[python.example_code.sesv2.GetEmailIdentity] + + # snippet-start:[python.example_code.sesv2.CreateEmailIdentity] + def create_email_identity(self, email_address: str) -> Dict[str, Any]: + """ + Starts the process of verifying an email identity (email address or domain). + + :param email_address: The email address or domain to verify. + :return: A dictionary with the identity type and verification status. + :raises ClientError: If the limit is exceeded (LimitExceededException). + """ + try: + response = self.sesv2_client.create_email_identity( + EmailIdentity=email_address + ) + logger.info( + "Started verification for email identity %s.", email_address + ) + return response + except ClientError as err: + if err.response["Error"]["Code"] == "LimitExceededException": + logger.error( + "Couldn't create email identity %s. You have exceeded " + "the maximum number of email identities. " + "Use an existing verified identity.", + email_address, + ) + else: + logger.error( + "Couldn't create email identity %s. Here's why: %s: %s", + email_address, + err.response["Error"]["Code"], + err.response["Error"]["Message"], + ) + raise + + # snippet-end:[python.example_code.sesv2.CreateEmailIdentity] + + # snippet-start:[python.example_code.sesv2.CreateEmailTemplate] + def create_email_template( + self, + template_name: str, + subject: str, + html_body: str, + text_body: str, + ) -> None: + """ + Creates an email template for use with templated and bulk email sends. + + :param template_name: The name for the new template. + :param subject: The subject line of the template. May include {{placeholders}}. + :param html_body: The HTML body of the template. + :param text_body: The plain text body of the template. + :raises ClientError: If the template limit is exceeded (LimitExceededException). + """ + try: + self.sesv2_client.create_email_template( + TemplateName=template_name, + TemplateContent={ + "Subject": subject, + "Html": html_body, + "Text": text_body, + }, + ) + logger.info("Created email template %s.", template_name) + except ClientError as err: + if err.response["Error"]["Code"] == "LimitExceededException": + logger.error( + "Couldn't create email template %s. You have exceeded " + "the maximum number of email templates. " + "Delete unused templates first.", + template_name, + ) + else: + logger.error( + "Couldn't create email template %s. Here's why: %s: %s", + template_name, + err.response["Error"]["Code"], + err.response["Error"]["Message"], + ) + raise + + # snippet-end:[python.example_code.sesv2.CreateEmailTemplate] + + # snippet-start:[python.example_code.sesv2.SendEmail] + def send_email( + self, + from_address: str, + to_addresses: List[str], + subject: str, + html_body: str, + text_body: str, + attachments: Optional[List[Dict[str, Any]]] = None, + ) -> str: + """ + Sends a simple email message with optional attachments. + + SES handles MIME construction automatically when using attachments + with the Simple content type, so developers don't need to build + raw MIME messages. + + :param from_address: The verified sender email address. + :param to_addresses: A list of recipient email addresses. + :param subject: The subject line of the email. + :param html_body: The HTML body content. + :param text_body: The plain text body content. + :param attachments: An optional list of attachment dictionaries. Each + attachment should contain 'RawContent' (bytes), 'FileName' (str), + and optionally 'ContentType', 'ContentDisposition', 'ContentId', + 'ContentDescription', and 'ContentTransferEncoding'. + :return: The MessageId of the sent email. + :raises ClientError: If the message is rejected (MessageRejected). + """ + try: + simple_message: Dict[str, Any] = { + "Subject": {"Data": subject}, + "Body": { + "Html": {"Data": html_body}, + "Text": {"Data": text_body}, + }, + } + + if attachments: + simple_message["Attachments"] = attachments + + response = self.sesv2_client.send_email( + FromEmailAddress=from_address, + Destination={"ToAddresses": to_addresses}, + Content={"Simple": simple_message}, + ) + message_id = response["MessageId"] + logger.info( + "Sent email from %s to %s. MessageId: %s", + from_address, + to_addresses, + message_id, + ) + return message_id + except ClientError as err: + if err.response["Error"]["Code"] == "MessageRejected": + logger.error( + "Message was rejected. Check that attachments use " + "supported file types and total message size is " + "under 40 MB. Details: %s", + err.response["Error"]["Message"], + ) + else: + logger.error( + "Couldn't send email. Here's why: %s: %s", + err.response["Error"]["Code"], + err.response["Error"]["Message"], + ) + raise + + # snippet-end:[python.example_code.sesv2.SendEmail] + + # snippet-start:[python.example_code.sesv2.SendBulkEmail] + def send_bulk_email( + self, + from_address: str, + template_name: str, + default_template_data: str, + bulk_entries: List[Dict[str, Any]], + attachments: Optional[List[Dict[str, Any]]] = None, + ) -> List[Dict[str, Any]]: + """ + Sends a templated email to multiple recipients in a single API call. + + All recipients receive the same attachment(s) defined in the default + content, while template data can be personalized per recipient. + + :param from_address: The verified sender email address. + :param template_name: The name of an existing email template. + :param default_template_data: Default JSON template data string. + :param bulk_entries: A list of BulkEmailEntry dicts, each containing + 'Destination' and optionally 'ReplacementEmailContent'. + :param attachments: An optional list of attachment dicts for all + recipients. + :return: A list of BulkEmailEntryResult dicts with status and MessageId. + :raises ClientError: If the message is rejected (MessageRejected). + """ + try: + template_content: Dict[str, Any] = { + "TemplateName": template_name, + "TemplateData": default_template_data, + } + + if attachments: + template_content["Attachments"] = attachments + + response = self.sesv2_client.send_bulk_email( + FromEmailAddress=from_address, + DefaultContent={"Template": template_content}, + BulkEmailEntries=bulk_entries, + ) + results = response.get("BulkEmailEntryResults", []) + logger.info( + "Sent bulk email from %s to %d recipients.", + from_address, + len(bulk_entries), + ) + return results + except ClientError as err: + if err.response["Error"]["Code"] == "MessageRejected": + logger.error( + "Bulk message was rejected. Check that the template " + "exists, attachment file types are supported, and " + "total message size is within limits. Details: %s", + err.response["Error"]["Message"], + ) + else: + logger.error( + "Couldn't send bulk email. Here's why: %s: %s", + err.response["Error"]["Code"], + err.response["Error"]["Message"], + ) + raise + + # snippet-end:[python.example_code.sesv2.SendBulkEmail] + + # snippet-start:[python.example_code.sesv2.DeleteEmailTemplate] + def delete_email_template(self, template_name: str) -> None: + """ + Deletes an email template. + + :param template_name: The name of the template to delete. + :raises ClientError: If the template is not found (NotFoundException). + """ + try: + self.sesv2_client.delete_email_template( + TemplateName=template_name + ) + logger.info("Deleted email template %s.", template_name) + except ClientError as err: + if err.response["Error"]["Code"] == "NotFoundException": + logger.info( + "Email template %s not found or already deleted.", + template_name, + ) + else: + logger.error( + "Couldn't delete email template %s. Here's why: %s: %s", + template_name, + err.response["Error"]["Code"], + err.response["Error"]["Message"], + ) + raise + + # snippet-end:[python.example_code.sesv2.DeleteEmailTemplate] + + # snippet-start:[python.example_code.sesv2.DeleteEmailIdentity] + def delete_email_identity(self, email_address: str) -> None: + """ + Deletes an email identity. + + :param email_address: The email address or domain to delete. + :raises ClientError: If the identity is not found (NotFoundException). + """ + try: + self.sesv2_client.delete_email_identity( + EmailIdentity=email_address + ) + logger.info("Deleted email identity %s.", email_address) + except ClientError as err: + if err.response["Error"]["Code"] == "NotFoundException": + logger.info( + "Email identity %s not found or already deleted.", + email_address, + ) + else: + logger.error( + "Couldn't delete email identity %s. Here's why: %s: %s", + email_address, + err.response["Error"]["Code"], + err.response["Error"]["Message"], + ) + raise + + # snippet-end:[python.example_code.sesv2.DeleteEmailIdentity] + + +# snippet-end:[python.example_code.sesv2.SESv2Wrapper.class] \ No newline at end of file diff --git a/python/example_code/sesv2/test_sesv2_email_attachments.py b/python/example_code/sesv2/test_sesv2_email_attachments.py new file mode 100644 index 00000000000..71b638d68d1 --- /dev/null +++ b/python/example_code/sesv2/test_sesv2_email_attachments.py @@ -0,0 +1,210 @@ +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +# SPDX-License-Identifier: Apache-2.0 + +""" +Integration tests for the SESv2 Email Attachments scenario. + +These tests call real AWS SESv2 APIs and require a verified email identity. +Set the environment variable SENDER_EMAIL to a verified SES email address. +""" + +import os + +import boto3 +import pytest + +from sesv2_wrapper import SESv2Wrapper +from scenario_sesv2_email_attachments import SESv2EmailAttachmentsScenario + + +@pytest.mark.integ +def test_sesv2_wrapper_get_email_identity(): + """Test that get_email_identity returns identity info for a verified sender.""" + sender_email = os.environ.get("SENDER_EMAIL") + if not sender_email: + pytest.skip("SENDER_EMAIL env var not set; skipping integration test.") + + wrapper = SESv2Wrapper.from_client() + try: + result = wrapper.get_email_identity(sender_email) + assert "VerifiedForSendingStatus" in result + finally: + # No cleanup needed for read-only operation. + pass + + +@pytest.mark.integ +def test_sesv2_wrapper_create_and_delete_template(): + """Test creating and deleting an email template.""" + wrapper = SESv2Wrapper.from_client() + template_name = "IntegTestTemplate" + try: + wrapper.create_email_template( + template_name=template_name, + subject="Test Subject for {{name}}", + html_body="

Hello {{name}}

", + text_body="Hello {{name}}", + ) + finally: + try: + wrapper.delete_email_template(template_name) + except Exception: + pass + + +@pytest.mark.integ +def test_sesv2_wrapper_send_email_with_attachment(): + """Test sending a simple email with a file attachment.""" + sender_email = os.environ.get("SENDER_EMAIL") + recipient_email = os.environ.get("RECIPIENT_EMAIL", sender_email) + if not sender_email: + pytest.skip("SENDER_EMAIL env var not set; skipping integration test.") + + wrapper = SESv2Wrapper.from_client() + sample_content = b"Integration test attachment content." + + attachment = { + "RawContent": sample_content, + "FileName": "integ-test.txt", + "ContentType": "text/plain", + "ContentDisposition": "ATTACHMENT", + "ContentDescription": "Integration test file", + "ContentTransferEncoding": "BASE64", + } + + try: + message_id = wrapper.send_email( + from_address=sender_email, + to_addresses=[recipient_email], + subject="SESv2 Integration Test — Attachment", + html_body="

Integration test with attachment.

", + text_body="Integration test with attachment.", + attachments=[attachment], + ) + assert message_id is not None + assert len(message_id) > 0 + finally: + # No cleanup needed for sent emails. + pass + + +@pytest.mark.integ +def test_sesv2_wrapper_send_email_with_inline_image(): + """Test sending a simple email with an inline image.""" + sender_email = os.environ.get("SENDER_EMAIL") + recipient_email = os.environ.get("RECIPIENT_EMAIL", sender_email) + if not sender_email: + pytest.skip("SENDER_EMAIL env var not set; skipping integration test.") + + wrapper = SESv2Wrapper.from_client() + + # Minimal 1x1 PNG + sample_image = ( + b"\x89PNG\r\n\x1a\n" + b"\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01" + b"\x08\x02\x00\x00\x00\x90wS\xde" + b"\x00\x00\x00\x0cIDATx\x9cc\xf8\x0f\x00\x00\x01\x01" + b"\x00\x05\x18\xd8N" + b"\x00\x00\x00\x00IEND\xaeB`\x82" + ) + + attachment = { + "RawContent": sample_image, + "FileName": "test-logo.png", + "ContentType": "image/png", + "ContentDisposition": "INLINE", + "ContentId": "testlogo123", + "ContentDescription": "Test logo", + "ContentTransferEncoding": "BASE64", + } + + html_body = ( + '

Test

' + 'Test Logo' + '' + ) + + try: + message_id = wrapper.send_email( + from_address=sender_email, + to_addresses=[recipient_email], + subject="SESv2 Integration Test — Inline Image", + html_body=html_body, + text_body="Inline image test — view in HTML client.", + attachments=[attachment], + ) + assert message_id is not None + assert len(message_id) > 0 + finally: + pass + + +@pytest.mark.integ +def test_sesv2_wrapper_send_bulk_email_with_attachment(): + """Test sending bulk templated email with an attachment.""" + sender_email = os.environ.get("SENDER_EMAIL") + recipient_email = os.environ.get("RECIPIENT_EMAIL", sender_email) + if not sender_email: + pytest.skip("SENDER_EMAIL env var not set; skipping integration test.") + + wrapper = SESv2Wrapper.from_client() + template_name = "IntegTestBulkTemplate" + + sample_content = b"Bulk test attachment content." + attachment = { + "RawContent": sample_content, + "FileName": "bulk-test.txt", + "ContentType": "text/plain", + "ContentDisposition": "ATTACHMENT", + "ContentDescription": "Bulk test file", + "ContentTransferEncoding": "BASE64", + } + + try: + wrapper.create_email_template( + template_name=template_name, + subject="Bulk Test for {{name}}", + html_body="

Hello {{name}}

Attached document.

", + text_body="Hello {{name}}, attached document.", + ) + + bulk_entries = [ + { + "Destination": {"ToAddresses": [recipient_email]}, + "ReplacementEmailContent": { + "ReplacementTemplate": { + "ReplacementTemplateData": '{"name": "TestUser"}' + } + }, + } + ] + + results = wrapper.send_bulk_email( + from_address=sender_email, + template_name=template_name, + default_template_data='{"name": "Default"}', + bulk_entries=bulk_entries, + attachments=[attachment], + ) + + assert results is not None + assert len(results) == 1 + assert results[0].get("Status") == "SUCCESS" + finally: + try: + wrapper.delete_email_template(template_name) + except Exception: + pass + + +@pytest.mark.integ +def test_sesv2_hello(capsys): + """Test the Hello SESv2 example.""" + from sesv2_hello import hello_sesv2 + + try: + hello_sesv2(boto3.client("sesv2")) + captured = capsys.readouterr() + assert "Hello, Amazon SESv2!" in captured.out + finally: + pass \ No newline at end of file