SendTemplatedEmailRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ses.model.SesRequest
    - - software.amazon.awssdk.services.ses.model.SendTemplatedEmailRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SendTemplatedEmailRequest.Builder,SendTemplatedEmailRequest>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class SendTemplatedEmailRequest
extends SesRequest
implements ToCopyableBuilder<SendTemplatedEmailRequest.Builder,SendTemplatedEmailRequest>
```
Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SendTemplatedEmailRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SendTemplatedEmailRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SendTemplatedEmailRequest.Builder`	`builder()`
`String`	`configurationSetName()` The name of the configuration set to use when you send an email using `SendTemplatedEmail`.
`Destination`	`destination()` The destination for this email, composed of To:, CC:, and BCC: fields.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<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`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`List<String>`	`replyToAddresses()` The reply-to email address(es) for the message.
`String`	`returnPath()` The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
`String`	`returnPathArn()` This parameter is used only for sending authorization.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SendTemplatedEmailRequest.Builder>`	`serializableBuilderClass()`
`String`	`source()` The email address that is sending the email.
`String`	`sourceArn()` This parameter is used only for sending authorization.
`List<MessageTag>`	`tags()` A list of tags, in the form of name/value pairs, to apply to an email that you send using `SendTemplatedEmail`.
`String`	`template()` The template to use when sending this email.
`String`	`templateArn()` The ARN of the template to use when sending this email.
`String`	`templateData()` A list of replacement values to apply to the template.
`SendTemplatedEmailRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - source
```
public final String source()
```
    The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
    
    If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
    
    Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
    
    Returns:
    
    The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
    
    If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
    
    Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.
  - destination
```
public final Destination destination()
```
    The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
    
    Returns:
    
    The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
  - 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 message. If the recipient replies to the message, each reply-to address will receive 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 message. If the recipient replies to the message, each reply-to address will receive the reply.
  - returnPath
```
public final String returnPath()
```
    The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
    
    Returns:
    
    The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
  - sourceArn
```
public final String sourceArn()
```
    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
    
    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be [email protected].
    
    For more information about sending authorization, see the Amazon SES Developer Guide.
    
    Returns:
    
    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
    
    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be [email protected].
    
    For more information about sending authorization, see the Amazon SES Developer Guide.
  - returnPathArn
```
public final String returnPathArn()
```
    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
    
    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be [email protected].
    
    For more information about sending authorization, see the Amazon SES Developer Guide.
    
    Returns:
    
    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
    
    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use [email protected], then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be [email protected].
    
    For more information about sending authorization, see the Amazon SES Developer Guide.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<MessageTag> tags()
```
    A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
    
    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 hasTags() method.
    
    Returns:
    
    A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
  - configurationSetName
```
public final String configurationSetName()
```
    The name of the configuration set to use when you send an email using SendTemplatedEmail.
    
    Returns:
    
    The name of the configuration set to use when you send an email using SendTemplatedEmail.
  - template
```
public final String template()
```
    The template to use when sending this email.
    
    Returns:
    
    The template to use when sending this email.
  - templateArn
```
public final String templateArn()
```
    The ARN of the template to use when sending this email.
    
    Returns:
    
    The ARN of the template to use when sending this email.
  - templateData
```
public final String templateData()
```
    A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
    
    Returns:
    
    A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
  - toBuilder
```
public SendTemplatedEmailRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SendTemplatedEmailRequest.Builder,SendTemplatedEmailRequest>
    
    Specified by:
    
    toBuilder in class SesRequest
  - builder
```
public static SendTemplatedEmailRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SendTemplatedEmailRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SendTemplatedEmailRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

source

destination

hasReplyToAddresses

replyToAddresses

returnPath

sourceArn

returnPathArn

hasTags

tags

configurationSetName

template

templateArn

templateData

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields