imap: expose labels as message flags

This is read-only for now.

imap/mailbox.go

@@ -163,10 +163,21 @@ func (mbox *mailbox) reset() error {
 }
 
 func (mbox *mailbox) fetchFlags(msg *protonmail.Message) []string {
-	flags := fetchFlags(msg)
+	var flags []string
+	if msg.Unread != 1 {
+		flags = append(flags, imap.SeenFlag)
+	}
+	if msg.IsReplied != 0 || msg.IsRepliedAll != 0 {
+		flags = append(flags, imap.AnsweredFlag)
+	}
 	if _, ok := mbox.deleted[msg.ID]; ok {
 		flags = append(flags, imap.DeletedFlag)
 	}
+	for _, label := range msg.LabelIDs {
+		if flag, ok := mbox.u.flags[label]; ok {
+			flags = append(flags, flag)
+		}
+	}
 	return flags
 }
 

imap/message.go

@@ -95,26 +95,6 @@ func hasLabel(msg *protonmail.Message, labelID string) bool {
 	return false
 }
 
-// Doesn't support imap.DeletedFlag.
-func fetchFlags(msg *protonmail.Message) []string {
-	var flags []string
-	if msg.Unread != 1 {
-		flags = append(flags, imap.SeenFlag)
-	}
-	if msg.IsReplied != 0 || msg.IsRepliedAll != 0 {
-		flags = append(flags, imap.AnsweredFlag)
-	}
-	for _, label := range msg.LabelIDs {
-		switch label {
-		case protonmail.LabelStarred:
-			flags = append(flags, imap.FlaggedFlag)
-		case protonmail.LabelDraft:
-			flags = append(flags, imap.DraftFlag)
-		}
-	}
-	return flags
-}
-
 func splitMIMEType(t string) (string, string) {
 	parts := strings.SplitN(t, "/", 2)
 	if len(parts) < 2 {

imap/user.go

@@ -2,6 +2,7 @@ package imap
 
 import (
 	"log"
+	"strings"
 	"sync"
 
 	"github.com/emersion/go-imap"
@@ -29,6 +30,11 @@ var systemMailboxes = []struct {
 	{"Trash", protonmail.LabelTrash, []string{specialuse.Trash}},
 }
 
+var systemFlags = map[string]string{
+	imap.FlaggedFlag: protonmail.LabelStarred,
+	imap.DraftFlag:   protonmail.LabelDraft,
+}
+
 type user struct {
 	backend     *backend
 	c           *protonmail.Client
@@ -41,7 +47,8 @@ type user struct {
 	eventsReceiver *events.Receiver
 
 	locker    sync.Mutex
-	mailboxes map[string]*mailbox
+	mailboxes map[string]*mailbox // indexed by label ID
+	flags     map[string]string   // indexed by label ID
 
 	done      chan<- struct{}
 	eventSent chan struct{}
@@ -103,12 +110,38 @@ func newUser(be *backend, c *protonmail.Client, u *protonmail.User, privateKeys
 	return uu, nil
 }
 
+func labelNameToFlag(s string) string {
+	var sb strings.Builder
+	var lastValid bool
+	for _, r := range s {
+		// See atom-specials in RFC 3501
+		var valid bool
+		switch r {
+		case '(', ')', '{':
+		case ' ', '\t': // SP
+		case '%', '*': // list-wildcards
+		case '"', '\\': // quoted-specials
+		case ']': // resp-specials
+		default:
+			valid = r <= '~' && r > 31
+		}
+		if !valid {
+			if !lastValid {
+				continue
+			}
+			r = '_'
+		}
+		sb.WriteRune(r)
+		lastValid = valid
+	}
+	return sb.String()
+}
+
 func (u *user) initMailboxes() error {
 	u.locker.Lock()
 	defer u.locker.Unlock()
 
 	u.mailboxes = make(map[string]*mailbox)
-
 	for _, data := range systemMailboxes {
 		var err error
 		u.mailboxes[data.label], err = newMailbox(data.name, data.label, data.attrs, u)
@@ -117,15 +150,18 @@ func (u *user) initMailboxes() error {
 		}
 	}
 
+	u.flags = make(map[string]string)
+	for flag, label := range systemFlags {
+		u.flags[flag] = label
+	}
+
 	labels, err := u.c.ListLabels()
 	if err != nil {
 		return err
 	}
 
 	for _, label := range labels {
-		if label.Exclusive != 1 {
-			continue
-		}
+		if label.Exclusive == 1 {
 			if _, ok := u.mailboxes[label.ID]; ok {
 				continue
 			}
@@ -134,6 +170,13 @@ func (u *user) initMailboxes() error {
 			if err != nil {
 				return err
 			}
+		} else {
+			if _, ok := u.flags[label.ID]; ok {
+				continue
+			}
+
+			u.flags[label.ID] = labelNameToFlag(label.Name)
+		}
 	}
 
 	counts, err := u.c.CountMessages("")
@@ -325,7 +368,7 @@ func (u *user) receiveEvents(updates chan<- imapbackend.Update, events <-chan *p
 							update := new(imapbackend.MessageUpdate)
 							update.Update = imapbackend.NewUpdate(u.u.Name, mbox.name)
 							update.Message = imap.NewMessage(seqNum, []imap.FetchItem{imap.FetchFlags})
-							update.Message.Flags = fetchFlags(msg)
+							update.Message.Flags = mbox.fetchFlags(msg)
 							eventUpdates = append(eventUpdates, update)
 						}
 					}