deprecate having only localparts in an Account's Destinations, it should always be a full email address

current behaviour isn't intuitive. it's not great to have to attempt parsing
the strings as both localpart and email address. so we deprecate the
localpart-only behaviour. when we load the config file, and it has
localpart-only Destinations keys, we'll change them to full addresses in
memory. when an admin causes a write of domains.conf, it'll automatically be
fixed. we log an error with a deprecated notice for each localpart-only
destinations key.

sometime in the future, we can remove the old localpart-only destination
support. will be in the release notes then.

also start keeping track of update notes that need to make it in the release
notes of the next release.

for issue #18
This commit is contained in:
Mechiel Lukkien
2023-03-09 22:07:37 +01:00
parent 5742ed1537
commit 2c07645ab4
20 changed files with 57 additions and 41 deletions

View File

@ -125,16 +125,16 @@ webhandlers".
if err != nil {
fatalf("parsing email address: %s", err)
}
username := addr.Localpart.String()
accountName := addr.Localpart.String()
domain := addr.Domain
for _, c := range username {
for _, c := range accountName {
if c > 0x7f {
fmt.Printf(`NOTE: Username %q is not ASCII-only. It is recommended you also configure an
ASCII-only alias. Both for delivery of email from other systems, and for
logging in with IMAP.
`, username)
`, accountName)
break
}
}
@ -538,7 +538,7 @@ listed in more DNS block lists, visit:
"public": public,
"internal": internal,
}
sc.Postmaster.Account = username
sc.Postmaster.Account = accountName
sc.Postmaster.Mailbox = "Postmaster"
mox.ConfigStaticPath = "config/mox.conf"
@ -548,7 +548,7 @@ listed in more DNS block lists, visit:
accountConf := mox.MakeAccountConfig(addr)
const withMTASTS = true
confDomain, keyPaths, err := mox.MakeDomainConfig(context.Background(), domain, dnshostname, username, withMTASTS)
confDomain, keyPaths, err := mox.MakeDomainConfig(context.Background(), domain, dnshostname, accountName, withMTASTS)
if err != nil {
fatalf("making domain config: %s", err)
}
@ -558,7 +558,7 @@ listed in more DNS block lists, visit:
domain.Name(): confDomain,
}
dc.Accounts = map[string]config.Account{
username: accountConf,
accountName: accountConf,
}
// Build config in memory, so we can easily comment out the DNSBLs config.
@ -584,12 +584,12 @@ listed in more DNS block lists, visit:
// This approach is a bit horrible, but it generates a convenient
// example that includes the comments. Though it is gone by the first
// write of the file by mox.
odests := fmt.Sprintf("\t\tDestinations:\n\t\t\t%s: nil\n", addr.Localpart.String())
odests := fmt.Sprintf("\t\tDestinations:\n\t\t\t%s: nil\n", addr.String())
var destsExample = struct {
Destinations map[string]config.Destination
}{
Destinations: map[string]config.Destination{
addr.Localpart.String(): {
addr.String(): {
Rulesets: []config.Ruleset{
{
VerifiedDomain: "list.example.org",
@ -641,7 +641,7 @@ listed in more DNS block lists, visit:
if err != nil {
fatalf("open account: %s", err)
}
cleanupPaths = append(cleanupPaths, dataDir, filepath.Join(dataDir, "accounts"), filepath.Join(dataDir, "accounts", username), filepath.Join(dataDir, "accounts", username, "index.db"))
cleanupPaths = append(cleanupPaths, dataDir, filepath.Join(dataDir, "accounts"), filepath.Join(dataDir, "accounts", accountName), filepath.Join(dataDir, "accounts", accountName, "index.db"))
password := pwgen()
if err := acc.SetPassword(password); err != nil {