Class SendRawEmailRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for SendRawEmailRequest object.SendRawEmailRequest
(RawMessage rawMessage) Constructs a new SendRawEmailRequest object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.This parameter is used only for sending authorization.The raw text of the message.This parameter is used only for sending authorization.The identity's email address.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
The identity's email address.void
setSourceArn
(String sourceArn) This parameter is used only for sending authorization.toString()
Returns a string representation of this object; useful for testing and debugging.withDestinations
(String... destinations) A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.withDestinations
(Collection<String> destinations) A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.withFromArn
(String fromArn) This parameter is used only for sending authorization.withRawMessage
(RawMessage rawMessage) The raw text of the message.withReturnPathArn
(String returnPathArn) This parameter is used only for sending authorization.withSource
(String source) The identity's email address.withSourceArn
(String sourceArn) This parameter is used only for sending authorization.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
Constructor Details
-
SendRawEmailRequest
public SendRawEmailRequest()Default constructor for SendRawEmailRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
SendRawEmailRequest
Constructs a new SendRawEmailRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
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.
-
-
Method Details
-
setSource
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.- Parameters:
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.
-
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.- Returns:
- 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.
-
withSource
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDestinations
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
- Returns:
- A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
-
setDestinations
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
- Parameters:
destinations
- A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
-
withDestinations
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)
orwithDestinations(java.util.Collection)
if you want to override the existing values.- Parameters:
destinations
- A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDestinations
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
- Parameters:
destinations
- A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRawMessage
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withRawMessage
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFromArn
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 theFromArn
parameter and the corresponding X-header, Amazon SES uses the value of theFromArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Parameters:
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 theFromArn
parameter and the corresponding X-header, Amazon SES uses the value of theFromArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
-
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 theFromArn
parameter and the corresponding X-header, Amazon SES uses the value of theFromArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Returns:
- This parameter is used only for sending authorization. It is the
ARN of the identity that is associated with the sending
authorization policy that permits you to 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 theFromArn
parameter and the corresponding X-header, Amazon SES uses the value of theFromArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
-
withFromArn
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 theFromArn
parameter and the corresponding X-header, Amazon SES uses the value of theFromArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Parameters:
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 theFromArn
parameter and the corresponding X-header, Amazon SES uses the value of theFromArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSourceArn
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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.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 theSourceArn
parameter and the corresponding X-header, Amazon SES uses the value of theSourceArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Parameters:
sourceArn
- This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in theSource
parameter.For example, if the owner of
example.com
(which has ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.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 theSourceArn
parameter and the corresponding X-header, Amazon SES uses the value of theSourceArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
-
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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.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 theSourceArn
parameter and the corresponding X-header, Amazon SES uses the value of theSourceArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Returns:
- This parameter is used only for sending authorization. It is the
ARN of the identity that is associated with the sending
authorization policy that permits you to send for the email
address specified in the
Source
parameter.For example, if the owner of
example.com
(which has ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.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 theSourceArn
parameter and the corresponding X-header, Amazon SES uses the value of theSourceArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
-
withSourceArn
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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.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 theSourceArn
parameter and the corresponding X-header, Amazon SES uses the value of theSourceArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Parameters:
sourceArn
- This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in theSource
parameter.For example, if the owner of
example.com
(which has ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to send fromuser@example.com
, then you would specify theSourceArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theSource
to beuser@example.com
.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 theSourceArn
parameter and the corresponding X-header, Amazon SES uses the value of theSourceArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setReturnPathArn
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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.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 theReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of theReturnPathArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Parameters:
returnPathArn
- This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in theReturnPath
parameter.For example, if the owner of
example.com
(which has ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.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 theReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of theReturnPathArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
-
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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.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 theReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of theReturnPathArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Returns:
- This parameter is used only for sending authorization. It is the
ARN of the identity that is associated with the sending
authorization policy that permits you to use the email address
specified in the
ReturnPath
parameter.For example, if the owner of
example.com
(which has ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.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 theReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of theReturnPathArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.
-
withReturnPathArn
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 ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.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 theReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of theReturnPathArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Parameters:
returnPathArn
- This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in theReturnPath
parameter.For example, if the owner of
example.com
(which has ARNarn:aws:ses:us-east-1:123456789012:identity/example.com
) attaches a policy to it that authorizes you to usefeedback@example.com
, then you would specify theReturnPathArn
to bearn:aws:ses:us-east-1:123456789012:identity/example.com
, and theReturnPath
to befeedback@example.com
.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 theReturnPathArn
parameter and the corresponding X-header, Amazon SES uses the value of theReturnPathArn
parameter.For information about when to use this parameter, see the description of SendRawEmail
in this guide, or see the Amazon SES Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-