public class SendRawEmailRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
SendRawEmail operation
.
Sends an email message, with header and content specified by the
client. The SendRawEmail
action is useful for sending
multipart MIME emails. The raw text of the message must comply with
Internet email standards; otherwise, the message cannot be sent.
There are several important points to know about
SendRawEmail
:
SendRawEmail
enables you to specify the
cross-account identity for the email's "Source," "From," and
"Return-Path" parameters in one of two ways: you can pass optional
parameters SourceArn
,
FromArn
, and/or
ReturnPathArn
to the API, or you can include the
following X-headers in the header of your raw email:
X-SES-SOURCE-ARN
X-SES-FROM-ARN
X-SES-RETURN-PATH-ARN
IMPORTANT:Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For the most common sending authorization use case, we recommend that you specify theSourceIdentityArn
and do not specify
either the FromIdentityArn
or
ReturnPathIdentityArn
. (The same note applies to the
corresponding X-headers.) If you only specify the
SourceIdentityArn
, Amazon SES will simply set the "From"
address and the "Return Path" address to the identity specified in
SourceIdentityArn
. For more information about sending
authorization, see the
Amazon SES Developer Guide
.NOOP
Constructor and Description |
---|
SendRawEmailRequest()
Default constructor for a new SendRawEmailRequest object.
|
SendRawEmailRequest(RawMessage rawMessage)
Constructs a new SendRawEmailRequest object.
|
Modifier and Type | Method and Description |
---|---|
SendRawEmailRequest |
clone() |
boolean |
equals(Object obj) |
List<String> |
getDestinations()
A list of destinations for the message, consisting of To:, CC:, and
BCC: addresses.
|
String |
getFromArn()
This parameter is used only for sending authorization.
|
RawMessage |
getRawMessage()
The raw text of the message.
|
String |
getReturnPathArn()
This parameter is used only for sending authorization.
|
String |
getSource()
The identity's email address.
|
String |
getSourceArn()
This parameter is used only for sending authorization.
|
int |
hashCode() |
void |
setDestinations(Collection<String> destinations)
A list of destinations for the message, consisting of To:, CC:, and
BCC: addresses.
|
void |
setFromArn(String fromArn)
This parameter is used only for sending authorization.
|
void |
setRawMessage(RawMessage rawMessage)
The raw text of the message.
|
void |
setReturnPathArn(String returnPathArn)
This parameter is used only for sending authorization.
|
void |
setSource(String source)
The identity's email address.
|
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.
|
SendRawEmailRequest |
withDestinations(Collection<String> destinations)
A list of destinations for the message, consisting of To:, CC:, and
BCC: addresses.
|
SendRawEmailRequest |
withDestinations(String... destinations)
A list of destinations for the message, consisting of To:, CC:, and
BCC: addresses.
|
SendRawEmailRequest |
withFromArn(String fromArn)
This parameter is used only for sending authorization.
|
SendRawEmailRequest |
withRawMessage(RawMessage rawMessage)
The raw text of the message.
|
SendRawEmailRequest |
withReturnPathArn(String returnPathArn)
This parameter is used only for sending authorization.
|
SendRawEmailRequest |
withSource(String source)
The identity's email address.
|
SendRawEmailRequest |
withSourceArn(String sourceArn)
This parameter is used only for sending authorization.
|
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public SendRawEmailRequest()
public SendRawEmailRequest(RawMessage rawMessage)
rawMessage
- The raw text of the message. The client is
responsible for ensuring the following:
public String getSource()
By default, the string 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
parameter and have
feedback forwarding enabled, then bounces and complaints will be sent
to this email address. This takes precedence over any
Return-Path header that you might include in the raw text of
the message.
By default, the string 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
parameter and have
feedback forwarding enabled, then bounces and complaints will be sent
to this email address. This takes precedence over any
Return-Path header that you might include in the raw text of
the message.
public void setSource(String source)
By default, the string 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
parameter and have
feedback forwarding enabled, then bounces and complaints will be sent
to this email address. This takes precedence over any
Return-Path header that you might include in the raw text of
the message.
source
- The identity's email address. If you do not provide a value for this
parameter, you must specify a "From" address in the raw text of the
message. (You can also specify both.) By default, the string 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
parameter and have
feedback forwarding enabled, then bounces and complaints will be sent
to this email address. This takes precedence over any
Return-Path header that you might include in the raw text of
the message.
public SendRawEmailRequest withSource(String source)
By default, the string 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
parameter and have
feedback forwarding enabled, then bounces and complaints will be sent
to this email address. This takes precedence over any
Return-Path header that you might include in the raw text of
the message.
Returns a reference to this object so that method calls can be chained together.
source
- The identity's email address. If you do not provide a value for this
parameter, you must specify a "From" address in the raw text of the
message. (You can also specify both.) By default, the string 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
parameter and have
feedback forwarding enabled, then bounces and complaints will be sent
to this email address. This takes precedence over any
Return-Path header that you might include in the raw text of
the message.
public List<String> getDestinations()
public void setDestinations(Collection<String> destinations)
destinations
- A list of destinations for the message, consisting of To:, CC:, and
BCC: addresses.public SendRawEmailRequest withDestinations(String... destinations)
NOTE: This method appends the values to the existing list (if
any). Use setDestinations(java.util.Collection)
or withDestinations(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.
destinations
- A list of destinations for the message, consisting of To:, CC:, and
BCC: addresses.public SendRawEmailRequest withDestinations(Collection<String> destinations)
Returns a reference to this object so that method calls can be chained together.
destinations
- A list of destinations for the message, consisting of To:, CC:, and
BCC: addresses.public RawMessage getRawMessage()
public void setRawMessage(RawMessage rawMessage)
rawMessage
- The raw text of the message. The client is responsible for ensuring
the following:
public SendRawEmailRequest withRawMessage(RawMessage rawMessage)
Returns a reference to this object so that method calls can be chained together.
rawMessage
- The raw text of the message. The client is responsible for ensuring
the following:
public String getFromArn()
Instead of using this parameter, you can
use the X-header X-SES-FROM-ARN
in the raw message of the
email. If you use both the FromArn
parameter and the
corresponding X-header, Amazon SES uses the value of the
FromArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
Instead of using this parameter, you can
use the X-header X-SES-FROM-ARN
in the raw message of the
email. If you use both the FromArn
parameter and the
corresponding X-header, Amazon SES uses the value of the
FromArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
public void setFromArn(String fromArn)
Instead of using this parameter, you can
use the X-header X-SES-FROM-ARN
in the raw message of the
email. If you use both the FromArn
parameter and the
corresponding X-header, Amazon SES uses the value of the
FromArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
fromArn
- 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 specify a particular "From" address in the
header of the raw email. Instead of using this parameter, you can
use the X-header X-SES-FROM-ARN
in the raw message of the
email. If you use both the FromArn
parameter and the
corresponding X-header, Amazon SES uses the value of the
FromArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
public SendRawEmailRequest withFromArn(String fromArn)
Instead of using this parameter, you can
use the X-header X-SES-FROM-ARN
in the raw message of the
email. If you use both the FromArn
parameter and the
corresponding X-header, Amazon SES uses the value of the
FromArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
Returns a reference to this object so that method calls can be chained together.
fromArn
- 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 specify a particular "From" address in the
header of the raw email. Instead of using this parameter, you can
use the X-header X-SES-FROM-ARN
in the raw message of the
email. If you use both the FromArn
parameter and the
corresponding X-header, Amazon SES uses the value of the
FromArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
public String getSourceArn()
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]
.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you
use both the SourceArn
parameter and the corresponding
X-header, Amazon SES uses the value of the SourceArn
parameter. SendRawEmail
in this guide, or 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
[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]
.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you
use both the SourceArn
parameter and the corresponding
X-header, Amazon SES uses the value of the SourceArn
parameter. SendRawEmail
in this guide, or see the
Amazon
SES Developer Guide.
public void setSourceArn(String sourceArn)
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]
.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you
use both the SourceArn
parameter and the corresponding
X-header, Amazon SES uses the value of the SourceArn
parameter. SendRawEmail
in this guide, or 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
[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]
.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you
use both the SourceArn
parameter and the corresponding
X-header, Amazon SES uses the value of the SourceArn
parameter. SendRawEmail
in this guide, or see the
Amazon
SES Developer Guide.
public SendRawEmailRequest withSourceArn(String sourceArn)
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]
.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you
use both the SourceArn
parameter and the corresponding
X-header, Amazon SES uses the value of the SourceArn
parameter. SendRawEmail
in this guide, or 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
[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]
.
Instead of using this parameter, you can use the X-header
X-SES-SOURCE-ARN
in the raw message of the email. If you
use both the SourceArn
parameter and the corresponding
X-header, Amazon SES uses the value of the SourceArn
parameter. SendRawEmail
in this guide, or see the
Amazon
SES Developer Guide.
public String getReturnPathArn()
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]
.
Instead of using this parameter,
you can use the X-header X-SES-RETURN-PATH-ARN
in the raw
message of the email. If you use both the ReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of
the ReturnPathArn
parameter. SendRawEmail
in this guide, or 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
[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]
.
Instead of using this parameter,
you can use the X-header X-SES-RETURN-PATH-ARN
in the raw
message of the email. If you use both the ReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of
the ReturnPathArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
public void setReturnPathArn(String returnPathArn)
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]
.
Instead of using this parameter,
you can use the X-header X-SES-RETURN-PATH-ARN
in the raw
message of the email. If you use both the ReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of
the ReturnPathArn
parameter. SendRawEmail
in this guide, or 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
[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]
.
Instead of using this parameter,
you can use the X-header X-SES-RETURN-PATH-ARN
in the raw
message of the email. If you use both the ReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of
the ReturnPathArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
public SendRawEmailRequest withReturnPathArn(String returnPathArn)
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]
.
Instead of using this parameter,
you can use the X-header X-SES-RETURN-PATH-ARN
in the raw
message of the email. If you use both the ReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of
the ReturnPathArn
parameter. SendRawEmail
in this guide, or 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
[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]
.
Instead of using this parameter,
you can use the X-header X-SES-RETURN-PATH-ARN
in the raw
message of the email. If you use both the ReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of
the ReturnPathArn
parameter. SendRawEmail
in this guide, or see the Amazon
SES Developer Guide.
public String toString()
toString
in class Object
Object.toString()
public SendRawEmailRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.