SendBulkEmailRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.sesv2.model.SesV2Request
    - - software.amazon.awssdk.services.sesv2.model.SendBulkEmailRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SendBulkEmailRequest.Builder,SendBulkEmailRequest>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class SendBulkEmailRequest
extends SesV2Request
implements ToCopyableBuilder<SendBulkEmailRequest.Builder,SendBulkEmailRequest>
```
Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SendBulkEmailRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SendBulkEmailRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SendBulkEmailRequest.Builder`	`builder()`
`List<BulkEmailEntry>`	`bulkEmailEntries()` The list of bulk email entry objects.
`String`	`configurationSetName()` The name of the configuration set to use when sending the email.
`BulkEmailContent`	`defaultContent()` An object that contains the body of the message.
`List<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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`feedbackForwardingEmailAddress()` The address that you want bounce and complaint notifications to be sent to.
`String`	`feedbackForwardingEmailAddressIdentityArn()` This parameter is used only for sending authorization.
`String`	`fromEmailAddress()` The email address to use as the "From" address for the email.
`String`	`fromEmailAddressIdentityArn()` This parameter is used only for sending authorization.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBulkEmailEntries()` For responses, this returns true if the service returned a value for the BulkEmailEntries property.
`boolean`	`hasDefaultEmailTags()` For responses, this returns true if the service returned a value for the DefaultEmailTags property.
`int`	`hashCode()`
`boolean`	`hasReplyToAddresses()` For responses, this returns true if the service returned a value for the ReplyToAddresses property.
`List<String>`	`replyToAddresses()` The "Reply-to" email addresses for the message.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SendBulkEmailRequest.Builder>`	`serializableBuilderClass()`
`SendBulkEmailRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - fromEmailAddress
```
public final String fromEmailAddress()
```
    The email address to use as the "From" address for the email. The address that you specify has to be verified.
    
    Returns:
    
    The email address to use as the "From" address for the email. The address that you specify has to be verified.
  - fromEmailAddressIdentityArn
```
public final 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 [email protected], then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be [email protected].
    
    For more information about sending authorization, see the Amazon SES Developer Guide.
    
    Returns:
    
    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 [email protected], then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be [email protected].
    
    For more information about sending authorization, see the Amazon SES Developer Guide.
  - hasReplyToAddresses
```
public final boolean hasReplyToAddresses()
```
    For responses, this returns true if the service returned a value for the ReplyToAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - replyToAddresses
```
public final List<String> replyToAddresses()
```
    The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReplyToAddresses() method.
    
    Returns:
    
    The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
  - feedbackForwardingEmailAddress
```
public final String feedbackForwardingEmailAddress()
```
    The address that you want bounce and complaint notifications to be sent to.
    
    Returns:
    
    The address that you want bounce and complaint notifications to be sent to.
  - feedbackForwardingEmailAddressIdentityArn
```
public final 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 [email protected], then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be [email protected].
    
    For more information about sending authorization, see the Amazon SES Developer Guide.
    
    Returns:
    
    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 [email protected], then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be [email protected].
    
    For more information about sending authorization, see the Amazon SES Developer Guide.
  - hasDefaultEmailTags
```
public final boolean hasDefaultEmailTags()
```
    For responses, this returns true if the service returned a value for the DefaultEmailTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - defaultEmailTags
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDefaultEmailTags() method.
    
    Returns:
    
    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.
  - defaultContent
```
public final BulkEmailContent defaultContent()
```
    An object that contains the body of the message. You can specify a template message.
    
    Returns:
    
    An object that contains the body of the message. You can specify a template message.
  - hasBulkEmailEntries
```
public final boolean hasBulkEmailEntries()
```
    For responses, this returns true if the service returned a value for the BulkEmailEntries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - bulkEmailEntries
```
public final List<BulkEmailEntry> bulkEmailEntries()
```
    The list of bulk email entry objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBulkEmailEntries() method.
    
    Returns:
    
    The list of bulk email entry objects.
  - configurationSetName
```
public final String configurationSetName()
```
    The name of the configuration set to use when sending the email.
    
    Returns:
    
    The name of the configuration set to use when sending the email.
  - toBuilder
```
public SendBulkEmailRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SendBulkEmailRequest.Builder,SendBulkEmailRequest>
    
    Specified by:
    
    toBuilder in class SesV2Request
  - builder
```
public static SendBulkEmailRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SendBulkEmailRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SendBulkEmailRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

fromEmailAddress

fromEmailAddressIdentityArn

hasReplyToAddresses

replyToAddresses

feedbackForwardingEmailAddress

feedbackForwardingEmailAddressIdentityArn

hasDefaultEmailTags

defaultEmailTags

defaultContent

hasBulkEmailEntries

bulkEmailEntries

configurationSetName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields