Class 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.

  • Method Details

    • 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 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.

      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 the FromEmailAddress 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

      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 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 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:
      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.

    • 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 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.
    • 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 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

      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.
    • 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()
      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 interface ToCopyableBuilder<SendEmailRequest.Builder,SendEmailRequest>
      Specified by:
      toBuilder in class SesV2Request
      Returns:
      a builder for type T
    • builder

      public static SendEmailRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends SendEmailRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.