SendEmailRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.pinpointemail.model.PinpointEmailRequest
    - - software.amazon.awssdk.services.pinpointemail.model.SendEmailRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<SendEmailRequest.Builder,SendEmailRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SendEmailRequest
extends PinpointEmailRequest
implements ToCopyableBuilder<SendEmailRequest.Builder,SendEmailRequest>

A request to send an email message.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SendEmailRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SendEmailRequest.Builder`	`builder()`
`String`	`configurationSetName()` The name of the configuration set that you want to use when sending the email.
`EmailContent`	`content()` An object that contains the body of the message.
`Destination`	`destination()` An object that contains the recipients of the email message.
`List<MessageTag>`	`emailTags()` A list of tags, in the form of name/value pairs, to apply to an email that you send using the `SendEmail` operation.
`boolean`	`equals(Object obj)`
`String`	`feedbackForwardingEmailAddress()` The address that Amazon Pinpoint should send bounce and complaint notifications to.
`String`	`fromEmailAddress()` The email address that you want to use as the "From" address for the email.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`List<String>`	`replyToAddresses()` The "Reply-to" email addresses for the message.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SendEmailRequest.Builder>`	`serializableBuilderClass()`
`SendEmailRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - fromEmailAddress
```
public String fromEmailAddress()
```
    The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.
    
    Returns:
    
    The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.
  - destination
```
public Destination destination()
```
    An object that contains the recipients of the email message.
    
    Returns:
    
    An object that contains the recipients of the email message.
  - replyToAddresses
```
public List<String> replyToAddresses()
```
    The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
  - feedbackForwardingEmailAddress
```
public String feedbackForwardingEmailAddress()
```
    The address that Amazon Pinpoint should send bounce and complaint notifications to.
    
    Returns:
    
    The address that Amazon Pinpoint should send bounce and complaint notifications to.
  - content
```
public EmailContent content()
```
    An object that contains the body of the message. You can send either a Simple message or a Raw message.
    
    Returns:
    
    An object that contains the body of the message. You can send either a Simple message or a Raw message.
  - emailTags
```
public List<MessageTag> emailTags()
```
    A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. 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.
    
    Returns:
    
    A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
  - configurationSetName
```
public String configurationSetName()
```
    The name of the configuration set that you want to use when sending the email.
    
    Returns:
    
    The name of the configuration set that you want to use when sending the email.
  - toBuilder
```
public SendEmailRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SendEmailRequest.Builder,SendEmailRequest>
    
    Specified by:
    
    toBuilder in class PinpointEmailRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static SendEmailRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SendEmailRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class SendEmailRequest

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

fromEmailAddress

destination

replyToAddresses

feedbackForwardingEmailAddress

content

emailTags

configurationSetName

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields