@aws-sdk/client-sesv2
Advanced tools
AWS SDK for JavaScript Sesv2 Client for Node.js, Browser and React Native
@aws-sdk/client-sesv2 is an AWS SDK for JavaScript package that allows you to interact with the Amazon Simple Email Service (SES) v2. It provides a range of functionalities for sending emails, managing email templates, handling email identities, and more.
Send Email
This feature allows you to send an email using Amazon SES. The code sample demonstrates how to create a client, construct a SendEmailCommand, and send an email.
{"import":"import { SESv2Client, SendEmailCommand } from '@aws-sdk/client-sesv2';","client":"const client = new SESv2Client({ region: 'us-east-1' });","command":"const command = new SendEmailCommand({\n Destination: {\n ToAddresses: ['recipient@example.com'],\n },\n Content: {\n Simple: {\n Subject: { Data: 'Test Email' },\n Body: { Text: { Data: 'This is a test email.' } },\n },\n },\n FromEmailAddress: 'sender@example.com',\n});","send":"const response = await client.send(command);\nconsole.log(response);"}Create Email Template
This feature allows you to create an email template in Amazon SES. The code sample demonstrates how to create a client, construct a CreateEmailTemplateCommand, and create a template.
{"import":"import { SESv2Client, CreateEmailTemplateCommand } from '@aws-sdk/client-sesv2';","client":"const client = new SESv2Client({ region: 'us-east-1' });","command":"const command = new CreateEmailTemplateCommand({\n TemplateName: 'MyTemplate',\n TemplateContent: {\n Subject: 'Hello, {{name}}',\n Html: '<h1>Hello, {{name}}</h1>',\n Text: 'Hello, {{name}}',\n },\n});","send":"const response = await client.send(command);\nconsole.log(response);"}List Email Identities
This feature allows you to list all email identities in your Amazon SES account. The code sample demonstrates how to create a client, construct a ListEmailIdentitiesCommand, and list email identities.
{"import":"import { SESv2Client, ListEmailIdentitiesCommand } from '@aws-sdk/client-sesv2';","client":"const client = new SESv2Client({ region: 'us-east-1' });","command":"const command = new ListEmailIdentitiesCommand({});","send":"const response = await client.send(command);\nconsole.log(response);"}Nodemailer is a module for Node.js applications to allow easy email sending. It is not tied to any specific email service and can be used with various SMTP servers. Compared to @aws-sdk/client-sesv2, Nodemailer is more flexible in terms of email service providers but does not offer the same level of integration with AWS services.
SendGrid is a cloud-based service that provides email delivery and marketing campaigns. The @sendgrid/mail package allows you to send emails using SendGrid's API. Compared to @aws-sdk/client-sesv2, SendGrid offers additional features like email analytics and marketing tools but requires a separate SendGrid account.
Mailgun is an email automation service that provides a powerful API for sending, receiving, and tracking emails. The mailgun-js package allows you to interact with Mailgun's API. Compared to @aws-sdk/client-sesv2, Mailgun offers advanced email tracking and analytics but requires a Mailgun account.
AWS SDK for JavaScript SESv2 Client for Node.js, Browser and React Native.
Amazon SES API v2
Amazon SES is an Amazon Web Services service that you can use to send email messages to your customers.
If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer Guide. The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.
To install this package, simply type add or install @aws-sdk/client-sesv2 using your favorite package manager:
npm install @aws-sdk/client-sesv2yarn add @aws-sdk/client-sesv2pnpm add @aws-sdk/client-sesv2The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SESv2Client and
the commands you need, for example ListContactListsCommand:
// ES5 example
const { SESv2Client, ListContactListsCommand } = require("@aws-sdk/client-sesv2");
// ES6+ example
import { SESv2Client, ListContactListsCommand } from "@aws-sdk/client-sesv2";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new SESv2Client({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListContactListsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-sesv2";
const client = new AWS.SESv2({ region: "REGION" });
// async/await.
try {
const data = await client.listContactLists(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listContactLists(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listContactLists(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-sesv2 package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.693.0 (2024-11-15)
FAQs
AWS SDK for JavaScript Sesv2 Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-sesv2 receives a total of 180,798 weekly downloads. As such, @aws-sdk/client-sesv2 popularity was classified as popular.
We found that @aws-sdk/client-sesv2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.