forked from dwd/draft-rfc4551-bis
-
Notifications
You must be signed in to change notification settings - Fork 1
/
draft-rfc4551-bis.xml
2891 lines (2472 loc) · 121 KB
/
draft-rfc4551-bis.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="us-ascii"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY rfc2119 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
<!ENTITY rfc5234 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5234.xml'>
<!ENTITY rfc3501 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.3501.xml'>
<!ENTITY rfc4466 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.4466.xml'>
<!ENTITY rfc4314 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.4314.xml'>
<!ENTITY rfc2180 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2180.xml'>
<!ENTITY rfc2683 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2683.xml'>
<!ENTITY rfc4731 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.4731.xml'>
<!ENTITY rfc5161 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5161.xml'>
<!ENTITY rfc5256 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5256.xml'>
<!ENTITY rfc5257 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5257.xml'>
<!ENTITY rfc5267 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5267.xml'>
<!ENTITY rfc5464 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5464.xml'>
<!ENTITY rfc6851 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6851.xml'>
]>
<rfc category="std" ipr="pre5378Trust200902" docName="draft-ietf-qresync-rfc5162bis-10.txt"
obsoletes="4551, 5162" updates='2683'>
<?xml-stylesheet href="rfc5162_files/rfc2629.htm" type="text/xsl"?>
<?rfc strict="yes" ?>
<?rfc toc="yes" ?>
<?rfc symrefs="yes" ?>
<?rfc sortrefs="yes"?>
<?rfc iprnotified="no" ?>
<?rfc strict="yes" ?>
<?rfc comments="yes" ?>
<?rfc inline="yes" ?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<front>
<title abbrev="IMAP CONDSTORE & QRESYNC">
IMAP Extensions for Conditional STORE Operation or Quick Flag Changes Resynchronization (CONDSTORE) and
Quick Mailbox Resynchronization (QRESYNC)</title>
<author initials="A." surname="Melnikov" fullname="Alexey Melnikov">
<organization>Isode Ltd</organization>
<address>
<postal>
<street>5 Castle Business Village</street>
<street>36 Station Road</street>
<city>Hampton</city>
<region>Middlesex</region>
<code>TW12 2BX</code>
<country>UK</country>
</postal>
<email>Alexey.Melnikov@isode.com</email>
</address>
</author>
<author initials="D." surname="Cridland" fullname="Dave Cridland">
<organization>Arcode Inc</organization>
<address>
<postal>
<street>4304 East West Highway</street>
<city>Bethesda</city>
<region>MD</region>
<code>20814</code>
<country>US</country>
</postal>
<email>dcridland@arcode.com</email>
</address>
</author>
<date year="2014"/>
<keyword>IMAP</keyword>
<keyword>CONDSTORE</keyword>
<keyword>QRESYNC</keyword>
<keyword>VANISHED</keyword>
<keyword>EXPUNGE</keyword>
<keyword>quick resynchronization</keyword>
<abstract>
<!--CONDSTORE-->
<t>Often, multiple IMAP (RFC 3501) clients need to coordinate changes to
a common IMAP mailbox. Examples include different clients working on
behalf of the same user, and multiple users accessing shared
mailboxes. These clients need a mechanism to efficiently synchronize state
changes for messages within the mailbox.</t>
<t>
Initially defined in RFC 4551, The Conditional Store facility provides
a protected update mechanism for message state information and a
mechanism for requesting only changes to message state. This memo
updates that mechanism and obsoletes RFC 4551, based on operational
experience.
</t>
<!--QRESYNC-->
<t>This document additionally updates another IMAP extension,
Quick Resynchronization, which builds on the Conditional Store extension to provide
an IMAP client the ability to fully resynchronize a mailbox as
part of the SELECT/EXAMINE command, without the need for additional server-side
state or client round-trips. Hence this memo obsoletes RFC 5162.
</t>
<t>
Finally, this document also updates the line length recommendation in Section 3.2.1.5 of RFC 2683.
</t>
</abstract>
</front>
<middle>
<section title="Introduction" anchor="intro">
<!--CONDSTORE-->
<t>
Often, multiple IMAP <xref target="RFC3501"/> clients need to coordinate changes to
a common IMAP mailbox. Examples include different clients working on
behalf of the same user, and client representing multiple users accessing shared
mailboxes. These clients need a mechanism to synchronize state
changes for messages within the mailbox.
The Conditional Store ("CONDSTORE") facility allows a client to quickly
resynchronize mailbox flag changes.
</t>
<t>
The Conditional Store facility also provides a protected update mechanism
for message state information that can detect and resolve conflicts
between multiple writing mail clients. The mechanism can be used to guarantee
that only one client can change message state at any given time.
For example, this can be used by multiple clients which treat
a mailbox as a message queue. <!--and need exclusive access to messages in the queue-->
</t>
<t>The Conditional Store facility is provided by associating a modification sequence
(mod-sequence) with every IMAP message. This is updated whenever metadata (such as a
message flag) is modified.</t>
<t>The CONDSTORE extension is described in more details in <xref target="condstore"/>.</t>
<!--QRESYNC-->
<t>
The CONDSTORE extension gives a disconnected client
the ability to quickly resynchronize IMAP flag changes for previously
seen messages. This can be done using the CHANGEDSINCE FETCH modifier
once a mailbox is opened. In order for the client to discover which
messages have been expunged, the client still has to issue a UID FETCH
or a UID SEARCH command. The QRESYNC ("quick resync") IMAP extension is an extension to
CONDSTORE that allows a reconnecting client to
perform full resynchronization, including discovery of expunged
messages, in a single round-trip. QRESYNC also
introduces a new response, VANISHED, that allows for a more compact
representation of a list of expunged messages.
</t>
<t>QRESYNC can be useful for mobile clients
that can experience frequent disconnects caused by environmental factors
(battery life, signal strength, etc.). Such clients need a way
to quickly reconnect to the IMAP server, while minimizing delay
experienced by the user as well as the amount of traffic
generated by resynchronization.
</t>
<t>
By extending the SELECT command to perform the additional
resynchronization, this also allows clients to reduce concurrent
connections to the IMAP server held purely for the sake of
avoiding the resynchronization.
</t>
<t>
The QRESYNC extension is described in more details in <xref target="qresync"/>.
</t>
</section>
<section title="Requirements Notation">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
"SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
and "OPTIONAL" in this document are to be interpreted as
described in <xref target="RFC2119"/>.</t>
<t>In examples, "C:" and "S:" indicate lines sent by
the client and server respectively. If a single "C:" or "S:"
label applies to multiple lines, then the line breaks between
those lines are for editorial clarity only and are not part
of the actual protocol exchange. The five characters [...] means that
something has been elided.</t>
<t>Formal syntax is defined using ABNF <xref target="RFC5234"/>.</t>
<t>The term "metadata" or "metadata item" is used throughout this
document. It refers to any system- or user-defined keyword.
If the server supports IMAP ANNOTATE-EXPERIMENT-1 extension <xref target="RFC5257"/>,
then metadata also includes message annotations. Future
documents may extend "metadata" to include other dynamic message
data.</t>
<t>Some IMAP mailboxes are private, accessible only to the owning user.
Other mailboxes are not, either because the owner has set an Access
Control List <xref target="RFC4314"/> that permits access by other users, or because it
is a shared mailbox. Let's call a metadata item "shared" for the
mailbox if any changes to the metadata items are persistent and
visible to all other users accessing the mailbox. Otherwise, the
metadata item is called "private". Note that private metadata items
are still visible to all sessions accessing the mailbox as the same
user. Also note that different mailboxes may have different metadata
items as shared.</t>
<t>See <xref target="condstore"/> for the definition of a "CONDSTORE-aware client" and a
"CONDSTORE enabling command".</t>
<t>
Understanding of the IMAP message sequence numbers and UIDs (see
<xref target="RFC3501"/>, Section 2.3.1) and the EXPUNGE response (see <xref target="RFC3501"/>,
Section 7.4.1) is essential when reading this document.
</t>
</section>
<section title="IMAP Protocol Changes">
<section title="CONDSTORE extension" anchor="condstore">
<t>
An IMAP server that supports CONDSTORE MUST associate a positive
unsigned 63-bit (*) value, called a modification sequence (mod-sequence),
with every IMAP message. This is an opaque value updated by the
server whenever a metadata item is modified. The server MUST
guarantee that each STORE command performed on the same mailbox
(including simultaneous stores to different metadata items from
different connections) will get a different mod-sequence value.
Also, for any two successful STORE operations performed in the same
session on the same mailbox, the mod-sequence of the second completed
operation MUST be greater than the mod-sequence of the first
completed. Note that the latter rule disallows the direct use of the system
clock as a mod-sequence, because if system time changes (e.g., an NTP
<xref target="NTP"/> client adjusting the time), the next generated value might be
less than the previous one.
</t>
<t>
(*) Note: RFC 4551 defined mod-sequences as unsigned 64-bit values. In order to make implementations
on various platforms (such as Java) easier, this version of the document redefines them as unsigned 63-bit values.
<!--
This reflects consensus among WG participants, including server implementers.
-->
</t>
<t>
These rules allow a client to list all metadata changes
since a well known point in time, as well as to perform conditional metadata
modifications based on an assumption that metadata state hasn't changed for
a particular message.</t>
<t>In particular, mod-sequences allow a client that supports the CONDSTORE extension to
determine if a message metadata has changed since some known moment.
<!--////Switching from a not yet defined "metadata" to a more specific "flag"-->
Whenever the state of a flag changes (i.e., the flag is added where
previously it wasn't set, or the flag is removed and before it was
set) the value of the modification sequence for the message MUST be
updated. Setting a flag that is already set, or clearing a flag that
is not set, SHOULD NOT change the mod-sequence.
</t>
<t>
When a message is appended to a mailbox (via the IMAP APPEND command,
COPY to the mailbox, or using an external mechanism) the server
generates a new modification sequence that is higher than the highest
modification sequence of all messages in the mailbox and assigns it
to the appended message.
</t>
<t>
The server MAY store separate (per-message) modification sequence
values for different metadata items. If the server does so, per-message
mod-sequence is the highest mod-sequence of all metadata
items accessible to the currently logged in user for the specified message.
</t>
<t>
The server that supports CONDSTORE is not required to be able to
store mod-sequences for every available mailbox. <xref target="nomodseq"/>
describes how the server may act if a particular mailbox doesn't
support the persistent storage of mod-sequences.
</t>
<t>
CONDSTORE makes the following changes to the IMAP4 protocol:
<list style='letters'>
<t>adds UNCHANGEDSINCE STORE modifier.</t>
<t>
adds the MODIFIED response code which is used with an OK
response to the STORE command. (It can also be used in a NO
response.)
</t>
<t>
adds a new MODSEQ message data item for use with the FETCH
command.
</t>
<t>adds CHANGEDSINCE FETCH modifier.</t>
<t>adds a new MODSEQ search criterion.</t>
<t>
extends the syntax of untagged SEARCH and ESEARCH responses to include
mod-sequence.
</t>
<t>
adds new OK untagged responses (HIGHESTMODSEQ and NOMODSEQ) for the SELECT and EXAMINE
commands.
</t>
<t>defines an additional CONDSTORE parameter to SELECT/EXAMINE commands.</t>
<t>adds the HIGHESTMODSEQ status data item to the STATUS command.</t>
</list>
</t>
<t>
A client supporting CONDSTORE extension indicates its willingness to
receive mod-sequence updates in all untagged FETCH responses by
issuing one of the following, which are called "CONDSTORE enabling
commands":
<list style='symbols'>
<t>a SELECT or EXAMINE command with the CONDSTORE parameter,</t>
<t>a STATUS (HIGHESTMODSEQ) command,</t>
<t>
a FETCH or SEARCH command that includes the MODSEQ message data
item,
</t>
<t>a FETCH command with the CHANGEDSINCE modifier,</t>
<t>a STORE command with the UNCHANGEDSINCE modifier, or</t>
<t>
an ENABLE command containing "CONDSTORE" as one of the parameters.
(This option only applies when the client is
communicating with a server that also implements the ENABLE extension <xref target='RFC5161'/>.)
</t>
</list>
</t>
<t>
Once a client issues a CONDSTORE enabling command, it has announced
itself as a "CONDSTORE-aware client". The server MUST then include
mod-sequence data in all subsequent untagged FETCH responses (until
the connection is closed), whether they were caused by a regular
STORE, a STORE with UNCHANGEDSINCE modifier, or an external agent.
</t>
<t>
A future extension to this
document may extend the list of CONDSTORE enabling commands. A first
CONDSTORE enabling command executed in the session with a mailbox selected MUST cause the
server to return HIGHESTMODSEQ (<xref target="highestmodseq"/>) for the mailbox (if any is selected),
unless the server has sent NOMODSEQ (<xref target="nomodseq"/>) response code when the currently
selected mailbox was selected.
</t>
<!--
<t>The rest of this document describes the protocol changes more
rigorously.</t>
-->
<section title="Advertising support for CONDSTORE">
<t>
The Conditional STORE extension is present in any IMAP4
implementation that returns "CONDSTORE" as one of the supported
capabilities in the CAPABILITY command response.
</t>
</section>
<section title='New OK Untagged Responses for SELECT and EXAMINE'>
<t>This document adds two new response codes, HIGHESTMODSEQ and
NOMODSEQ. One of these two response codes MUST be returned in an OK
untagged response for any successful SELECT/EXAMINE command issued after
a CONDSTORE enabling command.</t>
<t>When opening a mailbox, the server must check if the mailbox supports
the persistent storage of mod-sequences. If the mailbox supports the
persistent storage of mod-sequences and the mailbox open operation
succeeds, the server MUST send an OK untagged response including
HIGHESTMODSEQ response code. If the persistent storage for the
mailbox is not supported, the server MUST send an OK untagged
response including NOMODSEQ response code instead.</t>
<section title='HIGHESTMODSEQ Response Code' anchor="highestmodseq">
<t>This document adds a new response code that is returned in an OK
untagged response for the SELECT and EXAMINE commands.
Once a CONDSTORE enabling command is issued a server
supporting the persistent storage of mod-sequences for the mailbox
MUST send an OK untagged response including HIGHESTMODSEQ response
code with every successful SELECT or EXAMINE command:
<list style='empty'>
<t>OK [HIGHESTMODSEQ <mod-sequence-value>]</t>
<t>where <mod-sequence-value> is the highest mod-sequence value of
all messages in the mailbox. When the server changes UIDVALIDITY
for a mailbox, it doesn't have to keep the same HIGHESTMODSEQ for
the mailbox.
</t>
</list>
Note that some existing CONDSTORE servers don't start tracking mod-sequences
or don't report them until after a CONDSTORE enabling command is issued.
Because of that, client wishing to receive HIGHESTMODSEQ/NOMODSEQ information
must first send a CONDSTORE enabling command, for example by using
SELECT/EXAMINE with CONDSTORE parameter (see <xref target='select-condstore-param'/>).
</t>
<t>A disconnected client can use the value of HIGHESTMODSEQ to check if
it has to refetch metadata from the server. If the UIDVALIDITY value
has changed for the selected mailbox, the client MUST delete the
cached value of HIGHESTMODSEQ. If UIDVALIDITY for the mailbox is the
same, and if the HIGHESTMODSEQ value stored in the client's cache is
less than the value returned by the server, then some metadata items
on the server have changed since the last synchronization, and the
client needs to update its cache. The client MAY use SEARCH MODSEQ
(<xref target="SEARCH-MODSEQ"/>) to find out exactly which metadata items have changed.
Alternatively, the client MAY issue FETCH with the CHANGEDSINCE
modifier (<xref target="FETCH-CHANGEDSINCE"/>) in order to fetch data for all messages that
have metadata items changed since some known modification sequence.
</t>
<figure title='Example 1'>
<artwork>
C: A142 SELECT INBOX
S: * 172 EXISTS
S: * 1 RECENT
S: * OK [UNSEEN 12] Message 12 is first unseen
S: * OK [UIDVALIDITY 3857529045] UIDs valid
S: * OK [UIDNEXT 4392] Predicted next UID
S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft)
S: * OK [PERMANENTFLAGS (\Deleted \Seen \*)] Limited
S: * OK [HIGHESTMODSEQ 715194045007]
S: A142 OK [READ-WRITE] SELECT completed</artwork>
</figure>
</section>
<section title='NOMODSEQ Response Code' anchor="nomodseq">
<t>
Once a CONDSTORE enabling command is issued a server that doesn't support
the persistent storage of mod-sequences
for the mailbox MUST send an OK untagged response including NOMODSEQ
response code with every successful SELECT or EXAMINE command.
Note that some existing CONDSTORE servers don't return NOMODSEQ
until after a CONDSTORE enabling command is issued.
Because of that, client wishing to receive HIGHESTMODSEQ/NOMODSEQ information
must first send a CONDSTORE enabling command, for example by using
SELECT/EXAMINE with CONDSTORE parameter (see <xref target='select-condstore-param'/>).
</t>
<t>
A server that returned NOMODSEQ response code for a mailbox MUST
reject (with a tagged BAD response) any of the following commands while the mailbox remains
selected:
<list style='symbols'>
<t>a FETCH command with the CHANGEDSINCE modifier,</t>
<t>a FETCH or SEARCH command that includes the MODSEQ message data
item, or</t>
<t>a STORE command with the UNCHANGEDSINCE modifier</t>
</list>
</t>
<figure title='Example 2'>
<artwork>
C: A142 SELECT INBOX
S: * 172 EXISTS
S: * 1 RECENT
S: * OK [UNSEEN 12] Message 12 is first unseen
S: * OK [UIDVALIDITY 3857529045] UIDs valid
S: * OK [UIDNEXT 4392] Predicted next UID
S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft)
S: * OK [PERMANENTFLAGS (\Deleted \Seen \*)] Limited
S: * OK [NOMODSEQ] Sorry, this mailbox format doesn't support
modsequences
S: A142 OK [READ-WRITE] SELECT completed
</artwork>
</figure>
</section>
</section>
<section title='STORE and UID STORE Commands' anchor="STORE">
<t>This document defines the following STORE modifier (see Section 2.5
of <xref target="RFC4466"/>):
<list style='hanging'>
<t hangText='UNCHANGEDSINCE <mod-sequence>'/>
</list>
</t>
<t>
For each message specified in the message set, the server performs
the following. If the mod-sequence of every metadata item of the
message affected by the STORE/UID STORE is equal to or less than the specified UNCHANGEDSINCE value,
then the requested operation (as described by the message data
item) is performed. If the operation is successful, the server
MUST update the mod-sequence attribute of the message. An
untagged FETCH response MUST be sent, even if the .SILENT suffix
is specified, and the response MUST include the MODSEQ message
data item. This is required to update the client's cache with the
correct mod-sequence values. See <xref target="FETCH-MODSEQ"/> for more details.
</t>
<t>However, if the mod-sequence of any metadata item of the message
is greater than the specified UNCHANGEDSINCE value, then the
requested operation MUST NOT be performed. In this case, the
mod-sequence attribute of the message is not updated, and the
message number (or unique identifier in the case of the UID STORE
command) is added to the list of messages that failed the
UNCHANGEDSINCE test.</t>
<t>When the server finishes performing the operation on all the
messages in the message set, it checks for a non-empty list of
messages that failed the UNCHANGEDSINCE test. If this list is
non-empty, the server MUST return in the tagged response a
MODIFIED response code. The MODIFIED response code includes the
message set (for STORE) or set of UIDs (for UID STORE) of all
messages that failed the UNCHANGEDSINCE test.</t>
<figure title='Example 3'>
<preamble>All messages pass the UNCHANGEDSINCE test.</preamble>
<artwork>
C: a103 UID STORE 6,4,8 (UNCHANGEDSINCE 12121230045)
+FLAGS.SILENT (\Deleted)
S: * 1 FETCH (UID 4 MODSEQ (12121231000))
S: * 2 FETCH (UID 6 MODSEQ (12121230852))
S: * 4 FETCH (UID 8 MODSEQ (12121230956))
S: a103 OK Conditional Store completed
</artwork>
</figure>
<figure title='Example 4'>
<artwork>
C: a104 STORE * (UNCHANGEDSINCE 12121230045) +FLAGS.SILENT
(\Deleted $Processed)
S: * 50 FETCH (MODSEQ (12111230047))
S: a104 OK Store (conditional) completed
</artwork>
</figure>
<figure title='Example 5'>
<artwork>
C: c101 STORE 50 (UNCHANGEDSINCE 12121230045) -FLAGS.SILENT
(\Deleted)
S: * OK [HIGHESTMODSEQ 12111230047]
S: * 50 FETCH (MODSEQ (12111230048))
S: c101 OK Store (conditional) completed</artwork>
<postamble>HIGHESTMODSEQ response code was sent by the server presumably
because this was the first CONDSTORE enabling command.</postamble>
</figure>
<figure title='Example 6'>
<preamble>
The failure of the conditional STORE operation for any particular message
or messages (7 in this example) does not stop the server
from finding all messages that fail the UNCHANGEDSINCE test. All such messages are
returned in the MODIFIED response code.</preamble>
<artwork>
C: d105 STORE 7,5,9 (UNCHANGEDSINCE 320162338)
+FLAGS.SILENT (\Deleted)
S: * 5 FETCH (MODSEQ (320162350))
S: d105 OK [MODIFIED 7,9] Conditional STORE failed</artwork>
</figure>
<figure title='Example 7'>
<preamble>Same as above, but the server follows the SHOULD recommendation in
Section 6.4.6 of <xref target="RFC3501"/>.</preamble>
<artwork>
C: d105 STORE 7,5,9 (UNCHANGEDSINCE 320162338)
+FLAGS.SILENT (\Deleted)
S: * 7 FETCH (MODSEQ (320162342) FLAGS (\Seen \Deleted))
S: * 5 FETCH (MODSEQ (320162350))
S: * 9 FETCH (MODSEQ (320162349) FLAGS (\Answered))
S: d105 OK [MODIFIED 7,9] Conditional STORE failed
</artwork>
<postamble>Use of UNCHANGEDSINCE with a modification sequence of 0 always
fails if the metadata item exists. A system flag MUST always be
considered existent, whether it was set or not.</postamble>
</figure>
<figure title='Example 8'>
<artwork>
C: a102 STORE 12 (UNCHANGEDSINCE 0)
+FLAGS.SILENT ($MDNSent)
S: a102 OK [MODIFIED 12] Conditional STORE failed
</artwork>
<postamble>The client has tested the presence of the $MDNSent user-defined
keyword.</postamble>
</figure>
<t>Note: A client trying to make an atomic change to the state of a
particular metadata item (or a set of metadata items) MUST
prepared to deal with the case when the server returns the MODIFIED
response code if the state of the metadata item being watched hasn't
changed (but the state of some other metadata item has). This is
necessary, because some servers don't store separate mod-sequences
for different metadata items. However, a server implementation
SHOULD avoid generating spurious MODIFIED responses for +FLAGS/-FLAGS
STORE operations, even when the server stores a single mod-sequence
per message. <xref target="server-implem-consider"/> describes how this can be achieved.</t>
<t>Unless the server has included an unsolicited FETCH to update
client's knowledge about messages that have failed the UNCHANGEDSINCE
test, upon receipt of the MODIFIED response code the client SHOULD
try to figure out if the required metadata items have indeed changed
by issuing FETCH or NOOP command. It is RECOMMENDED that the server
avoids the need for the client to do that by sending an unsolicited
FETCH response (Examples 9 and 10).</t>
<t>If the required metadata items haven't changed, the client SHOULD
retry the command with the new mod-sequence. The client needs to allow
for a reasonable number of retries (at least 2).</t>
<figure title='Example 9'>
<preamble>In the example below, the server returns the MODIFIED response
code without sending information describing why the STORE
UNCHANGEDSINCE operation has failed.</preamble>
<artwork>
C: a106 STORE 100:150 (UNCHANGEDSINCE 212030000000)
+FLAGS.SILENT ($Processed)
S: * 100 FETCH (MODSEQ (303181230852))
S: * 102 FETCH (MODSEQ (303181230852))
...
S: * 150 FETCH (MODSEQ (303181230852))
S: a106 OK [MODIFIED 101] Conditional STORE failed
The flag $Processed was set on the message 101...
C: a107 NOOP
S: * 101 FETCH (MODSEQ (303011130956) FLAGS ($Processed))
S: a107 OK
</artwork>
</figure>
<t>Or the flag hasn't changed, but another has (note that this server
behaviour is discouraged. Server implementers should also see
<xref target="server-implem-consider"/>)...</t>
<figure>
<artwork>
C: b107 NOOP
S: * 101 FETCH (MODSEQ (303011130956) FLAGS (\Deleted \Answered))
S: b107 OK
...and the client retries the operation for the message 101 with
the updated UNCHANGEDSINCE value
C: b108 STORE 101 (UNCHANGEDSINCE 303011130956)
+FLAGS.SILENT ($Processed)
S: * 101 FETCH (MODSEQ (303181230852))
S: b108 OK Conditional Store completed
</artwork>
</figure>
<figure title='Example 10'>
<preamble>Same as above, but the server avoids the need for the client to
poll for changes.</preamble>
<artwork>
The flag $Processed was set on the message 101 by another
client...
C: a106 STORE 100:150 (UNCHANGEDSINCE 212030000000)
+FLAGS.SILENT ($Processed)
S: * 100 FETCH (MODSEQ (303181230852))
S: * 101 FETCH (MODSEQ (303011130956) FLAGS ($Processed))
S: * 102 FETCH (MODSEQ (303181230852))
...
S: * 150 FETCH (MODSEQ (303181230852))
S: a106 OK [MODIFIED 101] Conditional STORE failed
</artwork>
</figure>
<t>Or the flag hasn't changed, but another has (note that this server
behaviour is discouraged. Server implementers should also see
<xref target="server-implem-consider"/>)...</t>
<figure>
<artwork>
C: a106 STORE 100:150 (UNCHANGEDSINCE 212030000000)
+FLAGS.SILENT ($Processed)
S: * 100 FETCH (MODSEQ (303181230852))
S: * 101 FETCH (MODSEQ (303011130956) FLAGS (\Deleted \Answered))
S: * 102 FETCH (MODSEQ (303181230852))
...
S: * 150 FETCH (MODSEQ (303181230852))
S: a106 OK [MODIFIED 101] Conditional STORE failed
...and the client retries the operation for the message 101 with
the updated UNCHANGEDSINCE value
C: b108 STORE 101 (UNCHANGEDSINCE 303011130956)
+FLAGS.SILENT ($Processed)
S: * 101 FETCH (MODSEQ (303181230852))
S: b108 OK Conditional Store completed
</artwork>
</figure>
<t>Or the flag hasn't changed, but another has (nice server
behaviour. Server implementers should also see <xref target="server-implem-consider"/>)...</t>
<figure>
<artwork>
C: a106 STORE 100:150 (UNCHANGEDSINCE 212030000000)
+FLAGS.SILENT ($Processed)
S: * 100 FETCH (MODSEQ (303181230852))
S: * 101 FETCH (MODSEQ (303011130956) FLAGS ($Processed \Deleted
\Answered))
S: * 102 FETCH (MODSEQ (303181230852))
...
S: * 150 FETCH (MODSEQ (303181230852))
S: a106 OK Conditional STORE completed
</artwork>
</figure>
<figure title='Example 11'>
<preamble>The following example is based on the example from the Section
4.2.3 of <xref target="RFC2180"/> and demonstrates that the MODIFIED response
code MAY be also returned in the tagged NO response.</preamble>
<artwork>
Client tries to conditionally STORE flags on a mixture of expunged
and non-expunged messages; one message fails the UNCHANGEDSINCE
test.
C: B001 STORE 1:7 (UNCHANGEDSINCE 320172338) +FLAGS (\SEEN)
S: * 1 FETCH (MODSEQ (320172342) FLAGS (\SEEN))
S: * 3 FETCH (MODSEQ (320172342) FLAGS (\SEEN))
S: B001 NO [MODIFIED 2] Some of the messages no longer exist.
C: B002 NOOP
S: * 4 EXPUNGE
S: * 4 EXPUNGE
S: * 4 EXPUNGE
S: * 4 EXPUNGE
S: * 2 FETCH (MODSEQ (320172340) FLAGS (\Deleted \Answered))
S: B002 OK NOOP Completed.
By receiving FETCH responses for messages 1 and 3, and EXPUNGE
responses that indicate that messages 4 through 7 have been
expunged, the client retries the operation only for the message 2.
The updated UNCHANGEDSINCE value is used.
C: b003 STORE 2 (UNCHANGEDSINCE 320172340) +FLAGS (\Seen)
S: * 2 FETCH (MODSEQ (320180050) FLAGS (\SEEN \Flagged))
S: b003 OK Conditional Store completed
</artwork>
</figure>
<t>Note: If a message is specified multiple times in the message set,
and the server doesn't internally eliminate duplicates from the
message set, it MUST NOT fail the conditional STORE operation for the
second (or subsequent) occurrence of the message if the operation
completed successfully for the first occurrence. For example, if the
client specifies:
<list style='empty'>
<t>e105 STORE 7,3:9 (UNCHANGEDSINCE 12121230045) +FLAGS.SILENT (\Deleted)</t></list>
the server must not fail the operation for message 7 as part of
processing "3:9" if it succeeded when message 7 was processed the
first time.</t>
<t>As specified in <xref target="intro"/>, once the client specified the UNCHANGEDSINCE modifier in a STORE
command, the server starts including the MODSEQ FETCH response data items
in all subsequent unsolicited FETCH responses.</t>
<t>This document also changes the behaviour of the server when it has
performed a STORE or UID STORE command and the UNCHANGEDSINCE
modifier is not specified. If the operation is successful for a
message, the server MUST update the mod-sequence attribute of the
message. The server is REQUIRED to include the mod-sequence value
whenever it decides to send the unsolicited FETCH response to all
CONDSTORE-aware clients that have opened the mailbox containing the
message.</t>
<t>Server implementers should also see <xref target="server-qos"/> for additional
quality of implementation issues related to the STORE command.</t>
</section>
<section title='FETCH and UID FETCH Commands'>
<section title='CHANGEDSINCE FETCH Modifier' anchor="FETCH-CHANGEDSINCE">
<t>This document defines the following FETCH modifier (see Section 2.4
of <xref target="RFC4466"/>):
<list style='hanging'><t hangText='CHANGEDSINCE <mod-sequence>'>
CHANGEDSINCE FETCH modifier allows the client to further subset
the list of messages described by sequence set. The information
described by message data items is only returned for messages that
have mod-sequence bigger than <mod-sequence>.</t>
<t>When CHANGEDSINCE FETCH modifier is specified, it implicitly adds
MODSEQ FETCH message data item (<xref target="FETCH-MODSEQ"/>).</t>
</list>
</t>
<figure title='Example 12'>
<artwork>
C: s100 UID FETCH 1:* (FLAGS) (CHANGEDSINCE 12345)
S: * 1 FETCH (UID 4 MODSEQ (65402) FLAGS (\Seen))
S: * 2 FETCH (UID 6 MODSEQ (75403) FLAGS (\Deleted))
S: * 4 FETCH (UID 8 MODSEQ (29738) FLAGS ($NoJunk $AutoJunk
$MDNSent))
S: s100 OK FETCH completed
</artwork>
</figure>
</section>
<section title='MODSEQ Message Data Item in FETCH Command' anchor="FETCH-MODSEQ">
<t>CONDSTORE adds a MODSEQ message data item to the FETCH command.
The MODSEQ message data item allows clients to retrieve mod-sequence
values for a range of messages in the currently selected mailbox.</t>
<t>As specified in <xref target="condstore"/>, once the client has specified the MODSEQ message data item in a FETCH
request, the server starts including the MODSEQ FETCH response data items
in all subsequent unsolicited FETCH responses.
<list style='hanging'>
<t hangText='Syntax: MODSEQ'><vspace blankLines="1"/>
The MODSEQ message data item causes the server to return MODSEQ
FETCH response data items.</t>
<t hangText='Syntax: MODSEQ ( <permsg-modsequence> )'><vspace blankLines="1"/>
MODSEQ response data items contain per-message mod-sequences.</t>
<t>The MODSEQ response data item is returned if the client issued
FETCH with MODSEQ message data item. It also allows the server to
notify the client about mod-sequence changes caused by conditional
STOREs (<xref target="STORE"/>) and/or changes caused by external sources.</t>
</list></t>
<figure title='Example 13'>
<artwork>
C: a FETCH 1:3 (MODSEQ)
S: * 1 FETCH (MODSEQ (624140003))
S: * 2 FETCH (MODSEQ (624140007))
S: * 3 FETCH (MODSEQ (624140005))
S: a OK Fetch complete
</artwork>
<postamble>In this example, the client requests per-message mod-sequences for
a set of messages.</postamble>
</figure>
<t>
Servers that only support the CONDSTORE extension (and not QRESYNC) SHOULD comply with
requirements from <xref target="uid-on-fetch"/>.
</t>
<t>When a flag for a message is modified in a different session, the
server sends an unsolicited FETCH response containing the mod-sequence
for the message, as demonstrated in Example 14.
Note that when the server also supports the QRESYNC extension (<xref target="enable-qresync"/>)
and a "CONDSTORE enabling command" has been issued, all FETCH responses in the Example 14
must also include UID FETCH items as prescribed by <xref target="uid-on-fetch"/>.
</t>
<figure title='Example 14'>
<artwork>
(Session 1, authenticated as a user "alex"). The user adds a
shared flag \Deleted:
C: A142 SELECT INBOX
...
S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft)
S: * OK [PERMANENTFLAGS (\Answered \Deleted \Seen \*)] Limited
...
C: A160 STORE 7 +FLAGS.SILENT (\Deleted)
S: * 7 FETCH (MODSEQ (2121231000))
S: A160 OK Store completed
(Session 2, also authenticated as the user "alex"). Any changes
to flags are always reported to all sessions authenticated as the
same user as in the session 1.
C: C180 NOOP
S: * 7 FETCH (FLAGS (\Deleted \Answered) MODSEQ (12121231000))
S: C180 OK Noop completed
(Session 3, authenticated as a user "andrew"). As \Deleted is a
shared flag, changes in session 1 are also reported in session 3:
C: D210 NOOP
S: * 7 FETCH (FLAGS (\Deleted \Answered) MODSEQ (12121231000))
S: D210 OK Noop completed
The user modifies a private flag \Seen in session 1...
C: A240 STORE 7 +FLAGS.SILENT (\Seen)
S: * 7 FETCH (MODSEQ (12121231777))
S: A240 OK Store completed
...which is only reported in session 2...
C: C270 NOOP
S: * 7 FETCH (FLAGS (\Deleted \Answered \Seen) MODSEQ
(12121231777))
S: C270 OK Noop completed
...but not in session 3.
C: D300 NOOP
S: D300 OK Noop completed
And finally, the user removes flags \Answered (shared) and \Seen
(private) in session 1.
C: A330 STORE 7 -FLAGS.SILENT (\Answered \Seen)
S: * 7 FETCH (MODSEQ (12121245160))
S: A330 OK Store completed
Both changes are reported in the session 2...
C: C360 NOOP
S: * 7 FETCH (FLAGS (\Deleted) MODSEQ (12121245160))
S: C360 OK Noop completed
...and only changes to shared flags are reported in session 3.
C: D390 NOOP
S: * 7 FETCH (FLAGS (\Deleted) MODSEQ (12121245160))
S: D390 OK Noop completed
</artwork>
</figure>
<t>Server implementers should also see <xref target="server-qos"/> for additional
quality of implementation issues related to the FETCH command.</t>
</section>
</section>
<section title='MODSEQ Search Criterion in SEARCH' anchor="SEARCH-MODSEQ">
<t>The MODSEQ criterion for the SEARCH (or UID SEARCH) command allows a client to search
for the metadata items that were modified since a specified moment.</t>
<t>Syntax: MODSEQ [<entry-name> <entry-type-req>] <mod-sequence-valzer>
<list style="empty">
<!--////Mark this as "obsolete" or "backward compatibility" syntax?-->
<t>Messages that have modification values that are equal to or
greater than <mod-sequence-valzer>. This allows a client, for
example, to find out which messages contain metadata items that
have changed since the last time it updated its disconnected
cache. The client may also specify <entry-name> (name of metadata
item) and <entry-type-req> (type of metadata item) before
<mod-sequence-valzer>. <entry-type-req> can be one of "shared",
"priv" (private), or "all". The last means that the server
MUST use the biggest value among "priv" and "shared" mod-sequences
for the metadata item. If the server doesn't store
separate mod-sequences for different metadata items, it
MUST ignore <entry-name> and <entry-type-req>. Otherwise, the
server should use them to narrow down the search.</t>
<t>For a flag <flagname>, the corresponding <entry-name> has a form
"/flags/<flagname>" as defined in <xref target="RFC4466"/>. Note that the
leading "\" character that denotes a system flag has to be escaped
as per Section 4.3 of <xref target="RFC3501"/>, as <entry-name> uses the syntax for
quoted strings (see the examples below).</t>
</list></t>
<t>If client specifies a MODSEQ criterion in a SEARCH (or UID SEARCH) command and the
server returns a non-empty SEARCH result, the server MUST also append
(to the end of the untagged SEARCH response) the highest mod-sequence
for all messages being returned. See also <xref target="untagged-search"/>.
Note that other IMAP extensions such as ESEARCH <xref target="RFC4731"/>
can override this requirement (see <xref target="esearch-esort-modseq"/> for
more details.)</t>
<figure title='Example 15'>
<artwork>
C: a SEARCH MODSEQ "/flags/\\draft" all 620162338
S: * SEARCH 2 5 6 7 11 12 18 19 20 23 (MODSEQ 917162500)
S: a OK Search complete
</artwork>
<postamble>In the above example, the message numbers of any messages
having a mod-sequence equal to or greater
than 620162338 for the "\Draft" flag are returned in the search
results.</postamble>
</figure>
<figure title='Example 16'>
<artwork>
C: t SEARCH OR NOT MODSEQ 720162338 LARGER 50000
S: * SEARCH
S: t OK Search complete, nothing found</artwork></figure>
</section>
<section title='Modified SEARCH Untagged Response' anchor="untagged-search">
<figure>
<artwork>
Data: zero or more numbers
mod-sequence value (omitted if no match)
</artwork>
</figure>
<t>This document extends syntax of the untagged SEARCH response to