Skip to content

Commit

Permalink
📚 Update Namespace, Namespaces rdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
nevans committed Jan 4, 2025
1 parent 87879d6 commit 8ae8882
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions lib/net/imap/response_data.rb
Original file line number Diff line number Diff line change
Expand Up @@ -504,11 +504,12 @@ class MailboxACLItem < Struct.new(:user, :rights, :mailbox)
# The access rights the indicated #user has to the #mailbox.
end

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

# Net::IMAP::Namespaces represents a +NAMESPACE+ server response, which
# contains lists of #personal, #shared, and #other namespaces.
# Namespaces represents the data of an untagged +NAMESPACE+ response,
# returned by IMAP#namespace.
#
# Net::IMAP#namespace returns a Namespaces object.
# Contains lists of #personal, #shared, and #other namespaces.
#
# == Required capability
# Requires either +NAMESPACE+ [RFC2342[https://www.rfc-editor.org/rfc/rfc2342]]
# or +IMAP4rev2+ capability.
class Namespaces < Struct.new(:personal, :other, :shared)
##
# method: personal
Expand Down

0 comments on commit 8ae8882

Please sign in to comment.