Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/int128/ses-to-slack
Lambda function to forward mails from AWS SES to Slack/Mattermost
https://github.com/int128/ses-to-slack
aws-lambda aws-ses javascript mattermost serverless slack
Last synced: 25 days ago
JSON representation
Lambda function to forward mails from AWS SES to Slack/Mattermost
- Host: GitHub
- URL: https://github.com/int128/ses-to-slack
- Owner: int128
- License: apache-2.0
- Created: 2017-11-24T07:18:00.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-04T12:09:32.000Z (over 4 years ago)
- Last Synced: 2024-10-27T07:50:07.600Z (2 months ago)
- Topics: aws-lambda, aws-ses, javascript, mattermost, serverless, slack
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SES to Slack
This is an AWS Lambda function to forward mails from SES to Slack, based on the Serverless framework.
## How it works
```
Mail Server
↓ SMTP
AWS SES
↓ Publish
AWS SNS
↓ Subscribe
AWS Lambda
↓ HTTP(S)
Slack Incoming Webhook
```
## Getting Started
Deploy a Lambda function.
```sh
# Setup credentials
npm run serverless -- config credentials -p aws -k IAM_KEY -s IAM_SECRET
# Deploy
npm install
npm run deploy
```
Open the AWS Management Console and do following steps:
1. Open Lambda and Check ARN of the function, like `arn:aws:lambda:ap-northeast-1:***:function:ses-to-slack-dev-handle`.
1. Add an environment variable on the function:
- `WEBHOOK`: URL of Slack Incoming Webhook (Mandatory)
- `WEBHOOK_USERNAME`: Username for Incoming Webhook request (Optional)
- `WEBHOOK_ICON_EMOJI`: Icon for Incoming Webhook request (Optional)
- `WEBHOOK_HOST_HEADER`: Host header for Incoming Webhook request (Optional)
1. Open SNS and create a topic.
1. Create a subscription on the topic:
- Protocol: AWS Lambda.
- Endpoint: ARN of the Lambda function.
1. Open SES and make sure your domain has been verified.
1. Create a rule set with the following action:
- SNS topic: ARN of the SNS topic.
- Encoding: UTF-8
## Sending to Mattermost
Mattermost is a Slack alternative. You can send mails to a Mattermost channel as well.
1. Create an Incoming Webhook on a Mattermost team.
1. Set the `WEBHOOK` environment variable.
If the instance is protected by the security group, you can send mails via VPC.
For example,
```
Mail Server
↓ SMTP
AWS SES
↓ Publish
AWS SNS
↓ Subscribe
AWS Lambda
↓ ENI
↓ VPC
↓ ENI
AWS EC2
```
If a reverse proxy exists and requires `Host` header, you can specify the `WEBHOOK_HOST_HEADER` environment variable.
## Caveat
SNS can receive mails that are 150kB or less. Larger mails will bounce.
## Contributions
Feel free to open an issue or pull request.