Metadata-Version: 2.1
Name: aws-cdk.aws-ses
Version: 1.8.0
Summary: The CDK Construct Library for AWS::SES
Home-page: https://github.com/aws/aws-cdk
Author: Amazon Web Services
License: UNKNOWN
Project-URL: Source, https://github.com/aws/aws-cdk.git
Description: ## Amazon Simple Email Service Construct Library
        <!--BEGIN STABILITY BANNER-->
        
        ---
        
        ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
        
        > **This is a _developer preview_ (public beta) module. Releases might lack important features and might have
        > future breaking changes.**
        >
        > This API is still under active development and subject to non-backward
        > compatible changes or removal in any future version. Use of the API is not recommended in production
        > environments. Experimental APIs are not subject to the Semantic Versioning model.
        
        ---
        <!--END STABILITY BANNER-->
        
        This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
        
        ### Email receiving
        Create a receipt rule set with rules and actions:
        ```ts
        const bucket = new s3.Bucket(stack, 'Bucket');
        const topic = new sns.Topic(stack, 'Topic');
        
        new ses.ReceiptRuleSet(stack, 'RuleSet', {
          rules: [
            {
              recipients: ['hello@aws.com'],
              actions: [
                new ses.ReceiptRuleAddHeaderAction({
                  name: 'X-Special-Header',
                  value: 'aws'
                }),
                new ses.ReceiptRuleS3Action({
                  bucket,
                  objectKeyPrefix: 'emails/',
                  topic
                })
              ],
            },
            {
              recipients: ['aws.com'],
              actions: [
                new ses.ReceiptRuleSnsAction({
                  topic
                })
              ]
            }
          ]
        });
        ```
        
        Alternatively, rules can be added to a rule set:
        ```ts
        const ruleSet = new ses.ReceiptRuleSet(this, 'RuleSet'):
        
        const awsRule = ruleSet.addRule('Aws', {
          recipients: ['aws.com']
        });
        ```
        
        And actions to rules:
        ```ts
        awsRule.addAction(
          new ses.ReceiptRuleSnsAction({
            topic
          });
        );
        ```
        When using `addRule`, the new rule is added after the last added rule unless `after` is specified.
        
        [More actions](test/integ.receipt.ts)
        
        #### Drop spams
        A rule to drop spam can be added by setting `dropSpam` to `true`:
        
        ```ts
        new ses.ReceiptRuleSet(this, 'RuleSet', {
          dropSpam: true
        });
        ```
        
        This will add a rule at the top of the rule set with a Lambda action that stops processing messages that have at least one spam indicator. See [Lambda Function Examples](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda-example-functions.html).
        
        
        ### Receipt filter
        Create a receipt filter:
        ```ts
        new ses.ReceiptFilter(this, 'Filter', {
          ip: '1.2.3.4/16' // Will be blocked
        })
        ```
        
        A white list filter is also available:
        ```ts
        new ses.WhiteListReceiptFilter(this, 'WhiteList', {
          ips: [
            '10.0.0.0/16',
            '1.2.3.4/16',
          ]
        });
        ```
        This will first create a block all filter and then create allow filters for the listed ip addresses.
        
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
