Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
eexit committed Jan 7, 2021
1 parent 22603b3 commit ceac6bc
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,41 @@
# 📩 HTTP to SMTP

[![version](https://img.shields.io/github/v/tag/eexit/http2smtp?label=version&logo=github&sort=semver)](https://github.com/eexit/http2smtp/releases) [![docker pull](https://img.shields.io/docker/pulls/eexit/http2smtp)](https://hub.docker.com/repository/docker/eexit/http2smtp) [![ci](https://github.com/eexit/http2smtp/workflows/build/badge.svg)](https://github.com/eexit/http2smtp/actions) [![codecov](https://codecov.io/gh/eexit/http2smtp/branch/master/graph/badge.svg?token=XH18EYLDLZ)](https://codecov.io/gh/eexit/http2smtp) [![license](https://img.shields.io/github/license/eexit/http2smtp)](https://github.com/eexit/http2smtp/blob/master/LICENSE)
[![ci](https://github.com/eexit/http2smtp/workflows/build/badge.svg)](https://github.com/eexit/http2smtp/actions) [![codecov](https://codecov.io/gh/eexit/http2smtp/branch/master/graph/badge.svg?token=XH18EYLDLZ)](https://codecov.io/gh/eexit/http2smtp) [![version](https://img.shields.io/github/v/tag/eexit/http2smtp?label=version&logo=github&sort=semver)](https://github.com/eexit/http2smtp/releases) [![license](https://img.shields.io/github/license/eexit/http2smtp)](https://github.com/eexit/http2smtp/blob/master/LICENSE)

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

Plug a [MailHog](https://github.com/mailhog/MailHog) or [MailCatcher](https://mailcatcher.me/) to API email sending vendors such as [SparkPost](https://www.sparkpost.com/), [Mailgun](https://www.mailgun.com/) or [SendGrid](https://sendgrid.com/) for testing purposes.

#### Features

- :white_check_mark: 100% code coverage
- :whale: Light Docker image available
- :zap: AWS Lambda Function 3-commands deployment

## Usage

See [examples](examples).

:zap: ProTip: for tracing purposes, this app kinda supports [W3C Trace Context recommendation](https://www.w3.org/TR/trace-context/). 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 image [![docker pull](https://img.shields.io/docker/pulls/eexit/http2smtp)](https://hub.docker.com/repository/docker/eexit/http2smtp) [![size](https://img.shields.io/docker/image-size/eexit/http2smtp?sort=semver)](https://hub.docker.com/repository/docker/eexit/http2smtp)

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

## Vendor endpoints

### [SparkPost](https://developers.sparkpost.com/api/)
### AWS Lambda Function ![aws-lambda-ready](https://img.shields.io/badge/aws-lambda--ready-orange?logo=amazon-aws&style=flat)

#### Inline transmission
:zap: This project is also shipped for an AWS Lambda Function-ready. Check out the [README](cmd/http2smtp-lambda).

API documentation: https://developers.sparkpost.com/api/transmissions/#transmissions-post-send-inline-content
## Vendors

_:warning: Not supported yet._

#### RFC 822 transmission

API documentation: https://developers.sparkpost.com/api/transmissions/#transmissions-post-send-rfc822-content
### [SparkPost](https://developers.sparkpost.com/api/)

POST /sparkpost/api/v1/transmissions

SparkPost supports either [inline](https://developers.sparkpost.com/api/transmissions/#transmissions-post-send-inline-content) or [RFC 822 transmissions](https://developers.sparkpost.com/api/transmissions/#transmissions-post-send-rfc822-content). 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
Expand All @@ -43,4 +44,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

## Contributors

![contributors](https://contrib.rocks/image?repo=eexit/http2smtp)
[![contributors](https://contrib.rocks/image?repo=eexit/http2smtp)](https://github.com/eexit/http2smtp/graphs/contributors)
2 changes: 1 addition & 1 deletion cmd/http2smtp-lambda/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :zap: http2smtp for AWS Lambda

Deploy in 2 commands!
Deploy in 3 commands (assuming you already have a SMTP server deployed).

## Usage

Expand Down

0 comments on commit ceac6bc

Please sign in to comment.