Struct ReceiptRule

#[non_exhaustive]
pub struct ReceiptRule {
    pub name: String,
    pub enabled: bool,
    pub tls_policy: Option<TlsPolicy>,
    pub recipients: Option<Vec<String>>,
    pub actions: Option<Vec<ReceiptAction>>,
    pub scan_enabled: bool,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

enabled: bool

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

tls_policy: Option<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.

recipients: Option<Vec<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.

actions: Option<Vec<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.

scan_enabled: bool

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

Implementations

impl ReceiptRule

pub fn name(&self) -> &str

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.

pub fn enabled(&self) -> bool

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

pub fn tls_policy(&self) -> Option<&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.

pub fn recipients(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .recipients.is_none().

pub fn actions(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .actions.is_none().

pub fn scan_enabled(&self) -> bool

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

impl ReceiptRule

pub fn builder() -> ReceiptRuleBuilder

Creates a new builder-style object to manufacture ReceiptRule.

Trait Implementations

impl Clone for ReceiptRule

fn clone(&self) -> ReceiptRule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReceiptRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ReceiptRule

fn eq(&self, other: &ReceiptRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ReceiptRule