/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.simpleemail.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SendRawEmailRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** 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.
*
* A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. *
*/ private com.amazonaws.internal.SdkInternalList* 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. *
** 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.
*
* 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.
*
* 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.
*
* 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.
*
* The name of the configuration set to use when you send an email using SendRawEmail
.
*
* 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. *
** 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.
*
* 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.
*/
public void setSource(String source) {
this.source = 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.
*
* 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.
*/
public String getSource() {
return this.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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendRawEmailRequest withSource(String source) {
setSource(source);
return this;
}
/**
*
* A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. *
* * @return A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. */ public java.util.List* A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. *
* * @param destinations * A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. */ public void setDestinations(java.util.Collection* 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 * {@link #setDestinations(java.util.Collection)} or {@link #withDestinations(java.util.Collection)} if you want to * override the existing values. *
* * @param destinations * A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. * @return Returns a reference to this object so that method calls can be chained together. */ public SendRawEmailRequest withDestinations(String... destinations) { if (this.destinations == null) { setDestinations(new com.amazonaws.internal.SdkInternalList* A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. *
* * @param destinations * A list of destinations for the message, consisting of To:, CC:, and BCC: addresses. * @return Returns a reference to this object so that method calls can be chained together. */ public SendRawEmailRequest withDestinations(java.util.Collection* 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
SendRawEmail
. Tags correspond to characteristics of the email that you define, so that you
* can publish email sending events.
*/
public java.util.List
* 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.
*
SendRawEmail
. Tags correspond to characteristics of the email that you define, so that you
* can publish email sending events.
*/
public void setTags(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendRawEmailRequest withTags(MessageTag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList
* 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.
*
SendRawEmail
. Tags correspond to characteristics of the email that you define, so that you
* can publish email sending events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendRawEmailRequest withTags(java.util.Collection
* The name of the configuration set to use when you send an email using SendRawEmail
.
*
SendRawEmail
.
*/
public void setConfigurationSetName(String configurationSetName) {
this.configurationSetName = configurationSetName;
}
/**
*
* The name of the configuration set to use when you send an email using SendRawEmail
.
*
SendRawEmail
.
*/
public String getConfigurationSetName() {
return this.configurationSetName;
}
/**
*
* The name of the configuration set to use when you send an email using SendRawEmail
.
*
SendRawEmail
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendRawEmailRequest withConfigurationSetName(String configurationSetName) {
setConfigurationSetName(configurationSetName);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSource() != null)
sb.append("Source: ").append(getSource()).append(",");
if (getDestinations() != null)
sb.append("Destinations: ").append(getDestinations()).append(",");
if (getRawMessage() != null)
sb.append("RawMessage: ").append(getRawMessage()).append(",");
if (getFromArn() != null)
sb.append("FromArn: ").append(getFromArn()).append(",");
if (getSourceArn() != null)
sb.append("SourceArn: ").append(getSourceArn()).append(",");
if (getReturnPathArn() != null)
sb.append("ReturnPathArn: ").append(getReturnPathArn()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getConfigurationSetName() != null)
sb.append("ConfigurationSetName: ").append(getConfigurationSetName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SendRawEmailRequest == false)
return false;
SendRawEmailRequest other = (SendRawEmailRequest) obj;
if (other.getSource() == null ^ this.getSource() == null)
return false;
if (other.getSource() != null && other.getSource().equals(this.getSource()) == false)
return false;
if (other.getDestinations() == null ^ this.getDestinations() == null)
return false;
if (other.getDestinations() != null && other.getDestinations().equals(this.getDestinations()) == false)
return false;
if (other.getRawMessage() == null ^ this.getRawMessage() == null)
return false;
if (other.getRawMessage() != null && other.getRawMessage().equals(this.getRawMessage()) == false)
return false;
if (other.getFromArn() == null ^ this.getFromArn() == null)
return false;
if (other.getFromArn() != null && other.getFromArn().equals(this.getFromArn()) == false)
return false;
if (other.getSourceArn() == null ^ this.getSourceArn() == null)
return false;
if (other.getSourceArn() != null && other.getSourceArn().equals(this.getSourceArn()) == false)
return false;
if (other.getReturnPathArn() == null ^ this.getReturnPathArn() == null)
return false;
if (other.getReturnPathArn() != null && other.getReturnPathArn().equals(this.getReturnPathArn()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getConfigurationSetName() == null ^ this.getConfigurationSetName() == null)
return false;
if (other.getConfigurationSetName() != null && other.getConfigurationSetName().equals(this.getConfigurationSetName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode());
hashCode = prime * hashCode + ((getDestinations() == null) ? 0 : getDestinations().hashCode());
hashCode = prime * hashCode + ((getRawMessage() == null) ? 0 : getRawMessage().hashCode());
hashCode = prime * hashCode + ((getFromArn() == null) ? 0 : getFromArn().hashCode());
hashCode = prime * hashCode + ((getSourceArn() == null) ? 0 : getSourceArn().hashCode());
hashCode = prime * hashCode + ((getReturnPathArn() == null) ? 0 : getReturnPathArn().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getConfigurationSetName() == null) ? 0 : getConfigurationSetName().hashCode());
return hashCode;
}
@Override
public SendRawEmailRequest clone() {
return (SendRawEmailRequest) super.clone();
}
}