Package software.amazon.awssdk.services.ses.model

Interface SendRawEmailRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SendRawEmailRequest.Builder,SendRawEmailRequest>, SdkBuilder<SendRawEmailRequest.Builder,SendRawEmailRequest>, SdkPojo, SdkRequest.Builder, SesRequest.Builder
Enclosing class:
SendRawEmailRequest
public static interface SendRawEmailRequest.Builder extends SesRequest.Builder, SdkPojo, CopyableBuilder<SendRawEmailRequest.Builder,SendRawEmailRequest>

  • Method Details

    • source

      SendRawEmailRequest.Builder source(String source)

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

      Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

      If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints are sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

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

      Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.

      If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints are 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.

    • destinations

      SendRawEmailRequest.Builder destinations(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.

    • destinations

      SendRawEmailRequest.Builder destinations(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.

    • rawMessage

      SendRawEmailRequest.Builder rawMessage(RawMessage rawMessage)

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

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

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

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

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

      • The entire message must be base64-encoded.

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

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

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

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

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

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

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

      • The entire message must be base64-encoded.

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

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

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

    • rawMessage

      default SendRawEmailRequest.Builder rawMessage(Consumer<RawMessage.Builder> rawMessage)

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

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

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

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

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

      • The entire message must be base64-encoded.

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

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

      This is a convenience method that creates an instance of the RawMessage.Builder avoiding the need to create one manually via RawMessage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rawMessage(RawMessage).

      Parameters:
      rawMessage - a consumer that will call methods on RawMessage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fromArn

      SendRawEmailRequest.Builder fromArn(String fromArn)

      This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email.

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

      For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

      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.

    • sourceArn

      SendRawEmailRequest.Builder sourceArn(String sourceArn)

      This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

      For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

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

      For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

      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.

    • returnPathArn

      SendRawEmailRequest.Builder returnPathArn(String returnPathArn)

      This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

      For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

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

      For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

      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.

    • tags

      SendRawEmailRequest.Builder tags(Collection<MessageTag> tags)

      A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

      Parameters:
      tags - A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      SendRawEmailRequest.Builder tags(MessageTag... tags)

      A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

      Parameters:
      tags - A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      SendRawEmailRequest.Builder tags(Consumer<MessageTag.Builder>... 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.

      This is a convenience method that creates an instance of the MessageTag.Builder avoiding the need to create one manually via MessageTag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<MessageTag>).

      Parameters:
      tags - a consumer that will call methods on MessageTag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • configurationSetName

      SendRawEmailRequest.Builder configurationSetName(String configurationSetName)

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

      Parameters:
      configurationSetName - The name of the configuration set to use when you send an email using SendRawEmail.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SendRawEmailRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SendRawEmailRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.