Interface SendBulkEmailRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SendBulkEmailRequest.Builder,SendBulkEmailRequest>, SdkBuilder<SendBulkEmailRequest.Builder,SendBulkEmailRequest>, SdkPojo, SdkRequest.Builder, SesV2Request.Builder
Enclosing class:
SendBulkEmailRequest
@Mutable @NotThreadSafe public static interface SendBulkEmailRequest.Builder extends SesV2Request.Builder, SdkPojo, CopyableBuilder<SendBulkEmailRequest.Builder,SendBulkEmailRequest>

  • Method Details

    • fromEmailAddress

      SendBulkEmailRequest.Builder fromEmailAddress(String 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

      SendBulkEmailRequest.Builder fromEmailAddressIdentityArn(String 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 the FromEmailAddress 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 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 the FromEmailAddress 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

      SendBulkEmailRequest.Builder replyToAddresses(Collection<String> 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

      SendBulkEmailRequest.Builder replyToAddresses(String... 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

      SendBulkEmailRequest.Builder feedbackForwardingEmailAddress(String 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 the FeedbackForwardingEmailAddress 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 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 the FeedbackForwardingEmailAddress 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

      SendBulkEmailRequest.Builder defaultEmailTags(Collection<MessageTag> 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 the SendEmail 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

      SendBulkEmailRequest.Builder defaultEmailTags(MessageTag... 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 the SendEmail 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

      SendBulkEmailRequest.Builder 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 the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultEmailTags(List<MessageTag>).

      Parameters:
      defaultEmailTags - a consumer that will call methods on MessageTag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultContent

      SendBulkEmailRequest.Builder defaultContent(BulkEmailContent 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 the BulkEmailContent.Builder avoiding the need to create one manually via BulkEmailContent.builder().

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

      Parameters:
      defaultContent - a consumer that will call methods on BulkEmailContent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bulkEmailEntries

      SendBulkEmailRequest.Builder bulkEmailEntries(Collection<BulkEmailEntry> 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

      SendBulkEmailRequest.Builder bulkEmailEntries(BulkEmailEntry... 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

      SendBulkEmailRequest.Builder bulkEmailEntries(Consumer<BulkEmailEntry.Builder>... bulkEmailEntries)

      The list of bulk email entry objects.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bulkEmailEntries(List<BulkEmailEntry>).

      Parameters:
      bulkEmailEntries - a consumer that will call methods on BulkEmailEntry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • configurationSetName

      SendBulkEmailRequest.Builder configurationSetName(String 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.

    • endpointId

      SendBulkEmailRequest.Builder endpointId(String endpointId)

      The ID of the multi-region endpoint (global-endpoint).

      Parameters:
      endpointId - The ID of the multi-region endpoint (global-endpoint).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tenantName

      SendBulkEmailRequest.Builder tenantName(String tenantName)

      The name of the tenant through which this bulk email will be sent.

      The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.

      Parameters:
      tenantName - The name of the tenant through which this bulk email will be sent.

      The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.

      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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.