Class CampaignEmailMessage

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

Specifies the content and "From" address for an email message that's sent to recipients of a campaign.

See Also:

  • Method Details

    • body

      public final String body()

      The body of the email for recipients whose email clients don't render HTML content.

      Returns:
      The body of the email for recipients whose email clients don't render HTML content.

    • fromAddress

      public final String fromAddress()

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

      Returns:
      The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

    • 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 MessageHeaders for each email.

      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 MessageHeaders for each email.

    • htmlBody

      public final String htmlBody()

      The body of the email, in HTML format, for recipients whose email clients render HTML content.

      Returns:
      The body of the email, in HTML format, for recipients whose email clients render HTML content.

    • title

      public final String title()

      The subject line, or title, of the email.

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

    • toBuilder

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

    • builder

      public static CampaignEmailMessage.Builder builder()

    • serializableBuilderClass

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