Class SendBounceRequest
- 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.SendBounceRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SendBounceRequest.Builder,SendBounceRequest>
@Generated("software.amazon.awssdk:codegen") public final class SendBounceRequest extends SesRequest implements ToCopyableBuilder<SendBounceRequest.Builder,SendBounceRequest>
Represents a request to send a bounce message to the sender of an email you received through Amazon SES.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SendBounceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<BouncedRecipientInfo>
bouncedRecipientInfoList()
A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients.String
bounceSender()
The address to use in the "From" header of the bounce message.String
bounceSenderArn()
This parameter is used only for sending authorization.static SendBounceRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
explanation()
Human-readable text for the bounce message to explain the failure.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasBouncedRecipientInfoList()
For responses, this returns true if the service returned a value for the BouncedRecipientInfoList property.int
hashCode()
MessageDsn
messageDsn()
Message-related DSN fields.String
originalMessageId()
The message ID of the message to be bounced.List<SdkField<?>>
sdkFields()
static Class<? extends SendBounceRequest.Builder>
serializableBuilderClass()
SendBounceRequest.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
-
originalMessageId
public final String originalMessageId()
The message ID of the message to be bounced.
- Returns:
- The message ID of the message to be bounced.
-
bounceSender
public final String bounceSender()
The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.
- Returns:
- The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.
-
explanation
public final String explanation()
Human-readable text for the bounce message to explain the failure. If not specified, the text is auto-generated based on the bounced recipient information.
- Returns:
- Human-readable text for the bounce message to explain the failure. If not specified, the text is auto-generated based on the bounced recipient information.
-
messageDsn
public final MessageDsn messageDsn()
Message-related DSN fields. If not specified, Amazon SES chooses the values.
- Returns:
- Message-related DSN fields. If not specified, Amazon SES chooses the values.
-
hasBouncedRecipientInfoList
public final boolean hasBouncedRecipientInfoList()
For responses, this returns true if the service returned a value for the BouncedRecipientInfoList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
bouncedRecipientInfoList
public final List<BouncedRecipientInfo> bouncedRecipientInfoList()
A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one
BouncedRecipientInfo
in the list.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
hasBouncedRecipientInfoList()
method.- Returns:
- A list of recipients of the bounced message, including the information required to create the Delivery
Status Notifications (DSNs) for the recipients. You must specify at least one
BouncedRecipientInfo
in the list.
-
bounceSenderArn
public final String bounceSenderArn()
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 address in the "From" header of the bounce. 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 address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.
-
toBuilder
public SendBounceRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SendBounceRequest.Builder,SendBounceRequest>
- Specified by:
toBuilder
in classSesRequest
-
builder
public static SendBounceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends SendBounceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-