Class Message
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Message.Builder,Message>
Represents the email message that you're sending. The Message object consists of a subject line and a
message body.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List<Attachment>The List of attachments to include in your email.final Bodybody()The body of the message.static Message.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the Attachments property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Headers property.final List<MessageHeader>headers()The list of message headers that will be added to the email message.static Class<? extends Message.Builder>final Contentsubject()The subject line of the email.final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
subject
The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.
- Returns:
- The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.
-
body
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
- Returns:
- The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
-
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 theisEmpty()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
The list of message headers that will be added to the email message.
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 message headers that will be added to the email message.
-
hasAttachments
public final boolean hasAttachments()For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
attachments
The List of attachments to include in your email. All recipients will receive the same attachments.
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
hasAttachments()method.- Returns:
- The List of attachments to include in your email. All recipients will receive the same attachments.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<Message.Builder,Message>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-