Class SendBulkEmailRequest
- 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("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 Description static interfaceSendBulkEmailRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SendBulkEmailRequest.Builderbuilder()List<BulkEmailEntry>bulkEmailEntries()The list of bulk email entry objects.StringconfigurationSetName()The name of the configuration set to use when sending the email.BulkEmailContentdefaultContent()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 theSendEmailoperation.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfeedbackForwardingEmailAddress()The address that you want bounce and complaint notifications to be sent to.StringfeedbackForwardingEmailAddressIdentityArn()This parameter is used only for sending authorization.StringfromEmailAddress()The email address to use as the "From" address for the email.StringfromEmailAddressIdentityArn()This parameter is used only for sending authorization.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasBulkEmailEntries()For responses, this returns true if the service returned a value for the BulkEmailEntries property.booleanhasDefaultEmailTags()For responses, this returns true if the service returned a value for the DefaultEmailTags property.inthashCode()booleanhasReplyToAddresses()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.BuildertoBuilder()StringtoString()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
FromEmailAddressparameter.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
FromEmailAddressIdentityArnto be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFromEmailAddressto be sender@example.com.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
FromEmailAddressparameter.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
FromEmailAddressIdentityArnto be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFromEmailAddressto be sender@example.com.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 theisEmpty()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
FeedbackForwardingEmailAddressparameter.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
FeedbackForwardingEmailAddressIdentityArnto be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFeedbackForwardingEmailAddressto be feedback@example.com.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
FeedbackForwardingEmailAddressparameter.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
FeedbackForwardingEmailAddressIdentityArnto be arn:aws:ses:us-east-1:123456789012:identity/example.com, and theFeedbackForwardingEmailAddressto be feedback@example.com.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 theisEmpty()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
SendEmailoperation. 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
SendEmailoperation. 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 theisEmpty()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:
toBuilderin interfaceToCopyableBuilder<SendBulkEmailRequest.Builder,SendBulkEmailRequest>- Specified by:
toBuilderin classSesV2Request
-
builder
public static SendBulkEmailRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends SendBulkEmailRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-