Class Attachment

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

Contains metadata and attachment raw content.

See Also:

  • Method Details

    • rawContent

      public final SdkBytes rawContent()

      The raw data of the attachment. It needs to be base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.

      Returns:
      The raw data of the attachment. It needs to be base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you.

    • contentDisposition

      public final AttachmentContentDisposition contentDisposition()

      A standard descriptor indicating how the attachment should be rendered in the email. Supported values: ATTACHMENT or INLINE.

      If the service returns an enum value that is not available in the current SDK version, contentDisposition will return AttachmentContentDisposition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentDispositionAsString().

      Returns:
      A standard descriptor indicating how the attachment should be rendered in the email. Supported values: ATTACHMENT or INLINE.
      See Also:

    • contentDispositionAsString

      public final String contentDispositionAsString()

      A standard descriptor indicating how the attachment should be rendered in the email. Supported values: ATTACHMENT or INLINE.

      If the service returns an enum value that is not available in the current SDK version, contentDisposition will return AttachmentContentDisposition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentDispositionAsString().

      Returns:
      A standard descriptor indicating how the attachment should be rendered in the email. Supported values: ATTACHMENT or INLINE.
      See Also:

    • fileName

      public final String fileName()

      The file name for the attachment as it will appear in the email. Amazon SES restricts certain file extensions. To ensure attachments are accepted, check the Unsupported attachment types in the Amazon SES Developer Guide.

      Returns:
      The file name for the attachment as it will appear in the email. Amazon SES restricts certain file extensions. To ensure attachments are accepted, check the Unsupported attachment types in the Amazon SES Developer Guide.

    • contentDescription

      public final String contentDescription()

      A brief description of the attachment content.

      Returns:
      A brief description of the attachment content.

    • contentId

      public final String contentId()

      Unique identifier for the attachment, used for referencing attachments with INLINE disposition in HTML content.

      Returns:
      Unique identifier for the attachment, used for referencing attachments with INLINE disposition in HTML content.

    • contentTransferEncoding

      public final AttachmentContentTransferEncoding contentTransferEncoding()

      Specifies how the attachment is encoded. Supported values: BASE64, QUOTED_PRINTABLE, SEVEN_BIT.

      If the service returns an enum value that is not available in the current SDK version, contentTransferEncoding will return AttachmentContentTransferEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTransferEncodingAsString().

      Returns:
      Specifies how the attachment is encoded. Supported values: BASE64, QUOTED_PRINTABLE, SEVEN_BIT.
      See Also:

    • contentTransferEncodingAsString

      public final String contentTransferEncodingAsString()

      Specifies how the attachment is encoded. Supported values: BASE64, QUOTED_PRINTABLE, SEVEN_BIT.

      If the service returns an enum value that is not available in the current SDK version, contentTransferEncoding will return AttachmentContentTransferEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTransferEncodingAsString().

      Returns:
      Specifies how the attachment is encoded. Supported values: BASE64, QUOTED_PRINTABLE, SEVEN_BIT.
      See Also:

    • contentType

      public final String contentType()

      The MIME type of the attachment.

      Example: application/pdf, image/jpeg

      Returns:
      The MIME type of the attachment.

      Example: application/pdf, image/jpeg

    • toBuilder

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

    • builder

      public static Attachment.Builder builder()

    • serializableBuilderClass

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