Skip to content

Commit 5617a03

Browse files
committed
📚 Document COPYUID in tagged vs untagged responses
1 parent cfb93b9 commit 5617a03

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

lib/net/imap/uidplus_data.rb

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,20 @@ class IMAP < Protocol
66
# UIDPlusData represents the ResponseCode#data that accompanies the
77
# +APPENDUID+ and +COPYUID+ {response codes}[rdoc-ref:ResponseCode].
88
#
9-
# A server that supports +UIDPLUS+ should send a UIDPlusData object inside
10-
# every TaggedResponse returned by the append[rdoc-ref:Net::IMAP#append],
11-
# copy[rdoc-ref:Net::IMAP#copy], move[rdoc-ref:Net::IMAP#move], {uid
12-
# copy}[rdoc-ref:Net::IMAP#uid_copy], and {uid
13-
# move}[rdoc-ref:Net::IMAP#uid_move] commands---unless the destination
14-
# mailbox reports +UIDNOTSTICKY+.
9+
# A server that supports +UIDPLUS+ should send UIDPlusData in response to
10+
# the append[rdoc-ref:Net::IMAP#append], copy[rdoc-ref:Net::IMAP#copy],
11+
# move[rdoc-ref:Net::IMAP#move], {uid copy}[rdoc-ref:Net::IMAP#uid_copy],
12+
# and {uid move}[rdoc-ref:Net::IMAP#uid_move] commands---unless the
13+
# destination mailbox reports +UIDNOTSTICKY+.
14+
#
15+
# Note that append[rdoc-ref:Net::IMAP#append], copy[rdoc-ref:Net::IMAP#copy]
16+
# and {uid_copy}[rdoc-ref:Net::IMAP#uid_copy] return UIDPlusData in their
17+
# TaggedResponse. But move[rdoc-ref:Net::IMAP#copy] and
18+
# {uid_move}[rdoc-ref:Net::IMAP#uid_move] _should_ send UIDPlusData in an
19+
# UntaggedResponse response before sending their TaggedResponse. However
20+
# some servers do send UIDPlusData in the TaggedResponse for +MOVE+
21+
# commands---this complies with the older +UIDPLUS+ specification but is
22+
# discouraged by the +MOVE+ extension and disallowed by +IMAP4rev2+.
1523
#
1624
# == Required capability
1725
# Requires either +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315]]

0 commit comments

Comments
 (0)