概要
AWS SES (簡易メールサービス) 簡単に設定できるメール送受信サービスです。 通常、オンプレミスの電子メール システムを管理するのは難しく、面倒で面倒なので、プロセスをアウトソーシングすることが一般的な選択肢です。
Amazon SES を使用して、トランザクション E メール、マーケティング E メール、またはその他の種類の通知 E メールをクライアントに送信できます。 信頼性が高くスケーラブルなインフラストラクチャ上に構築されているため、電子メールを使用して顧客とつながるあらゆる規模の企業にとって手頃なソリューションです。 Amazon Webサービス（AWS）.
一括 E メールを送信するために、どのアプリケーションでも Amazon SES と対話できます。 トランザクションのメールかマーケティングのメールかを問わず、実際に送信したメールに対してのみ料金を支払います。 さらに、Amazon SES では、専用 IP アドレス、共有 IP アドレス、所有 IP アドレスなど、さまざまな構成がサポートされています。 企業は、到達率ダッシュボードと送信者情報に関するレポートを使用して、すべての電子メールを有効にすることができます。
このガイドでは、リージョンで AWS SES インスタンスを設定してから、 AWS 用の Spring クラウド のサブプロジェクトです 春の雲. アプリケーションからメールを送信するさまざまなシナリオを試します。
注： このガイドで使用されているすべてのソース コードは、 githubの.
AWS SES を使用した E メール送信のライフサイクル
アプリケーションによって送信された電子メールのライフサイクルが宛先メールボックスに到達する方法を見てみましょう。
-
アプリケーション (この場合、Spring Cloud コード) は、AWS SES に E メールを XNUMX 人以上の受信者に送信するように要求します。
-
SES は最初に要求を検証し、承認された場合は、要求の仕様を記載した電子メール メッセージを作成します。 この電子メール メッセージには、ヘッダー、本文、エンベロープがあり、 RFC 5322の Internet Message Format 定義。
-
次に、SES はメッセージをインターネット経由で受信者の受信者に送信します。 メッセージが SES に渡されるとすぐに送信されることが多く、最初の配信試行は通常数ミリ秒で行われます。
-
この時点でいくつかの結果があります。 例えば：
- 配達の成功: インターネット サービス プロバイダー (ISP) が電子メールを受け入れ、目的の受信者に送信します。
- ハードバウンス: 受信者のアドレスが無効であるため、ISP は電子メールを拒否します。 ISP はハードバウンス通知を Amazon SES に送り返します。Amazon SES は、E メールで送信者に通知するか、この通知を受信するように設定された Amazon Simple Notification Service (Amazon SNS) トピックに発行して送信者に通知します。
- ソフトバウンス: 受信者の受信トレイがいっぱいである、ドメインが存在しない、または ISP が忙しすぎて要求を処理できないなどの通過状況により、ISP は電子メールを受信者に配信できない場合があります。 その後、ISP は電子メールを特定の回数まで再試行し、SES にソフト バウンス メッセージを送信します。 SES が指定された時間枠内に電子メールを配信できない場合、イベントを SNS トピックに公開するか、電子メールでハード バウンス メッセージを送信します。
- 苦情: 電子メールは、電子メール プログラムの受信者によってスパムとして分類されます。 苦情通知は Amazon SES に送信され、Amazon SES と ISP でフィードバック ループが確立されている場合、送信者に中継されます。
- 自動応答: 受信者の ISP は、受信者からの自動応答 (不在通知など) を Amazon SES に通知し、Amazon SES はその通知を送信者に渡します。
配信が失敗すると、Amazon SES は送信者にエラーを返し、E メールを削除します。
Amazon SES のセットアップ
他の AWS サービスとは異なり、新しい AWS アカウントはすべてデフォルトで AWS SES サンドボックスに配置されるため、SES インスタンスを作成する必要は実質的にありません。 各 AWS アカウントには、デフォルトで、利用可能なリージョンで AWS SES のサンドボックス アクセス権があります。
サンドボックス モードを使用する場合、確認済みの ID にのみメールを送信できます。 電子メールの送信に使用するドメインまたは電子メール アドレスは、検証済みの ID です。 として使用する予定の各 ID を構築して検証する必要があります。 From, To, Source, Senderまたは Return-Path サンドボックス モードで SES を使用して電子メールを送信する前にアドレスを指定します。 Amazon SES を使用して身元を確認することで、所有権を証明し、不正使用を防止できます。
詐欺を回避し、IP アドレスの評判を維持するために、AWS SES には E メール送信制限が含まれています。 これらの制限により、XNUMX 秒あたりの電子メールの最大数と、各ユーザーの XNUMX 日の電子メール制限が指定されます。 AWS サポート センターに連絡することで、地域ごとにそのようなクォータを設定できます。
身元を確認しましょう。 AWS コンソールにログインし、「AmazonシンプルEメールサービス"
次に、アイデンティティを作成する」をクリックして、確認用の電子メールまたはドメインを追加します。 この例では、確認用の電子メールを追加します。
ID が作成されると、詳細を確認できます。
私たちが作成したアイデンティティは「検証保留中」ステージ。 この段階で、ユーザーは 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 BOM を 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 モジュールには、次の XNUMX つのクラスが含まれています。 SimpleEmailServiceMailSender & SimpleEmailServiceJavaMailSender.
-
SimpleEmailServiceMailSenderクラスは、Amazon Simple Email Service を利用してメールを送信します。 Java Mail API は、この実装の要件ではありません。 添付ファイルのない単純なメール メッセージを送信するために使用できます。 -
SimpleEmailServiceJavaMailSenderクラスは、添付ファイルやその他の MIME 要素を含む電子メールの送信を有効にします。
したがって、これですべての基本的な要件がカバーされます。
Bean の構成
上で説明したように、XNUMX 種類の Bean を定義する必要があります。 SimpleEmailServiceMailSender & SimpleEmailServiceJavaMailSender. access-key と secret-key をクレデンシャルとして渡すだけで、 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 のテンプレートを使用してパーソナライズされた E メールを送信する
前のユースケースでは、静的テンプレートを使用してメールを送信しました。 さまざまな目的やさまざまな種類の受信者向けにテンプレートを動的に設計できるようにするにはどうすればよいでしょうか? AWS SES を使用すると、E メール テンプレートを作成して、パーソナライズされた E メールを XNUMX 回の操作で XNUMX つ以上の宛先に送信できます。
Amazon SES アカウントごとに最大 10,000 個の E メール テンプレートを作成できます。 各テンプレートのサイズは、テキスト部分と HTML 部分の両方を含めて最大 500 KB です。 50 回の通話で最大 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}}メール送信時の送信先ごと。 - HTMLパート: これには電子メールの 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 アドレス、まだ確認する必要があります。 プロダクション アクセスのリクエストは、「アカウントのダッシュボード」ページは次のとおりです。
上記のすべての詳細を記入したリクエストを AWS コンソールから送信できます。 同じものを AWS CLI を使用して送信することもできます。 これは、多数の ID へのアクセスを要求する必要があり、プロセスを自動化したい場合に役立ちます。
まとめ
この記事では、Amazon Simple Email Service (SES) の重要なアイデアと、Spring Cloud AWS が提供するそれとのインターフェース用のライブラリについて説明しました。 さらに、Spring Cloud AWS SES モジュールを介してメールを送信できる REST API を備えた Spring Boot アプリケーションを作成しました。
これで、Amazon Simple Email Service (SES) とは何か、またそれを利用してメールを送信する方法をしっかりと理解できたはずです。
