Skip to content

Commit c92a71c

Browse files
committed
📚 Update MailboxList rdoc
1 parent 38651ed commit c92a71c

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

lib/net/imap/response_data.rb

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -393,10 +393,8 @@ def uid_mapping
393393
end
394394
end
395395

396-
# Net::IMAP::MailboxList represents contents of the LIST response,
397-
# representing a single mailbox path.
398-
#
399-
# Net::IMAP#list returns an array of MailboxList objects.
396+
# MailboxList represents the data of an untagged +LIST+ response, for a
397+
# _single_ mailbox path. IMAP#list returns an array of MailboxList objects.
400398
#
401399
class MailboxList < Struct.new(:attr, :delim, :name)
402400
##
@@ -406,11 +404,11 @@ class MailboxList < Struct.new(:attr, :delim, :name)
406404
# Returns the name attributes. Each name attribute is a symbol capitalized
407405
# by String#capitalize, such as :Noselect (not :NoSelect). For the
408406
# semantics of each attribute, see:
409-
# * rdoc-ref:Net::IMAP@Basic+Mailbox+Attributes
410-
# * rdoc-ref:Net::IMAP@Mailbox+role+Attributes
411-
# * Net::IMAP@SPECIAL-USE
407+
# * Net::IMAP@Basic+Mailbox+Attributes
408+
# * Net::IMAP@Mailbox+role+Attributes
412409
# * The IANA {IMAP Mailbox Name Attributes
413410
# registry}[https://www.iana.org/assignments/imap-mailbox-name-attributes/imap-mailbox-name-attributes.xhtml]
411+
# has links to specifications for all standard mailbox attributes.
414412

415413
##
416414
# method: delim

0 commit comments

Comments
 (0)