Package 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.97.0 (build 729de35)", date="2024-04-18T17:54:24.987Z") @Stability(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());

  • Method Details

    • getActions

      @Stability(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(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(Stable) @Nullable default Boolean getEnabled()
      Whether the rule is active.

      Default: true

    • getReceiptRuleName

      @Stability(Stable) @Nullable default String getReceiptRuleName()
      The name for the rule.

      Default: - A CloudFormation generated name.

    • getRecipients

      @Stability(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(Stable) @Nullable default Boolean getScanEnabled()
      Whether to scan for spam and viruses.

      Default: false

    • getTlsPolicy

      @Stability(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(Stable) static ReceiptRuleOptions.Builder builder()
      Returns:
      a ReceiptRuleOptions.Builder of ReceiptRuleOptions