Skip to content

Commit

Permalink
🔀 Merge pull request #227 from ruby/docs/status-DELETED
Browse files Browse the repository at this point in the history
📚 Update `#status` docs for `DELETED` (IMAP4rev2)
  • Loading branch information
nevans authored Nov 13, 2023
2 parents 6e284fd + e58a695 commit d7cdfeb
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions lib/net/imap.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#
Expand All @@ -1715,14 +1716,17 @@ 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].
#
# +RECENT+::
# The number of messages with the <tt>\Recent</tt> 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"])
Expand All @@ -1734,6 +1738,8 @@ def lsub(refname, mailbox)
# <tt>STATUS=SIZE</tt>
# {[RFC8483]}[https://www.rfc-editor.org/rfc/rfc8483.html].
#
# +DELETED+ requires the server's capabilities to include +IMAP4rev2+.
#
# +MAILBOXID+ requires the server's capabilities to include +OBJECTID+
# {[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html].
def status(mailbox, attr)
Expand Down

0 comments on commit d7cdfeb

Please sign in to comment.