Giter Club home page Giter Club logo

flyte-email's Introduction

flyte-email

Build Status Docker Stars Docker Pulls

Overview

The Email pack provides the ability to send emails.

Build and Run

Command Line

To build and run from the command line:

  • Clone this repo
  • Run make build
  • Run FLYTE_API_URL=<URL> SMTPSERVER=<SERVER> ./flyte-email
  • Fill in this command with the relevant API url and smtp server value.

Docker

To build and run from docker

  • Run make docker-build
  • Run docker run -e FLYTE_API_URL=<URL> -e SMTPSERVER=<SERVER> flyte-email
  • All of these environment variables need to be set

Commands

This pack provides the 'SendEmail' command, and as its name suggests, simply sends an email.

Input

This commands input requires the email from address, the email to address, the email subject, the email body and isHtmlEmail flag:

"input": {
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Open the pod bay doors, HAL",
    "body": "...",
    "isHtmlEmail": true
    }

Output

This command can either return an EmailSent event meaning the email has successfully sent or an SendEmailFailed event, meaning there was a problem.

EmailSent

This is the success event, it contains the command name, sender, receiver, subject and email body. It returns them in the form:

"payload": {
        "from": "[email protected]",
        "to": "[email protected]",
        "subject": "Open the pod bay doors, HAL",
        "body": "...",
        "isHtmlEmail": true
}
SendEmailFailed

This contains the normal output fields plus the error if the command fails:

"payload": {
        "from": "[email protected]",
        "to": "[email protected]",
        "subject": "Open the pod bay doors, HAL",
        "body": "...",
        "isHtmlEmail": true,
        "error": "I'm sorry, Dave. I'm afraid I can't do that."
}

flyte-email's People

Contributors

dangorst1066 avatar fooksca avatar isaacasensio avatar jollinshead avatar pamelin avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

flyte-email's Issues

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.