Package de.sebastianhesse.cdk.ses.email.forwarding

Interface EmailForwardingProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EmailForwardingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.59.0 (build eb02c92)",
           date="2022-06-01T13:32:59.396Z")
@Stability(Stable)
public interface EmailForwardingProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EmailForwardingProps.Builder	builder()
default software.amazon.awscdk.services.s3.Bucket	getBucket()	Optional: an S3 bucket to store the received emails.
default String	getBucketPrefix()	Optional: a prefix for the email files that are stored on the S3 bucket.
String	getDomainName()	The domain name for which you want to receive emails using SES, e.g.
List<EmailMapping>	getEmailMappings()	A list of email mappings to define the receive email address and target email addresses to which the emails are forwarded to.
String	getFromPrefix()	A prefix that is used as the sender address of the forwarded mail, e.g.
default software.amazon.awscdk.services.sns.Topic	getNotificationTopic()	Optional: an SNS topic to receive notifications about sending events like bounces or complaints.
default List<String>	getNotificationTypes()	Optional: a list of NotificationTypes to define which sending events should be subscribed.
default Boolean	getVerifyDomain()	Optional: true if you want to verify the domain identity in SES, false otherwise.
default Boolean	getVerifyTargetEmailAddresses()	Optional: true if you want to initiate the verification of your target email addresses, false otherwise.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The domain name for which you want to receive emails using SES, e.g. `example.org`.

getEmailMappings

@Stability(Stable)
@NotNull
List<EmailMapping> getEmailMappings()

A list of email mappings to define the receive email address and target email addresses to which the emails are forwarded to.

See Also:

EmailMapping

getFromPrefix

@Stability(Stable)
@NotNull
String getFromPrefix()

A prefix that is used as the sender address of the forwarded mail, e.g. `noreply`.

getBucket

@Stability(Stable)
@Nullable
default software.amazon.awscdk.services.s3.Bucket getBucket()

Optional: an S3 bucket to store the received emails.

If none is provided, a new one will be created.

Default: A new bucket.

getBucketPrefix

@Stability(Stable)
@Nullable
default String getBucketPrefix()

Optional: a prefix for the email files that are stored on the S3 bucket.

Default: inbox/

getNotificationTopic

@Stability(Stable)
@Nullable
default software.amazon.awscdk.services.sns.Topic getNotificationTopic()

Optional: an SNS topic to receive notifications about sending events like bounces or complaints.

The events are defined by notificationTypes using {@link NotificationType}. If no topic is defined, a new one will be created.

Default: A new SNS topic.

getNotificationTypes

@Stability(Stable)
@Nullable
default List<String> getNotificationTypes()

Optional: a list of NotificationTypes to define which sending events should be subscribed.

Default: ['Bounce', 'Complaint']

getVerifyDomain

@Stability(Stable)
@Nullable
default Boolean getVerifyDomain()

Optional: true if you want to verify the domain identity in SES, false otherwise.

Default: false

getVerifyTargetEmailAddresses

@Stability(Stable)
@Nullable
default Boolean getVerifyTargetEmailAddresses()

Optional: true if you want to initiate the verification of your target email addresses, false otherwise.

If true, a verification email is sent out to all target email addresses. Then, the owner of an email address needs to verify it by clicking the link in the verification email. Please note in case you don't verify your sender domain, it's required to verify your target email addresses in order to send mails to them.

Default: false

builder

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

Returns:

a EmailForwardingProps.Builder of EmailForwardingProps