@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.

This documentation contains reference information related to the following:

• Amazon SES API Actions

• Amazon SES API Data Types

• Common Parameters

• Common Errors

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 ListIdentitiesCommand:

// ES5 example
const { SESClient, ListIdentitiesCommand } = require("@aws-sdk/client-ses");

// ES6+ example
import { SESClient, ListIdentitiesCommand } 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.

// a client can be shared by different commands.
const client = new SESClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListIdentitiesCommand(params);

Async/await

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.

Promises

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.
  });

Callbacks

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.
});

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" });

// async/await.
try {
  const data = await client.listIdentities(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listIdentities(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listIdentities(params, (err, data) => {
  // process err and 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);
  // 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;
   * }
   */
}

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.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

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.

Client Commands (Operations List)

CloneReceiptRuleSet

Command API Reference / Input / Output

CreateConfigurationSet

Command API Reference / Input / Output

CreateConfigurationSetEventDestination

Command API Reference / Input / Output

CreateConfigurationSetTrackingOptions

Command API Reference / Input / Output

CreateCustomVerificationEmailTemplate

Command API Reference / Input / Output

CreateReceiptFilter

Command API Reference / Input / Output

CreateReceiptRule

Command API Reference / Input / Output

CreateReceiptRuleSet

Command API Reference / Input / Output

CreateTemplate

Command API Reference / Input / Output

DeleteConfigurationSet

Command API Reference / Input / Output

DeleteConfigurationSetEventDestination

Command API Reference / Input / Output

DeleteConfigurationSetTrackingOptions

Command API Reference / Input / Output

DeleteCustomVerificationEmailTemplate

Command API Reference / Input / Output

DeleteIdentity

Command API Reference / Input / Output

DeleteIdentityPolicy

Command API Reference / Input / Output

DeleteReceiptFilter

Command API Reference / Input / Output

DeleteReceiptRule

Command API Reference / Input / Output

DeleteReceiptRuleSet

Command API Reference / Input / Output

DeleteTemplate

Command API Reference / Input / Output

DeleteVerifiedEmailAddress

Command API Reference / Input / Output

DescribeActiveReceiptRuleSet

Command API Reference / Input / Output

DescribeConfigurationSet

Command API Reference / Input / Output

DescribeReceiptRule

Command API Reference / Input / Output

DescribeReceiptRuleSet

Command API Reference / Input / Output

GetAccountSendingEnabled

Command API Reference / Input / Output

GetCustomVerificationEmailTemplate

Command API Reference / Input / Output

GetIdentityDkimAttributes

Command API Reference / Input / Output

GetIdentityMailFromDomainAttributes

Command API Reference / Input / Output

GetIdentityNotificationAttributes

Command API Reference / Input / Output

GetIdentityPolicies

Command API Reference / Input / Output

GetIdentityVerificationAttributes

Command API Reference / Input / Output

GetSendQuota

Command API Reference / Input / Output

GetSendStatistics

Command API Reference / Input / Output

GetTemplate

Command API Reference / Input / Output

ListConfigurationSets

Command API Reference / Input / Output

ListCustomVerificationEmailTemplates

Command API Reference / Input / Output

ListIdentities

Command API Reference / Input / Output

ListIdentityPolicies

Command API Reference / Input / Output

ListReceiptFilters

Command API Reference / Input / Output

ListReceiptRuleSets

Command API Reference / Input / Output

ListTemplates

Command API Reference / Input / Output

ListVerifiedEmailAddresses

Command API Reference / Input / Output

PutConfigurationSetDeliveryOptions

Command API Reference / Input / Output

PutIdentityPolicy

Command API Reference / Input / Output

ReorderReceiptRuleSet

Command API Reference / Input / Output

SendBounce

Command API Reference / Input / Output

SendBulkTemplatedEmail

Command API Reference / Input / Output

SendCustomVerificationEmail

Command API Reference / Input / Output

SendEmail

Command API Reference / Input / Output

SendRawEmail

Command API Reference / Input / Output

SendTemplatedEmail

Command API Reference / Input / Output

SetActiveReceiptRuleSet

Command API Reference / Input / Output

SetIdentityDkimEnabled

Command API Reference / Input / Output

SetIdentityFeedbackForwardingEnabled

Command API Reference / Input / Output

SetIdentityHeadersInNotificationsEnabled

Command API Reference / Input / Output

SetIdentityMailFromDomain

Command API Reference / Input / Output

SetIdentityNotificationTopic

Command API Reference / Input / Output

SetReceiptRulePosition

Command API Reference / Input / Output

TestRenderTemplate

Command API Reference / Input / Output

UpdateAccountSendingEnabled

Command API Reference / Input / Output

UpdateConfigurationSetEventDestination

Command API Reference / Input / Output

UpdateConfigurationSetReputationMetricsEnabled

Command API Reference / Input / Output

UpdateConfigurationSetSendingEnabled

Command API Reference / Input / Output

UpdateConfigurationSetTrackingOptions

Command API Reference / Input / Output

UpdateCustomVerificationEmailTemplate

Command API Reference / Input / Output

UpdateReceiptRule

Command API Reference / Input / Output

UpdateTemplate

Command API Reference / Input / Output

VerifyDomainDkim

Command API Reference / Input / Output

VerifyDomainIdentity

Command API Reference / Input / Output

VerifyEmailAddress

Command API Reference / Input / Output

VerifyEmailIdentity

Command API Reference / Input / Output