Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cusspvz/contact-email.microservice
📩 A configurable Microservice that centralizes contact requests
https://github.com/cusspvz/contact-email.microservice
contact docker email microservice nodemailer recaptcha send
Last synced: about 10 hours ago
JSON representation
📩 A configurable Microservice that centralizes contact requests
- Host: GitHub
- URL: https://github.com/cusspvz/contact-email.microservice
- Owner: cusspvz
- License: mit
- Created: 2018-07-09T12:14:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-31T13:59:38.000Z (over 2 years ago)
- Last Synced: 2024-04-14T15:14:28.236Z (6 months ago)
- Topics: contact, docker, email, microservice, nodemailer, recaptcha, send
- Language: JavaScript
- Homepage:
- Size: 73.2 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Contact Email Microservice
### :envelope_with_arrow: A configurable Microservice that centralizes contact requests
```
Repos:
GITHUB: github.com/cusspvz/contact-email.microservice
NPM: @cusspvz/contact-email.microservice
DOCKER: cusspvz/contact-email.microservice
```
## Features
###Â Anti-Spam
+ reCAPTCHA
+ CORS
###Â Client
+ GMail
+ SMTP
### Others
+ `/healthz` - healthcheck route
+ support for a random string at the subject to prevent gmail group/trimming
## Usage
### Docker
```
docker pull cusspvz/contact-email.microservice
docker run -ti --rm --env-file path/to/settings.env cusspvz/contact-email.microservice
```
## Configuration
###Â Nodemailer
#### `NODEMAILER_SERVICE`
+ Default: `null`
+ Description: Defines a service for the transport
#### `NODEMAILER_HOST`
+ Default: `false`
+ Description: Sets the host to connect to.
#### `NODEMAILER_SECURE`
+ Default: `false`
+ Description: Set this variable as `1` if you want the transport to use secure ports
#### `NODEMAILER_AUTH`
+ Default: `false`
+ Description: Set this variable as `1` if you want to setup authentication
#### `NODEMAILER_TYPE`
+ Default: `false`
+ Description: Sets the authentication type. (needed for OAuth2)
+ Note: Requires `NODEMAILER_AUTH` to be set
#### `NODEMAILER_ACCESS_TOKEN`
+ Default: `false`
+ Description: Sets the token on authentication. (needed for OAuth2)
+ Note: Requires `NODEMAILER_AUTH` to be set
#### `NODEMAILER_USER`
+ Default: `false`
+ Description: Sets the user on authentication.
+ Note: Requires `NODEMAILER_AUTH` to be set
#### `NODEMAILER_PASS`
+ Default: `false`
+ Description: Sets the password on authentication.
+ Note: Requires `NODEMAILER_AUTH` to be set
###Â Email
#### `EMAIL_PREVENT_GROUPING`
+ Default: `1`
+ Description: Defines if subject gets an extra string to prevent email grouping
+ Note: Accepts 1 and 0
### CORS
#### `CORS_ORIGIN_REGEXP`
+ Default: `null`
+ Description: Defines a CORS origin based on a regexp
+ Note: Please insert the regexp without the slashes
+ Example: `(?:(www|marketing).)website.(com|org)`
#### `CORS_ORIGIN_COMMA_SEP`
+ Default: `null`
+ Description: Defines a CORS origin based on a comma separated string
+ Note: Please insert the urls without extra spaces
+ Example: `website.com,website.org,www.website.com,www.website.org`
### reCAPTCHA
#### `RECAPTCHA`
+ Default: `null`
+ Description: Set this variable as `1` if you want to setup reCAPTCHA
#### `RECAPTCHA_PUBLIC_KEY`
+ Default: `null`
+ Description: Defines the reCAPTCHA Public key
+ Note: Requires `RECAPTCHA` to be set.
#### `RECAPTCHA_PRIVATE_KEY`
+ Default: `null`
+ Description: Defines the reCAPTCHA Private key
+ Note: Requires `RECAPTCHA` to be set.
### Server
#### `SERVER_PORT`
+ Default: `8080`
+ Description: Set the HTTP server port