Interface SendOutboundEmailRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<SendOutboundEmailRequest.Builder,SendOutboundEmailRequest>, SdkBuilder<SendOutboundEmailRequest.Builder,SendOutboundEmailRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SendOutboundEmailRequest

@Mutable
@NotThreadSafe
public static interface SendOutboundEmailRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<SendOutboundEmailRequest.Builder,SendOutboundEmailRequest>

Method Summary

Modifier and Type	Method	Description
default SendOutboundEmailRequest.Builder	additionalRecipients(Consumer<OutboundAdditionalRecipients.Builder> additionalRecipients)	The additional recipients address of the email in CC.
SendOutboundEmailRequest.Builder	additionalRecipients(OutboundAdditionalRecipients additionalRecipients)	The additional recipients address of the email in CC.
SendOutboundEmailRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default SendOutboundEmailRequest.Builder	destinationEmailAddress(Consumer<EmailAddressInfo.Builder> destinationEmailAddress)	The email address to send the email to.
SendOutboundEmailRequest.Builder	destinationEmailAddress(EmailAddressInfo destinationEmailAddress)	The email address to send the email to.
default SendOutboundEmailRequest.Builder	emailMessage(Consumer<OutboundEmailContent.Builder> emailMessage)	The email message body to be sent to the newly created email.
SendOutboundEmailRequest.Builder	emailMessage(OutboundEmailContent emailMessage)	The email message body to be sent to the newly created email.
default SendOutboundEmailRequest.Builder	fromEmailAddress(Consumer<EmailAddressInfo.Builder> fromEmailAddress)	The email address to be used for sending email.
SendOutboundEmailRequest.Builder	fromEmailAddress(EmailAddressInfo fromEmailAddress)	The email address to be used for sending email.
SendOutboundEmailRequest.Builder	instanceId(String instanceId)	The identifier of the Amazon Connect instance.
SendOutboundEmailRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SendOutboundEmailRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SendOutboundEmailRequest.Builder	sourceCampaign(Consumer<SourceCampaign.Builder> sourceCampaign)	A Campaign object need for Campaign traffic type.
SendOutboundEmailRequest.Builder	sourceCampaign(SourceCampaign sourceCampaign)	A Campaign object need for Campaign traffic type.
SendOutboundEmailRequest.Builder	trafficType(String trafficType)	Denotes the class of traffic.
SendOutboundEmailRequest.Builder	trafficType(TrafficType trafficType)	Denotes the class of traffic.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

instanceId

SendOutboundEmailRequest.Builder instanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

fromEmailAddress

SendOutboundEmailRequest.Builder fromEmailAddress(EmailAddressInfo fromEmailAddress)

The email address to be used for sending email.

Parameters:

fromEmailAddress - The email address to be used for sending email.

Returns:

Returns a reference to this object so that method calls can be chained together.

fromEmailAddress

default SendOutboundEmailRequest.Builder fromEmailAddress(Consumer<EmailAddressInfo.Builder> fromEmailAddress)

The email address to be used for sending email.

This is a convenience method that creates an instance of the EmailAddressInfo.Builder avoiding the need to create one manually via EmailAddressInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fromEmailAddress(EmailAddressInfo).

Parameters:

fromEmailAddress - a consumer that will call methods on EmailAddressInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• fromEmailAddress(EmailAddressInfo)

destinationEmailAddress

SendOutboundEmailRequest.Builder destinationEmailAddress(EmailAddressInfo destinationEmailAddress)

The email address to send the email to.

Parameters:

destinationEmailAddress - The email address to send the email to.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinationEmailAddress

default SendOutboundEmailRequest.Builder destinationEmailAddress(Consumer<EmailAddressInfo.Builder> destinationEmailAddress)

The email address to send the email to.

This is a convenience method that creates an instance of the EmailAddressInfo.Builder avoiding the need to create one manually via EmailAddressInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationEmailAddress(EmailAddressInfo).

Parameters:

destinationEmailAddress - a consumer that will call methods on EmailAddressInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• destinationEmailAddress(EmailAddressInfo)

additionalRecipients

SendOutboundEmailRequest.Builder additionalRecipients(OutboundAdditionalRecipients additionalRecipients)

The additional recipients address of the email in CC.

Parameters:

additionalRecipients - The additional recipients address of the email in CC.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalRecipients

default SendOutboundEmailRequest.Builder additionalRecipients(Consumer<OutboundAdditionalRecipients.Builder> additionalRecipients)

The additional recipients address of the email in CC.

This is a convenience method that creates an instance of the OutboundAdditionalRecipients.Builder avoiding the need to create one manually via OutboundAdditionalRecipients.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to additionalRecipients(OutboundAdditionalRecipients).

Parameters:

additionalRecipients - a consumer that will call methods on OutboundAdditionalRecipients.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• additionalRecipients(OutboundAdditionalRecipients)

emailMessage

SendOutboundEmailRequest.Builder emailMessage(OutboundEmailContent emailMessage)

The email message body to be sent to the newly created email.

Parameters:

emailMessage - The email message body to be sent to the newly created email.

Returns:

Returns a reference to this object so that method calls can be chained together.

emailMessage

default SendOutboundEmailRequest.Builder emailMessage(Consumer<OutboundEmailContent.Builder> emailMessage)

The email message body to be sent to the newly created email.

This is a convenience method that creates an instance of the OutboundEmailContent.Builder avoiding the need to create one manually via OutboundEmailContent.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailMessage(OutboundEmailContent).

Parameters:

emailMessage - a consumer that will call methods on OutboundEmailContent.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• emailMessage(OutboundEmailContent)

trafficType

SendOutboundEmailRequest.Builder trafficType(String trafficType)

Denotes the class of traffic.

Only the CAMPAIGN traffic type is supported.

Parameters:

trafficType - Denotes the class of traffic.

Only the CAMPAIGN traffic type is supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• TrafficType
• TrafficType

trafficType

SendOutboundEmailRequest.Builder trafficType(TrafficType trafficType)

Denotes the class of traffic.

Only the CAMPAIGN traffic type is supported.

Parameters:

trafficType - Denotes the class of traffic.

Only the CAMPAIGN traffic type is supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• TrafficType
• TrafficType

sourceCampaign

SendOutboundEmailRequest.Builder sourceCampaign(SourceCampaign sourceCampaign)

A Campaign object need for Campaign traffic type.

Parameters:

sourceCampaign - A Campaign object need for Campaign traffic type.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceCampaign

default SendOutboundEmailRequest.Builder sourceCampaign(Consumer<SourceCampaign.Builder> sourceCampaign)

A Campaign object need for Campaign traffic type.

This is a convenience method that creates an instance of the SourceCampaign.Builder avoiding the need to create one manually via SourceCampaign.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceCampaign(SourceCampaign).

Parameters:

sourceCampaign - a consumer that will call methods on SourceCampaign.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sourceCampaign(SourceCampaign)

clientToken

SendOutboundEmailRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

SendOutboundEmailRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SendOutboundEmailRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.