@Generated(value="software.amazon.awssdk:codegen") public class SendRawEmailRequest extends SESRequest implements ToCopyableBuilder<SendRawEmailRequest.Builder,SendRawEmailRequest>
Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.
Modifier and Type | Class and Description |
---|---|
static interface |
SendRawEmailRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static SendRawEmailRequest.Builder |
builder() |
String |
configurationSetName()
The name of the configuration set to use when you send an email using
SendRawEmail . |
List<String> |
destinations()
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
|
boolean |
equals(Object obj) |
String |
fromArn()
This parameter is used only for sending authorization.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
RawMessage |
rawMessage()
The raw text of the message.
|
String |
returnPathArn()
This parameter is used only for sending authorization.
|
static Class<? extends SendRawEmailRequest.Builder> |
serializableBuilderClass() |
String |
source()
The identity's email address.
|
String |
sourceArn()
This parameter is used only for sending authorization.
|
List<MessageTag> |
tags()
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendRawEmail . |
SendRawEmailRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public 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.
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> destinations()
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
Must be base64-encoded.
Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.
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.
Must be base64-encoded.
Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.
public 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.
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 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
.
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 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
.
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 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
.
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 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
.
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 List<MessageTag> tags()
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendRawEmail
. Tags correspond to characteristics of the email that you define, so that you can
publish email sending events.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
SendRawEmail
. Tags correspond to characteristics of the email that you define, so that you
can publish email sending events.public String configurationSetName()
The name of the configuration set to use when you send an email using SendRawEmail
.
SendRawEmail
.public SendRawEmailRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SendRawEmailRequest.Builder,SendRawEmailRequest>
toBuilder
in class SESRequest
public static SendRawEmailRequest.Builder builder()
public static Class<? extends SendRawEmailRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.