Class ReceiptRule
- All Implemented Interfaces:
Serializable
,Cloneable
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.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
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.Iftrue
, the receipt rule is active.getName()
The name of the receipt rule.The recipient domains and email addresses to which the receipt rule applies.Iftrue
, then messages to which this receipt rule applies are scanned for spam and viruses.Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).int
hashCode()
Iftrue
, the receipt rule is active.Iftrue
, then messages to which this receipt rule applies are scanned for spam and viruses.void
setActions
(Collection<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.void
setEnabled
(Boolean enabled) Iftrue
, the receipt rule is active.void
The name of the receipt rule.void
setRecipients
(Collection<String> recipients) The recipient domains and email addresses to which the receipt rule applies.void
setScanEnabled
(Boolean scanEnabled) Iftrue
, then messages to which this receipt rule applies are scanned for spam and viruses.void
setTlsPolicy
(TlsPolicy tlsPolicy) Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).void
setTlsPolicy
(String tlsPolicy) Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).toString()
Returns a string representation of this object; useful for testing and debugging.withActions
(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.withActions
(Collection<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.withEnabled
(Boolean enabled) Iftrue
, the receipt rule is active.The name of the receipt rule.withRecipients
(String... recipients) The recipient domains and email addresses to which the receipt rule applies.withRecipients
(Collection<String> recipients) The recipient domains and email addresses to which the receipt rule applies.withScanEnabled
(Boolean scanEnabled) Iftrue
, then messages to which this receipt rule applies are scanned for spam and viruses.withTlsPolicy
(TlsPolicy tlsPolicy) Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).withTlsPolicy
(String tlsPolicy) Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).
-
Constructor Details
-
ReceiptRule
public ReceiptRule()
-
-
Method Details
-
setName
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.
- Parameters:
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.
-
getName
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.
-
withName
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setEnabled
If
true
, the receipt rule is active. The default value isfalse
.- Parameters:
enabled
- Iftrue
, the receipt rule is active. The default value isfalse
.
-
getEnabled
If
true
, the receipt rule is active. The default value isfalse
.- Returns:
- If
true
, the receipt rule is active. The default value isfalse
.
-
withEnabled
If
true
, the receipt rule is active. The default value isfalse
.- Parameters:
enabled
- Iftrue
, the receipt rule is active. The default value isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEnabled
If
true
, the receipt rule is active. The default value isfalse
.- Returns:
- If
true
, the receipt rule is active. The default value isfalse
.
-
setTlsPolicy
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 isOptional
.- Parameters:
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 toRequire
, Amazon SES will bounce emails that are not received over TLS. The default isOptional
.- See Also:
-
getTlsPolicy
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 isOptional
.- 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 isOptional
. - See Also:
-
withTlsPolicy
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 isOptional
.- Parameters:
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 toRequire
, Amazon SES will bounce emails that are not received over TLS. The default isOptional
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setTlsPolicy
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 isOptional
.- Parameters:
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 toRequire
, Amazon SES will bounce emails that are not received over TLS. The default isOptional
.- See Also:
-
withTlsPolicy
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 isOptional
.- Parameters:
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 toRequire
, Amazon SES will bounce emails that are not received over TLS. The default isOptional
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
getRecipients
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.
-
setRecipients
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.
- Parameters:
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.
-
withRecipients
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.
NOTE: This method appends the values to the existing list (if any). Use
setRecipients(java.util.Collection)
orwithRecipients(java.util.Collection)
if you want to override the existing values.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
withRecipients
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
getActions
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.
-
setActions
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.
- Parameters:
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.
-
withActions
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.
NOTE: This method appends the values to the existing list (if any). Use
setActions(java.util.Collection)
orwithActions(java.util.Collection)
if you want to override the existing values.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
withActions
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setScanEnabled
If
true
, then messages to which this receipt rule applies are scanned for spam and viruses. The default value isfalse
.- Parameters:
scanEnabled
- Iftrue
, then messages to which this receipt rule applies are scanned for spam and viruses. The default value isfalse
.
-
getScanEnabled
If
true
, then messages to which this receipt rule applies are scanned for spam and viruses. The default value isfalse
.- Returns:
- If
true
, then messages to which this receipt rule applies are scanned for spam and viruses. The default value isfalse
.
-
withScanEnabled
If
true
, then messages to which this receipt rule applies are scanned for spam and viruses. The default value isfalse
.- Parameters:
scanEnabled
- Iftrue
, then messages to which this receipt rule applies are scanned for spam and viruses. The default value isfalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isScanEnabled
If
true
, then messages to which this receipt rule applies are scanned for spam and viruses. The default value isfalse
.- Returns:
- If
true
, then messages to which this receipt rule applies are scanned for spam and viruses. The default value isfalse
.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-