Interface SendEmailRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<SendEmailRequest.Builder,,SendEmailRequest> PinpointEmailRequest.Builder,SdkBuilder<SendEmailRequest.Builder,,SendEmailRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
SendEmailRequest
-
Method Summary
Modifier and TypeMethodDescriptionconfigurationSetName(String configurationSetName) The name of the configuration set that you want to use when sending the email.default SendEmailRequest.Buildercontent(Consumer<EmailContent.Builder> content) An object that contains the body of the message.content(EmailContent content) An object that contains the body of the message.default SendEmailRequest.Builderdestination(Consumer<Destination.Builder> destination) An object that contains the recipients of the email message.destination(Destination destination) An object that contains the recipients of the email message.emailTags(Collection<MessageTag> emailTags) A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmailoperation.emailTags(Consumer<MessageTag.Builder>... emailTags) A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmailoperation.emailTags(MessageTag... emailTags) A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmailoperation.feedbackForwardingEmailAddress(String feedbackForwardingEmailAddress) The address that Amazon Pinpoint should send bounce and complaint notifications to.fromEmailAddress(String fromEmailAddress) The email address that you want to use as the "From" address for the email.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.replyToAddresses(String... replyToAddresses) The "Reply-to" email addresses for the message.replyToAddresses(Collection<String> replyToAddresses) The "Reply-to" email addresses for the message.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.pinpointemail.model.PinpointEmailRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
fromEmailAddress
The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.
- Parameters:
fromEmailAddress- The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destination
An object that contains the recipients of the email message.
- Parameters:
destination- An object that contains the recipients of the email message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destination
An object that contains the recipients of the email message.
This is a convenience method that creates an instance of theDestination.Builderavoiding the need to create one manually viaDestination.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todestination(Destination).- Parameters:
destination- a consumer that will call methods onDestination.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
replyToAddresses
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
- Parameters:
replyToAddresses- The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replyToAddresses
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
- Parameters:
replyToAddresses- The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
feedbackForwardingEmailAddress
The address that Amazon Pinpoint should send bounce and complaint notifications to.
- Parameters:
feedbackForwardingEmailAddress- The address that Amazon Pinpoint should send bounce and complaint notifications to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
content
An object that contains the body of the message. You can send either a Simple message or a Raw message.
- Parameters:
content- An object that contains the body of the message. You can send either a Simple message or a Raw message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
content
An object that contains the body of the message. You can send either a Simple message or a Raw message.
This is a convenience method that creates an instance of theEmailContent.Builderavoiding the need to create one manually viaEmailContent.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocontent(EmailContent).- Parameters:
content- a consumer that will call methods onEmailContent.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
emailTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendEmailoperation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.- Parameters:
emailTags- A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmailoperation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emailTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendEmailoperation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.- Parameters:
emailTags- A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmailoperation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emailTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
This is a convenience method that creates an instance of theSendEmailoperation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.MessageTag.Builderavoiding the need to create one manually viaMessageTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toemailTags(List<MessageTag>).- Parameters:
emailTags- a consumer that will call methods onMessageTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
configurationSetName
The name of the configuration set that you want to use when sending the email.
- Parameters:
configurationSetName- The name of the configuration set that you want to use when sending the email.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SendEmailRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SendEmailRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-