Class SendEmailRequest
- All Implemented Interfaces:
SdkPojo
,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
-
Method Summary
Modifier and TypeMethodDescriptionstatic SendEmailRequest.Builder
builder()
final String
The name of the configuration set to use when sending the email.final EmailContent
content()
An object that contains the body of the message.final Destination
An object that contains the recipients of the email message.final List
<MessageTag> A list of tags, in the form of name/value pairs, to apply to an email that you send using theSendEmail
operation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The address that you want bounce and complaint notifications to be sent to.final String
This parameter is used only for sending authorization.final String
The email address to use as the "From" address for the email.final String
This parameter is used only for sending authorization.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the EmailTags property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ReplyToAddresses property.final 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.The "Reply-to" email addresses for the message.static Class
<? extends SendEmailRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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.
For Raw emails, the
FromEmailAddressIdentityArn
value 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
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.
For Raw emails, the
FromEmailAddressIdentityArn
value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.
-
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
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
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
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.
- 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 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.
-
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
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
hasEmailTags()
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.
-
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.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SendEmailRequest.Builder,
SendEmailRequest> - Specified by:
toBuilder
in classSesV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-