Interface SendBulkEmailRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SendBulkEmailRequest.Builder,
,SendBulkEmailRequest> SdkBuilder<SendBulkEmailRequest.Builder,
,SendBulkEmailRequest> SdkPojo
,SdkRequest.Builder
,SesV2Request.Builder
- Enclosing class:
SendBulkEmailRequest
-
Method Summary
Modifier and TypeMethodDescriptionbulkEmailEntries
(Collection<BulkEmailEntry> bulkEmailEntries) The list of bulk email entry objects.bulkEmailEntries
(Consumer<BulkEmailEntry.Builder>... bulkEmailEntries) The list of bulk email entry objects.bulkEmailEntries
(BulkEmailEntry... bulkEmailEntries) The list of bulk email entry objects.configurationSetName
(String configurationSetName) The name of the configuration set to use when sending the email.default SendBulkEmailRequest.Builder
defaultContent
(Consumer<BulkEmailContent.Builder> defaultContent) An object that contains the body of the message.defaultContent
(BulkEmailContent defaultContent) An object that contains the body of the message.defaultEmailTags
(Collection<MessageTag> defaultEmailTags) A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmail
operation.defaultEmailTags
(Consumer<MessageTag.Builder>... defaultEmailTags) A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmail
operation.defaultEmailTags
(MessageTag... defaultEmailTags) A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmail
operation.feedbackForwardingEmailAddress
(String feedbackForwardingEmailAddress) The address that you want bounce and complaint notifications to be sent to.feedbackForwardingEmailAddressIdentityArn
(String feedbackForwardingEmailAddressIdentityArn) This parameter is used only for sending authorization.fromEmailAddress
(String fromEmailAddress) The email address to use as the "From" address for the email.fromEmailAddressIdentityArn
(String fromEmailAddressIdentityArn) This parameter is used only for sending authorization.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
overrideConfiguration
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, sdkFields
Methods inherited from interface software.amazon.awssdk.services.sesv2.model.SesV2Request.Builder
build
-
Method Details
-
fromEmailAddress
The email address to use as the "From" address for the email. The address that you specify has to be verified.
- Parameters:
fromEmailAddress
- The email address 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.
-
fromEmailAddressIdentityArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the
FromEmailAddress
parameter.For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the
FromEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFromEmailAddress
to be sender@example.com.For more information about sending authorization, see the Amazon SES Developer Guide.
- Parameters:
fromEmailAddressIdentityArn
- This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in theFromEmailAddress
parameter.For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the
FromEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFromEmailAddress
to be sender@example.com.For more information about sending authorization, see the Amazon SES Developer Guide.
- 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.
-
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 you want bounce and complaint notifications to be sent to.
- Parameters:
feedbackForwardingEmailAddress
- The address that you want bounce and complaint notifications to be sent to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
feedbackForwardingEmailAddressIdentityArn
SendBulkEmailRequest.Builder feedbackForwardingEmailAddressIdentityArn(String feedbackForwardingEmailAddressIdentityArn) This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the
FeedbackForwardingEmailAddress
parameter.For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the
FeedbackForwardingEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFeedbackForwardingEmailAddress
to be feedback@example.com.For more information about sending authorization, see the Amazon SES Developer Guide.
- Parameters:
feedbackForwardingEmailAddressIdentityArn
- This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in theFeedbackForwardingEmailAddress
parameter.For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the
FeedbackForwardingEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFeedbackForwardingEmailAddress
to be feedback@example.com.For more information about sending authorization, see the Amazon SES Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultEmailTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendEmail
operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.- Parameters:
defaultEmailTags
- A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmail
operation. 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.
-
defaultEmailTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendEmail
operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.- Parameters:
defaultEmailTags
- A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmail
operation. 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.
-
defaultEmailTags
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 theSendEmail
operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.MessageTag.Builder
avoiding the need to create one manually viaMessageTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultEmailTags(List<MessageTag>)
.- Parameters:
defaultEmailTags
- 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:
-
defaultContent
An object that contains the body of the message. You can specify a template message.
- Parameters:
defaultContent
- An object that contains the body of the message. You can specify a template message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultContent
default SendBulkEmailRequest.Builder defaultContent(Consumer<BulkEmailContent.Builder> defaultContent) An object that contains the body of the message. You can specify a template message.
This is a convenience method that creates an instance of theBulkEmailContent.Builder
avoiding the need to create one manually viaBulkEmailContent.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultContent(BulkEmailContent)
.- Parameters:
defaultContent
- a consumer that will call methods onBulkEmailContent.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bulkEmailEntries
The list of bulk email entry objects.
- Parameters:
bulkEmailEntries
- The list of bulk email entry objects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bulkEmailEntries
The list of bulk email entry objects.
- Parameters:
bulkEmailEntries
- The list of bulk email entry objects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bulkEmailEntries
The list of bulk email entry objects.
This is a convenience method that creates an instance of theBulkEmailEntry.Builder
avoiding the need to create one manually viaBulkEmailEntry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobulkEmailEntries(List<BulkEmailEntry>)
.- Parameters:
bulkEmailEntries
- a consumer that will call methods onBulkEmailEntry.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 to use when sending the email.
- Parameters:
configurationSetName
- The name of the configuration set to use when sending the email.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SendBulkEmailRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SendBulkEmailRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-