From e58a695bc11ffc355d87f812ccb2391d893942d5 Mon Sep 17 00:00:00 2001 From: nick evans Date: Mon, 13 Nov 2023 11:49:36 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Document=20`#status`=20attribute?= =?UTF-8?q?=20return=20values?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- lib/net/imap.rb | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/lib/net/imap.rb b/lib/net/imap.rb index 51024167..718289f1 100644 --- a/lib/net/imap.rb +++ b/lib/net/imap.rb @@ -1692,13 +1692,14 @@ def lsub(refname, mailbox) # and returns the status of the indicated +mailbox+. +attr+ is a list of one # or more attributes whose statuses are to be requested. # - # The return value is a hash of attributes. + # The return value is a hash of attributes. Most status attributes return + # integer values, but some return other value types (documented below). # # A Net::IMAP::NoResponseError is raised if status values # for +mailbox+ cannot be returned; for instance, because it # does not exist. # - # ===== Supported attributes: + # ===== Supported attributes # # +MESSAGES+:: The number of messages in the mailbox. # @@ -1715,7 +1716,7 @@ def lsub(refname, mailbox) # the sum of all messages' +RFC822.SIZE+ fetch item values. # # +MAILBOXID+:: - # A server-allocated unique identifier for the mailbox. + # A server-allocated unique _string_ identifier for the mailbox. # See +OBJECTID+ # {[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html#section-4]. # @@ -1723,6 +1724,9 @@ def lsub(refname, mailbox) # The number of messages with the \Recent flag. # _NOTE:_ +RECENT+ was removed from IMAP4rev2. # + # Unsupported attributes may be requested. The attribute value will be + # either an Integer or an ExtensionData object. + # # ===== For example: # # p imap.status("inbox", ["MESSAGES", "RECENT"])