Das AWS SDK for JavaScript APIV3-Referenzhandbuch beschreibt detailliert alle API Operationen für die AWS SDK for JavaScript Version 3 (V3).
Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
E-Mail mit Amazon senden SES
Dieses Node.js-Codebeispiel zeigt:
Senden Sie einen Text oder eine HTML E-Mail.
das Senden von E-Mails, die auf einer E-Mail-Vorlage basieren.
das Senden von Massen-E-Mails, die auf einer E-Mail-Vorlage basieren.
Amazon SES API bietet Ihnen zwei verschiedene Möglichkeiten, eine E-Mail zu senden, je nachdem, wie viel Kontrolle Sie über die Zusammensetzung der E-Mail-Nachricht haben möchten: formatiert und roh. Einzelheiten finden Sie unter Senden formatierter E-Mails über Amazon SES API und Senden von Roh-E-Mails über Amazon SES API.
Das Szenario
In diesem Beispiel verwenden Sie mehrere Node.js-Module, um E-Mails auf verschiedene Weisen zu senden. Die Module Node.js verwenden das SDK for JavaScript , um E-Mail-Vorlagen mithilfe der folgenden Methoden der SES
Client-Klasse zu erstellen und zu verwenden:
Erforderliche Aufgaben
Zum Einrichten und Ausführen dieses Beispiels müssen Sie zunächst diese Aufgaben abschließen:
-
Richten Sie die Projektumgebung ein, um diese TypeScript Node-Beispiele auszuführen, und installieren Sie die erforderlichen Module AWS SDK for JavaScript und Module von Drittanbietern. Folgen Sie den Anweisungen auf GitHub
.
Erstellen Sie eine freigegebene Konfigurationsdatei mit Ihren Anmeldeinformationen. Weitere Informationen zur Bereitstellung einer Datei mit gemeinsam genutzten Anmeldeinformationen finden Sie unter Dateien mit gemeinsam genutzten Konfigurationen und Anmeldeinformationen im AWS SDKsReferenzhandbuch zu Tools.
Wichtig
Diese Beispiele zeigen, wie Client-Dienstobjekte und Befehle mithilfe von ECMAScript6 () ES6 importiert/exportiert werden.
Dies erfordert Node.js Version 13.x oder höher. Informationen zum Herunterladen und Installieren der neuesten Version von Node.js finden Sie unter Node.js downloads
. . Wenn Sie die CommonJS-Syntax bevorzugen, finden Sie weitere Informationen unterJavaScript ES6/CommonJS-Syntax.
Anforderungen für den Versand von E-Mail-Nachrichten
Amazon SES verfasst eine E-Mail-Nachricht und stellt sie sofort in die Warteschlange für den Versand. Damit Sie mithilfe der SendEmailCommand
-Methode E-Mails senden können, muss Ihre Nachricht die folgenden Anforderungen erfüllen:
Sie müssen die Nachricht von einer verifizierten E-Mail-Adresse oder Domäne senden. Wenn Sie versuchen, E-Mails über eine nicht verifizierte Adresse oder Domäne zu senden, führt die Operation zu einem
"Email address not verified"
-Fehler.Wenn sich Ihr Konto noch in der SES Amazon-Sandbox befindet, können Sie nur an verifizierte Adressen oder Domains oder an E-Mail-Adressen senden, die mit dem Amazon SES Mailbox Simulator verknüpft sind. Weitere Informationen finden Sie unter Verifizieren von E-Mail-Adressen und Domains im Amazon Simple Email Service Developer Guide.
Die Gesamtgröße der Nachricht, einschließlich Anlagen, muss kleiner als 10 MB sein.
Die Nachricht muss mindestens eine E-Mail-Adresse für einen Empfänger enthalten. Die Empfängeradresse kann eine An: -Adresse, eine CC: -Adresse oder eineBCC: -Adresse sein. Wenn die E-Mail-Adresse eines Empfängers nicht gültig ist (d. h., sie hat nicht das Format
UserName@[SubDomain.]Domain.TopLevelDomain
), wird die gesamte Nachricht zurückgewiesen, auch wenn die Nachricht andere gültige Empfänger enthält.Die Nachricht darf in den Feldern An:, CC: undBCC: nicht mehr als 50 Empfänger enthalten. Wenn Sie eine E-Mail an eine größere Zielgruppe senden möchten, können Sie Ihre Empfängerliste in Gruppen von höchstens 50 unterteilen und dann die
sendEmail
-Methode aufrufen, um die Nachricht mehrmals an die einzelnen Gruppen zu senden.
Eine E-Mail senden
Verwenden Sie in diesem Beispiel ein Modul Node.js, um E-Mails mit Amazon zu sendenSES.
Erstellen Sie ein libs
Verzeichnis und ein Modul Node.js mit dem DateinamensesClient.js
. Kopieren Sie den folgenden Code und fügen Sie ihn ein, wodurch das SES Amazon-Client-Objekt erstellt wird. Ersetzen REGION
mit Ihrer AWS Region.
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 };
Diesen Beispielcode finden Sie hier auf GitHub
Erstellen Sie ein Node.js-Modul mit dem Dateinamen ses_sendemail.js
. Konfigurieren Sie das SDK wie zuvor gezeigt, einschließlich der Installation der erforderlichen Clients und Pakete.
Erstellen Sie ein Objekt, um die Parameterwerte, die die zu sendende E-Mail definieren, einschließlich Absender- und Empfängeradressen, Betreff und E-Mail-Text in Klartext und HTML Formaten, an die SendEmailCommand
Methode der SES
Client-Klasse zu übergeben. Um die SendEmailCommand
Methode aufzurufen, rufen Sie ein SES Amazon-Serviceobjekt auf und übergeben die Parameter.
Anmerkung
In diesem Beispiel werden die erforderlichen AWS Service V3-Paketclients und V3-Befehle importiert und verwendet und die send
Methode in einem Async/Await-Muster verwendet. Sie können dieses Beispiel stattdessen mit V2-Befehlen erstellen, indem Sie einige geringfügige Änderungen vornehmen. Details hierzu finden Sie unter Verwenden von v3-Befehlen.
Anmerkung
Ersetzen toAddress
mit der Adresse, an die die E-Mail gesendet werden soll, und fromAddress
mit der E-Mail-Adresse, von der die E-Mail gesendet werden soll.
import { SendEmailCommand } from "@aws-sdk/client-ses"; import { sesClient } from "./libs/sesClient.js"; const createSendEmailCommand = (toAddress, fromAddress) => { return new SendEmailCommand({ Destination: { /* required */ CcAddresses: [ /* more items */ ], ToAddresses: [ toAddress, /* more To-email addresses */ ], }, Message: { /* required */ Body: { /* required */ Html: { Charset: "UTF-8", Data: "HTML_FORMAT_BODY", }, Text: { Charset: "UTF-8", Data: "TEXT_FORMAT_BODY", }, }, Subject: { Charset: "UTF-8", Data: "EMAIL_SUBJECT", }, }, Source: fromAddress, ReplyToAddresses: [ /* more items */ ], }); }; const run = async () => { const sendEmailCommand = createSendEmailCommand( "recipient@example.com", "sender@example.com", ); try { return await sesClient.send(sendEmailCommand); } catch (caught) { if (caught instanceof Error && caught.name === "MessageRejected") { /** @type { import('@aws-sdk/client-ses').MessageRejected} */ const messageRejectedError = caught; return messageRejectedError; } throw caught; } };
Um das Beispiel auszuführen, geben Sie in der Befehlszeile Folgendes ein. Die E-Mail befindet sich in der Warteschlange für den Versand durch AmazonSES.
node ses_sendemail.js
Diesen Beispielcode finden Sie hier auf GitHub.
Senden einer E-Mail mithilfe einer Vorlage
Verwenden Sie in diesem Beispiel ein Modul Node.js, um E-Mails mit Amazon zu sendenSES. Erstellen Sie ein Node.js-Modul mit dem Dateinamen ses_sendtemplatedemail.js
. Konfigurieren Sie das SDK wie zuvor gezeigt, einschließlich der Installation der erforderlichen Clients und Pakete.
Erstellen Sie ein Objekt, um die Parameterwerte, die die zu sendende E-Mail definieren, einschließlich Absender- und Empfängeradressen, Betreff, E-Mail-Text im Klartext und HTML Formaten, an die SendTemplatedEmailCommand
Methode der SES
Client-Klasse zu übergeben. Um die SendTemplatedEmailCommand
Methode aufzurufen, rufen Sie ein SES Amazon-Client-Service-Objekt auf und übergeben die Parameter.
Anmerkung
In diesem Beispiel werden die erforderlichen AWS Service V3-Paketclients und V3-Befehle importiert und verwendet und die send
Methode in einem Async/Await-Muster verwendet. Sie können dieses Beispiel stattdessen mit V2-Befehlen erstellen, indem Sie einige geringfügige Änderungen vornehmen. Details hierzu finden Sie unter Verwenden von v3-Befehlen.
Anmerkung
Ersetzen REGION
mit deiner AWS Region, USER
mit dem Namen und der E-Mail-Adresse, an die die E-Mail gesendet werden soll, VERIFIED_EMAIL
mit der E-Mail-Adresse, von der die E-Mail gesendet werden soll, und TEMPLATE_NAME
mit dem Namen der Vorlage.
import { SendTemplatedEmailCommand } from "@aws-sdk/client-ses"; import { getUniqueName, postfix, } from "@aws-doc-sdk-examples/lib/utils/util-string.js"; import { sesClient } from "./libs/sesClient.js"; /** * Replace this with the name of an existing template. */ const TEMPLATE_NAME = getUniqueName("ReminderTemplate"); /** * Replace these with existing verified emails. */ const VERIFIED_EMAIL = postfix(getUniqueName("Bilbo"), "@example.com"); const USER = { firstName: "Bilbo", emailAddress: VERIFIED_EMAIL }; /** * * @param { { emailAddress: string, firstName: string } } user * @param { string } templateName - The name of an existing template in Amazon SES. * @returns { SendTemplatedEmailCommand } */ const createReminderEmailCommand = (user, templateName) => { return new SendTemplatedEmailCommand({ /** * Here's an example of how a template would be replaced with user data: * Template: <h1>Hello {{contact.firstName}},</h1><p>Don't forget about the party gifts!</p> * Destination: <h1>Hello Bilbo,</h1><p>Don't forget about the party gifts!</p> */ Destination: { ToAddresses: [user.emailAddress] }, TemplateData: JSON.stringify({ contact: { firstName: user.firstName } }), Source: VERIFIED_EMAIL, Template: templateName, }); }; const run = async () => { const sendReminderEmailCommand = createReminderEmailCommand( USER, TEMPLATE_NAME, ); try { return await sesClient.send(sendReminderEmailCommand); } catch (caught) { if (caught instanceof Error && caught.name === "MessageRejected") { /** @type { import('@aws-sdk/client-ses').MessageRejected} */ const messageRejectedError = caught; return messageRejectedError; } throw caught; } };
Um das Beispiel auszuführen, geben Sie in der Befehlszeile Folgendes ein. Die E-Mail befindet sich in der Warteschlange für den Versand durch AmazonSES.
node ses_sendtemplatedemail.js
Diesen Beispielcode finden Sie hier auf GitHub.
Senden von Massen-E-Mails mithilfe einer Vorlage
Verwenden Sie in diesem Beispiel ein Modul Node.js, um E-Mails mit Amazon zu sendenSES.
Erstellen Sie ein libs
Verzeichnis und ein Modul Node.js mit dem DateinamensesClient.js
. Kopieren Sie den folgenden Code und fügen Sie ihn ein, wodurch das SES Amazon-Client-Objekt erstellt wird. Ersetzen REGION
mit Ihrer AWS Region.
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 };
Diesen Beispielcode finden Sie hier auf GitHub
Erstellen Sie ein Node.js-Modul mit dem Dateinamen ses_sendbulktemplatedemail.js
. Konfigurieren Sie das SDK wie zuvor gezeigt, einschließlich der Installation der erforderlichen Clients und Pakete.
Erstellen Sie ein Objekt, um die Parameterwerte, die die zu sendende E-Mail definieren, einschließlich Absender- und Empfängeradressen, Betreff und E-Mail-Text in Klartext und HTML Formaten, an die SendBulkTemplatedEmailCommand
Methode der SES
Client-Klasse zu übergeben. Um die SendBulkTemplatedEmailCommand
Methode aufzurufen, rufen Sie ein SES Amazon-Serviceobjekt auf und übergeben die Parameter.
Anmerkung
In diesem Beispiel werden die erforderlichen AWS Service V3-Paketclients und V3-Befehle importiert und verwendet und die send
Methode in einem Async/Await-Muster verwendet. Sie können dieses Beispiel stattdessen mit V2-Befehlen erstellen, indem Sie einige geringfügige Änderungen vornehmen. Details hierzu finden Sie unter Verwenden von v3-Befehlen.
Anmerkung
Ersetzen USERS
mit den Namen und E-Mail-Adressen, an die die E-Mail gesendet werden soll, VERIFIED_EMAIL_1
mit der E-Mail-Adresse, von der die E-Mail gesendet werden soll, und TEMPLATE_NAME
mit dem Namen der Vorlage.
import { SendBulkTemplatedEmailCommand } from "@aws-sdk/client-ses"; import { getUniqueName, postfix, } from "@aws-doc-sdk-examples/lib/utils/util-string.js"; import { sesClient } from "./libs/sesClient.js"; /** * Replace this with the name of an existing template. */ const TEMPLATE_NAME = getUniqueName("ReminderTemplate"); /** * Replace these with existing verified emails. */ const VERIFIED_EMAIL_1 = postfix(getUniqueName("Bilbo"), "@example.com"); const VERIFIED_EMAIL_2 = postfix(getUniqueName("Frodo"), "@example.com"); const USERS = [ { firstName: "Bilbo", emailAddress: VERIFIED_EMAIL_1 }, { firstName: "Frodo", emailAddress: VERIFIED_EMAIL_2 }, ]; /** * * @param { { emailAddress: string, firstName: string }[] } users * @param { string } templateName the name of an existing template in SES * @returns { SendBulkTemplatedEmailCommand } */ const createBulkReminderEmailCommand = (users, templateName) => { return new SendBulkTemplatedEmailCommand({ /** * Each 'Destination' uses a corresponding set of replacement data. We can map each user * to a 'Destination' and provide user specific replacement data to create personalized emails. * * Here's an example of how a template would be replaced with user data: * Template: <h1>Hello {{name}},</h1><p>Don't forget about the party gifts!</p> * Destination 1: <h1>Hello Bilbo,</h1><p>Don't forget about the party gifts!</p> * Destination 2: <h1>Hello Frodo,</h1><p>Don't forget about the party gifts!</p> */ Destinations: users.map((user) => ({ Destination: { ToAddresses: [user.emailAddress] }, ReplacementTemplateData: JSON.stringify({ name: user.firstName }), })), DefaultTemplateData: JSON.stringify({ name: "Shireling" }), Source: VERIFIED_EMAIL_1, Template: templateName, }); }; const run = async () => { const sendBulkTemplateEmailCommand = createBulkReminderEmailCommand( USERS, TEMPLATE_NAME, ); try { return await sesClient.send(sendBulkTemplateEmailCommand); } catch (caught) { if (caught instanceof Error && caught.name === "MessageRejected") { /** @type { import('@aws-sdk/client-ses').MessageRejected} */ const messageRejectedError = caught; return messageRejectedError; } throw caught; } };
Um das Beispiel auszuführen, geben Sie in der Befehlszeile Folgendes ein. Die E-Mail befindet sich in der Warteschlange für den Versand durch AmazonSES.
node ses_sendbulktemplatedemail.js
Diesen Beispielcode finden Sie hier auf GitHub.