Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class SetIdentityMailFromDomainCommandProtected

Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Example

Use a bare-bones client and the command you need to make an API call.

import { SESClient, SetIdentityMailFromDomainCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, SetIdentityMailFromDomainCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const input = { // SetIdentityMailFromDomainRequest
Identity: "STRING_VALUE", // required
MailFromDomain: "STRING_VALUE",
BehaviorOnMXFailure: "UseDefaultValue" || "RejectMessage",
};
const command = new SetIdentityMailFromDomainCommand(input);
const response = await client.send(command);
// {};

Param

SetIdentityMailFromDomainCommandInput

Returns

SetIdentityMailFromDomainCommandOutput

See

Throws

SESServiceException

Base exception class for all service exceptions from SES service.

Example

SetIdentityMailFromDomain

// The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:
const input = {
"BehaviorOnMXFailure": "UseDefaultValue",
"Identity": "user@example.com",
"MailFromDomain": "bounces.example.com"
};
const command = new SetIdentityMailFromDomainCommand(input);
await client.send(command);
// example id: setidentitymailfromdomain-1469057693908

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods