com.amazonaws.services.simpleemailv2.model

Class SendEmailRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemailv2.model.SendEmailRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Represents a request to send a single formatted email 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
SendEmailRequest()

Method Summary

Modifier and Type	Method and Description
SendEmailRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getConfigurationSetName() The name of the configuration set to use when sending the email.
EmailContent	getContent() An object that contains the body of the message.
Destination	getDestination() An object that contains the recipients of the email message.
List<MessageTag>	getEmailTags() 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.
ListManagementOptions	getListManagementOptions() An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
List<String>	getReplyToAddresses() The "Reply-to" email addresses for the message.
int	hashCode()
void	setConfigurationSetName(String configurationSetName) The name of the configuration set to use when sending the email.
void	setContent(EmailContent content) An object that contains the body of the message.
void	setDestination(Destination destination) An object that contains the recipients of the email message.
void	setEmailTags(Collection<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.
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	setListManagementOptions(ListManagementOptions listManagementOptions) An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
void	setReplyToAddresses(Collection<String> replyToAddresses) The "Reply-to" email addresses for the message.
String	toString() Returns a string representation of this object.
SendEmailRequest	withConfigurationSetName(String configurationSetName) The name of the configuration set to use when sending the email.
SendEmailRequest	withContent(EmailContent content) An object that contains the body of the message.
SendEmailRequest	withDestination(Destination destination) An object that contains the recipients of the email message.
SendEmailRequest	withEmailTags(Collection<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.
SendEmailRequest	withEmailTags(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.
SendEmailRequest	withFeedbackForwardingEmailAddress(String feedbackForwardingEmailAddress) The address that you want bounce and complaint notifications to be sent to.
SendEmailRequest	withFeedbackForwardingEmailAddressIdentityArn(String feedbackForwardingEmailAddressIdentityArn) This parameter is used only for sending authorization.
SendEmailRequest	withFromEmailAddress(String fromEmailAddress) The email address to use as the "From" address for the email.
SendEmailRequest	withFromEmailAddressIdentityArn(String fromEmailAddressIdentityArn) This parameter is used only for sending authorization.
SendEmailRequest	withListManagementOptions(ListManagementOptions listManagementOptions) An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
SendEmailRequest	withReplyToAddresses(Collection<String> replyToAddresses) The "Reply-to" email addresses for the message.
SendEmailRequest	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

SendEmailRequest

public SendEmailRequest()

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

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

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

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

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

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

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

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

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

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

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

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

withFromEmailAddressIdentityArn

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

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

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

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

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

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

Returns:

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

setDestination

public void setDestination(Destination destination)

An object that contains the recipients of the email message.

Parameters:

destination - An object that contains the recipients of the email message.

getDestination

public Destination getDestination()

An object that contains the recipients of the email message.

Returns:

An object that contains the recipients of the email message.

withDestination

public SendEmailRequest withDestination(Destination destination)

An object that contains the recipients of the email message.

Parameters:

destination - An object that contains the recipients of the email message.

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

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

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

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

withFeedbackForwardingEmailAddressIdentityArn

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

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

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.

setContent

public void setContent(EmailContent content)

An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

Parameters:

content - An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

getContent

public EmailContent getContent()

An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

Returns:

An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

withContent

public SendEmailRequest withContent(EmailContent content)

An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

Parameters:

content - An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

Returns:

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

getEmailTags

public List<MessageTag> getEmailTags()

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.

setEmailTags

public void setEmailTags(Collection<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.

Parameters:

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.

withEmailTags

public SendEmailRequest withEmailTags(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.

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

Parameters:

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.

Returns:

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

withEmailTags

public SendEmailRequest withEmailTags(Collection<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.

Parameters:

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.

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

setListManagementOptions

public void setListManagementOptions(ListManagementOptions listManagementOptions)

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

Parameters:

listManagementOptions - An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

getListManagementOptions

public ListManagementOptions getListManagementOptions()

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

Returns:

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

withListManagementOptions

public SendEmailRequest withListManagementOptions(ListManagementOptions listManagementOptions)

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

Parameters:

listManagementOptions - An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

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 SendEmailRequest 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()