com.amazonaws.services.simpleemail.model

Class SendEmailRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemail.model.SendEmailRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SendEmailRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the SendEmail operation.

Composes an email message based on input data, and then immediately queues the message for sending.

There are several important points to know about SendEmail :

• You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide .
• The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
• Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.
• For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide .

See Also:

AmazonSimpleEmailService.sendEmail(SendEmailRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SendEmailRequest() Default constructor for a new SendEmailRequest object.
SendEmailRequest(String source, Destination destination, Message message) Constructs a new SendEmailRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
SendEmailRequest	clone()
boolean	equals(Object obj)
Destination	getDestination() The destination for this email, composed of To:, CC:, and BCC: fields.
Message	getMessage() The message to be sent.
List<String>	getReplyToAddresses() The reply-to email address(es) for the message.
String	getReturnPath() The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled.
String	getReturnPathArn() This parameter is used only for sending authorization.
String	getSource() The email address that is sending the email.
String	getSourceArn() This parameter is used only for sending authorization.
int	hashCode()
void	setDestination(Destination destination) The destination for this email, composed of To:, CC:, and BCC: fields.
void	setMessage(Message message) The message to be sent.
void	setReplyToAddresses(Collection<String> replyToAddresses) The reply-to email address(es) for the message.
void	setReturnPath(String returnPath) The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled.
void	setReturnPathArn(String returnPathArn) This parameter is used only for sending authorization.
void	setSource(String source) The email address that is sending the email.
void	setSourceArn(String sourceArn) This parameter is used only for sending authorization.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SendEmailRequest	withDestination(Destination destination) The destination for this email, composed of To:, CC:, and BCC: fields.
SendEmailRequest	withMessage(Message message) The message to be sent.
SendEmailRequest	withReplyToAddresses(Collection<String> replyToAddresses) The reply-to email address(es) for the message.
SendEmailRequest	withReplyToAddresses(String... replyToAddresses) The reply-to email address(es) for the message.
SendEmailRequest	withReturnPath(String returnPath) The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled.
SendEmailRequest	withReturnPathArn(String returnPathArn) This parameter is used only for sending authorization.
SendEmailRequest	withSource(String source) The email address that is sending the email.
SendEmailRequest	withSourceArn(String sourceArn) This parameter is used only for sending authorization.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendEmailRequest

public SendEmailRequest()

Default constructor for a new SendEmailRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

SendEmailRequest

public SendEmailRequest(String source,
                Destination destination,
                Message message)

Constructs a new SendEmailRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

source - The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

destination - The destination for this email, composed of To:, CC:, and BCC: fields.

message - The message to be sent.

Method Detail

getSource

public String getSource()

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

Returns:

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

setSource

public void setSource(String source)

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

Parameters:

source - The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

withSource

public SendEmailRequest withSource(String source)

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

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

Parameters:

source - The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

Returns:

A reference to this updated object so that method calls can be chained together.

getDestination

public Destination getDestination()

The destination for this email, composed of To:, CC:, and BCC: fields.

Returns:

The destination for this email, composed of To:, CC:, and BCC: fields.

setDestination

public void setDestination(Destination destination)

The destination for this email, composed of To:, CC:, and BCC: fields.

Parameters:

destination - The destination for this email, composed of To:, CC:, and BCC: fields.

withDestination

public SendEmailRequest withDestination(Destination destination)

The destination for this email, composed of To:, CC:, and BCC: fields.

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

Parameters:

destination - The destination for this email, composed of To:, CC:, and BCC: fields.

Returns:

A reference to this updated object so that method calls can be chained together.

getMessage

public Message getMessage()

The message to be sent.

Returns:

The message to be sent.

setMessage

public void setMessage(Message message)

The message to be sent.

Parameters:

message - The message to be sent.

withMessage

public SendEmailRequest withMessage(Message message)

The message to be sent.

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

Parameters:

message - The message to be sent.

Returns:

A reference to this updated object so that method calls can be chained together.

getReplyToAddresses

public List<String> getReplyToAddresses()

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Returns:

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

setReplyToAddresses

public void setReplyToAddresses(Collection<String> replyToAddresses)

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Parameters:

replyToAddresses - The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

withReplyToAddresses

public SendEmailRequest withReplyToAddresses(String... replyToAddresses)

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive 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.

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

Parameters:

replyToAddresses - The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Returns:

A reference to this updated object so that method calls can be chained together.

withReplyToAddresses

public SendEmailRequest withReplyToAddresses(Collection<String> replyToAddresses)

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

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

Parameters:

replyToAddresses - The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Returns:

A reference to this updated object so that method calls can be chained together.

getReturnPath

public String getReturnPath()

The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Returns:

The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

setReturnPath

public void setReturnPath(String returnPath)

The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Parameters:

returnPath - The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

withReturnPath

public SendEmailRequest withReturnPath(String returnPath)

The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

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

Parameters:

returnPath - The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Returns:

A reference to this updated object so that method calls can be chained together.

getSourceArn

public String getSourceArn()

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 send for the email address specified in the Source 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 send from [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source 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 send for the email address specified in the Source 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 send from [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be [email protected].

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

setSourceArn

public void setSourceArn(String sourceArn)

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 send for the email address specified in the Source 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 send from [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be [email protected].

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

Parameters:

sourceArn - 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 send for the email address specified in the Source 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 send from [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be [email protected].

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

withSourceArn

public SendEmailRequest withSourceArn(String sourceArn)

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 send for the email address specified in the Source 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 send from [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be [email protected].

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

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

Parameters:

sourceArn - 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 send for the email address specified in the Source 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 send from [email protected], then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be [email protected].

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

Returns:

A reference to this updated object so that method calls can be chained together.

getReturnPathArn

public String getReturnPathArn()

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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath 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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be [email protected].

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

setReturnPathArn

public void setReturnPathArn(String returnPathArn)

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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be [email protected].

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

Parameters:

returnPathArn - 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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be [email protected].

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

withReturnPathArn

public SendEmailRequest withReturnPathArn(String returnPathArn)

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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be [email protected].

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

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

Parameters:

returnPathArn - 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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be [email protected].

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public SendEmailRequest clone()

Overrides:

clone in class AmazonWebServiceRequest