Введение
AWS SES (простая служба электронной почты) это простая в настройке служба отправки и получения электронной почты. Обычно управлять локальной системой электронной почты сложно, кропотливо и утомительно, поэтому аутсорсинг этого процесса является популярным выбором.
Мы можем использовать Amazon SES для отправки транзакционных электронных писем, маркетинговых электронных писем или любых других уведомлений по электронной почте нашим клиентам. Это доступное решение для предприятий любого размера, которые используют электронную почту для связи со своими клиентами, поскольку оно построено на надежной и масштабируемой инфраструктуре Веб-службы Amazon (AWS).
Для отправки массовых электронных писем любое приложение может взаимодействовать с Amazon SES. Мы платим только за электронные письма, которые фактически отправляем, будь то транзакционные или маркетинговые электронные письма. Кроме того, Amazon SES поддерживает ряд конфигураций, включая выделенные, общие или собственные IP-адреса. Компании могут учитывать каждое электронное письмо с помощью панелей мониторинга доставляемости и отчетов по информации об отправителе.
В этом руководстве мы настроим экземпляр AWS SES в регионе, а затем интегрируем его с Весеннее облако для AWS который является подпроектом Весеннее облако. Мы попробуем разные сценарии отправки писем из нашего приложения.
Примечание: Вы можете найти весь исходный код, использованный в руководстве, на Github.
Жизненный цикл отправки электронной почты с использованием AWS SES
Давайте посмотрим, как жизненный цикл электронной почты, отправленной приложением, достигает почтового ящика назначения:
-
Приложение, в нашем случае код Spring Cloud, запрашивает у AWS SES отправку электронного письма одному или нескольким получателям.
-
Сначала SES проверяет запрос и, если он одобрен, создает сообщение электронной почты со спецификациями запроса. Это сообщение электронной почты имеет заголовок, тело и конверт и соответствует RFC 5322определение формата интернет-сообщений.
-
Затем SES передает сообщение получателю получателя через Интернет. Как только сообщение передается SES, оно часто передается сразу же, при этом первоначальная попытка доставки обычно занимает несколько миллисекунд.
-
На данный момент есть несколько исходов. Например:
- Успешная доставка: Интернет-провайдер (ISP) принимает электронную почту и отправляет ее предполагаемому получателю.
- Жесткий отскок: Поскольку адрес получателя недействителен, интернет-провайдер отклоняет электронное письмо. Интернет-провайдер отправляет уведомление о жестком возврате обратно в Amazon SES, который уведомляет отправителя по электронной почте или публикует его в теме Amazon Simple Notification Service (Amazon SNS), настроенной для получения этого уведомления.
- Мягкий отскок: из-за таких условий, как переполнение почтового ящика получателя, отсутствие домена или какие-либо преходящие обстоятельства, такие как интернет-провайдер, который слишком занят для обработки запроса, интернет-провайдер может быть не в состоянии доставить электронное письмо получателю. Затем интернет-провайдер повторяет отправку сообщения электронной почты определенное количество раз и отправляет SES мягкое сообщение о возврате. Если SES не может доставить электронное письмо в течение указанного периода времени, он либо публикует событие в теме SNS, либо отправляет жесткое сообщение о возврате по электронной почте.
- жалоба: электронная почта классифицируется получателем как спам в своей почтовой программе. Уведомление о жалобе передается в Amazon SES, который затем ретранслирует его отправителю, если Amazon SES и интернет-провайдер установили цикл обратной связи.
- Авто-ответ: Интернет-провайдер-получатель уведомляет Amazon SES об автоматическом ответе получателя, например об отсутствии на рабочем месте, и Amazon SES передает уведомление отправителю.
Если доставка не удалась, Amazon SES возвращает отправителю сообщение об ошибке и удаляет электронное письмо.
Настройка Amazon SES
В отличие от любых других сервисов AWS, практически нет необходимости создавать экземпляр SES, поскольку все новые учетные записи AWS по умолчанию помещаются в изолированную программную среду AWS SES. Каждый аккаунт AWS по умолчанию имеет доступ к песочнице для AWS SES в доступных регионах.
При использовании режима песочницы мы можем отправлять электронные письма только проверенным личностям. Домен или адрес электронной почты, который мы используем для отправки электронной почты, является подтвержденной личностью. Мы должны сконструировать и проверить каждую идентичность, которую мы намерены использовать в качестве From, To, Source, Senderили Return-Path адрес, прежде чем мы сможем отправить электронное письмо с помощью SES в режиме песочницы. Используя Amazon SES для подтверждения личности, мы можем доказать свое право собственности и пресечь незаконное использование.
Чтобы избежать мошенничества и сохранить репутацию IP-адреса, AWS SES включает ограничения на отправку электронной почты. Эти ограничения определяют максимальное количество электронных писем в секунду и дневной лимит электронной почты для каждого пользователя. Связавшись с Центром поддержки AWS, мы можем установить такие квоты по регионам.
Давайте проверим личности. Войдите в консоль AWS и выполните поиск «Простой почтовый сервис Amazon"
Затем нажмите «Создать личность», чтобы добавить адрес электронной почты или домен для проверки. В нашем случае мы собираемся добавить адрес электронной почты для проверки.
Как только личность будет создана, мы можем проверить детали.
Созданная нами айдентика переходит в «Ожидание подтверждения" сцена. На этом этапе пользователю необходимо проверить письмо с подтверждением от AWS и следовать инструкциям, чтобы подтвердить его.
Далее нам нужно получить «ключ доступа(Основной ключ) и Секретный ключ” для аутентификации и авторизации нашего приложения с помощью SES. Чтобы сгенерировать это, нам нужно создать группу пользователей и добавить пользователя в эту группу. Когда мы создаем этого пользователя, AWS генерирует ключ доступа и секретный ключ. Итак, давайте перенаправим на «IAM” в консоли AWS и создайте группу пользователей.
Затем нам нужно добавить «Доступ администратора” разрешение на эту группу для SES.
Наконец, мы добавим пользователя в указанную выше группу.
Далее нам нужно выбрать группу для разрешений.
Наконец, скопируйте ключ доступа и секретный ключ, отображаемые на экране, для дальнейшего использования.
Отправка электронных писем с помощью Spring Cloud Project
Настройка проекта
Давайте запустим проект Spring Cloud и рассмотрим варианты использования для интеграции с SES. Самый простой способ начать скелетный проект — через Весенний инициализр:
Мы добавили Весенняя паутина для REST MVC, Апач Фримаркер для создания шаблонов электронной почты на основе HTML, Отправитель почты Java отправить электронное письмо и Ломбок (дополнительная библиотека для сокращения шаблонов). Кроме того, нам нужно добавить соответствующие зависимости для Spring Cloud AWS и SES. Для Spring Cloud AWS мы добавим отдельную спецификацию Spring Cloud AWS в наш pom.xml файл с использованием этого Блок:
<dependencyManagement>
<dependencies>
<dependency>
<groupId>io.awspring.cloud</groupId>
<artifactId>spring-cloud-aws-dependencies</artifactId>
<version>2.3.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
Наконец, чтобы добавить поддержку SES, нам нужно включить зависимость модуля, которая доступна в качестве начального модуля. spring-cloud-starter-aws-ses:
<dependency>
<groupId>io.awspring.cloud</groupId>
<artifactId>spring-cloud-starter-aws-ses</artifactId>
</dependency>
spring-cloud-starter-aws-ses включает транзитивные зависимости для spring-cloud-starter-awsкачества spring-cloud-aws-ses, spring-cloud-aws-ses модуль для SES содержит два класса: SimpleEmailServiceMailSender и SimpleEmailServiceJavaMailSender.
- Ассоциация
SimpleEmailServiceMailSenderкласс использует Amazon Simple Email Service для отправки электронных писем. Java Mail API не является обязательным требованием для этой реализации. Его можно использовать для отправки простых почтовых сообщений без вложений. - Ассоциация
SimpleEmailServiceJavaMailSenderКласс позволяет отправлять электронные письма, содержащие вложения и другие элементы пантомимы.
Так что это покрывает все наши основные потребности!
Настройка компонентов
Как обсуждалось выше, нам нужно определить два типа bean-компонентов: SimpleEmailServiceMailSender и SimpleEmailServiceJavaMailSender. Мы можем просто передать ключ доступа и секретный ключ в качестве учетных данных и настроить MailSender bean, который мы будем использовать для отправки писем:
@Configuration
public class SesConfig {
@Value("${cloud.aws.credentials.access-key}")
private String accessKey;
@Value("${cloud.aws.credentials.secret-key}")
private String secretKey;
@Value("${cloud.aws.region.static}")
private String region;
@Bean
public AmazonSimpleEmailService amazonSimpleEmailService() {
BasicAWSCredentials credentials = new BasicAWSCredentials(accessKey, secretKey);
return AmazonSimpleEmailServiceClientBuilder.standard()
.withCredentials(new AWSStaticCredentialsProvider(credentials))
.withRegion(region)
.build();
}
@Bean
public MailSender mailSender(AmazonSimpleEmailService amazonSimpleEmailService) {
return new SimpleEmailServiceMailSender(amazonSimpleEmailService);
}
@Bean
public JavaMailSender javaMailSender(AmazonSimpleEmailService amazonSimpleEmailService) {
return new SimpleEmailServiceJavaMailSender(amazonSimpleEmailService);
}
}
Чтобы отправлять электронные письма с вложениями, нам нужно настроить SimpleEmailServiceJavaMailSender который является реализацией JavaMailSender интерфейс из почтовой абстракции Spring.
Ознакомьтесь с нашим практическим руководством по изучению Git с рекомендациями, принятыми в отрасли стандартами и прилагаемой памяткой. Перестаньте гуглить команды Git и на самом деле изучить это!
Мы также определим свойства для получения информации из application.yml:
cloud:
aws:
region:
static: eu-central-1
auto: false
stack:
auto: false
credentials:
access-key: ********
secret-key: **************************
Отправка простого электронного письма
Мы можем отправлять простые электронные письма, используя SimpleEmailServiceMailSender bean, который мы настроили выше. Давайте определим сервисный уровень для использования этого bean-компонента:
@Service
public class EmailService {
@Autowired
private MailSender mailSender;
public void sendMessage(SimpleMailMessage simpleMailMessage) {
this.mailSender.send(simpleMailMessage);
}
}
Мы звоним в send() метод в MailSender bean, чтобы отправить нашу электронную почту. Нам также необходимо пройти SimpleMailMessage который будет содержать такие атрибуты, как from, to, текст и тему нашего письма. Итак, давайте определим Controller класс для вызова вышеуказанной службы с помощью REST API:
@RestController
public class EmailController {
@Autowired
private EmailService emailService;
@PostMapping("/sendEmail")
public String sendMessage(@RequestBody EmailDetails emailDetails) {
SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
simpleMailMessage.setFrom(emailDetails.getFromEmail());
simpleMailMessage.setTo(emailDetails.getToEmail());
simpleMailMessage.setSubject(emailDetails.getSubject());
simpleMailMessage.setText(emailDetails.getBody());
emailService.sendMessage(simpleMailMessage);
return "Email sent successfully";
}
}
Теперь, если мы запустим приложение и выполним следующий curl, оно отправит электронное письмо на подтвержденный адрес электронной почты:
curl -i -X POST
-H "Content-Type:application/json"
-d
'{
"fromEmail": "[email protected]",
"toEmail": "[email protected]",
"subject": "test email",
"body": "Hi, This is a test email."
}'
'http://localhost:8080/sendEmail'
Затем мы можем войти в почтовый адрес получателя и проверить, получил ли получатель электронное письмо.
Отправка простого электронного письма с вложением
Мы определим сервисный уровень для передачи вложения как mime и установим другие атрибуты электронной почты, такие как from, to, текст и тема:
@Service
public class EmailService {
@Autowired
private JavaMailSender javaMailSender;
public void sendMessageWithAttachment(SimpleMailMessage simpleMailMessage) {
try {
MimeMessage message = javaMailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(
message,
MimeMessageHelper.MULTIPART_MODE_MIXED_RELATED,
StandardCharsets.UTF_8.name());
helper.addAttachment("logo.png", new ClassPathResource("logo.png"));
helper.setTo(Objects.requireNonNull(simpleMailMessage.getTo()));
helper.setText(Objects.requireNonNull(simpleMailMessage.getText()));
helper.setSubject(Objects.requireNonNull(simpleMailMessage.getSubject()));
helper.setFrom(Objects.requireNonNull(simpleMailMessage.getFrom()));
javaMailSender.send(message);
} catch (MessagingException e) {
System.err.println("Exception: " + e.getMessage());
}
}
}
Здесь мы используем MimeMessageHelper создать электронное письмо с вложением. Наконец, мы определим Controller слой, чтобы пройти SimpleMailMessage атрибуты:
@RestController
public class EmailController {
@Autowired
private EmailService emailService;
@PostMapping("/sendEmailWithAttachment")
public String sendMessageWithAttachment(@RequestBody EmailDetails emailDetails) {
SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
simpleMailMessage.setFrom(emailDetails.getFromEmail());
simpleMailMessage.setTo(emailDetails.getToEmail());
simpleMailMessage.setSubject(emailDetails.getSubject());
simpleMailMessage.setText(emailDetails.getBody());
emailService.sendMessageWithAttachment(simpleMailMessage);
return "Email sent successfully";
}
}
Теперь, если мы запустим приложение и выполним следующий curl, оно отправит электронное письмо на подтвержденный адрес электронной почты:
curl -i -X POST
-H "Content-Type:application/json"
-d
'{
"fromEmail": "[email protected]",
"toEmail": "[email protected]",
"subject": "test email",
"body": "Hi, This is a test email with attachment."
}'
'http://localhost:8080/sendEmailWithAttachment'
Затем мы можем войти в почтовый адрес получателя и проверить, получил ли получатель электронное письмо.
Отправка шаблонного письма с вложением
Предыдущие варианты использования, которые мы видели, хороши для сценариев разработки или тестирования, но в производстве мы обычно используем шаблон электронной почты с переменными, которые будут заменены с помощью ответов API. Ранее мы добавили зависимость для Апач Фримаркер. Мы будем использовать его для определения шаблона и загрузки его в процесс!
Для этого давайте сначала определим простой шаблон, назовем его как email-template.ftl и поместите его в templates папку под resources:
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>StackAbuse Email</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="0">
<tr>
<td align="center" valign="top" bgcolor="#838383"
style="background-color: #838383;"><br> <br>
<table width="600" border="0" cellspacing="0" cellpadding="0">
<tr>
<td align="center" valign="top" bgcolor="#d3be6c"
style="background-color: #d3be6c; font-family: Arial,
Helvetica, sans-serif; font-size: 13px; color: #000000;
padding: 0px 15px 10px 15px;">
<div style="font-size: 48px; color:blue;">
<b>StackAbuse</b>
</div>
<div style="font-size: 24px; color: #555100;">
<br> Sending Email using Spring Cloud with <b>FreeMarker</b> template !!! <br>
</div>
<div>
<br> Want to learn a new technology or become an in-demand full-stack developer?<br>
<br> We teach the skills you need to level up in your career.<br>
<br>"Sharing knowledge is the biggest learning" <br> <br>
<br> <br> <b>${Name}</b><br>${location}<br>
<br>
</div>
</td>
</tr>
</table> <br> <br></td>
</tr>
</table>
</body>
</html>
Далее нам нужно определить класс конфигурации для загрузки шаблона из пути и добавления в качестве bean-компонента. Для этого определим FreeMarkerConfigurationFactoryBean:
@Configuration
public class FreemarkerConfig {
@Primary
@Bean
public FreeMarkerConfigurationFactoryBean factoryBean() {
FreeMarkerConfigurationFactoryBean bean = new FreeMarkerConfigurationFactoryBean();
bean.setTemplateLoaderPath("classpath:/templates");
return bean;
}
}
Далее мы определим наш сервисный уровень для загрузки этого шаблона и создадим окончательное сообщение для отправки в SES:
@Service
public class EmailService {
@Autowired
private JavaMailSender javaMailSender;
@Autowired
private Configuration config;
public void sendTemplateMessageWithAttachment(SimpleMailMessage simpleMailMessage) {
try {
MimeMessage message = javaMailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(
message,
MimeMessageHelper.MULTIPART_MODE_MIXED_RELATED,
StandardCharsets.UTF_8.name());
Template t = config.getTemplate("email-template.ftl");
Map model = new HashMap();
model.put("Name", "StackAbuse Admin");
model.put("location", "Bangalore, India");
String html = FreeMarkerTemplateUtils.processTemplateIntoString(t, model);
helper.addAttachment("logo.png", new ClassPathResource("logo.png"));
helper.setTo(Objects.requireNonNull(simpleMailMessage.getTo()));
helper.setText(html, true);
helper.setSubject(Objects.requireNonNull(simpleMailMessage.getSubject()));
helper.setFrom(Objects.requireNonNull(simpleMailMessage.getFrom()));
javaMailSender.send(message);
} catch (MessagingException | IOException | TemplateException e) {
System.err.println("Exception: " + e.getMessage());
}
}
Наконец, мы определим Controller слой для передачи динамических атрибутов электронной почты:
@RestController
public class EmailController {
@Autowired
private EmailService emailService;
@PostMapping("/sendTemplateEmailWithAttachment")
public String sendTemplateMessageWithAttachment(@RequestBody EmailDetails emailDetails) {
SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
simpleMailMessage.setFrom(emailDetails.getFromEmail());
simpleMailMessage.setTo(emailDetails.getToEmail());
simpleMailMessage.setSubject(emailDetails.getSubject());
simpleMailMessage.setText(emailDetails.getBody());
emailService.sendTemplateMessageWithAttachment(simpleMailMessage);
return "Email sent successfully";
}
}
Теперь, если мы запустим приложение и выполним следующий curl, оно отправит электронное письмо на подтвержденный адрес электронной почты:
curl -i -X POST
-H "Content-Type:application/json"
-d
'{
"fromEmail": "[email protected]",
"toEmail": "[email protected]",
"subject": "test email",
"body": "Hi, This is a test template email with attachment."
}'
'http://localhost:8080/sendTemplateEmailWithAttachment'
Затем мы можем войти в почтовый адрес получателя и проверить, получил ли получатель электронное письмо:
Отправка персонализированной электронной почты с использованием шаблонов в AWS SES
В предыдущем примере использования мы использовали статический шаблон для отправки электронных писем. Как мы можем обеспечить динамическую разработку шаблонов для разных целей и разных типов получателей? AWS SES позволяет нам создавать шаблоны электронной почты для отправки персонализированных электронных писем одному или нескольким адресатам за одну операцию.
Мы можем создать до 10,000 500 шаблонов электронной почты для каждой учетной записи Amazon SES. Каждый шаблон может иметь размер до 50 КБ, включая текстовую и HTML-части. Мы можем отправить до XNUMX адресатов в каждом звонке.
Итак, давайте быстро создадим шаблон электронной почты. Во-первых, мы можем определить файл JSON, используя следующий шаблон:
{
"Template": {
"TemplateName": "MyTemplate",
"SubjectPart": "Greetings from {{name}}!",
"HtmlPart": "StackAbuse Email
StackAbuse
Sending Email using Spring Cloud with AWS SES Email template !!!
Want to learn a new technology or become an in-demand full-stack developer?
We teach the skills you need to level up in your career.
"Sharing knowledge is the biggest learning"
{{name}}
{{location}}
",
"TextPart": "Dear {{name}},rnHere is your StackAbuse Email."
}
}
Этот шаблон содержит следующие атрибуты:
- Имя Шаблона: содержит имя шаблона.
- ТемаЧасть: содержит строку темы письма. В этом ресурсе могут присутствовать заменяющие теги. Эти теги имеют следующий формат:
{{tagname}}. Вы можете ввести значение для{{tagname}}для каждого пункта назначения при отправке электронной почты. - HTMLPart: содержит HTML-текст сообщения электронной почты, а также может содержать замещающие теги.
- Текстовая часть: Представляет собой текст сообщения электронной почты. Эта версия электронной почты отправляется получателям, чьи почтовые клиенты не просматривают электронные письма в формате HTML. В этом ресурсе могут присутствовать заменяющие теги.
Мы можем сохранить этот файл как mytemplate.json. Наконец, мы можем использовать команду AWS CLI для создания шаблона следующим образом:
$ aws ses create-template --cli-input-json file://mytemplate.json
Затем давайте определим сервисный уровень для определения атрибутов и отправки шаблонных электронных писем:
@Service
public class EmailService {
@Autowired
private AmazonSimpleEmailService simpleEmailService;
public void sendTemplatedMessage(SimpleMailMessage simpleMailMessage) {
Destination destination = new Destination();
List toAddresses = new ArrayList();
String[] emails = simpleMailMessage.getTo();
Collections.addAll(toAddresses, Objects.requireNonNull(emails));
destination.setToAddresses(toAddresses);
SendTemplatedEmailRequest templatedEmailRequest = new SendTemplatedEmailRequest();
templatedEmailRequest.withDestination(destination);
templatedEmailRequest.withTemplate("MyTemplate");
templatedEmailRequest.withTemplateData("{ "name":"StackAbuse Admin", "location": "Bangalore, India"}");
templatedEmailRequest.withSource(simpleMailMessage.getFrom());
simpleEmailService.sendTemplatedEmail(templatedEmailRequest);
}
}
Мы можем добавить несколько Destination адреса для массовой рассылки писем нескольким получателям. Мы используем sendTemplatedEmail() метод из AmazonSimpleEmailService интерфейс для отправки этого шаблонного письма. Нам также необходимо передать заменяемые теги в тексте HTML нашего шаблона, который мы создали ранее.
Наконец, мы определим Controller слой, чтобы определить REST API для передачи атрибутов:
@RestController
public class EmailController {
@Autowired
private EmailService emailService;
@PostMapping("/sendAWSTemplatedEmail")
public String sendTemplatedMessage(@RequestBody EmailDetails emailDetails) {
SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
simpleMailMessage.setFrom(emailDetails.getFromEmail());
simpleMailMessage.setTo(emailDetails.getToEmail());
simpleMailMessage.setSubject(emailDetails.getSubject());
simpleMailMessage.setText(emailDetails.getBody());
emailService.sendTemplatedMessage(simpleMailMessage);
return "Email sent successfully";
}
}
Далее, когда мы запускаем приложение, мы можем выполнить следующее curl для отправки шаблонных писем:
curl -i -X POST
-H "Content-Type:application/json"
-d
'{
"fromEmail": "[email protected]",
"toEmail": "[email protected]",
"subject": "Greetings from StackAbuse Admin",
"body": "Hi, This is a AWS templated email."
}'
'http://localhost:8080/sendAWSTemplatedEmail'
Теперь получатель, наконец, увидит шаблонное письмо:
Запросить доступ к производству
Наконец, чтобы отправлять электронные письма любому получателю, независимо от того, проверен ли адрес или домен получателя, мы должны в конечном итоге вывести нашу учетную запись из песочницы. Все наши личности, включая From, Source, Senderкачества Return-Path адреса, все еще должны быть проверены. Мы можем отправить запрос на доступ к производству из «Удобный аккаунт Dashboard.” следующим образом:
Мы можем отправить запрос, заполнив все вышеуказанные данные из консоли AWS. То же самое можно отправить с помощью интерфейса командной строки AWS. Это было бы полезно, когда нам нужно запросить доступ к большому количеству удостоверений и мы хотели бы автоматизировать процесс.
Заключение
В этой статье были рассмотрены ключевые идеи Amazon Simple Email Service (SES) и библиотеки, предлагаемые Spring Cloud AWS для взаимодействия с ним. Кроме того, мы создали приложение Spring Boot с REST API, которое может отправлять электронные письма через модуль Spring Cloud AWS SES.
Теперь у вас должно быть четкое представление о том, что такое Amazon Simple Email Service (SES) и как его использовать для отправки электронных писем.
