https://github.com/teran/relay

SMTP server to use for forwarding messages
https://github.com/teran/relay

mailgun mailgun-api smtp smtp-relay

Last synced: 2 months ago
JSON representation

SMTP server to use for forwarding messages

• Host: GitHub
• URL: https://github.com/teran/relay
• Owner: teran
• License: mit
• Created: 2018-05-07T10:36:18.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-26T17:28:21.000Z (10 months ago)
• Last Synced: 2024-11-26T18:29:58.835Z (10 months ago)
• Topics: mailgun, mailgun-api, smtp, smtp-relay
• Language: Go
• Homepage:
• Size: 459 KB
• Stars: 6
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# mail-relay

[![Verify](https://github.com/teran/relay/actions/workflows/verify.yml/badge.svg?branch=master)](https://github.com/teran/relay/actions/workflows/verify.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/teran/relay)](https://goreportcard.com/report/github.com/teran/relay)

[![Go Reference](https://pkg.go.dev/badge/github.com/teran/relay.svg)](https://pkg.go.dev/github.com/teran/relay)

SMTP server to use for forwarding messages via HTTP-based services in environments

not supporting SMTP outbound directly

## How this works

Relay accepts SMTP connection to handle message with invoking Mailgun API with

the message it got. Simply :)

In depth in current implementation relay sends message synchronously via Mailgun

Go's client.

## How to use

```shell

docker run -it \

  -e RELAY_DRIVER=mailgun \

  -e RELAY_MAILGUN_API_KEY=" \

  -e RELAY_DOMAIN="" \

  -e RELAY_MAILGUN_URL="" \

  -e RELAY_ADDR=:25 \

  -e RELAY_MAX_IDLE_SECONDS=300 \

  -e RELAY_MAX_MESSAGE_BYTES=1048576 \

  -e RELAY_MAX_RECIPIENTS=50 \

  ghcr.io/teran/relay:latest

```

RELAY_MAILGUN_URL is an API URL:

* `https://api.eu.mailgun.net/v3` for EU

* `https://api.mailgun.net/v3` for US