Package software.amazon.awssdk.services.pinpoint.model

Class SimpleEmail

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SimpleEmail

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class SimpleEmail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SimpleEmail.Builder,SimpleEmail>

Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SimpleEmail.Builder

Method Summary

Modifier and Type	Method	Description
static SimpleEmail.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 MessageHeaders for the email.
SimpleEmailPart	htmlPart()	The body of the email message, in HTML format.
List<SdkField<?>>	sdkFields()
static Class<? extends SimpleEmail.Builder>	serializableBuilderClass()
SimpleEmailPart	subject()	The subject line, or title, of the email.
SimpleEmailPart	textPart()	The body of the email message, in plain text format.
SimpleEmail.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

htmlPart

public final SimpleEmailPart htmlPart()

The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

Returns:

The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

subject

public final SimpleEmailPart subject()

The subject line, or title, of the email.

Returns:

The subject line, or title, of the email.

textPart

public final SimpleEmailPart textPart()

The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

Returns:

The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

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 Headers.

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 Headers.

toBuilder

public SimpleEmail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SimpleEmail.Builder,SimpleEmail>

builder

public static SimpleEmail.Builder builder()

serializableBuilderClass

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