SendEmailRequest (AWS Java SDK :: Services :: Pinpoint Email 2.16.99 API)

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)`
`boolean`	`equalsBySdkFields(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)`
`boolean`	`hasEmailTags()` Returns true if the EmailTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasReplyToAddresses()` Returns true if the ReplyToAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`replyToAddresses()` The "Reply-to" email addresses for the message.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SendEmailRequest.Builder>`	`serializableBuilderClass()`
`SendEmailRequest.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
  - fromEmailAddress
```
public final 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 final Destination destination()
```
    An object that contains the recipients of the email message.
    
    Returns:
    
    An object that contains the recipients of the email message.
  - hasReplyToAddresses
```
public final boolean hasReplyToAddresses()
```
    Returns true if the ReplyToAddresses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - replyToAddresses
```
public final 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.
    
    You can use hasReplyToAddresses() to see if a value was sent in this field.
    
    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 final 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 final 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.
  - hasEmailTags
```
public final boolean hasEmailTags()
```
    Returns true if the EmailTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - emailTags
```
public final 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.
    
    You can use hasEmailTags() to see if a value was sent in this field.
    
    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 final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SendEmailRequest.Builder,SendEmailRequest>
    
    Specified by:
    
    toBuilder in class PinpointEmailRequest
  - builder
```
public static SendEmailRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SendEmailRequest.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 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

hasReplyToAddresses

replyToAddresses

feedbackForwardingEmailAddress

content

hasEmailTags

emailTags

configurationSetName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields