Giter Club home page Giter Club logo

pigeon's Introduction

Go Report Card

Pigeon

A Comms Micro Service

Abstract

Provides end points for sending communication such as Email

Prerequisite

dep ensure

Usage

export DOMAIN="mailgun domain"
export API_KEY="mailgun api key"
export PUBLIC_API_KEY="mailgun api public key"
export TEMPLATES="templates"
export TO_EMAIL="[email protected]"

Enable test mode

export TEST_MODE=1

Set api url to eu region

export MG_URL=https://api.eu.mailgun.net/v3

Send an email

curl -X POST http://localhost:3411/email \
-d "{
        \"to\":\"[email protected]\",
        \"from\":\"[email protected]\",
        \"subject\":\"Cool Subject\",
        \"text\":\"Interesting Message\"
    }"

Use a template

curl -X POST http://localhost:3411/email \
-d "{
        \"to\": \"[email protected]\",
        \"from\": \"[email protected]\",
        \"template\": \"test\",
        \"params\": {
            \"name\": \"Cuthbert\",
            \"colour\": \"Purple\"
        }
    }"

Get a template

curl -X POST http://localhost:3411/template \
-d "{
        \"template\": \"test\",
        \"params\": {
            \"name\": \"Cuthbert\",
            \"colour\": \"Purple\"
        }
    }"

Verify Email

curl -X POST http://localhost:3411/verify \
-d "{
        \"email\": \"[email protected]\",
        \"ip\": \"127.0.0.1\"
    }"

Upgrading Packages

Upgrade packages by specifying the package to upgrade.

go get -u github.com/aws/aws-sdk-go

pigeon's People

Contributors

thomaslorentsen avatar

Watchers

 avatar  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.