AWSSESReceiptRule

Objective-C

@interface AWSSESReceiptRule

Swift

class AWSSESReceiptRule

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.

Required parameters: [Name]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSSESReceiptAction *> *_Nullable actions;

    Swift

    var actions: [AWSSESReceiptAction]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable enabled;

    Swift

    var enabled: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable name;

    Swift

    var name: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable recipients;

    Swift

    var recipients: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable scanEnabled;

    Swift

    var scanEnabled: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSSESTlsPolicy tlsPolicy;

    Swift

    var tlsPolicy: AWSSESTlsPolicy { get set }