Git Product home page Git Product logo

flowroute-sms-email-proxy's Introduction

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]

flowroute-sms-email-proxy's People

Contributors

fredlackeyofficial avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.