de.sebastianhesse.cdk.ses.email.forwarding

Interface IEmailForwardingProps.Jsii$Default

All Superinterfaces:

IEmailForwardingProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IEmailForwardingProps.Jsii$Proxy

Enclosing interface:

IEmailForwardingProps

@Internal
public static interface IEmailForwardingProps.Jsii$Default
extends IEmailForwardingProps

Internal default implementation for IEmailForwardingProps.

Nested Class Summary

Nested classes/interfaces inherited from interface de.sebastianhesse.cdk.ses.email.forwarding.IEmailForwardingProps

IEmailForwardingProps.Jsii$Default, IEmailForwardingProps.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
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.
default String	getDomainName() The domain name for which you want to receive emails using SES, e.g.
default List<IEmailMapping>	getEmailMappings() A list of email mappings to define the receive email address and target email addresses to which the emails are forwarded to.
default 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(value=Stable)
 @NotNull
default String getDomainName()

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

Specified by:

getDomainName in interface IEmailForwardingProps

getEmailMappings

@Stability(value=Stable)
 @NotNull
default List<IEmailMapping> getEmailMappings()

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

Specified by:

getEmailMappings in interface IEmailForwardingProps

See Also:

IEmailMapping

getFromPrefix

@Stability(value=Stable)
 @NotNull
default String getFromPrefix()

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

Specified by:

getFromPrefix in interface IEmailForwardingProps

getBucket

@Stability(value=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.

Specified by:

getBucket in interface IEmailForwardingProps

getBucketPrefix

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

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

Default: inbox/

Specified by:

getBucketPrefix in interface IEmailForwardingProps

getNotificationTopic

@Stability(value=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.

Specified by:

getNotificationTopic in interface IEmailForwardingProps

getNotificationTypes

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

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

Default: ['Bounce', 'Complaint']

Specified by:

getNotificationTypes in interface IEmailForwardingProps

getVerifyDomain

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

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

Default: false

Specified by:

getVerifyDomain in interface IEmailForwardingProps

getVerifyTargetEmailAddresses

@Stability(value=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

Specified by:

getVerifyTargetEmailAddresses in interface IEmailForwardingProps