public static interface SendRawEmailRequest.Builder extends SESRequest.Builder, CopyableBuilder<SendRawEmailRequest.Builder,SendRawEmailRequest>
Modifier and Type | Method and Description |
---|---|
SendRawEmailRequest.Builder |
configurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using
SendRawEmail . |
SendRawEmailRequest.Builder |
destinations(Collection<String> destinations)
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
|
SendRawEmailRequest.Builder |
destinations(String... destinations)
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
|
SendRawEmailRequest.Builder |
fromArn(String fromArn)
This parameter is used only for sending authorization.
|
default SendRawEmailRequest.Builder |
rawMessage(Consumer<RawMessage.Builder> rawMessage)
The raw text of the message.
|
SendRawEmailRequest.Builder |
rawMessage(RawMessage rawMessage)
The raw text of the message.
|
SendRawEmailRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
SendRawEmailRequest.Builder |
returnPathArn(String returnPathArn)
This parameter is used only for sending authorization.
|
SendRawEmailRequest.Builder |
source(String source)
The identity's email address.
|
SendRawEmailRequest.Builder |
sourceArn(String sourceArn)
This parameter is used only for sending authorization.
|
SendRawEmailRequest.Builder |
tags(Collection<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 |
tags(MessageTag... tags)
A list of tags, in the form of name/value pairs, to apply to an email that you send using
SendRawEmail . |
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
SendRawEmailRequest.Builder source(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.
SendRawEmailRequest.Builder destinations(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.SendRawEmailRequest.Builder destinations(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.SendRawEmailRequest.Builder 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.
Must be base64-encoded.
Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.
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.
default SendRawEmailRequest.Builder rawMessage(Consumer<RawMessage.Builder> 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.
RawMessage.Builder
avoiding the need to create
one manually via RawMessage.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to rawMessage(RawMessage)
.rawMessage
- a consumer that will call methods on RawMessage.Builder
rawMessage(RawMessage)
SendRawEmailRequest.Builder fromArn(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.
SendRawEmailRequest.Builder sourceArn(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.
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.
SendRawEmailRequest.Builder returnPathArn(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.
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.
SendRawEmailRequest.Builder tags(Collection<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.
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.SendRawEmailRequest.Builder tags(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.
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.SendRawEmailRequest.Builder configurationSetName(String configurationSetName)
The name of the configuration set to use when you send an email using SendRawEmail
.
configurationSetName
- The name of the configuration set to use when you send an email using SendRawEmail
.SendRawEmailRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.