Package software.amazon.awssdk.services.sesv2.model

Class Message

java.lang.Object

software.amazon.awssdk.services.sesv2.model.Message

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Message.Builder,Message>

@Generated("software.amazon.awssdk:codegen")
public final class Message
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Message.Builder

Method Summary

Modifier and Type	Method	Description
List<Attachment>	attachments()	The List of attachments to include in your email.
Body	body()	The body of the message.
static Message.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttachments()	For responses, this returns true if the service returned a value for the Attachments property.
int	hashCode()
boolean	hasHeaders()	For responses, this returns true if the service returned a value for the Headers property.
List<MessageHeader>	headers()	The list of message headers that will be added to the email message.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Message.Builder>	serializableBuilderClass()
Content	subject()	The subject line of the email.
Message.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

subject

public final Content 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

public final Body 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 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 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 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.

attachments

public final List<Attachment> 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

public Message.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Message.Builder,Message>

builder

public static Message.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo