https://github.com/discretetom/ses-event-recorder
Publish AWS SES events to AWS DynamoDB table so you can see the delivery details of you email.
https://github.com/discretetom/ses-event-recorder
Last synced: 9 months ago
JSON representation
Publish AWS SES events to AWS DynamoDB table so you can see the delivery details of you email.
- Host: GitHub
- URL: https://github.com/discretetom/ses-event-recorder
- Owner: DiscreteTom
- Created: 2022-04-01T08:44:05.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-02T06:26:42.000Z (about 4 years ago)
- Last Synced: 2025-02-05T06:38:58.116Z (over 1 year ago)
- Language: TypeScript
- Size: 623 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SES Event Recorder
Publish AWS SES events to AWS CloudWatch Logs or AWS DynamoDB table so you can see the delivery details of your email.
For CloudWatch Logs, you can search events by keywords:
For DynamoDB, you can query your email events by recipient email address and a time range:
## Architecture
- SES Event Publishing will be used to publish selected events to SNS.
- By default the selected event types are `REJECT,BOUNCE,COMPLAINT`, you can customize it by using CDK/CloudFormation parameters.
- Lambda will save the full records to DynamoDB.
- You can customize the lambda handler code to make those records smaller.
- Raw event will be logged into CloudWatch Logs and be retained for 1 day.
- DynamoDB is used to query your SES events.
- The destinations/recipients of the email is the partition key of DynamoDB, and the timestamp of the email is the sort key.
- If a email contains multiple destinations, multiple item will be created in DynamoDB.
- By this design, you can query your email events by recipient email address and a time range.
- DynamoDB TTL attribute is set to control the size of the table. TTL is 7 days by default, you can customize it by using CDK/CloudFormation parameters.
## Prerequisites
- [Node.js](https://nodejs.org/en/) is installed.
- [AWS credentials are configured.](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html)
## Deploy
```bash
# install aws cdk
npm install -g aws-cdk
# download source code
git clone https://github.com/DiscreteTom/ses-event-recorder.git
cd ses-event-recorder
# install dependencies
npm install
# prepare cdk environment
cdk bootstrap
# deploy this project
cdk deploy
# equals to
# cdk deploy --parameters EventTypes=REJECT,BOUNCE,COMPLAINT --parameters StorageType="CloudWatch Logs" --parameters CloudWatchLogRetention=ONE_WEEK
```
After those above, you will see a new SES Configuration Set. Set that Configuration Set to the default Configuration Set of you Verified Identities.
Then, send a test email using `Bounce` type:
Now you can find your bounce event details in CloudWatch Logs:
Or DynamoDB:
## Clean Up
```bash
cdk destroy
```