Package software.amazon.awscdk.services.ses

Interface CfnReceiptRule.BounceActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReceiptRule.BounceActionProperty.Jsii$Proxy

Enclosing class:

CfnReceiptRule

@Stability(Stable)
public static interface CfnReceiptRule.BounceActionProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ses.*;
 BounceActionProperty bounceActionProperty = BounceActionProperty.builder()
         .message("message")
         .sender("sender")
         .smtpReplyCode("smtpReplyCode")
         // the properties below are optional
         .statusCode("statusCode")
         .topicArn("topicArn")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnReceiptRule.BounceActionProperty.Builder	builder()
String	getMessage()	Human-readable text to include in the bounce message.
String	getSender()	The email address of the sender of the bounced email.
String	getSmtpReplyCode()	The SMTP reply code, as defined by RFC 5321 .
default String	getStatusCode()	The SMTP enhanced status code, as defined by RFC 3463 .
default String	getTopicArn()	The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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()

Returns:

a CfnReceiptRule.BounceActionProperty.Builder of CfnReceiptRule.BounceActionProperty