Skip to content

Commit d7cdfeb

Browse files
authored
🔀 Merge pull request #227 from ruby/docs/status-DELETED
📚 Update `#status` docs for `DELETED` (IMAP4rev2)
2 parents 6e284fd + e58a695 commit d7cdfeb

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

lib/net/imap.rb

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1692,13 +1692,14 @@ def lsub(refname, mailbox)
16921692
# and returns the status of the indicated +mailbox+. +attr+ is a list of one
16931693
# or more attributes whose statuses are to be requested.
16941694
#
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).
16961697
#
16971698
# A Net::IMAP::NoResponseError is raised if status values
16981699
# for +mailbox+ cannot be returned; for instance, because it
16991700
# does not exist.
17001701
#
1701-
# ===== Supported attributes:
1702+
# ===== Supported attributes
17021703
#
17031704
# +MESSAGES+:: The number of messages in the mailbox.
17041705
#
@@ -1715,14 +1716,17 @@ def lsub(refname, mailbox)
17151716
# the sum of all messages' +RFC822.SIZE+ fetch item values.
17161717
#
17171718
# +MAILBOXID+::
1718-
# A server-allocated unique identifier for the mailbox.
1719+
# A server-allocated unique _string_ identifier for the mailbox.
17191720
# See +OBJECTID+
17201721
# {[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html#section-4].
17211722
#
17221723
# +RECENT+::
17231724
# The number of messages with the <tt>\Recent</tt> flag.
17241725
# _NOTE:_ +RECENT+ was removed from IMAP4rev2.
17251726
#
1727+
# Unsupported attributes may be requested. The attribute value will be
1728+
# either an Integer or an ExtensionData object.
1729+
#
17261730
# ===== For example:
17271731
#
17281732
# p imap.status("inbox", ["MESSAGES", "RECENT"])
@@ -1734,6 +1738,8 @@ def lsub(refname, mailbox)
17341738
# <tt>STATUS=SIZE</tt>
17351739
# {[RFC8483]}[https://www.rfc-editor.org/rfc/rfc8483.html].
17361740
#
1741+
# +DELETED+ requires the server's capabilities to include +IMAP4rev2+.
1742+
#
17371743
# +MAILBOXID+ requires the server's capabilities to include +OBJECTID+
17381744
# {[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html].
17391745
def status(mailbox, attr)

0 commit comments

Comments
 (0)