interface ReceiptRuleOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SES.ReceiptRuleOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsses#ReceiptRuleOptions |
![]() | software.amazon.awscdk.services.ses.ReceiptRuleOptions |
![]() | aws_cdk.aws_ses.ReceiptRuleOptions |
![]() | aws-cdk-lib » aws_ses » ReceiptRuleOptions |
Options to add a receipt rule to a receipt rule set.
Example
const ruleSet = new ses.ReceiptRuleSet(this, 'RuleSet');
const awsRule = ruleSet.addRule('Aws', {
recipients: ['aws.com'],
});
Properties
Name | Type | Description |
---|---|---|
actions? | IReceipt [] | An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule. |
after? | IReceipt | An existing rule after which the new rule will be placed. |
enabled? | boolean | Whether the rule is active. |
receipt | string | The name for the rule. |
recipients? | string[] | The recipient domains and email addresses that the receipt rule applies to. |
scan | boolean | Whether to scan for spam and viruses. |
tls | Tls | Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). |
actions?
Type:
IReceipt
[]
(optional, default: No actions.)
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
after?
Type:
IReceipt
(optional, default: The new rule is inserted at the beginning of the rule list.)
An existing rule after which the new rule will be placed.
enabled?
Type:
boolean
(optional, default: true)
Whether the rule is active.
receiptRuleName?
Type:
string
(optional, default: A CloudFormation generated name.)
The name for the rule.
recipients?
Type:
string[]
(optional, default: Match all recipients under all verified domains.)
The recipient domains and email addresses that the receipt rule applies to.
scanEnabled?
Type:
boolean
(optional, default: false)
Whether to scan for spam and viruses.
tlsPolicy?
Type:
Tls
(optional, default: Optional which will not check for TLS.)
Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).