Class SimpleEmail

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.SimpleEmail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SimpleEmail.Builder,SimpleEmail>
@Generated("software.amazon.awssdk:codegen") public final class SimpleEmail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SimpleEmail.Builder,SimpleEmail>

Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.

See Also:

  • Method Details

    • htmlPart

      public final SimpleEmailPart htmlPart()

      The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

      Returns:
      The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

    • subject

      public final SimpleEmailPart subject()

      The subject line, or title, of the email.

      Returns:
      The subject line, or title, of the email.

    • textPart

      public final SimpleEmailPart textPart()

      The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

      Returns:
      The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

    • hasHeaders

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

    • headers

      public final List<MessageHeader> headers()

      The list of MessageHeaders for the email. You can have up to 15 Headers.

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

      Returns:
      The list of MessageHeaders for the email. You can have up to 15 Headers.

    • toBuilder

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

    • builder

      public static SimpleEmail.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SimpleEmail.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.