Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erdemkosk/rabbitmq-mail-consumer-server
Headless mail consumer which is for sending mails and abstract it. If you want it controls blacklist from redis.
https://github.com/erdemkosk/rabbitmq-mail-consumer-server
mail nodejs rabbit-mq redis rpi
Last synced: 9 days ago
JSON representation
Headless mail consumer which is for sending mails and abstract it. If you want it controls blacklist from redis.
- Host: GitHub
- URL: https://github.com/erdemkosk/rabbitmq-mail-consumer-server
- Owner: erdemkosk
- Created: 2020-05-05T18:09:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T16:23:09.000Z (almost 2 years ago)
- Last Synced: 2023-03-08T03:19:33.995Z (almost 2 years ago)
- Topics: mail, nodejs, rabbit-mq, redis, rpi
- Language: JavaScript
- Homepage:
- Size: 325 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# rabbitmq-mail-consumer-server
Rabbitmq-mail-consumer-server is an independent mail sending server that abstracts the sending mails from system. Services that want to send mail do not need to know where and how this server works 😎. Just make sure you're looking at the same rabbit mq channel.
> Sending mail is abstracted from the whole system. You don't have to think ✌️.
### Tech
Rabbitmq-mail-consumer-server uses a number of open source projects to work properly:
* [Node Js] - for runnig server
* [Rabbit MQ] - for getting messages from another server
* [Redis] - for checking email blacklist
### For Blacklist
You need to add a mail adress to redis.
> /unsubscribe?email=(with encrypted mail)
### Installation
Rabbitmq-mail-consumer-server requires [Node.js](https://nodejs.org/) v8+ to run.
Install the dependencies and devDependencies and start the server.
```sh
$ cd rabbitmq-mail-consumer-server
$ npm install
$ node app
```
For Make A Docker Image:
```sh
$ docker build -t rabbitmq-mail-consumer-server .
$ docker run --env-file .env -p 5000:5000 rabbitmq-mail-consumer-server
```
Pull From Docker Hub
- latest
- rpi => ARM build for raspperry pi
```sh
$ docker run --env-file .env -p 5000:5000 erdemkosk/rabbitmq-mail-consumer-server:latest
or
$ docker run --env-file .env -p 5000:5000 erdemkosk/rabbitmq-mail-consumer-server:rpi
```
For Docker-Compose
- latest
- rpi => ARM build for raspperry pi
```sh
$ docker-compose -f docker-compose-latest.yml up
or
$ docker-compose -f docker-compose-rpi.yml up
```
### Running Stages
You need to send messages from your server to rabbit mq channel when you need to send mail.
Forget Password Mail:
```sh
rabbitMq.sendRabbitMQ('mailChannel', JSON.stringify({
email: '[email protected]',
nameSurname: 'Erdem Köşk',
type: 'forget',
appName: 'Test Me',
forgetTitle: 'Şifreni Unutmuşsun :(',
forgetMessage: 'nameSurname şifreni unutmuşsun! Aşağıdaki adımları takip edelim.',
mailIcon: 'https://img.icons8.com/clouds/100/000000/jake.png',
webSiteLink: 'http://localhost:3000',
webSiteLinkButton: 'Hadi Başlayalım!',
warningText: 'Şifre sıfırlama talebini siz yollamadıysanız, lütfen dikkate almayın !',
sincerelyText: 'Sevgilerle',
needHelpText: 'Yardım mı lazım?',
needHelpLink: 'http://erdemkosk.com',
}));
```
Register Mail:
```sh
rabbitMq.sendRabbitMQ('mailChannel', JSON.stringify({
email: '[email protected]',
nameSurname: 'Erdem Köşk',
type: 'register',
appName: 'Test Me',
welcomeTitle: 'Hoş Geldin!',
welcomeMessage: 'Seni aramızda görmek çok güzel nameSurname !
İngilizce kelime öğrenmenin en kolay yolu 🤙. Boş zamanlarında senin için oluşturulan rastgele ingilizce kelime testlerini cevapla 🙏 Kendini geliştir!',
mailIcon: 'https://img.icons8.com/clouds/100/000000/america.png',
webSiteLink: 'http://localhost:3000',
webSiteLinkButton: 'Hadi Başlayalım!',
thanksText: 'Projemize destek verdiğin için teşekkür ederiz!',
sincerelyText: 'Sevgilerle',
needHelpText: 'Yardım mı lazım?',
needHelpLink: 'http://erdemkosk.com',
}));
```
When messages arrvied rabbitmq-mail-consumer-server, it controls mail in blacklist (from redis).
If In Not Blacklist:
If In Blacklist:
### Env Variables
| Env | Example
| ------------- |:-------------:
| NODE_ENV | dev
| RABBITMQ_URL | amqp url
| RABBITMQ_CHANNEL | amqp channel
| MAIL_USER | user mail
| MAIL_PASS | yser mail password
| MAIL_HOST | smtp mail server
| MAIL_PORT | smtp mail port
| REDIS_HOST | redis url
| REDIS_PASS | redis password
| REDIS_PORT | redis port
| URL | unsubscribe url path
### Mail Types
There are two types of mail. Its type can be easily increased and different parameters can be sent for each.🙏
- Register
- Forget
Register:
Forget:
