com.amazonaws.services.simpleemailv2.model

Class SendBulkEmailRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemailv2.model.SendBulkEmailRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendBulkEmailRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SendBulkEmailRequest()

Method Summary

Modifier and Type	Method and Description
SendBulkEmailRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<BulkEmailEntry>	getBulkEmailEntries() The list of bulk email entry objects.
String	getConfigurationSetName() The name of the configuration set to use when sending the email.
BulkEmailContent	getDefaultContent() An object that contains the body of the message.
List<MessageTag>	getDefaultEmailTags() A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation.
String	getFeedbackForwardingEmailAddress() The address that you want bounce and complaint notifications to be sent to.
String	getFeedbackForwardingEmailAddressIdentityArn() This parameter is used only for sending authorization.
String	getFromEmailAddress() The email address to use as the "From" address for the email.
String	getFromEmailAddressIdentityArn() This parameter is used only for sending authorization.
List<String>	getReplyToAddresses() The "Reply-to" email addresses for the message.
int	hashCode()
void	setBulkEmailEntries(Collection<BulkEmailEntry> bulkEmailEntries) The list of bulk email entry objects.
void	setConfigurationSetName(String configurationSetName) The name of the configuration set to use when sending the email.
void	setDefaultContent(BulkEmailContent defaultContent) An object that contains the body of the message.
void	setDefaultEmailTags(Collection<MessageTag> defaultEmailTags) A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation.
void	setFeedbackForwardingEmailAddress(String feedbackForwardingEmailAddress) The address that you want bounce and complaint notifications to be sent to.
void	setFeedbackForwardingEmailAddressIdentityArn(String feedbackForwardingEmailAddressIdentityArn) This parameter is used only for sending authorization.
void	setFromEmailAddress(String fromEmailAddress) The email address to use as the "From" address for the email.
void	setFromEmailAddressIdentityArn(String fromEmailAddressIdentityArn) This parameter is used only for sending authorization.
void	setReplyToAddresses(Collection<String> replyToAddresses) The "Reply-to" email addresses for the message.
String	toString() Returns a string representation of this object.
SendBulkEmailRequest	withBulkEmailEntries(BulkEmailEntry... bulkEmailEntries) The list of bulk email entry objects.
SendBulkEmailRequest	withBulkEmailEntries(Collection<BulkEmailEntry> bulkEmailEntries) The list of bulk email entry objects.
SendBulkEmailRequest	withConfigurationSetName(String configurationSetName) The name of the configuration set to use when sending the email.
SendBulkEmailRequest	withDefaultContent(BulkEmailContent defaultContent) An object that contains the body of the message.
SendBulkEmailRequest	withDefaultEmailTags(Collection<MessageTag> defaultEmailTags) A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation.
SendBulkEmailRequest	withDefaultEmailTags(MessageTag... defaultEmailTags) A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation.
SendBulkEmailRequest	withFeedbackForwardingEmailAddress(String feedbackForwardingEmailAddress) The address that you want bounce and complaint notifications to be sent to.
SendBulkEmailRequest	withFeedbackForwardingEmailAddressIdentityArn(String feedbackForwardingEmailAddressIdentityArn) This parameter is used only for sending authorization.
SendBulkEmailRequest	withFromEmailAddress(String fromEmailAddress) The email address to use as the "From" address for the email.
SendBulkEmailRequest	withFromEmailAddressIdentityArn(String fromEmailAddressIdentityArn) This parameter is used only for sending authorization.
SendBulkEmailRequest	withReplyToAddresses(Collection<String> replyToAddresses) The "Reply-to" email addresses for the message.
SendBulkEmailRequest	withReplyToAddresses(String... replyToAddresses) The "Reply-to" email addresses for the message.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendBulkEmailRequest

public SendBulkEmailRequest()

Method Detail

setFromEmailAddress

public void setFromEmailAddress(String fromEmailAddress)

The email address to use as the "From" address for the email. The address that you specify has to be verified.

Parameters:

fromEmailAddress - The email address to use as the "From" address for the email. The address that you specify has to be verified.

getFromEmailAddress

public String getFromEmailAddress()

The email address to use as the "From" address for the email. The address that you specify has to be verified.

Returns:

The email address to use as the "From" address for the email. The address that you specify has to be verified.

withFromEmailAddress

public SendBulkEmailRequest withFromEmailAddress(String fromEmailAddress)

The email address to use as the "From" address for the email. The address that you specify has to be verified.

Parameters:

fromEmailAddress - The email address to use as the "From" address for the email. The address that you specify has to be verified.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFromEmailAddressIdentityArn

public void setFromEmailAddressIdentityArn(String fromEmailAddressIdentityArn)

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 FromEmailAddress 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 sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Parameters:

fromEmailAddressIdentityArn - 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 FromEmailAddress 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 sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

getFromEmailAddressIdentityArn

public String getFromEmailAddressIdentityArn()

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 FromEmailAddress 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 sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

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 FromEmailAddress 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 sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

withFromEmailAddressIdentityArn

public SendBulkEmailRequest withFromEmailAddressIdentityArn(String fromEmailAddressIdentityArn)

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 FromEmailAddress 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 sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Parameters:

fromEmailAddressIdentityArn - 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 FromEmailAddress 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 sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

getReplyToAddresses

public List<String> getReplyToAddresses()

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Returns:

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

setReplyToAddresses

public void setReplyToAddresses(Collection<String> replyToAddresses)

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Parameters:

replyToAddresses - The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

withReplyToAddresses

public SendBulkEmailRequest withReplyToAddresses(String... replyToAddresses)

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

NOTE: This method appends the values to the existing list (if any). Use setReplyToAddresses(java.util.Collection) or withReplyToAddresses(java.util.Collection) if you want to override the existing values.

Parameters:

replyToAddresses - The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Returns:

Returns a reference to this object so that method calls can be chained together.

withReplyToAddresses

public SendBulkEmailRequest withReplyToAddresses(Collection<String> replyToAddresses)

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Parameters:

replyToAddresses - The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFeedbackForwardingEmailAddress

public void setFeedbackForwardingEmailAddress(String feedbackForwardingEmailAddress)

The address that you want bounce and complaint notifications to be sent to.

Parameters:

feedbackForwardingEmailAddress - The address that you want bounce and complaint notifications to be sent to.

getFeedbackForwardingEmailAddress

public String getFeedbackForwardingEmailAddress()

The address that you want bounce and complaint notifications to be sent to.

Returns:

The address that you want bounce and complaint notifications to be sent to.

withFeedbackForwardingEmailAddress

public SendBulkEmailRequest withFeedbackForwardingEmailAddress(String feedbackForwardingEmailAddress)

The address that you want bounce and complaint notifications to be sent to.

Parameters:

feedbackForwardingEmailAddress - The address that you want bounce and complaint notifications to be sent to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFeedbackForwardingEmailAddressIdentityArn

public void setFeedbackForwardingEmailAddressIdentityArn(String feedbackForwardingEmailAddressIdentityArn)

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 FeedbackForwardingEmailAddress 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 feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Parameters:

feedbackForwardingEmailAddressIdentityArn - 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 FeedbackForwardingEmailAddress 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 feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

getFeedbackForwardingEmailAddressIdentityArn

public String getFeedbackForwardingEmailAddressIdentityArn()

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 FeedbackForwardingEmailAddress 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 feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

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 FeedbackForwardingEmailAddress 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 feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

withFeedbackForwardingEmailAddressIdentityArn

public SendBulkEmailRequest withFeedbackForwardingEmailAddressIdentityArn(String feedbackForwardingEmailAddressIdentityArn)

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 FeedbackForwardingEmailAddress 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 feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Parameters:

feedbackForwardingEmailAddressIdentityArn - 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 FeedbackForwardingEmailAddress 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 feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDefaultEmailTags

public List<MessageTag> getDefaultEmailTags()

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.

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.

setDefaultEmailTags

public void setDefaultEmailTags(Collection<MessageTag> defaultEmailTags)

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.

Parameters:

defaultEmailTags - 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.

withDefaultEmailTags

public SendBulkEmailRequest withDefaultEmailTags(MessageTag... defaultEmailTags)

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.

NOTE: This method appends the values to the existing list (if any). Use setDefaultEmailTags(java.util.Collection) or withDefaultEmailTags(java.util.Collection) if you want to override the existing values.

Parameters:

defaultEmailTags - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withDefaultEmailTags

public SendBulkEmailRequest withDefaultEmailTags(Collection<MessageTag> defaultEmailTags)

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.

Parameters:

defaultEmailTags - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDefaultContent

public void setDefaultContent(BulkEmailContent defaultContent)

An object that contains the body of the message. You can specify a template message.

Parameters:

defaultContent - An object that contains the body of the message. You can specify a template message.

getDefaultContent

public BulkEmailContent getDefaultContent()

An object that contains the body of the message. You can specify a template message.

Returns:

An object that contains the body of the message. You can specify a template message.

withDefaultContent

public SendBulkEmailRequest withDefaultContent(BulkEmailContent defaultContent)

An object that contains the body of the message. You can specify a template message.

Parameters:

defaultContent - An object that contains the body of the message. You can specify a template message.

Returns:

Returns a reference to this object so that method calls can be chained together.

getBulkEmailEntries

public List<BulkEmailEntry> getBulkEmailEntries()

The list of bulk email entry objects.

Returns:

The list of bulk email entry objects.

setBulkEmailEntries

public void setBulkEmailEntries(Collection<BulkEmailEntry> bulkEmailEntries)

The list of bulk email entry objects.

Parameters:

bulkEmailEntries - The list of bulk email entry objects.

withBulkEmailEntries

public SendBulkEmailRequest withBulkEmailEntries(BulkEmailEntry... bulkEmailEntries)

The list of bulk email entry objects.

NOTE: This method appends the values to the existing list (if any). Use setBulkEmailEntries(java.util.Collection) or withBulkEmailEntries(java.util.Collection) if you want to override the existing values.

Parameters:

bulkEmailEntries - The list of bulk email entry objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

withBulkEmailEntries

public SendBulkEmailRequest withBulkEmailEntries(Collection<BulkEmailEntry> bulkEmailEntries)

The list of bulk email entry objects.

Parameters:

bulkEmailEntries - The list of bulk email entry objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

setConfigurationSetName

public void setConfigurationSetName(String configurationSetName)

The name of the configuration set to use when sending the email.

Parameters:

configurationSetName - The name of the configuration set to use when sending the email.

getConfigurationSetName

public String getConfigurationSetName()

The name of the configuration set to use when sending the email.

Returns:

The name of the configuration set to use when sending the email.

withConfigurationSetName

public SendBulkEmailRequest withConfigurationSetName(String configurationSetName)

The name of the configuration set to use when sending the email.

Parameters:

configurationSetName - The name of the configuration set to use when sending the email.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SendBulkEmailRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()