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

Interface SendBulkTemplatedEmailRequest.Builder

    • Method Detail

      • source

        SendBulkTemplatedEmailRequest.Builder source​(String source)

        The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

        If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

        Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. 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.

        Parameters:
        source - The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

        If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

        Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. 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.

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

      • sourceArn

        SendBulkTemplatedEmailRequest.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 [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].

        For more information about sending authorization, 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 [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].

        For more information about sending authorization, see the Amazon SES Developer Guide.

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

      • replyToAddresses

        SendBulkTemplatedEmailRequest.Builder replyToAddresses​(Collection<String> replyToAddresses)

        The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.

        Parameters:
        replyToAddresses - The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replyToAddresses

        SendBulkTemplatedEmailRequest.Builder replyToAddresses​(String... replyToAddresses)

        The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.

        Parameters:
        replyToAddresses - The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • returnPath

        SendBulkTemplatedEmailRequest.Builder returnPath​(String returnPath)

        The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

        Parameters:
        returnPath - The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • returnPathArn

        SendBulkTemplatedEmailRequest.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 [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].

        For more information about sending authorization, 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 [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].

        For more information about sending authorization, see the Amazon SES Developer Guide.

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

      • configurationSetName

        SendBulkTemplatedEmailRequest.Builder configurationSetName​(String configurationSetName)

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

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

      • defaultTags

        SendBulkTemplatedEmailRequest.Builder defaultTags​(Collection<MessageTag> defaultTags)

        A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

        Parameters:
        defaultTags - A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultTags

        SendBulkTemplatedEmailRequest.Builder defaultTags​(MessageTag... defaultTags)

        A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

        Parameters:
        defaultTags - A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultTags

        SendBulkTemplatedEmailRequest.Builder defaultTags​(Consumer<MessageTag.Builder>... defaultTags)

        A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

        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 #defaultTags(List).

        Parameters:
        defaultTags - 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:
        #defaultTags(java.util.Collection)

      • template

        SendBulkTemplatedEmailRequest.Builder template​(String template)

        The template to use when sending this email.

        Parameters:
        template - The template to use when sending this email.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateArn

        SendBulkTemplatedEmailRequest.Builder templateArn​(String templateArn)

        The ARN of the template to use when sending this email.

        Parameters:
        templateArn - The ARN of the template to use when sending this email.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultTemplateData

        SendBulkTemplatedEmailRequest.Builder defaultTemplateData​(String defaultTemplateData)

        A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

        The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

        Parameters:
        defaultTemplateData - A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

        The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

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

      • destinations

        SendBulkTemplatedEmailRequest.Builder destinations​(Collection<BulkEmailDestination> destinations)

        One or more Destination objects. All of the recipients in a Destination receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

        Parameters:
        destinations - One or more Destination objects. All of the recipients in a Destination receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinations

        SendBulkTemplatedEmailRequest.Builder destinations​(BulkEmailDestination... destinations)

        One or more Destination objects. All of the recipients in a Destination receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

        Parameters:
        destinations - One or more Destination objects. All of the recipients in a Destination receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.
        Returns:
        Returns a reference to this object so that method calls can be chained together.