https://github.com/suin/google-cloud-functions-sendgrid-inbound-parse
This package is a backend for SendGrid Inbound Parse. It runs on Google Cloud Platform Functions. It receives the form data from SendGrid and publishes an EmailData event to GCP Pub/Sub.
https://github.com/suin/google-cloud-functions-sendgrid-inbound-parse
email-automation gcp-cloud-functions google-cloud-platform google-cloud-pubsub sendgrid sendgrid-inbound-webhook-parser serverless
Last synced: 5 months ago
JSON representation
This package is a backend for SendGrid Inbound Parse. It runs on Google Cloud Platform Functions. It receives the form data from SendGrid and publishes an EmailData event to GCP Pub/Sub.
- Host: GitHub
- URL: https://github.com/suin/google-cloud-functions-sendgrid-inbound-parse
- Owner: suin
- License: mit
- Created: 2020-07-23T04:26:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T12:13:45.000Z (almost 3 years ago)
- Last Synced: 2025-04-07T03:23:07.448Z (8 months ago)
- Topics: email-automation, gcp-cloud-functions, google-cloud-platform, google-cloud-pubsub, sendgrid, sendgrid-inbound-webhook-parser, serverless
- Language: TypeScript
- Homepage:
- Size: 3.65 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @suin/google-could-functions-sendgrid-inbound-parse
This package is a backend for [SendGrid Inbound Parse]. It runs on Google Cloud Platform Functions.
[sendgrid inbound parse]: https://sendgrid.com/docs/for-developers/parsing-email/setting-up-the-inbound-parse-webhook/
## Architecture
1. The GCP function `publishEmailDataOnSendgridInboundParse` is invoked by SendGrid Inbound Parse.
2. It parses the form data that was posted by SendGrid.
3. It transforms the form data into the [EmailData](https://github.com/suin/email-data) object.
4. It publishes the `EmailData` to GCP Pub/Sub topic `allEmail`.
## Setting Up
### Setting Up The Inbound Parse Webhook
Before using this package, please read [the SendGrid's official document](https://sendgrid.com/docs/for-developers/parsing-email/setting-up-the-inbound-parse-webhook/) to set up the SendGrid Inbound Parse.
### Deploying The Stacks To Your GCP
The [deploy.sh](./deploy.sh) a script that deploys this package to your Google Cloud Platform. The script performs these two operations:
1. Create a new Pub/Sub topic to publish the email data which is posted by the SendGrid Inbound Parse Webhook.
2. Deploy a new function. This function processes the form data which is posted by the SendGrid Inbound Parse Webhook, transforms the form data into an event payload, and publishes the event to the topic which was created by the operation above.
By default, the topic name is `allEmail`. If you would like to change it, please edit the `deploy.sh`.
To deploy these stacks, please run the following command:
```bash
./deploy.sh
```
### Configuring The SendGrid Inbound Parse
Once the deployment success, go back to the SendGrid console and add the inbound parse webhook URL.
As this function expects raw email data, you have to enable the raw option in the SendGrid console:
## Test Drive
After you have finished the setting up above, confirm the system works well.
At first, to make it possible to receive and read the messages that the function publishes, create a new subscription on the topic:
```bash
gcloud pubsub subscriptions create --topic allEmail testDrive
# If you have customized the topic name, please change the `allEmail` above.
```
At next, send a test email to the email address which the SendGrid Inbound Parse receives.
Then receive the message using the `testDrive` subscription:
```bash
gcloud pubsub subscriptions pull testDrive \
--format="flattened(ackId,message.messageId,message.publishTime,message.attributes,message.data.decode(base64).encode(utf-8))" \
--limit=10 \
--auto-ack
```
If the system works without any problems, you will see some messages.
Finally, delete the `testDrive` subscription:
```bash
gcloud pubsub subscriptions delete testDrive
```