What is @aws-sdk/client-ses?
@aws-sdk/client-ses is an AWS SDK for JavaScript package that allows you to interact with the Amazon Simple Email Service (SES). SES is a cloud-based email sending service designed to help digital marketers and application developers send marketing, notification, and transactional emails. The package provides a variety of functionalities to manage email sending, email receiving, and email analytics.
What are @aws-sdk/client-ses's main functionalities?
Send Email
This feature allows you to send an email using Amazon SES. The code sample demonstrates how to configure the SES client, set up the email parameters, and send the email.
const { SESClient, SendEmailCommand } = require('@aws-sdk/client-ses');
const client = new SESClient({ region: 'us-east-1' });
const params = {
Destination: {
ToAddresses: ['recipient@example.com'],
},
Message: {
Body: {
Text: { Data: 'Hello, this is a test email.' },
},
Subject: { Data: 'Test Email' },
},
Source: 'sender@example.com',
};
const run = async () => {
try {
const data = await client.send(new SendEmailCommand(params));
console.log('Email sent successfully:', data);
} catch (err) {
console.error('Error sending email:', err);
}
};
run();
Verify Email Identity
This feature allows you to verify an email address with Amazon SES. The code sample demonstrates how to initiate the email verification process.
const { SESClient, VerifyEmailIdentityCommand } = require('@aws-sdk/client-ses');
const client = new SESClient({ region: 'us-east-1' });
const params = {
EmailAddress: 'user@example.com',
};
const run = async () => {
try {
const data = await client.send(new VerifyEmailIdentityCommand(params));
console.log('Email identity verification initiated:', data);
} catch (err) {
console.error('Error verifying email identity:', err);
}
};
run();
List Verified Email Addresses
This feature allows you to list all email addresses that have been verified with Amazon SES. The code sample demonstrates how to retrieve and display the list of verified email addresses.
const { SESClient, ListVerifiedEmailAddressesCommand } = require('@aws-sdk/client-ses');
const client = new SESClient({ region: 'us-east-1' });
const run = async () => {
try {
const data = await client.send(new ListVerifiedEmailAddressesCommand({}));
console.log('Verified email addresses:', data.VerifiedEmailAddresses);
} catch (err) {
console.error('Error listing verified email addresses:', err);
}
};
run();
Other packages similar to @aws-sdk/client-ses
nodemailer
Nodemailer is a module for Node.js applications to allow easy email sending. It supports various transport methods, including SMTP, and is highly configurable. Compared to @aws-sdk/client-ses, Nodemailer is more general-purpose and can be used with any email service provider, not just Amazon SES.
sendgrid
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-ses, SendGrid offers additional features like email templates, analytics, and marketing campaign management.
mailgun-js
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-ses, Mailgun offers advanced email analytics and a more extensive set of email management features.
@aws-sdk/client-ses
Description
AWS SDK for JavaScript SES Client for Node.js, Browser and React Native.
Amazon Simple Email Service
This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version
2010-12-01. This document is best used in conjunction with the Amazon SES Developer
Guide.
For a list of Amazon SES endpoints to use in service requests, see Regions and
Amazon SES in the Amazon SES Developer
Guide.
Installing
To install the this package, simply type add or install @aws-sdk/client-ses
using your favorite package manager:
npm install @aws-sdk/client-ses
yarn add @aws-sdk/client-ses
pnpm add @aws-sdk/client-ses
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SESClient
and
the commands you need, for example CloneReceiptRuleSetCommand
:
const { SESClient, CloneReceiptRuleSetCommand } = require("@aws-sdk/client-ses");
import { SESClient, CloneReceiptRuleSetCommand } from "@aws-sdk/client-ses";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new SESClient({ region: "REGION" });
const params = {
};
const command = new CloneReceiptRuleSetCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
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-ses";
const client = new AWS.SES({ region: "REGION" });
try {
const data = await client.cloneReceiptRuleSet(params);
} catch (error) {
}
client
.cloneReceiptRuleSet(params)
.then((data) => {
})
.catch((error) => {
});
client.cloneReceiptRuleSet(params, (err, data) => {
});
Troubleshooting
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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
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.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-ses
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.