Interface RuleAction.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RuleAction.Builder,RuleAction>, SdkBuilder<RuleAction.Builder,RuleAction>, SdkPojo

Enclosing class:

RuleAction

@Mutable
@NotThreadSafe
public static interface RuleAction.Builder
extends SdkPojo, CopyableBuilder<RuleAction.Builder,RuleAction>

Method Summary

Modifier and Type	Method	Description
default RuleAction.Builder	addHeader(Consumer<AddHeaderAction.Builder> addHeader)	This action adds a header.
RuleAction.Builder	addHeader(AddHeaderAction addHeader)	This action adds a header.
default RuleAction.Builder	archive(Consumer<ArchiveAction.Builder> archive)	This action archives the email.
RuleAction.Builder	archive(ArchiveAction archive)	This action archives the email.
default RuleAction.Builder	deliverToMailbox(Consumer<DeliverToMailboxAction.Builder> deliverToMailbox)	This action delivers an email to a WorkMail mailbox.
RuleAction.Builder	deliverToMailbox(DeliverToMailboxAction deliverToMailbox)	This action delivers an email to a WorkMail mailbox.
default RuleAction.Builder	deliverToQBusiness(Consumer<DeliverToQBusinessAction.Builder> deliverToQBusiness)	This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.
RuleAction.Builder	deliverToQBusiness(DeliverToQBusinessAction deliverToQBusiness)	This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.
default RuleAction.Builder	drop(Consumer<DropAction.Builder> drop)	This action terminates the evaluation of rules in the rule set.
RuleAction.Builder	drop(DropAction drop)	This action terminates the evaluation of rules in the rule set.
default RuleAction.Builder	publishToSns(Consumer<SnsAction.Builder> publishToSns)	This action publishes the email content to an Amazon SNS topic.
RuleAction.Builder	publishToSns(SnsAction publishToSns)	This action publishes the email content to an Amazon SNS topic.
default RuleAction.Builder	relay(Consumer<RelayAction.Builder> relay)	This action relays the email to another SMTP server.
RuleAction.Builder	relay(RelayAction relay)	This action relays the email to another SMTP server.
default RuleAction.Builder	replaceRecipient(Consumer<ReplaceRecipientAction.Builder> replaceRecipient)	The action replaces certain or all recipients with a different set of recipients.
RuleAction.Builder	replaceRecipient(ReplaceRecipientAction replaceRecipient)	The action replaces certain or all recipients with a different set of recipients.
default RuleAction.Builder	send(Consumer<SendAction.Builder> send)	This action sends the email to the internet.
RuleAction.Builder	send(SendAction send)	This action sends the email to the internet.
default RuleAction.Builder	writeToS3(Consumer<S3Action.Builder> writeToS3)	This action writes the MIME content of the email to an S3 bucket.
RuleAction.Builder	writeToS3(S3Action writeToS3)	This action writes the MIME content of the email to an S3 bucket.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

addHeader

RuleAction.Builder addHeader(AddHeaderAction addHeader)

This action adds a header. This can be used to add arbitrary email headers.

Parameters:

addHeader - This action adds a header. This can be used to add arbitrary email headers.

Returns:

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

addHeader

default RuleAction.Builder addHeader(Consumer<AddHeaderAction.Builder> addHeader)

This action adds a header. This can be used to add arbitrary email headers.

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

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

Parameters:

addHeader - a consumer that will call methods on AddHeaderAction.Builder

Returns:

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

See Also:

• addHeader(AddHeaderAction)

archive

RuleAction.Builder archive(ArchiveAction archive)

This action archives the email. This can be used to deliver an email to an archive.

Parameters:

archive - This action archives the email. This can be used to deliver an email to an archive.

Returns:

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

archive

default RuleAction.Builder archive(Consumer<ArchiveAction.Builder> archive)

This action archives the email. This can be used to deliver an email to an archive.

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

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

Parameters:

archive - a consumer that will call methods on ArchiveAction.Builder

Returns:

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

See Also:

• archive(ArchiveAction)

deliverToMailbox

RuleAction.Builder deliverToMailbox(DeliverToMailboxAction deliverToMailbox)

This action delivers an email to a WorkMail mailbox.

Parameters:

deliverToMailbox - This action delivers an email to a WorkMail mailbox.

Returns:

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

deliverToMailbox

default RuleAction.Builder deliverToMailbox(Consumer<DeliverToMailboxAction.Builder> deliverToMailbox)

This action delivers an email to a WorkMail mailbox.

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

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

Parameters:

deliverToMailbox - a consumer that will call methods on DeliverToMailboxAction.Builder

Returns:

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

See Also:

• deliverToMailbox(DeliverToMailboxAction)

deliverToQBusiness

RuleAction.Builder deliverToQBusiness(DeliverToQBusinessAction deliverToQBusiness)

This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.

Parameters:

deliverToQBusiness - This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.

Returns:

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

deliverToQBusiness

default RuleAction.Builder deliverToQBusiness(Consumer<DeliverToQBusinessAction.Builder> deliverToQBusiness)

This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.

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

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

Parameters:

deliverToQBusiness - a consumer that will call methods on DeliverToQBusinessAction.Builder

Returns:

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

See Also:

• deliverToQBusiness(DeliverToQBusinessAction)

drop

RuleAction.Builder drop(DropAction drop)

This action terminates the evaluation of rules in the rule set.

Parameters:

drop - This action terminates the evaluation of rules in the rule set.

Returns:

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

drop

default RuleAction.Builder drop(Consumer<DropAction.Builder> drop)

This action terminates the evaluation of rules in the rule set.

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

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

Parameters:

drop - a consumer that will call methods on DropAction.Builder

Returns:

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

See Also:

• drop(DropAction)

publishToSns

RuleAction.Builder publishToSns(SnsAction publishToSns)

This action publishes the email content to an Amazon SNS topic.

Parameters:

publishToSns - This action publishes the email content to an Amazon SNS topic.

Returns:

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

publishToSns

default RuleAction.Builder publishToSns(Consumer<SnsAction.Builder> publishToSns)

This action publishes the email content to an Amazon SNS topic.

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

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

Parameters:

publishToSns - a consumer that will call methods on SnsAction.Builder

Returns:

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

See Also:

• publishToSns(SnsAction)

relay

RuleAction.Builder relay(RelayAction relay)

This action relays the email to another SMTP server.

Parameters:

relay - This action relays the email to another SMTP server.

Returns:

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

relay

default RuleAction.Builder relay(Consumer<RelayAction.Builder> relay)

This action relays the email to another SMTP server.

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

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

Parameters:

relay - a consumer that will call methods on RelayAction.Builder

Returns:

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

See Also:

• relay(RelayAction)

replaceRecipient

RuleAction.Builder replaceRecipient(ReplaceRecipientAction replaceRecipient)

The action replaces certain or all recipients with a different set of recipients.

Parameters:

replaceRecipient - The action replaces certain or all recipients with a different set of recipients.

Returns:

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

replaceRecipient

default RuleAction.Builder replaceRecipient(Consumer<ReplaceRecipientAction.Builder> replaceRecipient)

The action replaces certain or all recipients with a different set of recipients.

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

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

Parameters:

replaceRecipient - a consumer that will call methods on ReplaceRecipientAction.Builder

Returns:

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

See Also:

• replaceRecipient(ReplaceRecipientAction)

send

RuleAction.Builder send(SendAction send)

This action sends the email to the internet.

Parameters:

send - This action sends the email to the internet.

Returns:

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

send

default RuleAction.Builder send(Consumer<SendAction.Builder> send)

This action sends the email to the internet.

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

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

Parameters:

send - a consumer that will call methods on SendAction.Builder

Returns:

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

See Also:

• send(SendAction)

writeToS3

RuleAction.Builder writeToS3(S3Action writeToS3)

This action writes the MIME content of the email to an S3 bucket.

Parameters:

writeToS3 - This action writes the MIME content of the email to an S3 bucket.

Returns:

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

writeToS3

default RuleAction.Builder writeToS3(Consumer<S3Action.Builder> writeToS3)

This action writes the MIME content of the email to an S3 bucket.

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

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

Parameters:

writeToS3 - a consumer that will call methods on S3Action.Builder

Returns:

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

See Also:

• writeToS3(S3Action)