-
Notifications
You must be signed in to change notification settings - Fork 4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(ses): add constructs for email receiving #1971
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this looks excellent!
I have some small requests about documentation (move the example, make sure all publicly visible types have a docstring describing the purpose of the type) but the rest looks great.
Will merge this once the docs have been updated.
packages/@aws-cdk/aws-ses/README.md
Outdated
### Email receiving | ||
Create a receipt rule set with rules and actions: | ||
```ts | ||
const bucket = new s3.Bucket(this, 'Bucket'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please move this into a file named:
test/example.receiving.lit.ts
And add the requirement imports and Stack
declaration around it?
You can mark the piece of code that is relevant for the example with:
/// !show
...code goes here
/// !hide
And at this location in the README add:
[example of setting up a receive rule](test/example.receiving.lit.ts)
This will make sure that the example actually compiles, and if we make breaking API changes, the compiler failure will force us to update the example code.
Done. I thought Shouldn't completed-docs be included? I see a lot of PR comments about JSDoc... (maybe with a minimal configuration, the code base is large) |
Created #2026 |
I was thinking the same, we should have static checks on this. |
Add constructs for email receiving.
Add constructs for receipt rule set, receipt rule and receipt filter. Also add classes for rule actions.
A rule set with a first rule that drops spam/viruses can be easily created using the
dropSpam
prop of theReceiptRuleSet
construct.IP white listing can be implemented using the
WhiteListReceiptFilter
.Pull Request Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.