Code Monkey home page Code Monkey logo

envoy's Introduction

icon

GitHub GitHub release (latest by date including pre-releases GitHub top language GitHub Repo forks GitHub Repo stars GitHub Repo stars

Envoy

Welcome to Envoy - your all-in-one email management solution to schedule and track emails! ๐Ÿ’Œ

API

Base URL

  https://envoy-api.up.railway.app

Send a Normal Email

  POST /api/v1/send
Parameter Type Description
to email Required. Recipient's email address
subject string Required. Subject
body string Required. Body
cc array Optional. Cc list
bcc array Optional. Bcc list
trackEmail email Optional. Email address to recieve track notification

Example Request

{
  "to": "[email protected]",
  "subject": "Your Subject Here",
  "body": "Your Email Body Here",
  "cc": ["[email protected]", "[email protected]"],
  "bcc": ["[email protected]", "[email protected]"],
  "trackEmail": "[email protected]"
}

Response

{
    "success": true,
    "message": "Email sent successfully"
}

Schedule an Email

  POST api/v1/schedule
Parameter Type Description
to email Required. Recipient's email address
subject string Required. Subject
body string Required. Body
dateTime time Required. Scheduled time
timeZone string Required. Sender's zone id
cc array Optional. Cc list
bcc array Optional. Bcc list
trackEmail email Optional. Email address to recieve track notification

Example Request

{
    "to": "[email protected]",
    "subject": "Meeting Reminder",
    "body": "Don't forget our meeting tomorrow!",
    "dateTime": "2024-04-27T10:00:00Z",
    "zoneId": "America/New_York",
    "cc": ["[email protected]", "[email protected]"],
    "bcc": ["[email protected]"],
    "trackEmail": "[email protected]"
}

Response

{
  "success": true,
  "jobId": "96db0d1b-608c-4cba-8f76-19924e90b3ba",
  "jobGroup": "email-jobs",
  "message": "Email Scheduled Successfully!"
}

Project Created & Maintained By

Aniket Pathak

GitHub followers

Soham Dutta

GitHub followers

Stargazers

Stargazers repo roster for @aniketpathak028/envoy

Forkers

Forkers repo roster for @aniketpathak028/envoy

Copyright & License

Code and documentation Copyright (c) Apache-2.0 ยฉ 2024 Envoy.

envoy's People

Contributors

shm-dsgn avatar aniketpathak028 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.