https://github.com/fredlackey/flowroute-sms-email-proxy
Simple proxy service to email incoming SMS messages from Flowroute to an email address or domain.
https://github.com/fredlackey/flowroute-sms-email-proxy
Last synced: about 1 month ago
JSON representation
Simple proxy service to email incoming SMS messages from Flowroute to an email address or domain.
- Host: GitHub
- URL: https://github.com/fredlackey/flowroute-sms-email-proxy
- Owner: FredLackey
- Created: 2017-08-26T02:47:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-17T12:40:27.000Z (9 months ago)
- Last Synced: 2025-03-24T09:11:26.825Z (2 months ago)
- Language: JavaScript
- Size: 19.5 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# flowroute-sms-email-proxy
## Local Usage
TO_DOMAIN=batmail.com SMTP_PASS=brucenrobin [email protected] SMTP_HOST=smtp.batcave.com node ./server.js
... or ...
[email protected] SMTP_PASS=brucenrobin [email protected] SMTP_HOST=smtp.batcave.com node ./server.js
## Docker Usage
docker run --name test -p 3000:3000 \
-e TO_DOMAIN=batmail.com \
-e SMTP_PASS=brucenrobin \
-e [email protected] \
-e SMTP_HOST=smtp.batcave.com
fredlackey/flowroute-proxy
... or ...
docker run --name test -p 3000:3000 \
-e [email protected] \
-e SMTP_PASS=brucenrobin \
-e [email protected] \
-e SMTP_HOST=smtp.batcave.com
fredlackey/flowroute-proxy
## Settings
### General
NODE_PORT: (default 3000)
MOCK_DOMAIN: (default flowroute.com) Placeholder domain of mock sending email address
### Outbound
SMTP_HOST: Outgoing SMTP server
SMTP_PORT: (default 587)
SMTP_SECURE: (default false)
SMTP_USER: Username or email address for outbound mailing
SMTP_PASS: Password for outbound mailing
### Recipient
TO_NAME: (optional) Cosmetic name of destination email recipient
TO_EMAIL: Destination email address (required if TO_DOMAIN is not set)
TO_DOMAIN: Destination domain for wildcard recipients (required if TO_EMAIL is not set)
#### `TO_DOMAIN` vs `TO_EMAIL` Settings
In most scenarios, the `TO_EMAIL` is desired. When used, all incoming SMS messages will be sent to this one single address. The `TO_DOMAIN` setting is used for "wildcard forwarding" or "catchall" domains and is helpful when sorting email messages by sender. When used, all messages will be sent to a fictitious email address at that domain. It is your responsibility to ensure every possible email address at that domain is received. In the examples above, when using the `TO_DOMAIN` (as shown in the first examples) an SMS message sent to `14075551212` will be sent via email to `[email protected]`.
---
## Contact Info & Status
This project was whipped up out of neccessity for something I needed. Feel free to use it. Send any bugs or feature requests to me at:
Fred Lackey
[email protected]