Interface BulkEmailEntry.Builder

  • Method Details

    • destination

      BulkEmailEntry.Builder destination(Destination destination)

      Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

      Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination 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.

      Parameters:
      destination - Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

      Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination 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.

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

      default BulkEmailEntry.Builder destination(Consumer<Destination.Builder> destination)

      Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

      Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination 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.

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

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

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

      BulkEmailEntry.Builder replacementTags(Collection<MessageTag> replacementTags)

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

      Parameters:
      replacementTags - A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail operation. 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.
    • replacementTags

      BulkEmailEntry.Builder replacementTags(MessageTag... replacementTags)

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

      Parameters:
      replacementTags - A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail operation. 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.
    • replacementTags

      BulkEmailEntry.Builder replacementTags(Consumer<MessageTag.Builder>... replacementTags)

      A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail operation. 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 replacementTags(List<MessageTag>).

      Parameters:
      replacementTags - 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:
    • replacementEmailContent

      BulkEmailEntry.Builder replacementEmailContent(ReplacementEmailContent replacementEmailContent)

      The ReplacementEmailContent associated with a BulkEmailEntry.

      Parameters:
      replacementEmailContent - The ReplacementEmailContent associated with a BulkEmailEntry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • replacementEmailContent

      default BulkEmailEntry.Builder replacementEmailContent(Consumer<ReplacementEmailContent.Builder> replacementEmailContent)

      The ReplacementEmailContent associated with a BulkEmailEntry.

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

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

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

      BulkEmailEntry.Builder replacementHeaders(Collection<MessageHeader> replacementHeaders)

      The list of message headers associated with the BulkEmailEntry data type.

      • Headers Not Present in BulkEmailEntry: If a header is specified in Template but not in BulkEmailEntry, the header from Template will be added to the outgoing email.

      • Headers Present in BulkEmailEntry: If a header is specified in BulkEmailEntry, it takes precedence over any header of the same name specified in Template :

        • If the header is also defined within Template, the value from BulkEmailEntry will replace the header's value in the email.

        • If the header is not defined within Template, it will simply be added to the email as specified in BulkEmailEntry.

      Parameters:
      replacementHeaders - The list of message headers associated with the BulkEmailEntry data type.

      • Headers Not Present in BulkEmailEntry: If a header is specified in Template but not in BulkEmailEntry, the header from Template will be added to the outgoing email.

      • Headers Present in BulkEmailEntry: If a header is specified in BulkEmailEntry, it takes precedence over any header of the same name specified in Template :

        • If the header is also defined within Template, the value from BulkEmailEntry will replace the header's value in the email.

        • If the header is not defined within Template, it will simply be added to the email as specified in BulkEmailEntry.

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

      BulkEmailEntry.Builder replacementHeaders(MessageHeader... replacementHeaders)

      The list of message headers associated with the BulkEmailEntry data type.

      • Headers Not Present in BulkEmailEntry: If a header is specified in Template but not in BulkEmailEntry, the header from Template will be added to the outgoing email.

      • Headers Present in BulkEmailEntry: If a header is specified in BulkEmailEntry, it takes precedence over any header of the same name specified in Template :

        • If the header is also defined within Template, the value from BulkEmailEntry will replace the header's value in the email.

        • If the header is not defined within Template, it will simply be added to the email as specified in BulkEmailEntry.

      Parameters:
      replacementHeaders - The list of message headers associated with the BulkEmailEntry data type.

      • Headers Not Present in BulkEmailEntry: If a header is specified in Template but not in BulkEmailEntry, the header from Template will be added to the outgoing email.

      • Headers Present in BulkEmailEntry: If a header is specified in BulkEmailEntry, it takes precedence over any header of the same name specified in Template :

        • If the header is also defined within Template, the value from BulkEmailEntry will replace the header's value in the email.

        • If the header is not defined within Template, it will simply be added to the email as specified in BulkEmailEntry.

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

      BulkEmailEntry.Builder replacementHeaders(Consumer<MessageHeader.Builder>... replacementHeaders)

      The list of message headers associated with the BulkEmailEntry data type.

      • Headers Not Present in BulkEmailEntry: If a header is specified in Template but not in BulkEmailEntry, the header from Template will be added to the outgoing email.

      • Headers Present in BulkEmailEntry: If a header is specified in BulkEmailEntry, it takes precedence over any header of the same name specified in Template :

        • If the header is also defined within Template, the value from BulkEmailEntry will replace the header's value in the email.

        • If the header is not defined within Template, it will simply be added to the email as specified in BulkEmailEntry.

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

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

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