public class SendRawEmailRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.
NOOP
Constructor and Description |
---|
SendRawEmailRequest()
Default constructor for 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, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public SendRawEmailRequest()
public SendRawEmailRequest(RawMessage rawMessage)
rawMessage
- The raw text of the message. The client is responsible for
ensuring the following:
Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.
Content must be base64-encoded, if MIME requires it.
public void setSource(String 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.
If you specify the 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.
If you specify the 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 String getSource()
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.
If you specify the 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.
If you specify the 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)
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.
If you specify the 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.
If you specify the 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()
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
public void setDestinations(Collection<String> destinations)
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
destinations
- A list of destinations for the message, consisting of To:, CC:,
and BCC: addresses.public SendRawEmailRequest withDestinations(String... destinations)
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
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.
destinations
- A list of destinations for the message, consisting of To:, CC:,
and BCC: addresses.public SendRawEmailRequest withDestinations(Collection<String> destinations)
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
destinations
- A list of destinations for the message, consisting of To:, CC:,
and BCC: addresses.public void setRawMessage(RawMessage rawMessage)
The raw text of the message. The client is responsible for ensuring the following:
Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.
Content must be base64-encoded, if MIME requires it.
rawMessage
- The raw text of the message. The client is responsible for
ensuring the following:
Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.
Content must be base64-encoded, if MIME requires it.
public RawMessage getRawMessage()
The raw text of the message. The client is responsible for ensuring the following:
Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.
Content must be base64-encoded, if MIME requires it.
Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.
Content must be base64-encoded, if MIME requires it.
public SendRawEmailRequest withRawMessage(RawMessage rawMessage)
The raw text of the message. The client is responsible for ensuring the following:
Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.
Content must be base64-encoded, if MIME requires it.
rawMessage
- The raw text of the message. The client is responsible for
ensuring the following:
Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.
Content must be base64-encoded, if MIME requires it.
public void setFromArn(String 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.
For information about when to use this parameter, see the description of
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.
For information about when to use this parameter, see the
description of SendRawEmail
in this guide, or see the
Amazon SES Developer Guide.
public String getFromArn()
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.
For information about when to use this parameter, see the description of
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.
For information about when to use this parameter, see the
description of SendRawEmail
in this guide, or see
the Amazon SES Developer Guide.
public SendRawEmailRequest withFromArn(String 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.
For information about when to use this parameter, see the description of
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.
For information about when to use this parameter, see the
description of SendRawEmail
in this guide, or see the
Amazon SES Developer Guide.
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]
.
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.
For information about when to use this parameter, see the description of
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.
For information about when to use this parameter, see the
description of SendRawEmail
in this guide, or 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
[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.
For information about when to use this parameter, see the description of
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.
For information about when to use this parameter, see the
description of SendRawEmail
in this guide, or see
the Amazon SES Developer Guide.
public SendRawEmailRequest 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]
.
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.
For information about when to use this parameter, see the description of
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.
For information about when to use this parameter, see the
description of SendRawEmail
in this guide, or 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
[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.
For information about when to use this parameter, see the description of
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.
For information about when to use this parameter, see the
description of SendRawEmail
in this guide, or 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
[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.
For information about when to use this parameter, see the description of
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.
For information about when to use this parameter, see the
description of SendRawEmail
in this guide, or see
the Amazon SES Developer Guide.
public SendRawEmailRequest 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]
.
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.
For information about when to use this parameter, see the description of
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.
For information about when to use this parameter, see the
description of 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 © 2016. All rights reserved.