imapserver: add support for SPECIAL-USE

Author: dejanstrbac

cmd/imapmemserver/main.go

@@ -54,7 +54,54 @@ func main() {
 
 	if username != "" || password != "" {
 		user := imapmemserver.NewUser(username, password)
-		user.Create("INBOX", nil)
+
+		// Create standard mailboxes with special-use attributes as per RFC 6154
+		if err := user.Create("INBOX", nil); err != nil {
+			log.Printf("Failed to create INBOX: %v", err)
+		}
+
+		if err := user.Create("Drafts", &imap.CreateOptions{
+			SpecialUse: []imap.MailboxAttr{imap.MailboxAttrDrafts},
+		}); err != nil {
+			log.Printf("Failed to create Drafts mailbox: %v", err)
+		}
+
+		if err := user.Create("Sent", &imap.CreateOptions{
+			SpecialUse: []imap.MailboxAttr{imap.MailboxAttrSent},
+		}); err != nil {
+			log.Printf("Failed to create Sent mailbox: %v", err)
+		}
+
+		if err := user.Create("Archive", &imap.CreateOptions{
+			SpecialUse: []imap.MailboxAttr{imap.MailboxAttrArchive},
+		}); err != nil {
+			log.Printf("Failed to create Archive mailbox: %v", err)
+		}
+
+		if err := user.Create("Junk", &imap.CreateOptions{
+			SpecialUse: []imap.MailboxAttr{imap.MailboxAttrJunk},
+		}); err != nil {
+			log.Printf("Failed to create Junk mailbox: %v", err)
+		}
+
+		if err := user.Create("Trash", &imap.CreateOptions{
+			SpecialUse: []imap.MailboxAttr{imap.MailboxAttrTrash},
+		}); err != nil {
+			log.Printf("Failed to create Trash mailbox: %v", err)
+		}
+
+		if err := user.Create("Flagged", &imap.CreateOptions{
+			SpecialUse: []imap.MailboxAttr{imap.MailboxAttrFlagged},
+		}); err != nil {
+			log.Printf("Failed to create Flagged mailbox: %v", err)
+		}
+
+		// Subscribe to the most commonly used mailboxes
+		_ = user.Subscribe("INBOX")
+		_ = user.Subscribe("Drafts")
+		_ = user.Subscribe("Sent")
+		_ = user.Subscribe("Trash")
+
 		memServer.AddUser(user)
 	}
 

imapserver/capability.go

@@ -86,6 +86,7 @@ func (c *Conn) availableCaps() []imap.Cap {
 		// Capabilities which require backend support and apply to both
 		// IMAP4rev1 and IMAP4rev2
 		addAvailableCaps(&caps, available, []imap.Cap{
+			imap.CapSpecialUse,
 			imap.CapCreateSpecialUse,
 			imap.CapLiteralPlus,
 			imap.CapUnauthenticate,

imapserver/imapmemserver/mailbox.go

@@ -21,6 +21,7 @@ type Mailbox struct {
 	mutex      sync.Mutex
 	name       string
 	subscribed bool
+	specialUse []imap.MailboxAttr
 	l          []*message
 	uidNext    imap.UID
 }
@@ -42,6 +43,9 @@ func (mbox *Mailbox) list(options *imap.ListOptions) *imap.ListData {
 	if options.SelectSubscribed && !mbox.subscribed {
 		return nil
 	}
+	if options.SelectSpecialUse && len(mbox.specialUse) == 0 {
+		return nil
+	}
 
 	data := imap.ListData{
 		Mailbox: mbox.name,
@@ -50,6 +54,9 @@ func (mbox *Mailbox) list(options *imap.ListOptions) *imap.ListData {
 	if mbox.subscribed {
 		data.Attrs = append(data.Attrs, imap.MailboxAttrSubscribed)
 	}
+	if (options.ReturnSpecialUse || options.SelectSpecialUse) && len(mbox.specialUse) > 0 {
+		data.Attrs = append(data.Attrs, mbox.specialUse...)
+	}
 	if options.ReturnStatus != nil {
 		data.Status = mbox.statusDataLocked(options.ReturnStatus)
 	}

imapserver/list.go

@@ -135,6 +135,8 @@ func readListCmd(dec *imapwire.Decoder) (ref string, patterns []string, options
 			options.SelectRemote = true
 		case "RECURSIVEMATCH":
 			options.SelectRecursiveMatch = true
+		case "SPECIAL-USE":
+			options.SelectSpecialUse = true
 		default:
 			return newClientBugError("Unknown LIST select option")
 		}
@@ -229,6 +231,8 @@ func readReturnOption(dec *imapwire.Decoder, options *imap.ListOptions) error {
 		options.ReturnSubscribed = true
 	case "CHILDREN":
 		options.ReturnChildren = true
+	case "SPECIAL-USE":
+		options.ReturnSpecialUse = true
 	case "STATUS":
 		if !dec.ExpectSP() {
 			return dec.Err()