v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14142312451.1 KB

Creates a receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

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

get/#Action=CreateReceiptRule

Query parameters

RuleSetNamestring required

The name of the rule set that the receipt rule will be added to.

Afterstring

The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.

Namestring required
<p>The name of the receipt rule. The name must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>
Enabledboolean

If <code>true</code>, the receipt rule is active. The default value is <code>false</code>.

TlsPolicy'Require' | 'Optional'

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to <code>Require</code>, Amazon SES will bounce emails that are not received over TLS. The default is <code>Optional</code>.

RecipientsRecipient[]

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

ScanEnabledboolean

If <code>true</code>, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is <code>false</code>.

A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

Action'CreateReceiptRule' required
Version'2010-12-01' required

Response

Success