Add Support for Email Headers

[MrThreepwood]

Describe the feature

This post seems to imply there's an easy way to manage email headers with SES without resorting to using a raw email builder. I can't actually find any way to do that in the Java SDK though

Use Case

I was hoping to make unsubscribing easy by including a list-unsubscribe header in my emails

Proposed Solution

Implement a simple place to add headers through the SDK

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

AWS Java SDK version used

2.27.21

JDK version used

21

Operating System and version

macOs Sequoia

[debora-ito]

There's a hint about the way to provide the email headers in the blog post linked in the announcement, based on the Python SDK code example:

response = sesv2.send_email(
    FromEmailAddress='Nutrition.co <support@nutrition.co>',
    Destination={'ToAddresses': ['customer@destination.com']},
    ConfigurationSetName='ConfigSet',
    Content={
      "Simple": { 
         "Body": { 
            "Html": { 
               "Charset": "UTF-8",
               "Data": "Welcome to Nutrition.co"
            },
            "Text": { 
             "Charset": "UTF-8",
             "Data": "Welcome to Nutrition.co"
          }
         },
         "Subject": { 
            "Charset": "UTF-8",
            "Data": "Welcome to Nutrition.co"
         },		 
         "Headers": [ 
            { 
               "Name": "List-Unsubscribe",
               "Value": "<https://nutrition.co/?address=x&topic=x>, <mailto: unsubscribe@nutrition.co?subject=TopicUnsubscribe>"
            },
            {
              "Name": "List-Unsubscribe-Post",
              "Value": "List-Unsubscribe=One-Click"            
            }
         ]
      }
    }

So in Java SDK, using the Simple type of message, the headers can be provided in the Message:

Java SDK code example:

    EmailContent emailContent = EmailContent.builder()
        .simple(Message.builder()
            .body(b -> b.html(c -> c.charset(UTF8).data(WELCOME))
                        .text(c -> c.charset(UTF8).data(WELCOME)))
            .subject(c -> c.charset(UTF8).data(WELCOME))
            .headers(List.of(
                MessageHeader.builder()
                    .name("List-Unsubscribe")
                    .value("<https://nutrition.co/?address=x&topic=x>, <mailto: unsubscribe@nutrition.co?subject=TopicUnsubscribe>").build(), 
                MessageHeader.builder()
                    .name("List-Unsubscribe-Post")
                    .value("List-Unsubscribe=One-Click").build()))
            .build())
        .build();

    SendEmailRequest request = SendEmailRequest.builder()
        .fromEmailAddress(FROM_EMAIL_ADDRESS)
        .destination(d -> d.toAddresses(DESTINATION_EMAILS))
        .content(emailContent)
        .build();

    SendEmailResponse response = sesv2Client.sendEmail(request);

[MrThreepwood]

What is the code example you provided from? Could I get some imports? There is no headers function on Message.builder() and I don't even have an EmailContent class.

[debora-ito]

Make sure you're using the sesv2 client (not ses), and version 2.25.3 or later (which looks like you are).

import software.amazon.awssdk.services.sesv2.SesV2Client;
import software.amazon.awssdk.services.sesv2.model.EmailContent;
import software.amazon.awssdk.services.sesv2.model.Message;
import software.amazon.awssdk.services.sesv2.model.MessageHeader;
import software.amazon.awssdk.services.sesv2.model.SendEmailRequest;
import software.amazon.awssdk.services.sesv2.model.SendEmailResponse;

[MrThreepwood]

I have this package: https://mvnrepository.com/artifact/software.amazon.awssdk/ses

I assume that's not correct? I don't actually have an sesv2 package.

I randomly guessed at the correct package name, and it appears I should be using sesV2, instead of ses. Considering this was the 2.0 version of the Java SDK, I assumed references to sesv2 vs sesv1 were refernces to the 1.0 and 2.0 versions of the SDK respectively.
aws-bom = { module = "software.amazon.awssdk:bom", version.ref = "aws" }
aws-ses = { module = "software.amazon.awssdk:sesv2" }

I'm actually struggling to find any direct documentation about how to pull in the ses dependency at all, I think I just guessed in the first place from the s3 and DynamoDB examples in the readme. Is there somewhere with documentation about how to use the v2 client, or pull it in as a dependency?