From 31f2102031d35462c773aae66edbd403b2def004 Mon Sep 17 00:00:00 2001 From: "Felipe M. (aider)" Date: Mon, 2 Dec 2024 16:23:49 +0100 Subject: [PATCH 1/9] refactor: Reorganize SMTP2Shoutrrr code into separate files --- backend.go | 116 ++++++++++++++++++++ cmd/smtp2shoutrrr/main.go | 223 +------------------------------------- email.go | 65 +++++++++++ server.go | 50 +++++++++ 4 files changed, 232 insertions(+), 222 deletions(-) create mode 100644 backend.go create mode 100644 email.go create mode 100644 server.go diff --git a/backend.go b/backend.go new file mode 100644 index 0000000..ddcf792 --- /dev/null +++ b/backend.go @@ -0,0 +1,116 @@ +package smtp2shoutrrr + +import ( + "fmt" + "io" + "log/slog" + "net/mail" + "net/url" + "slices" + "strings" + + "github.com/containrrr/shoutrrr" + "github.com/emersion/go-sasl" + "github.com/emersion/go-smtp" +) + +type Backend struct { + config *Config +} + +func (bkd *Backend) NewSession(c *smtp.Conn) (smtp.Session, error) { + return &Session{ + forwarderFunc: bkd.forwardEmail, + config: bkd.config, + }, nil +} + +func (bkd *Backend) forwardEmail(email ReceivedEmail) error { + slog.Info("forwading message", slog.String("to", strings.Join(email.Recipients, ","))) + + for _, r := range bkd.config.Recipients { + for _, a := range email.Recipients { + if slices.Contains(r.Addresses, a) { + urlParams := url.Values{ + "title": {email.Msg.Header.Get("Subject")}, + } + + destinationURL := r.GetTargetURL() + destinationURL.RawQuery = urlParams.Encode() + + body, err := email.Body() + if err != nil { + slog.Error("Error getting email body", slog.String("err", err.Error())) + continue + } + + if err := shoutrrr.Send(destinationURL.String(), body); err != nil { + slog.Error("Error sending message", slog.String("err", err.Error())) + continue + } + + break + } + } + } + + return nil +} + +type Session struct { + addresses []string + body string + + config *Config + + forwarderFunc func(ReceivedEmail) error +} + +func (s *Session) AuthMechanisms() []string { + return []string{sasl.Plain} +} + +func (s *Session) Auth(mech string) (sasl.Server, error) { + return sasl.NewPlainServer(func(identity, username, password string) error { + if username != s.config.Username && password != s.config.Password { + return fmt.Errorf("invalid credentials") + } + return nil + }), nil +} + +func (s *Session) Mail(from string, opts *smtp.MailOptions) error { + slog.Debug("Mail from", slog.String("from", from)) + return nil +} + +func (s *Session) Rcpt(to string, opts *smtp.RcptOptions) error { + slog.Debug("Rcpt to", slog.String("to", to)) + s.addresses = append(s.addresses, to) + return nil +} + +func (s *Session) Data(r io.Reader) error { + msg, err := mail.ReadMessage(r) + if err != nil { + slog.Error("Error reading data", slog.String("err", err.Error())) + return fmt.Errorf("Error reading data: %w", err) + } + + slog.Info("Received email", slog.String("destination", strings.Join(s.addresses, ","))) + + if err := s.forwarderFunc(ReceivedEmail{ + Recipients: s.addresses, + Msg: msg, + }); err != nil { + slog.Error("Error forwarding email", slog.String("err", err.Error())) + } + + return nil +} + +func (s *Session) Reset() {} + +func (s *Session) Logout() error { + return nil +} diff --git a/cmd/smtp2shoutrrr/main.go b/cmd/smtp2shoutrrr/main.go index ef2c937..4e1b84a 100644 --- a/cmd/smtp2shoutrrr/main.go +++ b/cmd/smtp2shoutrrr/main.go @@ -1,236 +1,15 @@ package main import ( - "bytes" "context" - "fmt" - "io" - "log" "log/slog" - "mime" - "mime/multipart" - "net/mail" - "net/url" "os" - "slices" - "strings" - "time" "git.nakama.town/fmartingr/gotoolkit/encoding" - "git.nakama.town/fmartingr/gotoolkit/model" "git.nakama.town/fmartingr/gotoolkit/service" - "github.com/containrrr/shoutrrr" - "github.com/emersion/go-sasl" - "github.com/emersion/go-smtp" - "git.nakama.town/fmartingr/smtp2shoutrrr" ) -type ReceivedEmail struct { - Recipients []string - Msg *mail.Message - body string -} - -func (re *ReceivedEmail) Body() (string, error) { - if re.body == "" { - // Get the Content-Type header - contentType := re.Msg.Header.Get("Content-Type") - - if contentType == "" { - body, err := io.ReadAll(re.Msg.Body) - if err != nil { - return "", fmt.Errorf("failed to read email body: %w", err) - } - re.body = string(body) - } else { - mediaType, params, err := mime.ParseMediaType(contentType) - if err != nil { - log.Fatalf("Failed to parse Content-Type: %v", err) - } - - if strings.HasPrefix(mediaType, "multipart/alternative") { - // Parse the multipart message - mr := multipart.NewReader(re.Msg.Body, params["boundary"]) - for { - part, err := mr.NextPart() - if err != nil { - break // End of parts - } - defer part.Close() - - // Print part headers - fmt.Printf("Part Content-Type: %s\n", part.Header.Get("Content-Type")) - - // Set body if this is the text/plain part - if strings.HasPrefix(part.Header.Get("Content-Type"), "text/plain") { - // Read the part's body - body := new(bytes.Buffer) - _, err = body.ReadFrom(part) - if err != nil { - slog.Error("Failed to read part body", slog.String("err", err.Error())) - return "", fmt.Errorf("failed to read part body: %w", err) - } - - re.body = body.String() - break - } - } - } - } - } - - return re.body, nil -} - -var _ model.Server = (*smtpServer)(nil) - -type smtpServer struct { - backend *smtp.Server - config smtp2shoutrrr.Config -} - -func (s *smtpServer) IsEnabled() bool { - return true -} - -func (s *smtpServer) Start(_ context.Context) error { - slog.Info("Started SMTP server", slog.String("addr", s.backend.Addr)) - return s.backend.ListenAndServe() -} - -func (s *smtpServer) Stop(ctx context.Context) error { - slog.Info("Stopping SMTP server") - return s.backend.Shutdown(ctx) -} - -func NewSMTPServer(config *smtp2shoutrrr.Config) model.Server { - be := &Backend{ - config: config, - } - - smtpBackend := smtp.NewServer(be) - smtpBackend.Addr = fmt.Sprintf(":%d", config.Port) - // smtpBackend.Domain = "localhost" - smtpBackend.WriteTimeout = 10 * time.Second - smtpBackend.ReadTimeout = 10 * time.Second - smtpBackend.MaxMessageBytes = 1024 * 1024 - smtpBackend.MaxRecipients = 50 - smtpBackend.AllowInsecureAuth = true - - return &smtpServer{ - backend: smtpBackend, - } -} - -// The Backend implements SMTP server methods. -type Backend struct { - config *smtp2shoutrrr.Config -} - -// NewSession is called after client greeting (EHLO, HELO). -func (bkd *Backend) NewSession(c *smtp.Conn) (smtp.Session, error) { - return &Session{ - forwarderFunc: bkd.forwardEmail, - config: bkd.config, - }, nil -} - -func (bkd *Backend) forwardEmail(email ReceivedEmail) error { - slog.Info("forwading message", slog.String("to", strings.Join(email.Recipients, ","))) - - for _, r := range bkd.config.Recipients { - for _, a := range email.Recipients { - if slices.Contains(r.Addresses, a) { - urlParams := url.Values{ - "title": {email.Msg.Header.Get("Subject")}, - } - - destinationURL := r.GetTargetURL() - destinationURL.RawQuery = urlParams.Encode() - - body, err := email.Body() - if err != nil { - slog.Error("Error getting email body", slog.String("err", err.Error())) - continue - } - - if err := shoutrrr.Send(destinationURL.String(), body); err != nil { - slog.Error("Error sending message", slog.String("err", err.Error())) - continue - } - - // Already sent via this configuration, go to the next - break - } - } - } - - return nil -} - -// A Session is returned after successful login. -type Session struct { - addresses []string - body string - - config *smtp2shoutrrr.Config - - forwarderFunc func(ReceivedEmail) error -} - -// AuthMechanisms returns a slice of available auth mechanisms; only PLAIN is -// supported in this example. -func (s *Session) AuthMechanisms() []string { - return []string{sasl.Plain} -} - -// Auth is the handler for supported authenticators. -func (s *Session) Auth(mech string) (sasl.Server, error) { - return sasl.NewPlainServer(func(identity, username, password string) error { - if username != s.config.Username && password != s.config.Password { - return fmt.Errorf("invalid credentials") - } - return nil - }), nil -} - -func (s *Session) Mail(from string, opts *smtp.MailOptions) error { - slog.Debug("Mail from", slog.String("from", from)) - return nil -} - -func (s *Session) Rcpt(to string, opts *smtp.RcptOptions) error { - slog.Debug("Rcpt to", slog.String("to", to)) - s.addresses = append(s.addresses, to) - return nil -} - -func (s *Session) Data(r io.Reader) error { - msg, err := mail.ReadMessage(r) - if err != nil { - slog.Error("Error reading data", slog.String("err", err.Error())) - return fmt.Errorf("Error reading data: %w", err) - } - - slog.Info("Received email", slog.String("destination", strings.Join(s.addresses, ","))) - - if err := s.forwarderFunc(ReceivedEmail{ - Recipients: s.addresses, - Msg: msg, - }); err != nil { - slog.Error("Error forwarding email", slog.String("err", err.Error())) - } - - return nil -} - -func (s *Session) Reset() {} - -func (s *Session) Logout() error { - return nil -} - func main() { var config *smtp2shoutrrr.Config configPath := "config.toml" @@ -252,7 +31,7 @@ func main() { slog.Info("config loaded", slog.Int("recipients", len(config.Recipients))) ctx := context.Background() - smtpServer := NewSMTPServer(config) + smtpServer := smtp2shoutrrr.NewSMTPServer(config) svc, err := service.NewService([]model.Server{ smtpServer, diff --git a/email.go b/email.go new file mode 100644 index 0000000..bd2fa6a --- /dev/null +++ b/email.go @@ -0,0 +1,65 @@ +package smtp2shoutrrr + +import ( + "bytes" + "fmt" + "io" + "log" + "log/slog" + "mime" + "mime/multipart" + "net/mail" + "strings" +) + +type ReceivedEmail struct { + Recipients []string + Msg *mail.Message + body string +} + +func (re *ReceivedEmail) Body() (string, error) { + if re.body == "" { + contentType := re.Msg.Header.Get("Content-Type") + + if contentType == "" { + body, err := io.ReadAll(re.Msg.Body) + if err != nil { + return "", fmt.Errorf("failed to read email body: %w", err) + } + re.body = string(body) + } else { + mediaType, params, err := mime.ParseMediaType(contentType) + if err != nil { + log.Fatalf("Failed to parse Content-Type: %v", err) + } + + if strings.HasPrefix(mediaType, "multipart/alternative") { + mr := multipart.NewReader(re.Msg.Body, params["boundary"]) + for { + part, err := mr.NextPart() + if err != nil { + break + } + defer part.Close() + + fmt.Printf("Part Content-Type: %s\n", part.Header.Get("Content-Type")) + + if strings.HasPrefix(part.Header.Get("Content-Type"), "text/plain") { + body := new(bytes.Buffer) + _, err = body.ReadFrom(part) + if err != nil { + slog.Error("Failed to read part body", slog.String("err", err.Error())) + return "", fmt.Errorf("failed to read part body: %w", err) + } + + re.body = body.String() + break + } + } + } + } + } + + return re.body, nil +} diff --git a/server.go b/server.go new file mode 100644 index 0000000..afaa4a7 --- /dev/null +++ b/server.go @@ -0,0 +1,50 @@ +package smtp2shoutrrr + +import ( + "context" + "fmt" + "log/slog" + "time" + + "git.nakama.town/fmartingr/gotoolkit/model" + "github.com/emersion/go-smtp" +) + +var _ model.Server = (*smtpServer)(nil) + +type smtpServer struct { + backend *smtp.Server + config Config +} + +func (s *smtpServer) IsEnabled() bool { + return true +} + +func (s *smtpServer) Start(_ context.Context) error { + slog.Info("Started SMTP server", slog.String("addr", s.backend.Addr)) + return s.backend.ListenAndServe() +} + +func (s *smtpServer) Stop(ctx context.Context) error { + slog.Info("Stopping SMTP server") + return s.backend.Shutdown(ctx) +} + +func NewSMTPServer(config *Config) model.Server { + be := &Backend{ + config: config, + } + + smtpBackend := smtp.NewServer(be) + smtpBackend.Addr = fmt.Sprintf(":%d", config.Port) + smtpBackend.WriteTimeout = 10 * time.Second + smtpBackend.ReadTimeout = 10 * time.Second + smtpBackend.MaxMessageBytes = 1024 * 1024 + smtpBackend.MaxRecipients = 50 + smtpBackend.AllowInsecureAuth = true + + return &smtpServer{ + backend: smtpBackend, + } +} From cfebaf09e38e6c91f34875f7d27016e0ed2e1464 Mon Sep 17 00:00:00 2001 From: "Felipe M. (aider)" Date: Mon, 2 Dec 2024 16:29:03 +0100 Subject: [PATCH 2/9] feat: Add catch-all recipient configuration to Config struct --- config.go | 1 + 1 file changed, 1 insertion(+) diff --git a/config.go b/config.go index 9a64e9f..f1711ca 100644 --- a/config.go +++ b/config.go @@ -10,6 +10,7 @@ type Config struct { Username string Password string Recipients []ConfigRecipient + CatchAll *ConfigRecipient } func (c *Config) SetDefaults() { From a2b696471ce0aeee1610ca11513b742d5f2877e0 Mon Sep 17 00:00:00 2001 From: "Felipe M. (aider)" Date: Mon, 2 Dec 2024 16:30:43 +0100 Subject: [PATCH 3/9] feat: Add catch-all recipient support for unmatched email addresses --- backend.go | 55 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 17 deletions(-) diff --git a/backend.go b/backend.go index ddcf792..ce529e3 100644 --- a/backend.go +++ b/backend.go @@ -18,6 +18,28 @@ type Backend struct { config *Config } +func (bkd *Backend) sendNotification(recipient ConfigRecipient, email ReceivedEmail) error { + urlParams := url.Values{ + "title": {email.Msg.Header.Get("Subject")}, + } + + destinationURL := recipient.GetTargetURL() + destinationURL.RawQuery = urlParams.Encode() + + body, err := email.Body() + if err != nil { + slog.Error("Error getting email body", slog.String("err", err.Error())) + return fmt.Errorf("failed to get email body: %w", err) + } + + if err := shoutrrr.Send(destinationURL.String(), body); err != nil { + slog.Error("Error sending message", slog.String("err", err.Error())) + return fmt.Errorf("failed to send notification: %w", err) + } + + return nil +} + func (bkd *Backend) NewSession(c *smtp.Conn) (smtp.Session, error) { return &Session{ forwarderFunc: bkd.forwardEmail, @@ -28,30 +50,29 @@ func (bkd *Backend) NewSession(c *smtp.Conn) (smtp.Session, error) { func (bkd *Backend) forwardEmail(email ReceivedEmail) error { slog.Info("forwading message", slog.String("to", strings.Join(email.Recipients, ","))) + // Try to match configured recipients first + matched := false for _, r := range bkd.config.Recipients { for _, a := range email.Recipients { if slices.Contains(r.Addresses, a) { - urlParams := url.Values{ - "title": {email.Msg.Header.Get("Subject")}, + if err := bkd.sendNotification(r, email); err != nil { + return err } - - destinationURL := r.GetTargetURL() - destinationURL.RawQuery = urlParams.Encode() - - body, err := email.Body() - if err != nil { - slog.Error("Error getting email body", slog.String("err", err.Error())) - continue - } - - if err := shoutrrr.Send(destinationURL.String(), body); err != nil { - slog.Error("Error sending message", slog.String("err", err.Error())) - continue - } - + matched = true break } } + if matched { + break + } + } + + // If no recipient matched and catch-all is configured, use it + if !matched && bkd.config.CatchAll != nil { + slog.Info("using catch-all recipient for unmatched email") + if err := bkd.sendNotification(*bkd.config.CatchAll, email); err != nil { + return err + } } return nil From 4ace8af18b82e180c088ac65994769cb300b5d95 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 2 Dec 2024 16:31:58 +0100 Subject: [PATCH 4/9] fix: missing import (aider fix) --- cmd/smtp2shoutrrr/main.go | 1 + 1 file changed, 1 insertion(+) diff --git a/cmd/smtp2shoutrrr/main.go b/cmd/smtp2shoutrrr/main.go index 4e1b84a..ff48845 100644 --- a/cmd/smtp2shoutrrr/main.go +++ b/cmd/smtp2shoutrrr/main.go @@ -6,6 +6,7 @@ import ( "os" "git.nakama.town/fmartingr/gotoolkit/encoding" + "git.nakama.town/fmartingr/gotoolkit/model" "git.nakama.town/fmartingr/gotoolkit/service" "git.nakama.town/fmartingr/smtp2shoutrrr" ) From 787b0f99fc8bb08340ca1418c208d1dcb2f6f12b Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 2 Dec 2024 16:32:11 +0100 Subject: [PATCH 5/9] fix: ignore recipient if no target is set (aider fix) --- backend.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/backend.go b/backend.go index ce529e3..baba722 100644 --- a/backend.go +++ b/backend.go @@ -19,6 +19,11 @@ type Backend struct { } func (bkd *Backend) sendNotification(recipient ConfigRecipient, email ReceivedEmail) error { + if recipient.Target == "" { + slog.Warn("no target provided for recipient", slog.String("recipient", strings.Join(recipient.Addresses, ","))) + return nil + } + urlParams := url.Values{ "title": {email.Msg.Header.Get("Subject")}, } From 57acca06213d8bb2564b04c34e3606dfddabaf15 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 2 Dec 2024 16:32:32 +0100 Subject: [PATCH 6/9] chore: ignore aider files --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 00a88f1..7a7ec77 100644 --- a/.gitignore +++ b/.gitignore @@ -31,3 +31,4 @@ dist/ # smtp2shoutrrr config.toml +.aider* From a00f64e43c0fbc7b805b7f3a629fef6e844dad93 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 2 Dec 2024 16:32:40 +0100 Subject: [PATCH 7/9] chore: add some disclaimer to containerfile --- Containerfile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Containerfile b/Containerfile index ad06a9a..9fa3ce9 100644 --- a/Containerfile +++ b/Containerfile @@ -1,3 +1,5 @@ +# This file is used directly by the goreleaser build +# It is used to build the final container image FROM scratch COPY /smtp2shoutrrr /usr/bin/smtp2shoutrrr ENTRYPOINT ["/usr/bin/smtp2shoutrrr"] From aa1fd99ffd6f473248dc79baa39c33dec1041cd4 Mon Sep 17 00:00:00 2001 From: "Felipe M." Date: Mon, 2 Dec 2024 16:32:49 +0100 Subject: [PATCH 8/9] chore: unused vars in makefile --- Makefile | 2 -- 1 file changed, 2 deletions(-) diff --git a/Makefile b/Makefile index 8daaabb..90d86e1 100644 --- a/Makefile +++ b/Makefile @@ -12,7 +12,6 @@ CGO_ENABLED := 0 BUILDS_PATH := ./dist FROM_MAKEFILE := y -CONTAINER_RUNTIME := podman CONTAINERFILE_NAME := Containerfile CONTAINER_ALPINE_VERSION := 3.20 CONTAINER_SOURCE_URL := "https://git.nakama.town/fmartingr/${PROJECT_NAME}" @@ -31,7 +30,6 @@ export TEST_OPTIONS export TEST_TIMEOUT export BUILDS_PATH -export CONTAINER_RUNTIME export CONTAINERFILE_NAME export CONTAINER_ALPINE_VERSION export CONTAINER_SOURCE_URL From bd8a3395e9a97e15e09c201810f3b54dd6fae3df Mon Sep 17 00:00:00 2001 From: "Felipe M. (aider)" Date: Mon, 2 Dec 2024 16:33:48 +0100 Subject: [PATCH 9/9] docs: Add catch-all recipient configuration to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e9deefe..76c1bcb 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,11 @@ Addresses = ["some@email.com"] Target = "ntfy://ntfy.sh/my-ntfy-topic?tags=thing" # Note: Repeat [[Recipients]] as needed + +# Optional: Configure a catch-all recipient for unmatched email addresses +[CatchAll] +# Shoutrrr service to forward unmatched emails to +Target = "ntfy://ntfy.sh/catch-all-topic?tags=unmatched" ``` ### From releases