Skip to content

Commit 38651ed

Browse files
committed
📚 Update UIDPlusData rdoc
1 parent 2b473e1 commit 38651ed

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

lib/net/imap/response_data.rb

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -344,24 +344,19 @@ class ResponseCode < Struct.new(:name, :data)
344344
# code data can take.
345345
end
346346

347-
# Net::IMAP::UIDPlusData represents the ResponseCode#data that accompanies
348-
# the +APPENDUID+ and +COPYUID+ response codes.
347+
# UIDPlusData represents the ResponseCode#data that accompanies the
348+
# +APPENDUID+ and +COPYUID+ {response codes}[rdoc-ref:ResponseCode].
349349
#
350-
# See [[UIDPLUS[https://www.rfc-editor.org/rfc/rfc4315.html]].
351-
#
352-
# ==== Capability requirement
353-
#
354-
# The +UIDPLUS+ capability[rdoc-ref:Net::IMAP#capability] must be supported.
355350
# A server that supports +UIDPLUS+ should send a UIDPlusData object inside
356351
# every TaggedResponse returned by the append[rdoc-ref:Net::IMAP#append],
357352
# copy[rdoc-ref:Net::IMAP#copy], move[rdoc-ref:Net::IMAP#move], {uid
358353
# copy}[rdoc-ref:Net::IMAP#uid_copy], and {uid
359354
# move}[rdoc-ref:Net::IMAP#uid_move] commands---unless the destination
360355
# mailbox reports +UIDNOTSTICKY+.
361356
#
362-
#--
363-
# TODO: support MULTIAPPEND
364-
#++
357+
# == Required capability
358+
# Requires either +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315]]
359+
# or +IMAP4rev2+ capability.
365360
#
366361
class UIDPlusData < Struct.new(:uidvalidity, :source_uids, :assigned_uids)
367362
##

0 commit comments

Comments
 (0)