java.lang.Object
software.amazon.awssdk.services.pinpoint.model.EmailMessage
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EmailMessage.Builder,EmailMessage>

@Generated("software.amazon.awssdk:codegen") public final class EmailMessage extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EmailMessage.Builder,EmailMessage>

Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.

See Also:
  • Method Details

    • body

      public final String body()

      The body of the email message.

      Returns:
      The body of the email message.
    • feedbackForwardingAddress

      public final String feedbackForwardingAddress()

      The email address to forward bounces and complaints to, if feedback forwarding is enabled.

      Returns:
      The email address to forward bounces and complaints to, if feedback forwarding is enabled.
    • fromAddress

      public final String fromAddress()

      The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

      Returns:
      The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
    • rawEmail

      public final RawEmail rawEmail()

      The email message, represented as a raw MIME message.

      Returns:
      The email message, represented as a raw MIME 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 address(es) for the email message. If a recipient replies to the email, 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 address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
    • simpleEmail

      public final SimpleEmail simpleEmail()

      The email message, composed of a subject, a text part, and an HTML part.

      Returns:
      The email message, composed of a subject, a text part, and an HTML part.
    • hasSubstitutions

      public final boolean hasSubstitutions()
      For responses, this returns true if the service returned a value for the Substitutions 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.
    • substitutions

      public final Map<String,List<String>> substitutions()

      The default message variables to use in the email message. You can override the default variables with individual address variables.

      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 hasSubstitutions() method.

      Returns:
      The default message variables to use in the email message. You can override the default variables with individual address variables.
    • toBuilder

      public EmailMessage.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<EmailMessage.Builder,EmailMessage>
      Returns:
      a builder for type T
    • builder

      public static EmailMessage.Builder builder()
    • serializableBuilderClass

      public static Class<? extends EmailMessage.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.