Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 2.78 KB

README.md

File metadata and controls

47 lines (27 loc) · 2.78 KB
Raw

📩 HTTP to SMTP

ci codecov version license

An API that forwards HTTP-backed vendor mailer calls to SMTP.

Plug a MailHog or MailCatcher to API email sending vendors such as SparkPost, Mailgun or SendGrid for testing purposes.

Features

  • ✅ 100% code coverage
  • 🐳 Light Docker image available
  • ⚡ AWS Lambda Function 3-commands deployment

Usage

See examples.

⚡ ProTip: for tracing purposes, this app kinda supports W3C Trace Context recommendation. Configure the env var TRACEPARENT_HEADER and inject any trace into this header value. All log entries will be contextualized with the given value.

Docker image docker pull size

  1. Checkout this repo or only copy the .env.dist and docker-compose.yml files
  2. Rename .env.dist into .env
  3. Optional: update the values accordingly
  4. Pull images and run docker-compose up http2smtp

AWS Lambda Function aws-lambda-ready

⚡ This project is also shipped for an AWS Lambda Function-ready. Check out the README.

Vendors

SparkPost

POST /sparkpost/api/v1/transmissions

SparkPost supports either inline or RFC 822 transmissions. For now, only the latter one is supported.

Basic validation is enforced, only the recipients list email and the RFC 822 content are used and mandatory.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

contributors