Skip to content

Commit 8ae8882

Browse files
committed
📚 Update Namespace, Namespaces rdoc
1 parent 87879d6 commit 8ae8882

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

lib/net/imap/response_data.rb

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -504,11 +504,12 @@ class MailboxACLItem < Struct.new(:user, :rights, :mailbox)
504504
# The access rights the indicated #user has to the #mailbox.
505505
end
506506

507-
# Net::IMAP::Namespace represents a single namespace contained inside a
508-
# NAMESPACE response.
509-
#
510-
# Returned by Net::IMAP#namespace, contained inside a Namespaces object.
507+
# Namespace represents a _single_ namespace, contained inside a Namespaces
508+
# object.
511509
#
510+
# == Required capability
511+
# Requires either +NAMESPACE+ [RFC2342[https://www.rfc-editor.org/rfc/rfc2342]]
512+
# or +IMAP4rev2+ capability.
512513
class Namespace < Struct.new(:prefix, :delim, :extensions)
513514
##
514515
# method: prefix
@@ -530,11 +531,14 @@ class Namespace < Struct.new(:prefix, :delim, :extensions)
530531
# Extension parameter semantics would be defined by the extension.
531532
end
532533

533-
# Net::IMAP::Namespaces represents a +NAMESPACE+ server response, which
534-
# contains lists of #personal, #shared, and #other namespaces.
534+
# Namespaces represents the data of an untagged +NAMESPACE+ response,
535+
# returned by IMAP#namespace.
535536
#
536-
# Net::IMAP#namespace returns a Namespaces object.
537+
# Contains lists of #personal, #shared, and #other namespaces.
537538
#
539+
# == Required capability
540+
# Requires either +NAMESPACE+ [RFC2342[https://www.rfc-editor.org/rfc/rfc2342]]
541+
# or +IMAP4rev2+ capability.
538542
class Namespaces < Struct.new(:personal, :other, :shared)
539543
##
540544
# method: personal

0 commit comments

Comments
 (0)