Git Product home page Git Product logo

smsapi2email's Introduction

SMS-API 2 EMAIL

Go Report Card GitHub

Drop-in replacement for SMSAPI for testing environments

Features:

  • Send messages to mail address instead of SMS using simple API
  • Very simple API
  • REST API compatible with popular Smsapi.pl service
  • Easy integration with MailHog

How it works:

Application send messages to email address to@domain instead of SMS

where

  • to is query param in REST (this is usually phone number)
  • domain is environment variable DOMAIN (can be anything when using MailHog)

API

Endpoint: http://HOST:PORT/sms.do

Query parameters:

  • to phone number
  • message - content of message

Example

  • sending message using cURL
curl 'http://localhost:8080/sms.do?username=user&from=smsapi&to=666777888&message=some_message'

run in docker

Docker image krzysbaranski/smsapi2email

docker run --rm -d --env DOMAIN=example.com --env SMTP_HOST=smtp.example.com --env SMTP_PORT=25 -p 8080:8080 krzysbaranski/smsapi2email

docker-compose

docker compose setup both smsapi2email and MailHog

docker-compose up -d

run

  • setup environment (optional)
export DOMAIN="mydomain"
export PORT="8090"
export HOSTNAME="localhost"
  • run directly from go

go run main.go

  • run from binary:

SMTP_HOST=mysmtpserver SMTP_PORT=25 ./smsapi2email

compile

go build

build docker image

docker build -t krzysbaranski/smsapi2email .

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.