Conversation
nevans
force-pushed
the
document-incomplete-quota-support-and-update-names
branch
from
2e0b2e9 to
a1d90f9
Compare
This updates the QUOTA docs with references to RFC9208 (`QUOTA=RES-*`). For the most part, RFC9208 is backward compatible with RFC2087. So this updates the documentation to reference it wherever relevant. This also documents how `net-imap`'s support for `QUOTA` is incomplete: that it only supports setting `STORAGE` and can only parse a single resource type (which is _usually_ `STORAGE`). The RFCs are very clear that `quota root` is _not_ the same as `mailbox`, so this updates method parameters and rdoc to reflect that. `MailboxQuota#mailbox` is incorrectly named, but renaming it would be backward incompatible. This just updates the documentation and adds `quota_root` as an alias. This also fixes the rdoc for `MailboxQuota#quota` to specify that it is the _storage_ limit, rather than any other quota resource type. This adds a note in the rdoc that _only_ `STORAGE` is currently supported. `GETQUOTA` generally _is_ available to normal users. That comment on `#getquota` may have been copied from `SETQUOTA`. See also: #622
nevans
force-pushed
the
document-incomplete-quota-support-and-update-names
branch
from
a1d90f9 to
0ea729c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This updates the QUOTA docs with references to RFC9208 (
QUOTA=RES-*). For the most part, RFC9208 is backward compatible with RFC2087. So this updates the documentation to reference it wherever relevant.This also documents how
net-imap's support forQUOTAis incomplete: that it only supports settingSTORAGEand can only parse a single resource type (which is usuallySTORAGE).The RFCs are very clear that
quota rootis not the same asmailbox, so this updates method parameters and rdoc to reflect that.MailboxQuota#mailboxis incorrectly named, but renaming it would be backward incompatible, so this just updates the documentation and addsquota_rootas an alias.This also fixes the rdoc for
MailboxQuota#quotato specify that it is the storage limit, rather than any other quota resource type. This adds a note in the rdoc that onlySTORAGEis currently supported.GETQUOTAgenerally is available to normal users. That comment on#getquotamay have been copied fromSETQUOTA.See also: #622