setting: Infer [email.incoming].PORT from .USE_TLS

If `[email.incoming].USE_TLS` is set, but the port isn't, infer the
default from `.USE_TLS`: set the port to 993 if using tls, and to 143
otherwise. Explicitly setting a port overrides this.

Fixes #3357.

Signed-off-by: Gergely Nagy <forgejo@gergo.csillger.hu>
This commit is contained in:
Gergely Nagy 2024-04-22 16:27:32 +02:00
parent 073cc891c6
commit 0cb46f63df
No known key found for this signature in database
2 changed files with 68 additions and 9 deletions

View file

@ -47,6 +47,15 @@ func loadIncomingEmailFrom(rootCfg ConfigProvider) {
IncomingEmail.Password = sec.Key("PASSWD").String() IncomingEmail.Password = sec.Key("PASSWD").String()
} }
// Infer Port if not set
if IncomingEmail.Port == 0 {
if IncomingEmail.UseTLS {
IncomingEmail.Port = 993
} else {
IncomingEmail.Port = 143
}
}
if err := checkReplyToAddress(IncomingEmail.ReplyToAddress); err != nil { if err := checkReplyToAddress(IncomingEmail.ReplyToAddress); err != nil {
log.Fatal("Invalid incoming_mail.REPLY_TO_ADDRESS (%s): %v", IncomingEmail.ReplyToAddress, err) log.Fatal("Invalid incoming_mail.REPLY_TO_ADDRESS (%s): %v", IncomingEmail.ReplyToAddress, err)
} }

View file

@ -10,15 +10,65 @@ import (
) )
func Test_loadIncomingEmailFrom(t *testing.T) { func Test_loadIncomingEmailFrom(t *testing.T) {
cfg, _ := NewConfigProviderFromData("") makeBaseConfig := func() (ConfigProvider, ConfigSection) {
sec := cfg.Section("email.incoming") cfg, _ := NewConfigProviderFromData("")
sec.NewKey("ENABLED", "true") sec := cfg.Section("email.incoming")
sec.NewKey("USER", "jane.doe@example.com") sec.NewKey("ENABLED", "true")
sec.NewKey("PASSWD", "y0u'll n3v3r gUess th1S!!1") sec.NewKey("REPLY_TO_ADDRESS", "forge+%{token}@example.com")
sec.NewKey("REPLY_TO_ADDRESS", "forge+%{token}@example.com")
loadIncomingEmailFrom(cfg) return cfg, sec
}
resetIncomingEmailPort := func() func() {
return func() {
IncomingEmail.Port = 0
}
}
assert.EqualValues(t, "jane.doe@example.com", IncomingEmail.Username) t.Run("aliases", func(t *testing.T) {
assert.EqualValues(t, "y0u'll n3v3r gUess th1S!!1", IncomingEmail.Password) cfg, sec := makeBaseConfig()
sec.NewKey("USER", "jane.doe@example.com")
sec.NewKey("PASSWD", "y0u'll n3v3r gUess th1S!!1")
loadIncomingEmailFrom(cfg)
assert.EqualValues(t, "jane.doe@example.com", IncomingEmail.Username)
assert.EqualValues(t, "y0u'll n3v3r gUess th1S!!1", IncomingEmail.Password)
})
t.Run("Port settings", func(t *testing.T) {
t.Run("no port, no tls", func(t *testing.T) {
defer resetIncomingEmailPort()()
cfg, sec := makeBaseConfig()
// False is the default, but we test it explicitly.
sec.NewKey("USE_TLS", "false")
loadIncomingEmailFrom(cfg)
assert.EqualValues(t, 143, IncomingEmail.Port)
})
t.Run("no port, with tls", func(t *testing.T) {
defer resetIncomingEmailPort()()
cfg, sec := makeBaseConfig()
sec.NewKey("USE_TLS", "true")
loadIncomingEmailFrom(cfg)
assert.EqualValues(t, 993, IncomingEmail.Port)
})
t.Run("port overrides tls", func(t *testing.T) {
defer resetIncomingEmailPort()()
cfg, sec := makeBaseConfig()
sec.NewKey("PORT", "1993")
sec.NewKey("USE_TLS", "true")
loadIncomingEmailFrom(cfg)
assert.EqualValues(t, 1993, IncomingEmail.Port)
})
})
} }