software.amazon.awscdk.services.ses

Interface ReceiptRuleOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DropSpamReceiptRuleProps, ReceiptRuleProps

All Known Implementing Classes:

DropSpamReceiptRuleProps.Jsii$Proxy, ReceiptRuleOptions.Jsii$Proxy, ReceiptRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.219Z")
 @Stability(value=Stable)
public interface ReceiptRuleOptions
extends software.amazon.jsii.JsiiSerializable

Options to add a receipt rule to a receipt rule set.

Example:

 ReceiptRuleSet ruleSet = new ReceiptRuleSet(this, "RuleSet");
 ReceiptRule awsRule = ruleSet.addRule("Aws", ReceiptRuleOptions.builder()
         .recipients(List.of("aws.com"))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReceiptRuleOptions.Builder A builder for ReceiptRuleOptions
static class	ReceiptRuleOptions.Jsii$Proxy An implementation for ReceiptRuleOptions

Method Summary

Modifier and Type	Method and Description
static ReceiptRuleOptions.Builder	builder()
default List<IReceiptRuleAction>	getActions() 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.
default IReceiptRule	getAfter() An existing rule after which the new rule will be placed.
default Boolean	getEnabled() Whether the rule is active.
default String	getReceiptRuleName() The name for the rule.
default List<String>	getRecipients() The recipient domains and email addresses that the receipt rule applies to.
default Boolean	getScanEnabled() Whether to scan for spam and viruses.
default TlsPolicy	getTlsPolicy() Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActions

@Stability(value=Stable)
 @Nullable
default List<IReceiptRuleAction> getActions()

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.

Default: - No actions.

getAfter

@Stability(value=Stable)
 @Nullable
default IReceiptRule getAfter()

An existing rule after which the new rule will be placed.

Default: - The new rule is inserted at the beginning of the rule list.

getEnabled

@Stability(value=Stable)
 @Nullable
default Boolean getEnabled()

Whether the rule is active.

Default: true

getReceiptRuleName

@Stability(value=Stable)
 @Nullable
default String getReceiptRuleName()

The name for the rule.

Default: - A CloudFormation generated name.

getRecipients

@Stability(value=Stable)
 @Nullable
default List<String> getRecipients()

The recipient domains and email addresses that the receipt rule applies to.

Default: - Match all recipients under all verified domains.

getScanEnabled

@Stability(value=Stable)
 @Nullable
default Boolean getScanEnabled()

Whether to scan for spam and viruses.

Default: false

getTlsPolicy

@Stability(value=Stable)
 @Nullable
default TlsPolicy getTlsPolicy()

Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

Default: - Optional which will not check for TLS.

builder

@Stability(value=Stable)
static ReceiptRuleOptions.Builder builder()

Returns:

a ReceiptRuleOptions.Builder of ReceiptRuleOptions