Add support for CREATE-SPECIAL-USE

Author: emersion

create.go

@@ -1,4 +1,6 @@
 package imap
 
 // CreateOptions contains options for the CREATE command.
-type CreateOptions struct{}
+type CreateOptions struct {
+	SpecialUse []MailboxAttr // requires CREATE-SPECIAL-USE
+}

imapclient/client.go

@@ -880,17 +880,6 @@ func (c *Client) Login(username, password string) *Command {
 	return &cmd.cmd
 }
 
-// Create sends a CREATE command.
-//
-// A nil options pointer is equivalent to a zero options value.
-func (c *Client) Create(mailbox string, options *imap.CreateOptions) *Command {
-	cmd := &Command{}
-	enc := c.beginCommand("CREATE", cmd)
-	enc.SP().Mailbox(mailbox)
-	enc.end()
-	return cmd
-}
-
 // Delete sends a DELETE command.
 func (c *Client) Delete(mailbox string) *Command {
 	cmd := &Command{}

imapclient/create.go

@@ -0,0 +1,21 @@
+package imapclient
+
+import (
+	"github.com/emersion/go-imap/v2"
+)
+
+// Create sends a CREATE command.
+//
+// A nil options pointer is equivalent to a zero options value.
+func (c *Client) Create(mailbox string, options *imap.CreateOptions) *Command {
+	cmd := &Command{}
+	enc := c.beginCommand("CREATE", cmd)
+	enc.SP().Mailbox(mailbox)
+	if options != nil && len(options.SpecialUse) > 0 {
+		enc.SP().Special('(').Atom("USE").SP().List(len(options.SpecialUse), func(i int) {
+			enc.Atom(string(options.SpecialUse[i])) // TODO: validate attr
+		}).Special(')')
+	}
+	enc.end()
+	return cmd
+}

imapserver/conn.go

@@ -313,17 +313,6 @@ func (c *Conn) handleLogout(dec *imapwire.Decoder) error {
 	})
 }
 
-func (c *Conn) handleCreate(dec *imapwire.Decoder) error {
-	var name string
-	if !dec.ExpectSP() || !dec.ExpectMailbox(&name) || !dec.ExpectCRLF() {
-		return dec.Err()
-	}
-	if err := c.checkState(imap.ConnStateAuthenticated); err != nil {
-		return err
-	}
-	return c.session.Create(name, &imap.CreateOptions{})
-}
-
 func (c *Conn) handleDelete(dec *imapwire.Decoder) error {
 	var name string
 	if !dec.ExpectSP() || !dec.ExpectMailbox(&name) || !dec.ExpectCRLF() {

imapserver/create.go

@@ -0,0 +1,51 @@
+package imapserver
+
+import (
+	"strings"
+
+	"github.com/emersion/go-imap/v2"
+	"github.com/emersion/go-imap/v2/internal"
+	"github.com/emersion/go-imap/v2/internal/imapwire"
+)
+
+func (c *Conn) handleCreate(dec *imapwire.Decoder) error {
+	var (
+		name    string
+		options imap.CreateOptions
+	)
+	if !dec.ExpectSP() || !dec.ExpectMailbox(&name) {
+		return dec.Err()
+	}
+	if dec.SP() {
+		var name string
+		if !dec.ExpectSpecial('(') || !dec.ExpectAtom(&name) || !dec.ExpectSP() {
+			return dec.Err()
+		}
+		switch strings.ToUpper(name) {
+		case "USE":
+			err := dec.ExpectList(func() error {
+				flag, err := internal.ReadFlag(dec)
+				if err != nil {
+					return err
+				}
+				options.SpecialUse = append(options.SpecialUse, imap.MailboxAttr(flag))
+				return nil
+			})
+			if err != nil {
+				return err
+			}
+		default:
+			return newClientBugError("unknown CREATE parameter")
+		}
+		if !dec.ExpectSpecial(')') {
+			return dec.Err()
+		}
+	}
+	if !dec.ExpectCRLF() {
+		return dec.Err()
+	}
+	if err := c.checkState(imap.ConnStateAuthenticated); err != nil {
+		return err
+	}
+	return c.session.Create(name, &options)
+}