Class SendEmailRequest
- 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.SendEmailRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<SendEmailRequest.Builder,SendEmailRequest>
@Generated("software.amazon.awssdk:codegen") public final class SendEmailRequest extends SesV2Request implements ToCopyableBuilder<SendEmailRequest.Builder,SendEmailRequest>
Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSendEmailRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SendEmailRequest.Builderbuilder()StringconfigurationSetName()The name of the configuration set to use when sending the email.EmailContentcontent()An object that contains the body of the message.Destinationdestination()An object that contains the recipients of the email message.List<MessageTag>emailTags()A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmailoperation.StringendpointId()The ID of the multi-region endpoint (global-endpoint).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)booleanhasEmailTags()For responses, this returns true if the service returned a value for the EmailTags property.inthashCode()booleanhasReplyToAddresses()For responses, this returns true if the service returned a value for the ReplyToAddresses property.ListManagementOptionslistManagementOptions()An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.List<String>replyToAddresses()The "Reply-to" email addresses for the message.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends SendEmailRequest.Builder>serializableBuilderClass()SendEmailRequest.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.
For Raw emails, the
FromEmailAddressIdentityArnvalue overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.- 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.
For Raw emails, the
FromEmailAddressIdentityArnvalue overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.
-
destination
public final Destination destination()
An object that contains the recipients of the email message.
- Returns:
- An object that contains the recipients of the email message.
-
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.
-
content
public final EmailContent content()
An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.
- Returns:
- An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.
-
hasEmailTags
public final boolean hasEmailTags()
For responses, this returns true if the service returned a value for the EmailTags 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.
-
emailTags
public final List<MessageTag> 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.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
hasEmailTags()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.
-
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.
-
endpointId
public final String endpointId()
The ID of the multi-region endpoint (global-endpoint).
- Returns:
- The ID of the multi-region endpoint (global-endpoint).
-
listManagementOptions
public final ListManagementOptions listManagementOptions()
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
- Returns:
- An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
-
toBuilder
public SendEmailRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SendEmailRequest.Builder,SendEmailRequest>- Specified by:
toBuilderin classSesV2Request
-
builder
public static SendEmailRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends SendEmailRequest.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
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-