Package com.amazonaws.services.simpleemail.model

Class SendRawEmailRequest

    • Constructor Detail

      • SendRawEmailRequest

        public SendRawEmailRequest()
        Default constructor for SendRawEmailRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

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

    • Method Detail

      • setSource

        public void setSource​(String source)

        The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)

        By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

        If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.
        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.)

        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.

      • getSource

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

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

        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.

      • withSource

        public SendRawEmailRequest withSource​(String source)

        The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)

        By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

        If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.
        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.)

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

      • getDestinations

        public List<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​(Collection<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​(String... 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 setDestinations(java.util.Collection) or withDestinations(java.util.Collection) if you want to override the existing values.

        Parameters:
        destinations - A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • withDestinations

        public SendRawEmailRequest withDestinations​(Collection<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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setRawMessage

        public void setRawMessage​(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.

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

      • getRawMessage

        public RawMessage getRawMessage()

        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.

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

      • withRawMessage

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

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

      • setFromArn

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

      • getFromArn

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

      • withFromArn

        public SendRawEmailRequest withFromArn​(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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setSourceArn

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

      • getSourceArn

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

      • withSourceArn

        public SendRawEmailRequest withSourceArn​(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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setReturnPathArn

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

      • getReturnPathArn

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

      • withReturnPathArn

        public SendRawEmailRequest withReturnPathArn​(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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object