From 15d72605021710607848b3ab1a5dba085dfda9bd Mon Sep 17 00:00:00 2001
From: "fox.cpp" <fox.cpp@disroot.org>
Date: Sun, 26 Apr 2020 21:30:14 +0300
Subject: [PATCH] cmd/maddyctl: Create a set of typical mailboxes on IMAP
 account creation

Closes #219.
---
 cmd/maddyctl/imap.go     |  9 +++++--
 cmd/maddyctl/imapacct.go | 54 +++++++++++++++++++++++++++++++++++++++-
 cmd/maddyctl/main.go     | 25 +++++++++++++++++++
 3 files changed, 85 insertions(+), 3 deletions(-)

diff --git a/cmd/maddyctl/imap.go b/cmd/maddyctl/imap.go
index a50a33d..426cee5 100644
--- a/cmd/maddyctl/imap.go
+++ b/cmd/maddyctl/imap.go
@@ -79,10 +79,15 @@ func mboxesCreate(be module.Storage, ctx *cli.Context) error {
 		return err
 	}
 
-	// TODO: Generalize.
 	if ctx.IsSet("special") {
 		attr := "\\" + strings.Title(ctx.String("special"))
-		return u.(*imapsql.User).CreateMailboxSpecial(name, attr)
+
+		suu, ok := u.(SpecialUseUser)
+		if !ok {
+			return errors.New("Error: storage backend does not support SPECIAL-USE IMAP extension")
+		}
+
+		return suu.CreateMailboxSpecial(name, attr)
 	}
 
 	return u.CreateMailbox(name)
diff --git a/cmd/maddyctl/imapacct.go b/cmd/maddyctl/imapacct.go
index b4bfc8b..5dab0b3 100644
--- a/cmd/maddyctl/imapacct.go
+++ b/cmd/maddyctl/imapacct.go
@@ -5,11 +5,16 @@ import (
 	"fmt"
 	"os"
 
+	specialuse "github.com/emersion/go-imap-specialuse"
 	"github.com/foxcpp/maddy/cmd/maddyctl/clitools"
 	"github.com/foxcpp/maddy/internal/module"
 	"github.com/urfave/cli"
 )
 
+type SpecialUseUser interface {
+	CreateMailboxSpecial(name, specialUseAttr string) error
+}
+
 func imapAcctList(be module.Storage, ctx *cli.Context) error {
 	mbe, ok := be.(module.ManageableStorage)
 	if !ok {
@@ -42,7 +47,54 @@ func imapAcctCreate(be module.Storage, ctx *cli.Context) error {
 		return errors.New("Error: USERNAME is required")
 	}
 
-	return mbe.CreateAcct(username)
+	if err := mbe.CreateAcct(username); err != nil {
+		return err
+	}
+
+	act, err := mbe.GetIMAPAcct(username)
+	if err != nil {
+		return fmt.Errorf("failed to get user: %w", err)
+	}
+
+	suu, ok := act.(SpecialUseUser)
+	if !ok {
+		fmt.Fprintf(os.Stderr, "Note: Storage backend does not support SPECIAL-USE IMAP extension")
+	}
+
+	createMbox := func(name, specialUseAttr string) error {
+		if suu == nil {
+			return act.CreateMailbox(name)
+		}
+		return suu.CreateMailboxSpecial(name, specialUseAttr)
+	}
+
+	if name := ctx.String("sent-name"); name != "" {
+		if err := createMbox(name, specialuse.Sent); err != nil {
+			fmt.Fprintf(os.Stderr, "Failed to create sent folder: %v", err)
+		}
+	}
+	if name := ctx.String("trash-name"); name != "" {
+		if err := createMbox(name, specialuse.Trash); err != nil {
+			fmt.Fprintf(os.Stderr, "Failed to create trash folder: %v", err)
+		}
+	}
+	if name := ctx.String("junk-name"); name != "" {
+		if err := createMbox(name, specialuse.Junk); err != nil {
+			fmt.Fprintf(os.Stderr, "Failed to create junk folder: %v", err)
+		}
+	}
+	if name := ctx.String("drafts-name"); name != "" {
+		if err := createMbox(name, specialuse.Drafts); err != nil {
+			fmt.Fprintf(os.Stderr, "Failed to create drafts folder: %v", err)
+		}
+	}
+	if name := ctx.String("archive-name"); name != "" {
+		if err := createMbox(name, specialuse.Archive); err != nil {
+			fmt.Fprintf(os.Stderr, "Failed to create archive folder: %v", err)
+		}
+	}
+
+	return nil
 }
 
 func imapAcctRemove(be module.Storage, ctx *cli.Context) error {
diff --git a/cmd/maddyctl/main.go b/cmd/maddyctl/main.go
index c716a49..2898368 100644
--- a/cmd/maddyctl/main.go
+++ b/cmd/maddyctl/main.go
@@ -191,6 +191,31 @@ func main() {
 							EnvVar: "MADDY_CFGBLOCK",
 							Value:  "local_mailboxes",
 						},
+						cli.StringFlag{
+							Name:  "sent-name",
+							Usage: "Name of special mailbox for sent messages, use empty string to not create any",
+							Value: "Sent",
+						},
+						cli.StringFlag{
+							Name:  "trash-name",
+							Usage: "Name of special mailbox for trash, use empty string to not create any",
+							Value: "Trash",
+						},
+						cli.StringFlag{
+							Name:  "junk-name",
+							Usage: "Name of special mailbox for 'junk' (spam), use empty string to not create any",
+							Value: "Junk",
+						},
+						cli.StringFlag{
+							Name:  "drafts-name",
+							Usage: "Name of special mailbox for drafts, use empty string to not create any",
+							Value: "Drafts",
+						},
+						cli.StringFlag{
+							Name:  "archive-name",
+							Usage: "Name of special mailbox for archive, use empty string to not create any",
+							Value: "Archive",
+						},
 					},
 					Action: func(ctx *cli.Context) error {
 						be, err := openStorage(ctx)