.NET v3: SESv2 Coupon Newsletter Workflow (awsdocs#6459)

Author: rlhagerm

.doc_gen/metadata/sesv2_metadata.yaml

@@ -1,5 +1,13 @@
 sesv2_CreateContactList:
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description:
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper.CreateContactList
     Rust:
       versions:
         - sdk_version: 1
@@ -30,6 +38,14 @@ sesv2_CreateContactList:
     sesv2: {CreateContactList}
 sesv2_CreateContact:
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description:
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper.CreateContact
     Rust:
       versions:
         - sdk_version: 1
@@ -84,6 +100,14 @@ sesv2_ListContactLists:
     sesv2: {ListContactLists}
 sesv2_ListContacts:
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description:
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper.ListContacts
     Rust:
       versions:
         - sdk_version: 1
@@ -114,6 +138,14 @@ sesv2_ListContacts:
     sesv2: {ListContacts}
 sesv2_SendEmail:
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description:
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper.SendEmail
     Java:
       versions:
         - sdk_version: 2
@@ -164,6 +196,14 @@ sesv2_SendEmail:
     sesv2: {SendEmail}
 sesv2_CreateEmailIdentity:
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description:
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper.CreateEmailIdentity
     Java:
       versions:
         - sdk_version: 2
@@ -194,6 +234,14 @@ sesv2_CreateEmailIdentity:
     sesv2: {CreateEmailIdentity}
 sesv2_CreateEmailTemplate:
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description:
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper.CreateEmailTemplate
     Java:
       versions:
         - sdk_version: 2
@@ -224,6 +272,14 @@ sesv2_CreateEmailTemplate:
     sesv2: {CreateEmailTemplate}
 sesv2_DeleteContactList:
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description:
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper.DeleteContactList
     Java:
       versions:
         - sdk_version: 2
@@ -254,6 +310,14 @@ sesv2_DeleteContactList:
     sesv2: {DeleteContactList}
 sesv2_DeleteEmailIdentity:
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description:
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper.DeleteEmailIdentity
     Java:
       versions:
         - sdk_version: 2
@@ -284,6 +348,14 @@ sesv2_DeleteEmailIdentity:
     sesv2: {DeleteEmailIdentity}
 sesv2_DeleteEmailTemplate:
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description:
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper.DeleteEmailTemplate
     Java:
       versions:
         - sdk_version: 2
@@ -318,6 +390,17 @@ sesv2_NewsletterWorkflow:
   synopsis: '&SESv2; newsletter workflow.'
   category: Scenarios
   languages:
+    .NET:
+      versions:
+        - sdk_version: 3
+          github: dotnetv3/SESv2
+          excerpts:
+            - description: Run the workflow.
+              snippet_tags:
+                - SESWorkflow.dotnetv3.NewsletterWorkflow
+            - description: Wrapper for service operations.
+              snippet_tags:
+                - SESWorkflow.dotnetv3.SESv2Wrapper
     Java:
       versions:
         - sdk_version: 2

dotnetv3/SESv2/NewsLetterWorkflow/NewsLetterWorkflow.sln

@@ -0,0 +1,31 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.9.34714.143
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sesv2Scenario", "Sesv2Scenario\Sesv2Scenario.csproj", "{79AE1B89-241B-4450-B1EB-9AAF79DA558C}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sesv2Tests", "Sesv2Tests\Sesv2Tests.csproj", "{E7E4EB7C-C785-4E8C-9E68-19825736F053}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{79AE1B89-241B-4450-B1EB-9AAF79DA558C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{79AE1B89-241B-4450-B1EB-9AAF79DA558C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{79AE1B89-241B-4450-B1EB-9AAF79DA558C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{79AE1B89-241B-4450-B1EB-9AAF79DA558C}.Release|Any CPU.Build.0 = Release|Any CPU
+		{E7E4EB7C-C785-4E8C-9E68-19825736F053}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{E7E4EB7C-C785-4E8C-9E68-19825736F053}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{E7E4EB7C-C785-4E8C-9E68-19825736F053}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{E7E4EB7C-C785-4E8C-9E68-19825736F053}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {7DE7AD4A-0683-440E-B2B7-0D91C5402601}
+	EndGlobalSection
+EndGlobal

dotnetv3/SESv2/NewsLetterWorkflow/README.md

@@ -0,0 +1,77 @@
+# Amazon SES v2 Coupon Newsletter Workflow
+
+## Overview
+
+This workflow demonstrates how to use the Amazon Simple Email Service (SES) v2 to send a coupon newsletter to a list of contacts. It covers the following key steps:
+
+1. **Prepare the Application**
+
+   - Create a verified email identity for the "send/reply" email addresses.
+   - Create a contact list to store the newsletter subscribers.
+
+2. **Gather Subscriber Email Addresses**
+
+   - Allow subscribers to sign up for the newsletter by providing their email addresses.
+   - Send a welcome email to each new subscriber.
+
+3. **Send the Coupon Newsletter**
+
+   - Create a template for the coupon newsletter.
+   - Retrieve the list of contacts (subscribers).
+   - Send individual emails with the coupon newsletter template to each subscriber.
+   - Include Unsubscribe links and headers to follow bulk email best practices.
+
+4. **Monitor and Review**
+
+   - Review dashboards and metrics in the AWS console for the newsletter campaign.
+   - Because this workflow minimizes the number of email addresses necessary by utilizing subaddresses to show the features of SES Contact Lists, it is likely an email provider will mark the messages as Spam. Check your spam folder to ensure they sent.
+
+5. **Clean up**
+
+   - Delete the template.
+   - Delete the contact list.
+   - Optionally delete the sender verified email identity.
+
+## ⚠ Important
+
+* Running this code might result in charges to your AWS account.
+* Running the tests might result in charges to your AWS account.
+* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
+* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
+
+## Scenario
+
+### Prerequisites
+
+For general prerequisites, see the [README](../../../README.md) in the `dotnetv3` folder.
+
+### Resources
+
+Before running this workflow, ensure you have:
+
+- An AWS account with proper permissions to use Amazon SES v2.
+- (Optional) A verified email identity (domain or email address) in Amazon SES for the Sending address.
+   - This will be created during the workflow if it does not already exist.
+- (Optional, if the account is in the SES Sandbox) A verified destination address.
+   - This will NOT be created during the workflow.
+
+### Instructions
+
+After the example compiles, you can run it from the command line. To do so, navigate to
+the folder that contains the .sln file and run the following command:
+
+```
+dotnet run
+```
+
+Alternatively, you can run the example from within your IDE.
+
+## Additional resources
+
+- [Amazon SES v2 API Developer Guide](https://docs.aws.amazon.com/ses/latest/dg/Welcome.html)
+- [Amazon SES v2 API API Reference](https://docs.aws.amazon.com/ses/latest/APIReference-V2/Welcome.html)
+- [SDK for .NET Amazon SES v2 API reference](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Sesv2/NSesv2.html)
+
+---
+
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0