java.lang.Object
- software.amazon.awssdk.services.sesv2.model.Template

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Template.Builder,Template>
```
@Generated("software.amazon.awssdk:codegen")
public final class Template
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Template.Builder,Template>
```
An object that defines the email template to use for an email message, and the values to use for any message variables in that template. An email template is a type of message template that contains content that you want to reuse in email messages that you send. You can specifiy the email template by providing the name or ARN of an email template previously saved in your Amazon SES account or by providing the full template content.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Template.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<Attachment>`	`attachments()`	The List of attachments to include in your email.
`static Template.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 Template.Builder>`	`serializableBuilderClass()`
`String`	`templateArn()`	The Amazon Resource Name (ARN) of the template.
`EmailTemplateContent`	`templateContent()`	The content of the template.
`String`	`templateData()`	An object that defines the values to use for message variables in the template.
`String`	`templateName()`	The name of the template.
`Template.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
  - templateName
```
public final String templateName()
```
    The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
    
    Returns:
    
    The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
  - templateArn
```
public final String templateArn()
```
    The Amazon Resource Name (ARN) of the template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the template.
  - templateContent
```
public final EmailTemplateContent templateContent()
```
    The content of the template.
    
    Amazon SES supports only simple substitions when you send email using the SendEmail or SendBulkEmail operations and you provide the full template content in the request.
    
    Returns:
    
    The content of the template.
    
    Amazon SES supports only simple substitions when you send email using the SendEmail or SendBulkEmail operations and you provide the full template content in the request.
  - templateData
```
public final String templateData()
```
    An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
    
    Returns:
    
    An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
  - 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 Template.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Template.Builder,Template>
  - builder
```
public static Template.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Template.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

Class Template

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

templateName

templateArn

templateContent

templateData

hasHeaders

headers

hasAttachments

attachments

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField