Class BulkEmailEntry

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

  • Method Details

    • destination

      public final Destination destination()

      Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

      Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.

      Returns:
      Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

      Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.

    • hasReplacementTags

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

    • replacementTags

      public final List<MessageTag> replacementTags()

      A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail 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 hasReplacementTags() method.

      Returns:
      A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

    • replacementEmailContent

      public final ReplacementEmailContent replacementEmailContent()

      The ReplacementEmailContent associated with a BulkEmailEntry.

      Returns:
      The ReplacementEmailContent associated with a BulkEmailEntry.

    • hasReplacementHeaders

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

    • replacementHeaders

      public final List<MessageHeader> replacementHeaders()

      The list of message headers associated with the BulkEmailEntry data type.

      • Headers Not Present in BulkEmailEntry: If a header is specified in Template but not in BulkEmailEntry, the header from Template will be added to the outgoing email.

      • Headers Present in BulkEmailEntry: If a header is specified in BulkEmailEntry, it takes precedence over any header of the same name specified in Template :

        • If the header is also defined within Template, the value from BulkEmailEntry will replace the header's value in the email.

        • If the header is not defined within Template, it will simply be added to the email as specified in BulkEmailEntry.

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

      Returns:
      The list of message headers associated with the BulkEmailEntry data type.

      • Headers Not Present in BulkEmailEntry: If a header is specified in Template but not in BulkEmailEntry, the header from Template will be added to the outgoing email.

      • Headers Present in BulkEmailEntry: If a header is specified in BulkEmailEntry, it takes precedence over any header of the same name specified in Template :

        • If the header is also defined within Template, the value from BulkEmailEntry will replace the header's value in the email.

        • If the header is not defined within Template, it will simply be added to the email as specified in BulkEmailEntry.

    • toBuilder

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

    • builder

      public static BulkEmailEntry.Builder builder()

    • serializableBuilderClass

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