Skip to content

Commit

Permalink
📚 Update MailboxQuota, MailboxQuotaRoot rdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
nevans committed Jan 4, 2025
1 parent c92a71c commit 62c91dc
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions lib/net/imap/response_data.rb
Original file line number Diff line number Diff line change
Expand Up @@ -423,16 +423,16 @@ class MailboxList < Struct.new(:attr, :delim, :name)
# Returns the mailbox name.
end

# Net::IMAP::MailboxQuota represents contents of GETQUOTA response.
# This object can also be a response to GETQUOTAROOT. In the syntax
# specification below, the delimiter used with the "#" construct is a
# single space (SPACE).
# MailboxQuota represents the data of an untagged +QUOTA+ response.
#
# Net:IMAP#getquota returns an array of MailboxQuota objects.
# IMAP#getquota returns an array of MailboxQuota objects.
#
# Net::IMAP#getquotaroot returns an array containing both MailboxQuotaRoot
# and MailboxQuota objects.
#
# == Required capability
# Requires +QUOTA+ [RFC2087[https://www.rfc-editor.org/rfc/rfc2087]]
# capability.
class MailboxQuota < Struct.new(:mailbox, :usage, :quota)
##
# method: mailbox
Expand All @@ -454,12 +454,14 @@ class MailboxQuota < Struct.new(:mailbox, :usage, :quota)
#
end

# Net::IMAP::MailboxQuotaRoot represents part of the GETQUOTAROOT
# response. (GETQUOTAROOT can also return Net::IMAP::MailboxQuota.)
# MailboxQuotaRoot represents the data of an untagged +QUOTAROOT+ response.
#
# Net::IMAP#getquotaroot returns an array containing both MailboxQuotaRoot
# and MailboxQuota objects.
# IMAP#getquotaroot returns an array containing both MailboxQuotaRoot and
# MailboxQuota objects.
#
# == Required capability
# Requires +QUOTA+ [RFC2087[https://www.rfc-editor.org/rfc/rfc2087]]
# capability.
class MailboxQuotaRoot < Struct.new(:mailbox, :quotaroots)
##
# method: mailbox
Expand Down

0 comments on commit 62c91dc

Please sign in to comment.