software.amazon.awscdk.services.ses

Interface ReceiptRuleOptions

All Known Subinterfaces:

DropSpamReceiptRuleProps, ReceiptRuleProps

All Known Implementing Classes:

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

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:16.330Z")
public interface ReceiptRuleOptions

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 java.util.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 java.lang.Boolean	getEnabled() Whether the rule is active.
default java.lang.String	getReceiptRuleName() The name for the rule.
default java.util.List<java.lang.String>	getRecipients() The recipient domains and email addresses that the receipt rule applies to.
default java.lang.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).

Method Detail

getActions

default java.util.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

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

default java.lang.Boolean getEnabled()

Whether the rule is active.

Default: true

getReceiptRuleName

default java.lang.String getReceiptRuleName()

The name for the rule.

Default: - A CloudFormation generated name.

getRecipients

default java.util.List<java.lang.String> getRecipients()

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

Default: - Match all recipients under all verified domains.

getScanEnabled

default java.lang.Boolean getScanEnabled()

Whether to scan for spam and viruses.

Default: false

getTlsPolicy

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

static ReceiptRuleOptions.Builder builder()

Returns:

a ReceiptRuleOptions.Builder of ReceiptRuleOptions