管理 Amazon SES 身份 - AWS SDK for JavaScript

AWS SDK for JavaScript V3 API 参考指南详细描述了 AWS SDK for JavaScript 版本 3 (V3) 的所有 API 操作。

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

管理 Amazon SES 身份

JavaScript code example that applies to Node.js execution

此 Node.js 代码示例演示:

  • 如何验证用于 Amazon SES 的电子邮件地址和域。

  • 如何为您的 Amazon SES 身份分配 AWS Identity and Access Management (IAM) 策略。

  • 如何列出您 AWS 账户的所有 Amazon SES 身份。

  • 如何删除用于 Amazon SES 的身份。

Amazon SES 身份 是 Amazon SES 用来发送电子邮件的电子邮件地址或域。Amazon SES 要求您验证电子邮件身份,以确认您拥有该身份,并防止他人使用。

有关如何在 Amazon SES 中验证电子邮件地址和域名的详细信息,请参阅《Amazon Simple Email Service 开发人员指南》中的在 Amazon SES 中验证电子邮件地址和域。有关在 Amazon SES 中发送授权的信息,请参阅 Amazon SES 发送授权概述

情景

在本示例中,您使用一系列 Node.js 模块验证和管理 Amazon SES 身份。Node.js 模块使用的 SDK JavaScript 来验证电子邮件地址和域名,使用SES客户端类的以下方法:

完成先决条件任务

要设置和运行此示例,您必须先完成以下任务:

  • 设置项目环境以运行这些 Node TypeScript 示例,并安装所需的模块 AWS SDK for JavaScript 和第三方模块。按照上的说明进行操作 GitHub

  • 使用用户凭证创建共享配置文件。有关提供共享凭证文件的更多信息,请参阅《AWS SDK 和工具参考指南》 中的共享配置和凭证文件

重要

这些示例演示了如何使用 ECMAScript6(ES6)导入/导出客户端服务对象和命令。

列出身份

在本示例中,使用 Node.js 模块列出用于 Amazon SES 的电子邮件地址和域。

创建一个 libs 目录,然后使用文件名 sesClient.js 创建一个 Node.js 模块。将以下代码复制并粘贴到其中,这将创建 Amazon SES 客户端对象。将 “区域” 替换为您的 “ AWS 区域”。

import { SESClient } from "@aws-sdk/client-ses"; // Set the AWS Region. const REGION = "us-east-1"; // Create SES service object. const sesClient = new SESClient({ region: REGION }); export { sesClient };

可以在此处找到此示例代码 GitHub。

创建文件名为 ses_listidentities.js 的 Node.js 模块。如前所示配置 SDK,包括安装所需的客户端和软件包。

创建对象,为 SES 客户端类的 ListIdentitiesCommand 方法传递 IdentityType 及其他参数。要调用 ListIdentitiesCommand 方法,请调用一个 Amazon SES 服务对象来传递参数对象。

返回的 data 包含 IdentityType 参数所指定的域身份数组。

注意

IDENTITY_TYPE 替换为身份类型,身份类型可以是 “EmailAddress” 或 “域”。

import { ListIdentitiesCommand } from "@aws-sdk/client-ses"; import { sesClient } from "./libs/sesClient.js"; const createListIdentitiesCommand = () => new ListIdentitiesCommand({ IdentityType: "EmailAddress", MaxItems: 10 }); const run = async () => { const listIdentitiesCommand = createListIdentitiesCommand(); try { return await sesClient.send(listIdentitiesCommand); } catch (err) { console.log("Failed to list identities.", err); return err; } };

要运行示例,请在命令提示符中键入以下内容。

node ses_listidentities.js

可以在此处找到此示例代码 GitHub。

验证电子邮件地址身份

在本示例中,使用 Node.js 模块验证用于 Amazon SES 的电子邮件发送方。

创建一个 libs 目录,然后使用文件名 sesClient.js 创建一个 Node.js 模块。将以下代码复制并粘贴到其中,这将创建 Amazon SES 客户端对象。将 “区域” 替换为您的 “ AWS 区域”。

import { SESClient } from "@aws-sdk/client-ses"; // Set the AWS Region. const REGION = "us-east-1"; // Create SES service object. const sesClient = new SESClient({ region: REGION }); export { sesClient };

可以在此处找到此示例代码 GitHub。

创建文件名为 ses_verifyemailidentity.js 的 Node.js 模块。如前所示配置 SDK,包括下载所需的客户端和软件包。

创建对象,为 SES 客户端类的 VerifyEmailIdentityCommand 方法传递 EmailAddress 参数。要调用 VerifyEmailIdentityCommand 方法,请调用一个 Amazon SES 客户端服务对象来传递参数。

注意

ADDRESS@DOMAIN.EXT 替换为电子邮件地址,例如 name@example.com。

// Import required AWS SDK clients and commands for Node.js import { VerifyEmailIdentityCommand } from "@aws-sdk/client-ses"; import { sesClient } from "./libs/sesClient.js"; const EMAIL_ADDRESS = "name@example.com"; const createVerifyEmailIdentityCommand = (emailAddress) => { return new VerifyEmailIdentityCommand({ EmailAddress: emailAddress }); }; const run = async () => { const verifyEmailIdentityCommand = createVerifyEmailIdentityCommand(EMAIL_ADDRESS); try { return await sesClient.send(verifyEmailIdentityCommand); } catch (err) { console.log("Failed to verify email identity.", err); return err; } };

要运行示例,请在命令提示符中键入以下内容。域会添加到 Amazon SES 等待验证。

node ses_verifyemailidentity.js

可以在此处找到此示例代码 GitHub。

验证域身份

在本示例中,使用 Node.js 模块验证用于 Amazon SES 的电子邮件域。

创建一个 libs 目录,然后使用文件名 sesClient.js 创建一个 Node.js 模块。将以下代码复制并粘贴到其中,这将创建 Amazon SES 客户端对象。将 “区域” 替换为您的 “ AWS 区域”。

import { SESClient } from "@aws-sdk/client-ses"; // Set the AWS Region. const REGION = "us-east-1"; // Create SES service object. const sesClient = new SESClient({ region: REGION }); export { sesClient };

可以在此处找到此示例代码 GitHub。

创建文件名为 ses_verifydomainidentity.js 的 Node.js 模块。如前所示配置 SDK,包括安装所需的客户端和软件包。

创建对象,为 SES 客户端类的 VerifyDomainIdentityCommand 方法传递 Domain 参数。要调用 VerifyDomainIdentityCommand 方法,请调用一个 Amazon SES 客户端服务对象来传递参数对象。

注意

此示例导入并使用所需的 S AWS ervice V3 包客户端、V3 命令,并以异步/等待模式使用该send方法。您可以改用 V2 命令创建此示例,方法是进行一些细微的更改。有关更多信息,请参阅 使用 V3 命令

注意

AMI_ID 替换为要运行的 Amazon 机器映像 (AMI) 的 ID,以及要分配给 AMI ID 的密钥对的 KEY_PAIR_NAME

import { VerifyDomainIdentityCommand } from "@aws-sdk/client-ses"; import { getUniqueName, postfix, } from "@aws-doc-sdk-examples/lib/utils/util-string.js"; import { sesClient } from "./libs/sesClient.js"; /** * You must have access to the domain's DNS settings to complete the * domain verification process. */ const DOMAIN_NAME = postfix(getUniqueName("Domain"), ".example.com"); const createVerifyDomainIdentityCommand = () => { return new VerifyDomainIdentityCommand({ Domain: DOMAIN_NAME }); }; const run = async () => { const VerifyDomainIdentityCommand = createVerifyDomainIdentityCommand(); try { return await sesClient.send(VerifyDomainIdentityCommand); } catch (err) { console.log("Failed to verify domain.", err); return err; } };

要运行示例,请在命令提示符中键入以下内容。域会添加到 Amazon SES 等待验证。

node ses_verifydomainidentity.js

可以在此处找到此示例代码 GitHub。

删除身份

在本示例中,使用 Node.js 模块删除用于 Amazon SES 的电子邮件地址或域。

创建一个 libs 目录,然后使用文件名 sesClient.js 创建一个 Node.js 模块。将以下代码复制并粘贴到其中,这将创建 Amazon SES 客户端对象。将 “区域” 替换为您的 “ AWS 区域”。

import { SESClient } from "@aws-sdk/client-ses"; // Set the AWS Region. const REGION = "us-east-1"; // Create SES service object. const sesClient = new SESClient({ region: REGION }); export { sesClient };

可以在此处找到此示例代码 GitHub。

创建文件名为 ses_deleteidentity.js 的 Node.js 模块。如前所示配置 SDK,包括安装所需的客户端和软件包。

创建对象,为 SES 客户端类的 DeleteIdentityCommand 方法传递 Identity 参数。要调用 DeleteIdentityCommand 方法,请创建一个 request 来调用 Amazon SES 客户端服务对象并传递参数。

注意

此示例导入并使用所需的 S AWS ervice V3 包客户端、V3 命令,并以异步/等待模式使用该send方法。您可以改用 V2 命令创建此示例,方法是进行一些细微的更改。有关更多信息,请参阅 使用 V3 命令

注意

IDENTITY_TYPE 替换为要删除的身份类型,将 IDENTITY_NAME 替换为要删除的身份的名称。

import { DeleteIdentityCommand } from "@aws-sdk/client-ses"; import { sesClient } from "./libs/sesClient.js"; const IDENTITY_EMAIL = "fake@example.com"; const createDeleteIdentityCommand = (identityName) => { return new DeleteIdentityCommand({ Identity: identityName, }); }; const run = async () => { const deleteIdentityCommand = createDeleteIdentityCommand(IDENTITY_EMAIL); try { return await sesClient.send(deleteIdentityCommand); } catch (err) { console.log("Failed to delete identity.", err); return err; } };

要运行示例,请在命令提示符中键入以下内容。

node ses_deleteidentity.js

可以在此处找到此示例代码 GitHub。