software.amazon.awssdk.services.pinpoint.model

Class EmailMessage

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.EmailMessage

All Implemented Interfaces:

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

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

Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EmailMessage.Builder

Method Summary

Modifier and Type	Method and Description
String	body() The body of the email message.
static EmailMessage.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	feedbackForwardingAddress() The email address to forward bounces and complaints to, if feedback forwarding is enabled.
String	fromAddress() The verified email address to send the email message from.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReplyToAddresses() For responses, this returns true if the service returned a value for the ReplyToAddresses property.
boolean	hasSubstitutions() For responses, this returns true if the service returned a value for the Substitutions property.
RawEmail	rawEmail() The email message, represented as a raw MIME message.
List<String>	replyToAddresses() The reply-to email address(es) for the email message.
List<SdkField<?>>	sdkFields()
static Class<? extends EmailMessage.Builder>	serializableBuilderClass()
SimpleEmail	simpleEmail() The email message, composed of a subject, a text part, and an HTML part.
Map<String,List<String>>	substitutions() The default message variables to use in the email message.
EmailMessage.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

body

public final String body()

The body of the email message.

Returns:

The body of the email message.

feedbackForwardingAddress

public final String feedbackForwardingAddress()

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

Returns:

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

fromAddress

public final String fromAddress()

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

Returns:

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

rawEmail

public final RawEmail rawEmail()

The email message, represented as a raw MIME message.

Returns:

The email message, represented as a raw MIME message.

hasReplyToAddresses

public final boolean hasReplyToAddresses()

For responses, this returns true if the service returned a value for the ReplyToAddresses 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.

replyToAddresses

public final List<String> replyToAddresses()

The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

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

Returns:

The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

simpleEmail

public final SimpleEmail simpleEmail()

The email message, composed of a subject, a text part, and an HTML part.

Returns:

The email message, composed of a subject, a text part, and an HTML part.

hasSubstitutions

public final boolean hasSubstitutions()

For responses, this returns true if the service returned a value for the Substitutions 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.

substitutions

public final Map<String,List<String>> substitutions()

The default message variables to use in the email message. You can override the default variables with individual address variables.

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

Returns:

The default message variables to use in the email message. You can override the default variables with individual address variables.

toBuilder

public EmailMessage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EmailMessage.Builder,EmailMessage>

builder

public static EmailMessage.Builder builder()

serializableBuilderClass

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