ReceiptRule (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.ses.model.ReceiptRule

All Implemented Interfaces:

ToCopyableBuilder<ReceiptRule.Builder,ReceiptRule>
```
@Generated("software.amazon.awssdk:codegen")
public class ReceiptRule
extends Object
implements ToCopyableBuilder<ReceiptRule.Builder,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 to which it applies. 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.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ReceiptRule.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`ReceiptRule.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<ReceiptAction>`	`actions()`	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.
`static ReceiptRule.Builder`	`builder()`
`Boolean`	`enabled()`	If `true`, the receipt rule is active.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`name()`	The name of the receipt rule.
`List<String>`	`recipients()`	The recipient domains and email addresses to which the receipt rule applies.
`Boolean`	`scanEnabled()`	If `true`, then messages to which this receipt rule applies are scanned for spam and viruses.
`static Class<? extends ReceiptRule.Builder>`	`serializableBuilderClass()`
`String`	`tlsPolicy()`	Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).
`ReceiptRule.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - name
```
public String name()
```
    The name of the receipt rule. The name must:
    - Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
    - Start and end with a letter or number.
    - Contain less than 64 characters.
    Returns:
    The name of the receipt rule. The name must:
    
    Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).
    
    Start and end with a letter or number.
    
    Contain less than 64 characters.
  - enabled
```
public Boolean enabled()
```
    If true, the receipt rule is active. The default value is false.
    
    Returns:
    
    If true, the receipt rule is active. The default value is false.
  - tlsPolicy
```
public String 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 will bounce emails that are not received over TLS. The default is Optional.
    
    Returns:
    
    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 will bounce emails that are not received over TLS. The default is Optional.
    
    See Also:
    
    TlsPolicy
  - recipients
```
public List<String> recipients()
```
    The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.
    
    Returns:
    
    The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.
  - actions
```
public List<ReceiptAction> actions()
```
    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.
    
    Returns:
    
    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.
  - scanEnabled
```
public Boolean scanEnabled()
```
    If true, then messages to which this receipt rule applies are scanned for spam and viruses. The default value is false.
    
    Returns:
    
    If true, then messages to which this receipt rule applies are scanned for spam and viruses. The default value is false.
  - toBuilder
```
public ReceiptRule.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReceiptRule.Builder,ReceiptRule>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ReceiptRule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReceiptRule.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ReceiptRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

name

enabled

tlsPolicy

recipients

actions

scanEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString