Opened 5 years ago

Closed 4 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
(diff, github, buildbot, log)
Author: exarkun Launchpad Bug:

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 5 years ago by exarkun

  • Author set to exarkun
  • Branch set to branches/imap4-unseen-docs-4271

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

comment:2 Changed 5 years ago by exarkun

  • Keywords review added
  • Owner exarkun deleted

comment:3 Changed 5 years ago by khorn

  • Keywords review removed
  • Owner set to exarkun

Looks good to me...merge.

comment:4 Changed 4 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

(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 4 years ago by <automation>

  • Owner exarkun deleted
Note: See TracTickets for help on using tickets.