https://github.com/stemmlerjs/mail-microservice
📧 Simple mail microservice using AWS SES.
https://github.com/stemmlerjs/mail-microservice
aws-ses email microservice nodejs
Last synced: 2 months ago
JSON representation
📧 Simple mail microservice using AWS SES.
- Host: GitHub
- URL: https://github.com/stemmlerjs/mail-microservice
- Owner: stemmlerjs
- Created: 2018-07-25T17:59:00.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-25T21:40:13.000Z (almost 7 years ago)
- Last Synced: 2025-03-27T19:23:15.450Z (3 months ago)
- Topics: aws-ses, email, microservice, nodejs
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mail-microservice
Mail micro service for my node apps.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
- NodeJS
- Amazon API Key
### Running the example
The Mailer microservice can be run with:
```
npm run start
```
And then to run the mock service registry, run:
```
node example/app.js
```
To test out an email, send `POST` request to ```http://127.0.0.1:3000/register``` with the body as follows:
```
{
"email": "[email protected]",
"password": "examplepassword"
}
```
## v2
### Branch: master
Version 2 is an improvement that allows me to plug this into any app backend now.
Features:
- Slack webhook update on exceptions
- Starts with unique port and announces itself to a service registry.
- Reusable with any app.
- Expandable.
Upcoming:
- Add the ability to use different mail services (mailchimp, mailgun, nodemailer).
- Add ability to email maintainers if exceptions occur.
## v1
### Branch: v1
Version 1 was quickly created in order to respond to an influx of new users @ Univjobs.
It served it's purpose but it wasn't very reusable for my other projects. This is mainly due to the fact that it wasn't designed as a service but rather as a separate module to the platform. That being said, here are the pros and cons of this version.
Pros:
- We can re-send failed emails.
- If there is any downtime, we can be sure that these emails will be attempted to be sent when the services comes back online.
Cons:
- It requires access to the database.
- It polls the database for work.
- It's too specific / not generic enough. Can't be plugged into another app.
- If we were to add more instances, there is a chance that we could in a rare case, send the same email more than once (very bad).
These cons are why I decided to update the this repo to use a more traditional micro-service architecture.