Package software.amazon.awscdk.services.ses

Interface BounceActionConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BounceActionConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.010Z")
@Stability(Stable)
public interface BounceActionConfig
extends software.amazon.jsii.JsiiSerializable

BoundAction configuration.

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.*;
 BounceActionConfig bounceActionConfig = BounceActionConfig.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	BounceActionConfig.Builder	A builder for BounceActionConfig
static final class	BounceActionConfig.Jsii$Proxy	An implementation for BounceActionConfig

Method Summary

Modifier and Type	Method	Description
static BounceActionConfig.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 that the bounce message is sent from.

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.

Default: - No status code.

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.

Default: - No notification is sent to SNS.

builder

@Stability(Stable)
static BounceActionConfig.Builder builder()

Returns:

a BounceActionConfig.Builder of BounceActionConfig