README.md

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

Soham Dutta

Stargazers

Forkers

Copyright & License

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