@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.
NOOP
Constructor and Description |
---|
SendEmailRequest()
Default constructor for SendEmailRequest object.
|
SendEmailRequest(String source,
Destination destination,
Message message)
Constructs a new SendEmailRequest object.
|
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 you send an email using
SendEmail . |
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 that bounces and complaints are forwarded to 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.
|
List<MessageTag> |
getTags()
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail . |
int |
hashCode() |
void |
setConfigurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using
SendEmail . |
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 that bounces and complaints are forwarded to 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.
|
void |
setTags(Collection<MessageTag> tags)
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail . |
String |
toString()
Returns a string representation of this object.
|
SendEmailRequest |
withConfigurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using
SendEmail . |
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 that bounces and complaints are forwarded to 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.
|
SendEmailRequest |
withTags(Collection<MessageTag> tags)
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail . |
SendEmailRequest |
withTags(MessageTag... tags)
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail . |
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
public SendEmailRequest()
public SendEmailRequest(String source, Destination destination, Message message)
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.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
destination
- The destination for this email, composed of To:, CC:, and BCC: fields.message
- The message to be sent.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.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
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.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
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.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
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.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
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.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
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.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
public void setDestination(Destination destination)
The destination for this email, composed of To:, CC:, and BCC: fields.
destination
- The destination for this email, composed of To:, CC:, and BCC: fields.public Destination getDestination()
The destination for this email, composed of To:, CC:, and BCC: fields.
public SendEmailRequest withDestination(Destination destination)
The destination for this email, composed of To:, CC:, and BCC: fields.
destination
- The destination for this email, composed of To:, CC:, and BCC: fields.public void setMessage(Message message)
The message to be sent.
message
- The message to be sent.public Message getMessage()
The message to be sent.
public SendEmailRequest withMessage(Message message)
The message to be sent.
message
- The message to be sent.public List<String> getReplyToAddresses()
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
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 receives the reply.
replyToAddresses
- The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
address receives the reply.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 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.
replyToAddresses
- The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
address receives the reply.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 receives the reply.
replyToAddresses
- The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to
address receives the reply.public void setReturnPath(String returnPath)
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the
message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this
message is 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.
returnPath
- The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the
message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP;
this message is 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.public String getReturnPath()
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the
message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this
message is 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.
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.public SendEmailRequest withReturnPath(String returnPath)
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the
message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this
message is 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.
returnPath
- The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the
message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP;
this message is 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.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 user@example.com
, then you would specify the SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the Source
to be
user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 user@example.com
, then you would specify the
SourceArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the
Source
to be user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 user@example.com
, then you would specify the SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the Source
to be
user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 user@example.com
, then you would specify the
SourceArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the Source
to be user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 user@example.com
, then you would specify the SourceArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the Source
to be
user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 user@example.com
, then you would specify the
SourceArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the
Source
to be user@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 feedback@example.com
, then you would specify the ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the ReturnPath
to be
feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 feedback@example.com
, then you would specify the
ReturnPathArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the ReturnPath
to be feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 feedback@example.com
, then you would specify the ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the ReturnPath
to be
feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 feedback@example.com
, then you would specify the
ReturnPathArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
,
and the ReturnPath
to be feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 feedback@example.com
, then you would specify the ReturnPathArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com
, and the ReturnPath
to be
feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
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 feedback@example.com
, then you would specify the
ReturnPathArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com
, and
the ReturnPath
to be feedback@example.com
.
For more information about sending authorization, see the Amazon SES Developer Guide.
public List<MessageTag> getTags()
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail
.
Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
SendEmail
. Tags correspond to characteristics of the email that you define, so that you can
publish email sending events.public void setTags(Collection<MessageTag> tags)
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail
.
Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
tags
- A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail
. Tags correspond to characteristics of the email that you define, so that you can
publish email sending events.public SendEmailRequest withTags(MessageTag... tags)
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail
.
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
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail
. Tags correspond to characteristics of the email that you define, so that you can
publish email sending events.public SendEmailRequest withTags(Collection<MessageTag> tags)
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail
.
Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
tags
- A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendEmail
. Tags correspond to characteristics of the email that you define, so that you can
publish email sending events.public void setConfigurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using SendEmail
.
configurationSetName
- The name of the configuration set to use when you send an email using SendEmail
.public String getConfigurationSetName()
The name of the configuration set to use when you send an email using SendEmail
.
SendEmail
.public SendEmailRequest withConfigurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using SendEmail
.
configurationSetName
- The name of the configuration set to use when you send an email using SendEmail
.public String toString()
toString
in class Object
Object.toString()
public SendEmailRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()