mailmanager/aws.sdk.kotlin.services.mailmanager.model/RuleAction

RuleAction

sealed class RuleAction

The action for a rule to take. Only one of the contained actions can be set.

Inheritors

DeliverToMailbox

DeliverToQBusiness

ReplaceRecipient

Types

data class AddHeader(val value: AddHeaderAction) : RuleAction

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

data class Archive(val value: ArchiveAction) : RuleAction

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

DeliverToMailbox

data class DeliverToMailbox(val value: DeliverToMailboxAction) : RuleAction

This action delivers an email to a WorkMail mailbox.

DeliverToQBusiness

data class DeliverToQBusiness(val value: DeliverToQBusinessAction) : RuleAction

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

data class Drop(val value: DropAction) : RuleAction

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

data class PublishToSns(val value: SnsAction) : RuleAction

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

data class Relay(val value: RelayAction) : RuleAction

This action relays the email to another SMTP server.

ReplaceRecipient

data class ReplaceRecipient(val value: ReplaceRecipientAction) : RuleAction

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

object SdkUnknown : RuleAction

data class Send(val value: SendAction) : RuleAction

This action sends the email to the internet.

data class WriteToS3(val value: S3Action) : RuleAction

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

Functions

fun asAddHeader(): AddHeaderAction

Casts this RuleAction as a AddHeader and retrieves its aws.sdk.kotlin.services.mailmanager.model.AddHeaderAction value. Throws an exception if the RuleAction is not a AddHeader.

asAddHeaderOrNull

fun asAddHeaderOrNull(): AddHeaderAction?

Casts this RuleAction as a AddHeader and retrieves its aws.sdk.kotlin.services.mailmanager.model.AddHeaderAction value. Returns null if the RuleAction is not a AddHeader.

fun asArchive(): ArchiveAction

Casts this RuleAction as a Archive and retrieves its aws.sdk.kotlin.services.mailmanager.model.ArchiveAction value. Throws an exception if the RuleAction is not a Archive.

asArchiveOrNull

fun asArchiveOrNull(): ArchiveAction?

Casts this RuleAction as a Archive and retrieves its aws.sdk.kotlin.services.mailmanager.model.ArchiveAction value. Returns null if the RuleAction is not a Archive.

asDeliverToMailbox

fun asDeliverToMailbox(): DeliverToMailboxAction

Casts this RuleAction as a DeliverToMailbox and retrieves its aws.sdk.kotlin.services.mailmanager.model.DeliverToMailboxAction value. Throws an exception if the RuleAction is not a DeliverToMailbox.

asDeliverToMailboxOrNull

fun asDeliverToMailboxOrNull(): DeliverToMailboxAction?

Casts this RuleAction as a DeliverToMailbox and retrieves its aws.sdk.kotlin.services.mailmanager.model.DeliverToMailboxAction value. Returns null if the RuleAction is not a DeliverToMailbox.

asDeliverToQBusiness

fun asDeliverToQBusiness(): DeliverToQBusinessAction

Casts this RuleAction as a DeliverToQBusiness and retrieves its aws.sdk.kotlin.services.mailmanager.model.DeliverToQBusinessAction value. Throws an exception if the RuleAction is not a DeliverToQBusiness.

asDeliverToQBusinessOrNull

fun asDeliverToQBusinessOrNull(): DeliverToQBusinessAction?

Casts this RuleAction as a DeliverToQBusiness and retrieves its aws.sdk.kotlin.services.mailmanager.model.DeliverToQBusinessAction value. Returns null if the RuleAction is not a DeliverToQBusiness.

fun asDrop(): DropAction

Casts this RuleAction as a Drop and retrieves its aws.sdk.kotlin.services.mailmanager.model.DropAction value. Throws an exception if the RuleAction is not a Drop.

fun asDropOrNull(): DropAction?

Casts this RuleAction as a Drop and retrieves its aws.sdk.kotlin.services.mailmanager.model.DropAction value. Returns null if the RuleAction is not a Drop.

fun asPublishToSns(): SnsAction

Casts this RuleAction as a PublishToSns and retrieves its aws.sdk.kotlin.services.mailmanager.model.SnsAction value. Throws an exception if the RuleAction is not a PublishToSns.

asPublishToSnsOrNull

fun asPublishToSnsOrNull(): SnsAction?

Casts this RuleAction as a PublishToSns and retrieves its aws.sdk.kotlin.services.mailmanager.model.SnsAction value. Returns null if the RuleAction is not a PublishToSns.

fun asRelay(): RelayAction

Casts this RuleAction as a Relay and retrieves its aws.sdk.kotlin.services.mailmanager.model.RelayAction value. Throws an exception if the RuleAction is not a Relay.

fun asRelayOrNull(): RelayAction?

Casts this RuleAction as a Relay and retrieves its aws.sdk.kotlin.services.mailmanager.model.RelayAction value. Returns null if the RuleAction is not a Relay.

asReplaceRecipient

fun asReplaceRecipient(): ReplaceRecipientAction

Casts this RuleAction as a ReplaceRecipient and retrieves its aws.sdk.kotlin.services.mailmanager.model.ReplaceRecipientAction value. Throws an exception if the RuleAction is not a ReplaceRecipient.

asReplaceRecipientOrNull

fun asReplaceRecipientOrNull(): ReplaceRecipientAction?

Casts this RuleAction as a ReplaceRecipient and retrieves its aws.sdk.kotlin.services.mailmanager.model.ReplaceRecipientAction value. Returns null if the RuleAction is not a ReplaceRecipient.

fun asSend(): SendAction

Casts this RuleAction as a Send and retrieves its aws.sdk.kotlin.services.mailmanager.model.SendAction value. Throws an exception if the RuleAction is not a Send.

fun asSendOrNull(): SendAction?

Casts this RuleAction as a Send and retrieves its aws.sdk.kotlin.services.mailmanager.model.SendAction value. Returns null if the RuleAction is not a Send.

fun asWriteToS3(): S3Action

Casts this RuleAction as a WriteToS3 and retrieves its aws.sdk.kotlin.services.mailmanager.model.S3Action value. Throws an exception if the RuleAction is not a WriteToS3.

asWriteToS3OrNull

fun asWriteToS3OrNull(): S3Action?

Casts this RuleAction as a WriteToS3 and retrieves its aws.sdk.kotlin.services.mailmanager.model.S3Action value. Returns null if the RuleAction is not a WriteToS3.