Opened 8 years ago

Closed 7 years ago

#4271 defect closed fixed (fixed)

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

Reported by: bobf Owned by:
Priority: normal Milestone:
Component: mail Keywords:
Cc: Branch: branches/imap4-unseen-docs-4271
branch-diff, diff-cov, branch-cov, buildbot
Author: exarkun

Description

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").

Change History (5)

comment:1 Changed 8 years ago by Jean-Paul Calderone

Author: exarkun
Branch: branches/imap4-unseen-docs-4271

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

comment:2 Changed 8 years ago by Jean-Paul Calderone

Keywords: review added
Owner: Jean-Paul Calderone deleted

comment:3 Changed 8 years ago by khorn

Keywords: review removed
Owner: set to Jean-Paul Calderone

Looks good to me...merge.

comment:4 Changed 7 years ago by Jean-Paul Calderone

Resolution: fixed
Status: newclosed

(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.

comment:5 Changed 7 years ago by <automation>

Owner: Jean-Paul Calderone deleted
Note: See TracTickets for help on using tickets.