Introduce a UID type

References: #526

Author: emersion

append.go

@@ -12,5 +12,7 @@ type AppendOptions struct {
 
 // AppendData is the data returned by an APPEND command.
 type AppendData struct {
-	UID, UIDValidity uint32 // requires UIDPLUS or IMAP4rev2
+	// requires UIDPLUS or IMAP4rev2
+	UID         UID
+	UIDValidity uint32
 }

imap.go

@@ -100,3 +100,6 @@ type LiteralReader interface {
 	io.Reader
 	Size() int64
 }
+
+// UID is a message unique identifier.
+type UID uint32

imapclient/client.go

@@ -643,7 +643,7 @@ func (c *Client) readResponseTagged(tag, typ string) (startTLS *startTLSCommand,
 				return nil, fmt.Errorf("in resp-code-apnd: %v", c.dec.Err())
 			}
 			if cmd, ok := cmd.(*AppendCommand); ok {
-				cmd.data.UID = uid
+				cmd.data.UID = imap.UID(uid)
 				cmd.data.UIDValidity = uidValidity
 			}
 		case "COPYUID":
@@ -765,7 +765,7 @@ func (c *Client) readResponseData(typ string) error {
 					return c.dec.Err()
 				}
 				if cmd := findPendingCmdByType[*SelectCommand](c); cmd != nil {
-					cmd.data.UIDNext = uidNext
+					cmd.data.UIDNext = imap.UID(uidNext)
 				}
 			case "UIDVALIDITY":
 				var uidValidity uint32

imapclient/fetch.go

@@ -347,7 +347,7 @@ func (FetchItemDataRFC822Size) fetchItemData() {}
 
 // FetchItemDataUID holds data returned by FETCH UID.
 type FetchItemDataUID struct {
-	UID uint32
+	UID imap.UID
 }
 
 func (FetchItemDataUID) fetchItemData() {}
@@ -387,7 +387,7 @@ type FetchMessageBuffer struct {
 	Envelope          *imap.Envelope
 	InternalDate      time.Time
 	RFC822Size        int64
-	UID               uint32
+	UID               imap.UID
 	BodyStructure     imap.BodyStructure
 	BodySection       map[*imap.FetchItemBodySection][]byte
 	BinarySection     map[*imap.FetchItemBinarySection][]byte
@@ -548,7 +548,7 @@ func (c *Client) handleFetch(seqNum uint32) error {
 				return dec.Err()
 			}
 
-			item = FetchItemDataUID{UID: uid}
+			item = FetchItemDataUID{UID: imap.UID(uid)}
 		case "BODY", "BINARY":
 			if dec.Special('[') {
 				var section interface{}

imapclient/status.go

@@ -111,7 +111,9 @@ func readStatusAttVal(dec *imapwire.Decoder, data *imap.StatusData) error {
 		ok = dec.ExpectNumber(&num)
 		data.NumMessages = &num
 	case "UIDNEXT":
-		ok = dec.ExpectNumber(&data.UIDNext)
+		var uidNext uint32
+		ok = dec.ExpectNumber(&uidNext)
+		data.UIDNext = imap.UID(uidNext)
 	case "UIDVALIDITY":
 		ok = dec.ExpectNumber(&data.UIDValidity)
 	case "UNSEEN":

imapserver/append.go

@@ -94,7 +94,7 @@ func (c *Conn) writeAppendOK(tag string, data *imap.AppendData) error {
 	enc.Atom(tag).SP().Atom("OK").SP()
 	if data != nil {
 		enc.Special('[')
-		enc.Atom("APPENDUID").SP().Number(data.UIDValidity).SP().Number(data.UID)
+		enc.Atom("APPENDUID").SP().Number(data.UIDValidity).SP().Number(uint32(data.UID))
 		enc.Special(']').SP()
 	}
 	enc.Text("APPEND completed")

imapserver/conn.go

@@ -588,7 +588,7 @@ func (w *UpdateWriter) WriteMailboxFlags(flags []imap.Flag) error {
 }
 
 // WriteMessageFlags writes a FETCH response with FLAGS.
-func (w *UpdateWriter) WriteMessageFlags(seqNum, uid uint32, flags []imap.Flag) error {
+func (w *UpdateWriter) WriteMessageFlags(seqNum uint32, uid imap.UID, flags []imap.Flag) error {
 	fetchWriter := &FetchWriter{conn: w.conn}
 	respWriter := fetchWriter.CreateMessage(seqNum)
 	if uid != 0 {

imapserver/fetch.go

@@ -349,9 +349,9 @@ func (w *FetchResponseWriter) writeItemSep() {
 }
 
 // WriteUID writes the message's UID.
-func (w *FetchResponseWriter) WriteUID(uid uint32) {
+func (w *FetchResponseWriter) WriteUID(uid imap.UID) {
 	w.writeItemSep()
-	w.enc.Atom("UID").SP().Number(uid)
+	w.enc.Atom("UID").SP().Number(uint32(uid))
 }
 
 // WriteFlags writes the message's flags.

imapserver/imapmemserver/mailbox.go

@@ -22,7 +22,7 @@ type Mailbox struct {
 	name       string
 	subscribed bool
 	l          []*message
-	uidNext    uint32
+	uidNext    imap.UID
 }
 
 // NewMailbox creates a new mailbox.
@@ -207,7 +207,7 @@ func (mbox *Mailbox) Expunge(w *imapserver.ExpungeWriter, uids *imap.SeqSet) err
 	expunged := make(map[*message]struct{})
 	mbox.mutex.Lock()
 	for _, msg := range mbox.l {
-		if uids != nil && !uids.Contains(msg.uid) {
+		if uids != nil && !uids.Contains(uint32(msg.uid)) {
 			continue
 		}
 		if _, ok := msg.flags[canonicalFlag(imap.FlagDeleted)]; ok {
@@ -335,7 +335,7 @@ func (mbox *MailboxView) Search(numKind imapserver.NumKind, criteria *imap.Searc
 		case imapserver.NumKindSeq:
 			num = seqNum
 		case imapserver.NumKindUID:
-			num = msg.uid
+			num = uint32(msg.uid)
 		}
 		if num == 0 {
 			continue
@@ -391,7 +391,7 @@ func (mbox *MailboxView) forEachLocked(numKind imapserver.NumKind, seqSet imap.S
 		case imapserver.NumKindSeq:
 			num = mbox.tracker.EncodeSeqNum(seqNum)
 		case imapserver.NumKindUID:
-			num = msg.uid
+			num = uint32(msg.uid)
 		}
 		if num == 0 || !seqSet.Contains(num) {
 			continue
@@ -411,7 +411,7 @@ func (mbox *MailboxView) staticSeqSet(seqSet imap.SeqSet, numKind imapserver.Num
 	case imapserver.NumKindSeq:
 		max = uint32(len(mbox.l))
 	case imapserver.NumKindUID:
-		max = mbox.uidNext - 1
+		max = uint32(mbox.uidNext) - 1
 	}
 
 	for i := range seqSet {

imapserver/imapmemserver/message.go

@@ -19,7 +19,7 @@ import (
 
 type message struct {
 	// immutable
-	uid uint32
+	uid imap.UID
 	buf []byte
 	t   time.Time
 
@@ -245,7 +245,7 @@ func (msg *message) search(seqNum uint32, criteria *imap.SearchCriteria) bool {
 		}
 	}
 	for _, seqSet := range criteria.UID {
-		if !seqSet.Contains(msg.uid) {
+		if !seqSet.Contains(uint32(msg.uid)) {
 			return false
 		}
 	}