ses/aws.sdk.kotlin.services.ses.model/ReceiptRule

ReceiptRule

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

Types

Builder

class Builder

Companion

object Companion

Properties

actions

val actions: List<ReceiptAction>?

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

enabled

val enabled: Boolean

If true, the receipt rule is active. The default value is false.

name

val name: String

The name of the receipt rule. The name must meet the following requirements:

recipients

val recipients: List<String>?

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.

scanEnabled

val scanEnabled: Boolean

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

tlsPolicy

val tlsPolicy: TlsPolicy?

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.

Functions

copy

inline fun copy(block: ReceiptRule.Builder.() -> Unit = {}): ReceiptRule

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String