public class SendEmailRequest extends AmazonWebServiceRequest implements java.io.Serializable
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.
Constructor and Description |
---|
SendEmailRequest()
Default constructor for SendEmailRequest object.
|
SendEmailRequest(java.lang.String source,
Destination destination,
Message message)
Constructs a new SendEmailRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
Destination |
getDestination()
The destination for this email, composed of To:, CC:, and BCC: fields.
|
Message |
getMessage()
The message to be sent.
|
java.util.List<java.lang.String> |
getReplyToAddresses()
The reply-to email address(es) for the message.
|
java.lang.String |
getReturnPath()
The email address to which bounces and complaints are to be forwarded
when feedback forwarding is enabled.
|
java.lang.String |
getReturnPathArn()
This parameter is used only for sending authorization.
|
java.lang.String |
getSource()
The email address that is sending the email.
|
java.lang.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(java.util.Collection<java.lang.String> replyToAddresses)
The reply-to email address(es) for the message.
|
void |
setReturnPath(java.lang.String returnPath)
The email address to which bounces and complaints are to be forwarded
when feedback forwarding is enabled.
|
void |
setReturnPathArn(java.lang.String returnPathArn)
This parameter is used only for sending authorization.
|
void |
setSource(java.lang.String source)
The email address that is sending the email.
|
void |
setSourceArn(java.lang.String sourceArn)
This parameter is used only for sending authorization.
|
java.lang.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(java.util.Collection<java.lang.String> replyToAddresses)
The reply-to email address(es) for the message.
|
SendEmailRequest |
withReplyToAddresses(java.lang.String... replyToAddresses)
The reply-to email address(es) for the message.
|
SendEmailRequest |
withReturnPath(java.lang.String returnPath)
The email address to which bounces and complaints are to be forwarded
when feedback forwarding is enabled.
|
SendEmailRequest |
withReturnPathArn(java.lang.String returnPathArn)
This parameter is used only for sending authorization.
|
SendEmailRequest |
withSource(java.lang.String source)
The email address that is sending the email.
|
SendEmailRequest |
withSourceArn(java.lang.String sourceArn)
This parameter is used only for sending authorization.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public SendEmailRequest()
public SendEmailRequest(java.lang.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.
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.
public java.lang.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.
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.
public void setSource(java.lang.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.
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.
public SendEmailRequest withSource(java.lang.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.
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.
public Destination getDestination()
The destination for this email, composed of To:, CC:, and BCC: fields.
The destination for this email, composed of To:, CC:, and BCC: fields.
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 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.
destination
- The destination for this email, composed of To:, CC:, and BCC: fields.
public Message getMessage()
The message to be sent.
The message to be sent.
public void setMessage(Message message)
The message to be sent.
message
- The message to be sent.
public SendEmailRequest withMessage(Message message)
The message to be sent.
Returns a reference to this object so that method calls can be chained together.
message
- The message to be sent.
public java.util.List<java.lang.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.
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
public void setReplyToAddresses(java.util.Collection<java.lang.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.
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.
public SendEmailRequest withReplyToAddresses(java.lang.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.
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.
public SendEmailRequest withReplyToAddresses(java.util.Collection<java.lang.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.
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.
public java.lang.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.
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.
public void setReturnPath(java.lang.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.
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.
public SendEmailRequest withReturnPath(java.lang.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.
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.
public java.lang.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.
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 setSourceArn(java.lang.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 SendEmailRequest withSourceArn(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.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.
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 void setReturnPathArn(java.lang.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 SendEmailRequest withReturnPathArn(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.