@@ -1692,13 +1692,14 @@ def lsub(refname, mailbox)
1692
1692
# and returns the status of the indicated +mailbox+. +attr+ is a list of one
1693
1693
# or more attributes whose statuses are to be requested.
1694
1694
#
1695
- # The return value is a hash of attributes.
1695
+ # The return value is a hash of attributes. Most status attributes return
1696
+ # integer values, but some return other value types (documented below).
1696
1697
#
1697
1698
# A Net::IMAP::NoResponseError is raised if status values
1698
1699
# for +mailbox+ cannot be returned; for instance, because it
1699
1700
# does not exist.
1700
1701
#
1701
- # ===== Supported attributes:
1702
+ # ===== Supported attributes
1702
1703
#
1703
1704
# +MESSAGES+:: The number of messages in the mailbox.
1704
1705
#
@@ -1715,14 +1716,17 @@ def lsub(refname, mailbox)
1715
1716
# the sum of all messages' +RFC822.SIZE+ fetch item values.
1716
1717
#
1717
1718
# +MAILBOXID+::
1718
- # A server-allocated unique identifier for the mailbox.
1719
+ # A server-allocated unique _string_ identifier for the mailbox.
1719
1720
# See +OBJECTID+
1720
1721
# {[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html#section-4].
1721
1722
#
1722
1723
# +RECENT+::
1723
1724
# The number of messages with the <tt>\Recent</tt> flag.
1724
1725
# _NOTE:_ +RECENT+ was removed from IMAP4rev2.
1725
1726
#
1727
+ # Unsupported attributes may be requested. The attribute value will be
1728
+ # either an Integer or an ExtensionData object.
1729
+ #
1726
1730
# ===== For example:
1727
1731
#
1728
1732
# p imap.status("inbox", ["MESSAGES", "RECENT"])
@@ -1734,6 +1738,8 @@ def lsub(refname, mailbox)
1734
1738
# <tt>STATUS=SIZE</tt>
1735
1739
# {[RFC8483]}[https://www.rfc-editor.org/rfc/rfc8483.html].
1736
1740
#
1741
+ # +DELETED+ requires the server's capabilities to include +IMAP4rev2+.
1742
+ #
1737
1743
# +MAILBOXID+ requires the server's capabilities to include +OBJECTID+
1738
1744
# {[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html].
1739
1745
def status ( mailbox , attr )
0 commit comments