Class: Aws::SES::Types::ReceiptRule

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ses/types.rb

Overview

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].

[1]: docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ Array<Types::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.

Returns:



3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
 
# File 'lib/aws-sdk-ses/types.rb', line 3229

class ReceiptRule < Struct.new(
  :name,
  :enabled,
  :tls_policy,
  :recipients,
  :actions,
  :scan_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
 
# File 'lib/aws-sdk-ses/types.rb', line 3229

class ReceiptRule < Struct.new(
  :name,
  :enabled,
  :tls_policy,
  :recipients,
  :actions,
  :scan_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).

  • Start and end with a letter or number.

  • Contain 64 characters or fewer.

Returns:

  • (String) 


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
 
# File 'lib/aws-sdk-ses/types.rb', line 3229

class ReceiptRule < Struct.new(
  :name,
  :enabled,
  :tls_policy,
  :recipients,
  :actions,
  :scan_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#recipients ⇒ Array<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.

Returns:

  • (Array<String>) 


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
 
# File 'lib/aws-sdk-ses/types.rb', line 3229

class ReceiptRule < Struct.new(
  :name,
  :enabled,
  :tls_policy,
  :recipients,
  :actions,
  :scan_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#scan_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
 
# File 'lib/aws-sdk-ses/types.rb', line 3229

class ReceiptRule < Struct.new(
  :name,
  :enabled,
  :tls_policy,
  :recipients,
  :actions,
  :scan_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#tls_policy ⇒ String

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`.

Returns:

  • (String) 


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
 
# File 'lib/aws-sdk-ses/types.rb', line 3229

class ReceiptRule < Struct.new(
  :name,
  :enabled,
  :tls_policy,
  :recipients,
  :actions,
  :scan_enabled)
  SENSITIVE = []
  include Aws::Structure
end