de.sebastianhesse.cdk.ses.email.forwarding

Class EmailMapping.Builder

java.lang.Object

de.sebastianhesse.cdk.ses.email.forwarding.EmailMapping.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EmailMapping>

Enclosing interface:

EmailMapping

@Stability(value=Stable)
public static final class EmailMapping.Builder
extends Object
implements software.amazon.jsii.Builder<EmailMapping>

A builder for EmailMapping

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EmailMapping	build() Builds the configured instance.
EmailMapping.Builder	receiveEmail(String receiveEmail) Sets the value of EmailMapping.getReceiveEmail()
EmailMapping.Builder	receivePrefix(String receivePrefix) Sets the value of EmailMapping.getReceivePrefix()
EmailMapping.Builder	targetEmails(List<String> targetEmails) Sets the value of EmailMapping.getTargetEmails()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

targetEmails

@Stability(value=Stable)
public EmailMapping.Builder targetEmails(List<String> targetEmails)

Sets the value of EmailMapping.getTargetEmails()

Parameters:

targetEmails - A list of target email addresses that should receive the forwarded emails for the given email addresses matched by either `receiveEmail` or `receivePrefix`. This parameter is required. 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']

Returns:

this

receiveEmail

@Stability(value=Stable)
public EmailMapping.Builder receiveEmail(String receiveEmail)

Sets the value of EmailMapping.getReceiveEmail()

Parameters:

receiveEmail - 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.

Returns:

this

receivePrefix

@Stability(value=Stable)
public EmailMapping.Builder receivePrefix(String receivePrefix)

Sets the value of EmailMapping.getReceivePrefix()

Parameters:

receivePrefix - 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.

Returns:

this

build

@Stability(value=Stable)
public EmailMapping build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<EmailMapping>

Returns:

a new instance of EmailMapping

Throws:

NullPointerException - if any required attribute was not provided