Skip to content

Commit dd181d3

Browse files
committed
📚 Add CONDSTORE extension to class documention
1 parent f40e758 commit dd181d3

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

lib/net/imap.rb

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -504,6 +504,8 @@ module Net
504504
#
505505
# ==== RFC7162: +CONDSTORE+
506506
#
507+
# - Updates #enable with +CONDSTORE+ parameter. +CONDSTORE+ will also be
508+
# enabled by using any of the extension's command parameters, listed below.
507509
# - Updates #status with the +HIGHESTMODSEQ+ status attribute.
508510
# - Updates #select and #examine with the +condstore+ modifier, and adds
509511
# either a +HIGHESTMODSEQ+ or +NOMODSEQ+ ResponseCode to the responses.
@@ -683,6 +685,16 @@ module Net
683685
# Resnick, P., Ed., Newman, C., Ed., and S. Shen, Ed.,
684686
# "IMAP Support for UTF-8", RFC 6855, DOI 10.17487/RFC6855, March 2013,
685687
# <https://www.rfc-editor.org/info/rfc6855>.
688+
# [CONDSTORE[https://tools.ietf.org/html/rfc7162]]::
689+
# [QRESYNC[https://tools.ietf.org/html/rfc7162]]::
690+
# Melnikov, A. and D. Cridland, "IMAP Extensions: Quick Flag Changes
691+
# Resynchronization (CONDSTORE) and Quick Mailbox Resynchronization
692+
# (QRESYNC)", RFC 7162, DOI 10.17487/RFC7162, May 2014,
693+
# <https://www.rfc-editor.org/info/rfc7162>.
694+
# [OBJECTID[https://tools.ietf.org/html/rfc8474]]::
695+
# Gondwana, B., Ed., "IMAP Extension for Object Identifiers",
696+
# RFC 8474, DOI 10.17487/RFC8474, September 2018,
697+
# <https://www.rfc-editor.org/info/rfc8474>.
686698
#
687699
# === IANA registries
688700
# * {IMAP Capabilities}[http://www.iana.org/assignments/imap4-capabilities]
@@ -2306,6 +2318,13 @@ def uid_thread(algorithm, search_keys, charset)
23062318
# each enabled extension (usually the same name as the enabled extension).
23072319
# The following capabilities may be enabled:
23082320
#
2321+
# [+CONDSTORE+ {[RFC7162]}[https://www.rfc-editor.org/rfc/rfc7162.html]]
2322+
#
2323+
# Updates various commands to return +CONDSTORE+ extension responses. It
2324+
# is not necessary to explicitly enable +CONDSTORE+—using any of the
2325+
# command parameters defined by the extension will implicitly enable it.
2326+
# See {[RFC7162 §3.1]}[https://www.rfc-editor.org/rfc/rfc7162.html#section-3.1].
2327+
#
23092328
# [+:utf8+ --- an alias for <tt>"UTF8=ACCEPT"</tt>]
23102329
#
23112330
# In a future release, <tt>enable(:utf8)</tt> will enable either

0 commit comments

Comments
 (0)