Class ReceiptRuleProps

Construction properties for a ReceiptRule.

Inheritance

object

ReceiptRuleProps

Implements

IReceiptRuleProps

IReceiptRuleOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ReceiptRuleProps : IReceiptRuleProps, IReceiptRuleOptions

Syntax (vb)

Public Class ReceiptRuleProps Implements IReceiptRuleProps, IReceiptRuleOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.SES;

            ReceiptRule receiptRule;
            IReceiptRuleAction receiptRuleAction;
            ReceiptRuleSet receiptRuleSet;

            var receiptRuleProps = new ReceiptRuleProps {
                RuleSet = receiptRuleSet,

                // the properties below are optional
                Actions = new [] { receiptRuleAction },
                After = receiptRule,
                Enabled = false,
                ReceiptRuleName = "receiptRuleName",
                Recipients = new [] { "recipients" },
                ScanEnabled = false,
                TlsPolicy = TlsPolicy.OPTIONAL
            };

Synopsis

Constructors

ReceiptRuleProps()

Construction properties for a ReceiptRule.

Properties

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.
After	An existing rule after which the new rule will be placed.
Enabled	Whether the rule is active.
ReceiptRuleName	The name for the rule.
Recipients	The recipient domains and email addresses that the receipt rule applies to.
RuleSet	The name of the rule set that the receipt rule will be added to.
ScanEnabled	Whether to scan for spam and viruses.
TlsPolicy	Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

Constructors

ReceiptRuleProps()

Construction properties for a ReceiptRule.

public ReceiptRuleProps()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.SES;

            ReceiptRule receiptRule;
            IReceiptRuleAction receiptRuleAction;
            ReceiptRuleSet receiptRuleSet;

            var receiptRuleProps = new ReceiptRuleProps {
                RuleSet = receiptRuleSet,

                // the properties below are optional
                Actions = new [] { receiptRuleAction },
                After = receiptRule,
                Enabled = false,
                ReceiptRuleName = "receiptRuleName",
                Recipients = new [] { "recipients" },
                ScanEnabled = false,
                TlsPolicy = TlsPolicy.OPTIONAL
            };

Properties

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.

public IReceiptRuleAction[]? Actions { get; set; }

Property Value

IReceiptRuleAction[]

Remarks

Default: - No actions.

After

An existing rule after which the new rule will be placed.

public IReceiptRule? After { get; set; }

Property Value

IReceiptRule

Remarks

Default: - The new rule is inserted at the beginning of the rule list.

Enabled

Whether the rule is active.

public bool? Enabled { get; set; }

Property Value

bool?

Remarks

Default: true

ReceiptRuleName

The name for the rule.

public string? ReceiptRuleName { get; set; }

Property Value

string

Remarks

Default: - A CloudFormation generated name.

Recipients

The recipient domains and email addresses that the receipt rule applies to.

public string[]? Recipients { get; set; }

Property Value

string[]

Remarks

Default: - Match all recipients under all verified domains.

RuleSet

The name of the rule set that the receipt rule will be added to.

public IReceiptRuleSet RuleSet { get; set; }

Property Value

IReceiptRuleSet

Remarks

ExampleMetadata: fixture=_generated

ScanEnabled

Whether to scan for spam and viruses.

public bool? ScanEnabled { get; set; }

Property Value

bool?

Remarks

Default: false

TlsPolicy

Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

public TlsPolicy? TlsPolicy { get; set; }

Property Value

TlsPolicy?

Remarks

Default: - Optional which will not check for TLS.

Implements

IReceiptRuleProps

IReceiptRuleOptions