Giter VIP home page Giter VIP logo

abalonemail's Introduction

abalonemail

A microservice to send emails in response to job queue items using sendgrid. Example job queue item:

{
  "service": "abalonemail",
  "type": "email",
  "config": {
    "multiple": false,
    "from": "[email protected]",
    "to": {
      "name": "Billy bob",
      "email": "[email protected]"
    },
    "subject": "Test mail",
    "templateData": {
      "foo": "bar"
    },
    "text": "Test!",
    "html": "<h1>Test: {{ foo }}</h1>",
    "attachments": [
      {
        "content": "RXhhbXBsZSBkYXRh",
        "filename": "test.dat",
        "type": "plain/text"
      }
    ]
  }
}

Checkout @oada/formats for a more detailed description of the format.

The from address and the sendgrid API key are set with .env. For example:

domain=oada.example.org
token=ajxhcjkal7y83hdsjkhc8l2
apiKey=aksdjca83d.asdfkxjjc93cSDFUsDaAfaj23FEVhSDvksljsadv0CdADs3V0g84rjksdf

Installation

cd /path/to/your/oada-srvc-docker
cd services-available
git clone [email protected]:trellisfw/abalonemail.git
cd ../services-enabled
ln -s ../services-available/abalonemail .

Overriding defaults for production

Using z_tokens method from oada-srvc-docker, the following docker-compose entry overrides configs for production:

  abalonemail:
    environment:
      - TOKEN=aproductiontokentouse
      - DOMAIN=your.trellis.domain
      - API_KEY=thekeyforsendgridsapi

abalonemail's People

Contributors

abalmos avatar aultac avatar awlayton avatar dependabot[bot] avatar sanoel avatar

Watchers

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