Package software.amazon.awssdk.services.sesv2.model

Interface SendEmailRequest.Builder

    • Method Detail

      • fromEmailAddress

        SendEmailRequest.Builder fromEmailAddress​(String fromEmailAddress)

        The email address to use as the "From" address for the email. The address that you specify has to be verified.

        Parameters:
        fromEmailAddress - The email address to use as the "From" address for the email. The address that you specify has to be verified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fromEmailAddressIdentityArn

        SendEmailRequest.Builder fromEmailAddressIdentityArn​(String fromEmailAddressIdentityArn)

        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 FromEmailAddress 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 FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be [email protected].

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

        For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

        Parameters:
        fromEmailAddressIdentityArn - 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 FromEmailAddress 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 FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be [email protected].

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

        For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

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

      • destination

        SendEmailRequest.Builder destination​(Destination destination)

        An object that contains the recipients of the email message.

        Parameters:
        destination - An object that contains the recipients of the email message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replyToAddresses

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

        The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

        Parameters:
        replyToAddresses - The "Reply-to" email addresses for the message. When 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

        SendEmailRequest.Builder replyToAddresses​(String... replyToAddresses)

        The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

        Parameters:
        replyToAddresses - The "Reply-to" email addresses for the message. When 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.

      • feedbackForwardingEmailAddress

        SendEmailRequest.Builder feedbackForwardingEmailAddress​(String feedbackForwardingEmailAddress)

        The address that you want bounce and complaint notifications to be sent to.

        Parameters:
        feedbackForwardingEmailAddress - The address that you want bounce and complaint notifications to be sent to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • feedbackForwardingEmailAddressIdentityArn

        SendEmailRequest.Builder feedbackForwardingEmailAddressIdentityArn​(String feedbackForwardingEmailAddressIdentityArn)

        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 FeedbackForwardingEmailAddress 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 FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be [email protected].

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

        Parameters:
        feedbackForwardingEmailAddressIdentityArn - 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 FeedbackForwardingEmailAddress 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 FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress 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.

      • content

        SendEmailRequest.Builder content​(EmailContent content)

        An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.

        Parameters:
        content - An object that contains the body of the message. You can send either a Simple message, Raw message, or a Templated message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • emailTags

        SendEmailRequest.Builder emailTags​(Collection<MessageTag> emailTags)

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

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

      • emailTags

        SendEmailRequest.Builder emailTags​(MessageTag... emailTags)

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

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

      • emailTags

        SendEmailRequest.Builder emailTags​(Consumer<MessageTag.Builder>... emailTags)

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

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

      • configurationSetName

        SendEmailRequest.Builder configurationSetName​(String configurationSetName)

        The name of the configuration set to use when sending the email.

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

      • listManagementOptions

        SendEmailRequest.Builder listManagementOptions​(ListManagementOptions listManagementOptions)

        An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

        Parameters:
        listManagementOptions - An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
        Returns:
        Returns a reference to this object so that method calls can be chained together.