@Generated(value="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 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.
Modifier and Type | Class and Description |
---|---|
static interface |
ReceiptRule.Builder |
Modifier and Type | Method and 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
name()
The name of the receipt rule.
|
List<String> |
recipients()
The recipient domains and email addresses that the receipt rule applies to.
|
Boolean |
scanEnabled()
If
true , then messages that this receipt rule applies to are scanned for spam and viruses. |
static Class<? extends ReceiptRule.Builder> |
serializableBuilderClass() |
TlsPolicy |
tlsPolicy()
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with
Transport Layer Security (TLS).
|
String |
tlsPolicyString()
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() |
copy
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.
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.
public Boolean enabled()
If true
, the receipt rule is active. The default value is false
.
true
, the receipt rule is active. The default value is false
.public 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 will bounce emails
that are not received over TLS. The default is Optional
.
If the service returns an enum value that is not available in the current SDK version, tlsPolicy
will
return TlsPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
tlsPolicyString()
.
Require
, Amazon SES will
bounce emails that are not received over TLS. The default is Optional
.TlsPolicy
public String tlsPolicyString()
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
.
If the service returns an enum value that is not available in the current SDK version, tlsPolicy
will
return TlsPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
tlsPolicyString()
.
Require
, Amazon SES will
bounce emails that are not received over TLS. The default is Optional
.TlsPolicy
public List<String> recipients()
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean scanEnabled()
If true
, then messages that this receipt rule applies to are scanned for spam and viruses. The
default value is false
.
true
, then messages that this receipt rule applies to are scanned for spam and viruses.
The default value is false
.public ReceiptRule.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ReceiptRule.Builder,ReceiptRule>
public static ReceiptRule.Builder builder()
public static Class<? extends ReceiptRule.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.