twisted.mail.imap4 docs state incorrect meaning of UNSEEN value

[bobf]

The docs for IMAP4Client.select() ( http://twistedmatrix.com/documents/current/api/twisted.mail.imap4.IMAP4Client.html#select) state: "UNSEEN: An integer indicating the number of messages not flagged \Seen in this mailbox."

However, the RFC ( http://www.faqs.org/rfcs/rfc3501.html) states:

"OK [UNSEEN <n>]

The message sequence number of the first unseen message in the mailbox. If this is missing, the client can not make any assumptions about the first unseen message in the mailbox, and needs to issue a SEARCH command if it wants to find it."

The behaviour of IMAP4Client matches the RFC, not the Twisted docs (i.e. if I have one unread message, UNSEEN is the sequence number of that unread message, not "1").

[exarkun]

(In [28231]) Branching to 'imap4-unseen-docs-4271'

[khorn]

Looks good to me...merge.

[exarkun]

(In [28643]) Merge imap4-unseen-docs-4271

Author: exarkun Reviewer: khorn Fixes: #4271

Correct the twisted.mail.imap4 API documentation about the meaning of the UNSEEN flag in responses.