go/mailpit
1
0
Fork 0
mirror of https://github.com/axllent/mailpit.git synced 2025-08-13 20:04:49 +02:00
Code Issues Releases Activity

Rename smtp-silently-drop-rejected-recipients to smtp-ignore-rejected-recipients

Browse Source
This commit is contained in:
Ralph Slooten
2025-08-10 21:04:22 +12:00
parent 39d80df809
commit 41ef4ecd60
5 changed files with 69 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
cmd/root.go
View File

@@ -126,7 +126,7 @@ func init() {
rootCmd.Flags().BoolVar(&config.SMTPStrictRFCHeaders, "smtp-strict-rfc-headers", config.SMTPStrictRFCHeaders, "Return SMTP error if message headers contain <CR><CR><LF>") rootCmd.Flags().BoolVar(&config.SMTPStrictRFCHeaders, "smtp-strict-rfc-headers", config.SMTPStrictRFCHeaders, "Return SMTP error if message headers contain <CR><CR><LF>")
rootCmd.Flags().IntVar(&config.SMTPMaxRecipients, "smtp-max-recipients", config.SMTPMaxRecipients, "Maximum SMTP recipients allowed") rootCmd.Flags().IntVar(&config.SMTPMaxRecipients, "smtp-max-recipients", config.SMTPMaxRecipients, "Maximum SMTP recipients allowed")
rootCmd.Flags().StringVar(&config.SMTPAllowedRecipients, "smtp-allowed-recipients", config.SMTPAllowedRecipients, "Only allow SMTP recipients matching a regular expression (default allow all)") rootCmd.Flags().StringVar(&config.SMTPAllowedRecipients, "smtp-allowed-recipients", config.SMTPAllowedRecipients, "Only allow SMTP recipients matching a regular expression (default allow all)")
rootCmd.Flags().BoolVar(&config.SMTPSilentlyDropRejectedRecipients, "smtp-silently-drop-rejected-recipients", config.SMTPSilentlyDropRejectedRecipients, "Accept emails to rejected recipients with 2xx response but silently drop them") rootCmd.Flags().BoolVar(&config.SMTPIgnoreRejectedRecipients, "smtp-ignore-rejected-recipients", config.SMTPIgnoreRejectedRecipients, "Ignore rejected SMTP recipients with 2xx response")
rootCmd.Flags().BoolVar(&smtpd.DisableReverseDNS, "smtp-disable-rdns", smtpd.DisableReverseDNS, "Disable SMTP reverse DNS lookups") rootCmd.Flags().BoolVar(&smtpd.DisableReverseDNS, "smtp-disable-rdns", smtpd.DisableReverseDNS, "Disable SMTP reverse DNS lookups")
// SMTP relay // SMTP relay
@@ -302,8 +302,8 @@ func initConfigFromEnv() {
if len(os.Getenv("MP_SMTP_ALLOWED_RECIPIENTS")) > 0 { if len(os.Getenv("MP_SMTP_ALLOWED_RECIPIENTS")) > 0 {
config.SMTPAllowedRecipients = os.Getenv("MP_SMTP_ALLOWED_RECIPIENTS") config.SMTPAllowedRecipients = os.Getenv("MP_SMTP_ALLOWED_RECIPIENTS")
} }
if getEnabledFromEnv("MP_SMTP_SILENTLY_DROP_REJECTED_RECIPIENTS") { if getEnabledFromEnv("MP_SMTP_IGNORE_REJECTED_RECIPIENTS") {
config.SMTPSilentlyDropRejectedRecipients = true config.SMTPIgnoreRejectedRecipients = true
} }
if getEnabledFromEnv("MP_SMTP_DISABLE_RDNS") { if getEnabledFromEnv("MP_SMTP_DISABLE_RDNS") {
smtpd.DisableReverseDNS = true smtpd.DisableReverseDNS = true

12
config/config.go
View File

@@ -181,8 +181,8 @@ var (
// SMTPAllowedRecipientsRegexp is the compiled version of SMTPAllowedRecipients // SMTPAllowedRecipientsRegexp is the compiled version of SMTPAllowedRecipients
SMTPAllowedRecipientsRegexp *regexp.Regexp SMTPAllowedRecipientsRegexp *regexp.Regexp
// SMTPSilentlyDropRejectedRecipients if true, will accept emails to rejected recipients with 2xx response but silently drop them // SMTPIgnoreRejectedRecipients if true, will accept emails to rejected recipients with 2xx response but silently drop them
SMTPSilentlyDropRejectedRecipients bool SMTPIgnoreRejectedRecipients bool
// POP3Listen address - if set then Mailpit will start the POP3 server and listen on this address // POP3Listen address - if set then Mailpit will start the POP3 server and listen on this address
POP3Listen = "[::]:1110" POP3Listen = "[::]:1110"
@@ -584,6 +584,14 @@ func VerifyConfig() error {
logger.Log().Infof("[smtp] only allowing recipients matching regexp: %s", SMTPAllowedRecipients) logger.Log().Infof("[smtp] only allowing recipients matching regexp: %s", SMTPAllowedRecipients)
} }
if SMTPIgnoreRejectedRecipients {
if SMTPAllowedRecipientsRegexp == nil {
logger.Log().Warn("[smtp] ignoring rejected recipients has no effect without setting smtp-allowed-recipients")
} else {
logger.Log().Info("[smtp] ignoring rejected recipients")
}
}
if err := parseRelayConfig(SMTPRelayConfigFile); err != nil { if err := parseRelayConfig(SMTPRelayConfigFile); err != nil {
return err return err
} }

20
internal/smtpd/main.go
View File

@@ -194,16 +194,16 @@ func listenAndServe(addr string, handler MsgIDHandler, authHandler AuthHandler)
Debug = true // to enable Mailpit logging Debug = true // to enable Mailpit logging
srv := &Server{ srv := &Server{
Addr: addr, Addr: addr,
MsgIDHandler: handler, MsgIDHandler: handler,
HandlerRcpt: handlerRcpt, HandlerRcpt: handlerRcpt,
AppName: "Mailpit", AppName: "Mailpit",
Hostname: "", Hostname: "",
AuthHandler: nil, AuthHandler: nil,
AuthRequired: false, AuthRequired: false,
MaxRecipients: config.SMTPMaxRecipients, MaxRecipients: config.SMTPMaxRecipients,
SilentlyDropRejectedRecipients: config.SMTPSilentlyDropRejectedRecipients, IgnoreRejectedRecipients: config.SMTPIgnoreRejectedRecipients,
DisableReverseDNS: DisableReverseDNS, DisableReverseDNS: DisableReverseDNS,
LogRead: func(remoteIP, verb, line string) { LogRead: func(remoteIP, verb, line string) {
logger.Log().Debugf("[smtpd] %s (%s) %s", verbLogTranslator(verb), remoteIP, line) logger.Log().Debugf("[smtpd] %s (%s) %s", verbLogTranslator(verb), remoteIP, line)
}, },

44
internal/smtpd/smtpd.go
View File

@@ -92,27 +92,27 @@ type LogFunc func(remoteIP, verb, line string)
// Server is an SMTP server. // Server is an SMTP server.
type Server struct { type Server struct {
Addr string // TCP address to listen on, defaults to ":25" (all addresses, port 25) if empty Addr string // TCP address to listen on, defaults to ":25" (all addresses, port 25) if empty
AppName string AppName string
AuthHandler AuthHandler AuthHandler AuthHandler
AuthMechs map[string]bool // Override list of allowed authentication mechanisms. Currently supported: LOGIN, PLAIN, CRAM-MD5. Enabling LOGIN and PLAIN will reduce RFC 4954 compliance. AuthMechs map[string]bool // Override list of allowed authentication mechanisms. Currently supported: LOGIN, PLAIN, CRAM-MD5. Enabling LOGIN and PLAIN will reduce RFC 4954 compliance.
AuthRequired bool // Require authentication for every command except AUTH, EHLO, HELO, NOOP, RSET or QUIT as per RFC 4954. Ignored if AuthHandler is not configured. AuthRequired bool // Require authentication for every command except AUTH, EHLO, HELO, NOOP, RSET or QUIT as per RFC 4954. Ignored if AuthHandler is not configured.
DisableReverseDNS bool // Disable reverse DNS lookups, enforces "unknown" hostname DisableReverseDNS bool // Disable reverse DNS lookups, enforces "unknown" hostname
Handler Handler Handler Handler
HandlerRcpt HandlerRcpt HandlerRcpt HandlerRcpt
Hostname string Hostname string
LogRead LogFunc LogRead LogFunc
LogWrite LogFunc LogWrite LogFunc
MaxSize int // Maximum message size allowed, in bytes MaxSize int // Maximum message size allowed, in bytes
MaxRecipients int // Maximum number of recipients, defaults to 100. MaxRecipients int // Maximum number of recipients, defaults to 100.
MsgIDHandler MsgIDHandler MsgIDHandler MsgIDHandler
SilentlyDropRejectedRecipients bool // Accept emails to rejected recipients with 2xx response but silently drop them IgnoreRejectedRecipients bool // Accept emails to rejected recipients with 2xx response but silently drop them
Timeout time.Duration Timeout time.Duration
TLSConfig *tls.Config TLSConfig *tls.Config
TLSListener bool // Listen for incoming TLS connections only (not recommended as it may reduce compatibility). Ignored if TLS is not configured. TLSListener bool // Listen for incoming TLS connections only (not recommended as it may reduce compatibility). Ignored if TLS is not configured.
TLSRequired bool // Require TLS for every command except NOOP, EHLO, STARTTLS, or QUIT as per RFC 3207. Ignored if TLS is not configured. TLSRequired bool // Require TLS for every command except NOOP, EHLO, STARTTLS, or QUIT as per RFC 3207. Ignored if TLS is not configured.
Protocol string // Default tcp, supports unix Protocol string // Default tcp, supports unix
SocketPerm fs.FileMode // if using Unix socket, socket permissions SocketPerm fs.FileMode // if using Unix socket, socket permissions
inShutdown int32 // server was closed or shutdown inShutdown int32 // server was closed or shutdown
openSessions int32 // count of open sessions openSessions int32 // count of open sessions
@@ -497,7 +497,7 @@ loop:
if accept { if accept {
to = append(to, match[1]) to = append(to, match[1])
s.writef("250 2.1.5 Ok") s.writef("250 2.1.5 Ok")
} else if s.srv.SilentlyDropRejectedRecipients { } else if s.srv.IgnoreRejectedRecipients {
hasRejectedRecipients = true hasRejectedRecipients = true
s.writef("250 2.1.5 Ok") s.writef("250 2.1.5 Ok")
} else { } else {

48
internal/smtpd/smtpd_test.go
View File

@@ -1622,20 +1622,20 @@ func (m *mockDropRejectedHandler) msgIDHandler(remoteAddr net.Addr, from string,
return "test-message-id", nil return "test-message-id", nil
} }
// Test the SilentlyDropRejectedRecipients option // Test the IgnoreRejectedRecipients option
func TestSilentlyDropRejectedRecipients(t *testing.T) { func TestIgnoreRejectedRecipients(t *testing.T) {
tests := []struct { tests := []struct {
name string name string
silentlyDropRejectedRecipients bool IgnoreRejectedRecipients bool
handlerRcpt func(net.Addr, string, string) bool handlerRcpt func(net.Addr, string, string) bool
rcptCommands []struct{ addr, expectedCode string } rcptCommands []struct{ addr, expectedCode string }
expectedHandlerCalls int expectedHandlerCalls int
expectedHandlerRecipients []string expectedHandlerRecipients []string
useMsgIDHandler bool useMsgIDHandler bool
}{ }{
{ {
name: "Disabled_DefaultBehavior", name: "Disabled_DefaultBehavior",
silentlyDropRejectedRecipients: false, IgnoreRejectedRecipients: false,
handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool { handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool {
return !strings.HasSuffix(to, "@rejected.com") return !strings.HasSuffix(to, "@rejected.com")
}, },
@@ -1647,8 +1647,8 @@ func TestSilentlyDropRejectedRecipients(t *testing.T) {
expectedHandlerRecipients: []string{"valid@example.com"}, expectedHandlerRecipients: []string{"valid@example.com"},
}, },
{ {
name: "Enabled_MixedRecipients", name: "Enabled_MixedRecipients",
silentlyDropRejectedRecipients: true, IgnoreRejectedRecipients: true,
handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool { handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool {
return !strings.HasSuffix(to, "@rejected.com") return !strings.HasSuffix(to, "@rejected.com")
}, },
@@ -1662,8 +1662,8 @@ func TestSilentlyDropRejectedRecipients(t *testing.T) {
expectedHandlerRecipients: []string{"valid1@example.com", "valid2@example.com"}, expectedHandlerRecipients: []string{"valid1@example.com", "valid2@example.com"},
}, },
{ {
name: "Enabled_AllRejected", name: "Enabled_AllRejected",
silentlyDropRejectedRecipients: true, IgnoreRejectedRecipients: true,
handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool { handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool {
return false // Reject all return false // Reject all
}, },
@@ -1675,8 +1675,8 @@ func TestSilentlyDropRejectedRecipients(t *testing.T) {
expectedHandlerRecipients: nil, expectedHandlerRecipients: nil,
}, },
{ {
name: "Enabled_OnlyValid", name: "Enabled_OnlyValid",
silentlyDropRejectedRecipients: true, IgnoreRejectedRecipients: true,
handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool { handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool {
return strings.HasSuffix(to, "@valid.com") return strings.HasSuffix(to, "@valid.com")
}, },
@@ -1689,8 +1689,8 @@ func TestSilentlyDropRejectedRecipients(t *testing.T) {
expectedHandlerRecipients: []string{"user1@valid.com", "user2@valid.com", "user3@valid.com"}, expectedHandlerRecipients: []string{"user1@valid.com", "user2@valid.com", "user3@valid.com"},
}, },
{ {
name: "Enabled_WithMsgIDHandler", name: "Enabled_WithMsgIDHandler",
silentlyDropRejectedRecipients: true, IgnoreRejectedRecipients: true,
handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool { handlerRcpt: func(remoteAddr net.Addr, from string, to string) bool {
return !strings.HasSuffix(to, "@rejected.com") return !strings.HasSuffix(to, "@rejected.com")
}, },
@@ -1709,11 +1709,11 @@ func TestSilentlyDropRejectedRecipients(t *testing.T) {
mock := &mockDropRejectedHandler{} mock := &mockDropRejectedHandler{}
server := &Server{ server := &Server{
Hostname: "mail.example.com", Hostname: "mail.example.com",
AppName: "TestMail", AppName: "TestMail",
MaxRecipients: 100, MaxRecipients: 100,
HandlerRcpt: tt.handlerRcpt, HandlerRcpt: tt.handlerRcpt,
SilentlyDropRejectedRecipients: tt.silentlyDropRejectedRecipients, IgnoreRejectedRecipients: tt.IgnoreRejectedRecipients,
} }
if tt.useMsgIDHandler { if tt.useMsgIDHandler {