Interface CfnReceiptRule.BounceActionProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnReceiptRule.BounceActionProperty extends
When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 BounceActionProperty bounceActionProperty = BounceActionProperty.builder()
         // the properties below are optional
  • Method Details

    • getMessage

      @Stability(Stable) @NotNull String getMessage()
      Human-readable text to include in the bounce message.
    • getSender

      @Stability(Stable) @NotNull String getSender()
      The email address of the sender of the bounced email.

      This is the address from which the bounce message is sent.

    • getSmtpReplyCode

      @Stability(Stable) @NotNull String getSmtpReplyCode()
      The SMTP reply code, as defined by RFC 5321 .
    • getStatusCode

      @Stability(Stable) @Nullable default String getStatusCode()
      The SMTP enhanced status code, as defined by RFC 3463 .
    • getTopicArn

      @Stability(Stable) @Nullable default String getTopicArn()
      The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.

      You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

      For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .

    • builder

      @Stability(Stable) static CfnReceiptRule.BounceActionProperty.Builder builder()
      a CfnReceiptRule.BounceActionProperty.Builder of CfnReceiptRule.BounceActionProperty