SMTP server to forward messages to shoutrrr endpoints
  • Go 91.6%
  • Makefile 5.2%
  • Dockerfile 3.2%
Find a file
Felipe M. d5aeca8875
All checks were successful
CI / format (push) Successful in 28s
CI / goreleaser-lint (push) Successful in 6s
CI / test (push) Successful in 1m42s
CI / lint (push) Successful in 3m13s
CI / build (push) Successful in 2m8s
ci: migrate from Woodpecker to Forgejo Actions and simplify dev tooling (#6)
Switch CI pipelines to GitHub/Forgejo Actions using ci-base container
image, simplify Makefile by removing tools/bin versioned-symlink pattern,
update Containerfile with multi-stage build for CA certs and non-root
user, and clean up GoReleaser config with ldflags and explicit release
target.

Reviewed-on: #6
Co-authored-by: Felipe M. <me@fmartingr.com>
Co-committed-by: Felipe M. <me@fmartingr.com>
2026-04-07 18:22:04 +02:00
.github/workflows ci: migrate from Woodpecker to Forgejo Actions and simplify dev tooling (#6) 2026-04-07 18:22:04 +02:00
cmd Revert "refactor: change base url to codeberg.org" 2025-03-26 17:37:13 +01:00
.gitignore dev: updated golangci-lint to latest and fixed issues 2026-02-04 12:59:15 +01:00
.goreleaser.yml ci: migrate from Woodpecker to Forgejo Actions and simplify dev tooling (#6) 2026-04-07 18:22:04 +02:00
backend.go fix: handle all email content types and preserve query parameters 2026-02-04 16:31:13 +01:00
backend_test.go deps: update 2026-02-04 12:49:10 +01:00
config.go feat: multiple target support 2026-02-04 12:35:44 +01:00
Containerfile ci: migrate from Woodpecker to Forgejo Actions and simplify dev tooling (#6) 2026-04-07 18:22:04 +02:00
email.go fix: handle all email content types and preserve query parameters 2026-02-04 16:31:13 +01:00
go.mod ci: updated pipelines with variables 2026-02-04 15:41:18 +01:00
go.sum deps: update 2026-02-04 12:49:10 +01:00
LICENSE Initial commit 2024-11-13 15:32:54 +01:00
Makefile ci: migrate from Woodpecker to Forgejo Actions and simplify dev tooling (#6) 2026-04-07 18:22:04 +02:00
README.md feat: multiple target support 2026-02-04 12:35:44 +01:00
server.go test: added some tests 2025-02-21 09:59:12 +01:00

smtp2Shoutrrr

A simple SMTP server that forwards incoming emails to a Shoutrrr supported service.

Installing

First generate a new configuration file following this example:

# config.toml
# Port the SMTP server will listen on
Port = 11025

# Credentials for the SMTP server (default to username/password if not set/empty)
Username = "user"
Password = "nometokens"

# Configure recipients to forward emails to

# Multiple Targets (Recommended)
# Use the Targets array to send notifications to multiple services
[[Recipients]]
# Email addresses to forward emails from
Addresses = ["user@example.com"]
# Shoutrrr services to forward emails to
# See shoutrrr documentation: https://containrrr.dev/shoutrrr/
Targets = [
    "ntfy://ntfy.sh/my-ntfy-topic?tags=email",
    "discord://token@id",
    "slack://token@channel"
]

# Single Target (Deprecated)
# The Target field is still supported for backward compatibility
[[Recipients]]
Addresses = ["legacy@example.com"]
Target = "ntfy://ntfy.sh/legacy-topic?tags=thing"  # Will show deprecation warning

# Note: Repeat [[Recipients]] as needed

# Optional: Configure a catch-all recipient for unmatched email addresses
[CatchAll]
# Shoutrrr services to forward unmatched emails to
Targets = ["ntfy://ntfy.sh/catch-all-topic?tags=unmatched"]

From releases

  • Grab the latest release from the releases page
  • Put the configuration file in the same directory as the binary
  • Run the binary for your appropriate platform

From source (development)

  • Clone this repository
  • Put the configuration file in the repository folder
  • Run make quick-run

Using docker

  • Create a config.toml file as described above
  • Run the docker image mounting the Config.toml file as /config.toml and exposing the configured port:
docker run -v /path/to/config.toml:/config.toml \
    -p 11025:11025 \
    git.nakama.town/fmartingr/smtp2shoutrrr:latest

Development

Run the server with:

make quick-run

Send a test email with:

This will read the config.toml in the current directory to set the appropriate SMTP client configuration.

go run ./cmd/sendmail/.