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

Interface EmailMapping

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EmailMapping.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EmailMapping.Builder	builder()
default String	getReceiveEmail()	You can define a string that is matching an email address, e.g.
default String	getReceivePrefix()	A short way to match a specific email addresses by only providing a prefix, e.g.
List<String>	getTargetEmails()	A list of target email addresses that should receive the forwarded emails for the given email addresses matched by either `receiveEmail` or `receivePrefix`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTargetEmails

@Stability(Stable)
@NotNull
List<String> getTargetEmails()

A list of target email addresses that should receive the forwarded emails for the given email addresses matched by either `receiveEmail` or `receivePrefix`.

Make sure that you only specify email addresses that are verified by SES. Otherwise SES won't send them out.

Example: ['foobar@gmail.com', 'foo+bar@gmail.com', 'whatever@example.org']

getReceiveEmail

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

You can define a string that is matching an email address, e.g. `hello@example.org`.

If this property is defined, the receivePrefix will be ignored. You must define either this property or receivePrefix, otherwise no emails will be forwarded.

getReceivePrefix

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

A short way to match a specific email addresses by only providing a prefix, e.g. `hello`. The prefix will be combined with the given domain name from EmailForwardingRuleProps. If an email was sent to this specific email address, all emails matching this receiver will be forwarded to all email addresses defined in `targetEmails`.

If receiveEmail property is defined as well, then receiveEmail is preferred. Hence, only define one of them.

builder

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

Returns:

a EmailMapping.Builder of EmailMapping