Metadata-Version: 2.1
Name: aws-cdk.aws-ses
Version: 1.47.0
Summary: The CDK Construct Library for AWS::SES
Home-page: https://github.com/aws/aws-cdk
Author: Amazon Web Services
License: Apache-2.0
Project-URL: Source, https://github.com/aws/aws-cdk.git
Description: ## Amazon Simple Email Service Construct Library
        
        <!--BEGIN STABILITY BANNER-->---
        
        
        ![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
        
        > All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always stable and safe to use.
        
        ![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
        
        > The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
        
        ---
        <!--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 (actions can be found in the
        `@aws-cdk/aws-ses-actions` package):
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        import aws_cdk.aws_s3 as s3
        import aws_cdk.aws_ses as ses
        import aws_cdk.aws_ses_actions as actions
        import aws_cdk.aws_sns as sns
        
        bucket = s3.Bucket(stack, "Bucket")
        topic = sns.Topic(stack, "Topic")
        
        ses.ReceiptRuleSet(stack, "RuleSet",
            rules=[ReceiptRuleOptions(
                recipients=["hello@aws.com"],
                actions=[
                    actions.AddHeader(
                        name="X-Special-Header",
                        value="aws"
                    ),
                    actions.S3(
                        bucket=bucket,
                        object_key_prefix="emails/",
                        topic=topic
                    )
                ]
            ), ReceiptRuleOptions(
                recipients=["aws.com"],
                actions=[
                    actions.Sns(
                        topic=topic
                    )
                ]
            )
            ]
        )
        ```
        
        Alternatively, rules can be added to a rule set:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        rule_set = ses.ReceiptRuleSet(self, "RuleSet")
        
        aws_rule = rule_set.add_rule("Aws",
            recipients=["aws.com"]
        )
        ```
        
        And actions to rules:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        aws_rule.add_action(actions.Sns(
            topic=topic
        ))
        ```
        
        When using `addRule`, the new rule is added after the last added rule unless `after` is specified.
        
        #### Drop spams
        
        A rule to drop spam can be added by setting `dropSpam` to `true`:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        ses.ReceiptRuleSet(self, "RuleSet",
            drop_spam=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:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        ses.ReceiptFilter(self, "Filter",
            ip="1.2.3.4/16"
        )
        ```
        
        A white list filter is also available:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        ses.WhiteListReceiptFilter(self, "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
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
