com.amazonaws.services.simpleemail.model

Class SendRawEmailRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemail.model.SendRawEmailRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SendRawEmailRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Composes an email message and immediately queues it for sending.

This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.

The SendRawEmail operation has the following requirements:

• You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an "Email address not verified" error.

• If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.

• The maximum message size, including attachments, is 10 MB.

• Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.

• If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.

• Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.

• Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.

Additionally, keep the following considerations in mind when using the SendRawEmail operation:

• Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.

• If you are using sending authorization to send on behalf of another user, 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

  Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.

  If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.

  For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.

• For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendRawEmailRequest() Default constructor for SendRawEmailRequest object.
SendRawEmailRequest(RawMessage rawMessage) Constructs a new SendRawEmailRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getConfigurationSetName() The name of the configuration set to use when you send an email using SendRawEmail.
java.util.List<java.lang.String>	getDestinations() A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
java.lang.String	getFromArn() This parameter is used only for sending authorization.
RawMessage	getRawMessage() The raw email message itself.
java.lang.String	getReturnPathArn() This parameter is used only for sending authorization.
java.lang.String	getSource() The identity's email address.
java.lang.String	getSourceArn() This parameter is used only for sending authorization.
java.util.List<MessageTag>	getTags() A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail.
int	hashCode()
void	setConfigurationSetName(java.lang.String configurationSetName) The name of the configuration set to use when you send an email using SendRawEmail.
void	setDestinations(java.util.Collection<java.lang.String> destinations) A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
void	setFromArn(java.lang.String fromArn) This parameter is used only for sending authorization.
void	setRawMessage(RawMessage rawMessage) The raw email message itself.
void	setReturnPathArn(java.lang.String returnPathArn) This parameter is used only for sending authorization.
void	setSource(java.lang.String source) The identity's email address.
void	setSourceArn(java.lang.String sourceArn) This parameter is used only for sending authorization.
void	setTags(java.util.Collection<MessageTag> tags) A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SendRawEmailRequest	withConfigurationSetName(java.lang.String configurationSetName) The name of the configuration set to use when you send an email using SendRawEmail.
SendRawEmailRequest	withDestinations(java.util.Collection<java.lang.String> destinations) A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
SendRawEmailRequest	withDestinations(java.lang.String... destinations) A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
SendRawEmailRequest	withFromArn(java.lang.String fromArn) This parameter is used only for sending authorization.
SendRawEmailRequest	withRawMessage(RawMessage rawMessage) The raw email message itself.
SendRawEmailRequest	withReturnPathArn(java.lang.String returnPathArn) This parameter is used only for sending authorization.
SendRawEmailRequest	withSource(java.lang.String source) The identity's email address.
SendRawEmailRequest	withSourceArn(java.lang.String sourceArn) This parameter is used only for sending authorization.
SendRawEmailRequest	withTags(java.util.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	withTags(MessageTag... tags) A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendRawEmailRequest

public SendRawEmailRequest()

Default constructor for SendRawEmailRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

SendRawEmailRequest

public SendRawEmailRequest(RawMessage rawMessage)

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 email message itself. The message has to meet the following criteria:

• The message has to contain a header and a body, separated by a blank line.

• All of the required header fields must be present in the message.

• Each part of a multipart MIME message must be formatted properly.

• Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.

• The entire message must be base64-encoded.

• If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.

• Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

Method Detail

getSource

public java.lang.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.)

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

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.)

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

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.

setSource

public void setSource(java.lang.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.)

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

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.)

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

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

public SendRawEmailRequest withSource(java.lang.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.)

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

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 a reference to this object so that method calls can be chained together.

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.)

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

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:

A reference to this updated object so that method calls can be chained together.

getDestinations

public java.util.List<java.lang.String> 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

public void setDestinations(java.util.Collection<java.lang.String> destinations)

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

public SendRawEmailRequest withDestinations(java.lang.String... destinations)

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

Returns a reference to this object so that method calls can be chained together.

Parameters:

destinations -

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

Returns:

A reference to this updated object so that method calls can be chained together.

withDestinations

public SendRawEmailRequest withDestinations(java.util.Collection<java.lang.String> destinations)

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

Returns a reference to this object so that method calls can be chained together.

Parameters:

destinations -

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

Returns:

A reference to this updated object so that method calls can be chained together.

getRawMessage

public RawMessage getRawMessage()

The raw email message itself. The message has to meet the following criteria:

• The message has to contain a header and a body, separated by a blank line.

• All of the required header fields must be present in the message.

• Each part of a multipart MIME message must be formatted properly.

• Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.

• The entire message must be base64-encoded.

• If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.

• Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

Returns:

The raw email message itself. The message has to meet the following criteria:

• The message has to contain a header and a body, separated by a blank line.

• All of the required header fields must be present in the message.

• Each part of a multipart MIME message must be formatted properly.

• Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.

• The entire message must be base64-encoded.

• If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.

• Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

setRawMessage

public void setRawMessage(RawMessage rawMessage)

The raw email message itself. The message has to meet the following criteria:

• The message has to contain a header and a body, separated by a blank line.

• All of the required header fields must be present in the message.

• Each part of a multipart MIME message must be formatted properly.

• Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.

• The entire message must be base64-encoded.

• If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.

• Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

Parameters:

rawMessage -

The raw email message itself. The message has to meet the following criteria:

• The message has to contain a header and a body, separated by a blank line.

• All of the required header fields must be present in the message.

• Each part of a multipart MIME message must be formatted properly.

• Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.

• The entire message must be base64-encoded.

• If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.

• Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

withRawMessage

public SendRawEmailRequest withRawMessage(RawMessage rawMessage)

The raw email message itself. The message has to meet the following criteria:

• The message has to contain a header and a body, separated by a blank line.

• All of the required header fields must be present in the message.

• Each part of a multipart MIME message must be formatted properly.

• Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.

• The entire message must be base64-encoded.

• If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.

• Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

Returns a reference to this object so that method calls can be chained together.

Parameters:

rawMessage -

The raw email message itself. The message has to meet the following criteria:

• The message has to contain a header and a body, separated by a blank line.

• All of the required header fields must be present in the message.

• Each part of a multipart MIME message must be formatted properly.

• Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.

• The entire message must be base64-encoded.

• If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.

• Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

Returns:

A reference to this updated object so that method calls can be chained together.

getFromArn

public java.lang.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.

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 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.

setFromArn

public void setFromArn(java.lang.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.

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 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.

withFromArn

public SendRawEmailRequest withFromArn(java.lang.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.

Returns a reference to this object so that method calls can be chained together.

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 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getSourceArn

public java.lang.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 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.

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 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.

setSourceArn

public void setSourceArn(java.lang.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.

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 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.

withSourceArn

public SendRawEmailRequest withSourceArn(java.lang.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.

Returns a reference to this object so that method calls can be chained together.

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 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getReturnPathArn

public java.lang.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 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.

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 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.

setReturnPathArn

public void setReturnPathArn(java.lang.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.

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 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.

withReturnPathArn

public SendRawEmailRequest withReturnPathArn(java.lang.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.

Returns a reference to this object so that method calls can be chained together.

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 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public java.util.List<MessageTag> getTags()

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.

Returns:

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.

setTags

public void setTags(java.util.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.

Parameters:

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.

withTags

public SendRawEmailRequest withTags(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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

withTags

public SendRawEmailRequest withTags(java.util.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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getConfigurationSetName

public java.lang.String getConfigurationSetName()

The name of the configuration set to use when you send an email using SendRawEmail.

Returns:

The name of the configuration set to use when you send an email using SendRawEmail.

setConfigurationSetName

public void setConfigurationSetName(java.lang.String configurationSetName)

The name of the configuration set to use when you send an email using SendRawEmail.

Parameters:

configurationSetName -

The name of the configuration set to use when you send an email using SendRawEmail.

withConfigurationSetName

public SendRawEmailRequest withConfigurationSetName(java.lang.String configurationSetName)

The name of the configuration set to use when you send an email using SendRawEmail.

Returns a reference to this object so that method calls can be chained together.

Parameters:

configurationSetName -

The name of the configuration set to use when you send an email using SendRawEmail.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object