Skip to content

Commit 62c91dc

Browse files
committed
📚 Update MailboxQuota, MailboxQuotaRoot rdoc
1 parent c92a71c commit 62c91dc

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

lib/net/imap/response_data.rb

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -423,16 +423,16 @@ class MailboxList < Struct.new(:attr, :delim, :name)
423423
# Returns the mailbox name.
424424
end
425425

426-
# Net::IMAP::MailboxQuota represents contents of GETQUOTA response.
427-
# This object can also be a response to GETQUOTAROOT. In the syntax
428-
# specification below, the delimiter used with the "#" construct is a
429-
# single space (SPACE).
426+
# MailboxQuota represents the data of an untagged +QUOTA+ response.
430427
#
431-
# Net:IMAP#getquota returns an array of MailboxQuota objects.
428+
# IMAP#getquota returns an array of MailboxQuota objects.
432429
#
433430
# Net::IMAP#getquotaroot returns an array containing both MailboxQuotaRoot
434431
# and MailboxQuota objects.
435432
#
433+
# == Required capability
434+
# Requires +QUOTA+ [RFC2087[https://www.rfc-editor.org/rfc/rfc2087]]
435+
# capability.
436436
class MailboxQuota < Struct.new(:mailbox, :usage, :quota)
437437
##
438438
# method: mailbox
@@ -454,12 +454,14 @@ class MailboxQuota < Struct.new(:mailbox, :usage, :quota)
454454
#
455455
end
456456

457-
# Net::IMAP::MailboxQuotaRoot represents part of the GETQUOTAROOT
458-
# response. (GETQUOTAROOT can also return Net::IMAP::MailboxQuota.)
457+
# MailboxQuotaRoot represents the data of an untagged +QUOTAROOT+ response.
459458
#
460-
# Net::IMAP#getquotaroot returns an array containing both MailboxQuotaRoot
461-
# and MailboxQuota objects.
459+
# IMAP#getquotaroot returns an array containing both MailboxQuotaRoot and
460+
# MailboxQuota objects.
462461
#
462+
# == Required capability
463+
# Requires +QUOTA+ [RFC2087[https://www.rfc-editor.org/rfc/rfc2087]]
464+
# capability.
463465
class MailboxQuotaRoot < Struct.new(:mailbox, :quotaroots)
464466
##
465467
# method: mailbox

0 commit comments

Comments
 (0)