All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.simpleemail.model.SendRawEmailRequest Maven / Gradle / Ivy

/*
 * Copyright 2010-2016 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 com.amazonaws.AmazonWebServiceRequest;

/**
 * 
 */
public class SendRawEmailRequest extends 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.) *

*

* 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. */ private String source; /** *

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

*/ private com.amazonaws.internal.SdkInternalList destinations; /** *

* The raw text of the message. The client is responsible for ensuring the * following: *

*

*

    *
  • Message must contain a header and a body, separated by a blank line.
  • *
  • All required header fields must be present.
  • *
  • Each part of a multipart MIME message must be formatted properly.
  • *
  • MIME content types must be among those supported by Amazon SES. For * more information, go to the Amazon SES Developer Guide.
  • *
  • Content must be base64-encoded, if MIME requires it.
  • *
*

*/ private RawMessage rawMessage; /** *

* 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. */ private 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 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 * [email protected], then you would specify the * SourceArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com, and * the Source to be [email protected]. *

*

* 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. */ private 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 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 * [email protected], then you would specify the * ReturnPathArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com, and * the ReturnPath to be [email protected]. *

*

* 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. */ private String returnPathArn; /** * Default constructor for SendRawEmailRequest object. Callers should use * the setter or fluent setter (with...) methods to initialize the object * after creating it. */ public SendRawEmailRequest() { } /** * Constructs a new SendRawEmailRequest object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. * * @param rawMessage * The raw text of the message. The client is responsible for * ensuring the following:

*

*

    *
  • Message must contain a header and a body, separated by a blank * line.
  • *
  • All required header fields must be present.
  • *
  • Each part of a multipart MIME message must be formatted * properly.
  • *
  • MIME content types must be among those supported by Amazon * SES. For more information, go to the Amazon SES Developer Guide.
  • *
  • Content must be base64-encoded, if MIME requires it.
  • *
*/ public SendRawEmailRequest(RawMessage rawMessage) { setRawMessage(rawMessage); } /** *

* 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. * * @param 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. */ 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.) *

*

* 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. * * @return 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. */ 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.) *

*

* 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. * * @param 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. * @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 getDestinations() { if (destinations == null) { destinations = new com.amazonaws.internal.SdkInternalList(); } return destinations; } /** *

* 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 destinations) { if (destinations == null) { this.destinations = null; return; } this.destinations = new com.amazonaws.internal.SdkInternalList( destinations); } /** *

* 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( destinations.length)); } for (String ele : destinations) { this.destinations.add(ele); } return this; } /** *

* 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 destinations) { setDestinations(destinations); return this; } /** *

* The raw text of the message. The client is responsible for ensuring the * following: *

*

*

    *
  • Message must contain a header and a body, separated by a blank line.
  • *
  • All required header fields must be present.
  • *
  • Each part of a multipart MIME message must be formatted properly.
  • *
  • MIME content types must be among those supported by Amazon SES. For * more information, go to the Amazon SES Developer Guide.
  • *
  • Content must be base64-encoded, if MIME requires it.
  • *
*

* * @param rawMessage * The raw text of the message. The client is responsible for * ensuring the following:

*

*

    *
  • Message must contain a header and a body, separated by a blank * line.
  • *
  • All required header fields must be present.
  • *
  • Each part of a multipart MIME message must be formatted * properly.
  • *
  • MIME content types must be among those supported by Amazon * SES. For more information, go to the Amazon SES Developer Guide.
  • *
  • Content must be base64-encoded, if MIME requires it.
  • *
*/ public void setRawMessage(RawMessage rawMessage) { this.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.
  • *
  • Content must be base64-encoded, if MIME requires it.
  • *
*

* * @return The raw text of the message. The client is responsible for * ensuring the following:

*

*

    *
  • Message must contain a header and a body, separated by a * blank line.
  • *
  • All required header fields must be present.
  • *
  • Each part of a multipart MIME message must be formatted * properly.
  • *
  • MIME content types must be among those supported by Amazon * SES. For more information, go to the Amazon SES Developer Guide.
  • *
  • Content must be base64-encoded, if MIME requires it.
  • *
*/ public RawMessage getRawMessage() { return this.rawMessage; } /** *

* The raw text of the message. The client is responsible for ensuring the * following: *

*

*

    *
  • Message must contain a header and a body, separated by a blank line.
  • *
  • All required header fields must be present.
  • *
  • Each part of a multipart MIME message must be formatted properly.
  • *
  • MIME content types must be among those supported by Amazon SES. For * more information, go to the Amazon SES Developer Guide.
  • *
  • Content must be base64-encoded, if MIME requires it.
  • *
*

* * @param rawMessage * The raw text of the message. The client is responsible for * ensuring the following:

*

*

    *
  • Message must contain a header and a body, separated by a blank * line.
  • *
  • All required header fields must be present.
  • *
  • Each part of a multipart MIME message must be formatted * properly.
  • *
  • MIME content types must be among those supported by Amazon * SES. For more information, go to the Amazon SES Developer Guide.
  • *
  • Content must be base64-encoded, if MIME requires it.
  • *
* @return Returns a reference to this object so that method calls can be * chained together. */ public SendRawEmailRequest withRawMessage(RawMessage rawMessage) { setRawMessage(rawMessage); return this; } /** *

* 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. * * @param 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. */ public void setFromArn(String fromArn) { this.fromArn = 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. * * @return 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. */ public String getFromArn() { return this.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. * * @param 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. * @return Returns a reference to this object so that method calls can be * chained together. */ public SendRawEmailRequest withFromArn(String fromArn) { setFromArn(fromArn); return this; } /** *

* 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 * [email protected], then you would specify the * SourceArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com, and * the Source to be [email protected]. *

*

* 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. * * @param 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 * [email protected], then you would specify the * SourceArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com * , and the Source to be [email protected]. *

*

* Instead of using this parameter, you can use the X-header * X-SES-SOURCE-ARN in the raw message of the email. If * you use both the SourceArn parameter and the * corresponding X-header, Amazon SES uses the value of the * SourceArn parameter. *

* For information about when to use this parameter, see the * description of SendRawEmail in this guide, or see the * Amazon SES Developer Guide. */ public void setSourceArn(String sourceArn) { this.sourceArn = 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 * [email protected], then you would specify the * SourceArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com, and * the Source to be [email protected]. *

*

* 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. * * @return 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 * [email protected], then you would specify the * SourceArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com * , and the Source to be [email protected] * . *

*

* Instead of using this parameter, you can use the X-header * X-SES-SOURCE-ARN in the raw message of the email. If * you use both the SourceArn parameter and the * corresponding X-header, Amazon SES uses the value of the * SourceArn parameter. *

* For information about when to use this parameter, see the * description of SendRawEmail in this guide, or see * the Amazon SES Developer Guide. */ public String getSourceArn() { return this.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 * [email protected], then you would specify the * SourceArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com, and * the Source to be [email protected]. *

*

* 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. * * @param 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 * [email protected], then you would specify the * SourceArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com * , and the Source to be [email protected]. *

*

* 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. * @return Returns a reference to this object so that method calls can be * chained together. */ public SendRawEmailRequest withSourceArn(String sourceArn) { setSourceArn(sourceArn); return this; } /** *

* 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 * [email protected], then you would specify the * ReturnPathArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com, and * the ReturnPath to be [email protected]. *

*

* 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. * * @param 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 * [email protected], then you would specify the * ReturnPathArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com * , and the ReturnPath to be * [email protected]. *

*

* Instead of using this parameter, you can use the X-header * X-SES-RETURN-PATH-ARN in the raw message of the * email. If you use both the ReturnPathArn parameter * and the corresponding X-header, Amazon SES uses the value of the * ReturnPathArn parameter. *

* For information about when to use this parameter, see the * description of SendRawEmail in this guide, or see the * Amazon SES Developer Guide. */ public void setReturnPathArn(String returnPathArn) { this.returnPathArn = 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 * [email protected], then you would specify the * ReturnPathArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com, and * the ReturnPath to be [email protected]. *

*

* 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. * * @return 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 * [email protected], then you would specify the * ReturnPathArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com * , and the ReturnPath to be * [email protected]. *

*

* Instead of using this parameter, you can use the X-header * X-SES-RETURN-PATH-ARN in the raw message of the * email. If you use both the ReturnPathArn parameter * and the corresponding X-header, Amazon SES uses the value of the * ReturnPathArn parameter. *

* For information about when to use this parameter, see the * description of SendRawEmail in this guide, or see * the Amazon SES Developer Guide. */ public String getReturnPathArn() { return this.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 * [email protected], then you would specify the * ReturnPathArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com, and * the ReturnPath to be [email protected]. *

*

* 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. * * @param 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 * [email protected], then you would specify the * ReturnPathArn to be * arn:aws:ses:us-east-1:123456789012:identity/example.com * , and the ReturnPath to be * [email protected]. *

*

* 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. * @return Returns a reference to this object so that method calls can be * chained together. */ public SendRawEmailRequest withReturnPathArn(String returnPathArn) { setReturnPathArn(returnPathArn); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @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: " + getSource() + ","); if (getDestinations() != null) sb.append("Destinations: " + getDestinations() + ","); if (getRawMessage() != null) sb.append("RawMessage: " + getRawMessage() + ","); if (getFromArn() != null) sb.append("FromArn: " + getFromArn() + ","); if (getSourceArn() != null) sb.append("SourceArn: " + getSourceArn() + ","); if (getReturnPathArn() != null) sb.append("ReturnPathArn: " + getReturnPathArn()); 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; 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()); return hashCode; } @Override public SendRawEmailRequest clone() { return (SendRawEmailRequest) super.clone(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy