Skip to main content

jmap_types/
data_types.rs

1//! The IANA "JMAP Data Types" registry (RFC 9404 §6.3, its fields
2//! restated by draft-ietf-jmap-blobext-03 §11.5), with the "Supports
3//! History" column draft-ietf-jmap-object-history-03 §7.2 adds.
4//!
5//! One shared table read by Blob/lookup (which type names may be looked up,
6//! and which capability each needs) and by object history (which types
7//! support it), so the two never disagree.
8//!
9//! Rows are the registrations in RFC 9404 Table 1, RFC 9425, RFC 9661,
10//! RFC 9670, RFC 9610, draft-ietf-jmap-calendars-34 and
11//! draft-ietf-jmap-filenode-20, plus the registrations requested by the
12//! draft-atwood-jmap drafts (chat, chat-mimi, graph, graph-edit, scene and
13//! vtc), each citing its document in [`DataTypeEntry::reference`].
14//!
15//! "Supports History" is object-history-03 §7.2 Table 1 for the types that
16//! table lists. For the draft-atwood types it is the value those drafts are
17//! to register (decision 22 in `docs/design/DECISIONS.md`); a type with no
18//! value takes the §7.2 default, "No".
19//!
20//! # Example
21//!
22//! ```
23//! use jmap_types::data_types::data_type;
24//!
25//! let email = data_type("Email").unwrap();
26//! assert_eq!(email.capability, "urn:ietf:params:jmap:mail");
27//! assert!(email.can_reference_blobs);
28//! assert!(data_type("NoSuchType").is_none());
29//! ```
30
31/// One row of the "JMAP Data Types" registry.
32#[non_exhaustive]
33#[derive(Debug, Clone, Copy, PartialEq, Eq)]
34pub struct DataTypeEntry {
35    /// The data type name, as used in `typeNames` in Blob/lookup and as a
36    /// key in a StateChange object (RFC 8620 §7.1), such as `"Email"`.
37    pub type_name: &'static str,
38    /// The capability URI a client puts in `using` to use the type.
39    pub capability: &'static str,
40    /// "Can Reference Blobs": whether objects of the type can reference
41    /// blobs, which makes the type usable in Blob/lookup.
42    pub can_reference_blobs: bool,
43    /// "Can Use for State Change": whether the type name can appear in a
44    /// StateChange object.
45    pub can_use_for_state_change: bool,
46    /// "Supports History" (object-history-03 §7.2): whether the history
47    /// extensions apply to the type.
48    pub supports_history: bool,
49    /// The document that registers the type, such as `"RFC 8621"` or
50    /// `"draft-atwood-jmap-chat-00"`.
51    pub reference: &'static str,
52}
53
54const fn row(
55    type_name: &'static str,
56    capability: &'static str,
57    can_reference_blobs: bool,
58    can_use_for_state_change: bool,
59    supports_history: bool,
60    reference: &'static str,
61) -> DataTypeEntry {
62    DataTypeEntry {
63        type_name,
64        capability,
65        can_reference_blobs,
66        can_use_for_state_change,
67        supports_history,
68        reference,
69    }
70}
71
72/// Every registered data type, sorted by [`DataTypeEntry::type_name`]
73/// (byte order).
74///
75/// Task, TaskList and TaskNotification come from crate-jmap's local Tasks
76/// profile (docs/specs/jmap-tasks-local.md §IANA, docs/design/DECISIONS.md
77/// decisions 23 and 52): draft-ietf-jmap-tasks-06 registers no JMAP Data
78/// Types, and the IETF task-lists work has not yet produced a document.
79pub const DATA_TYPES: &[DataTypeEntry] = &[
80    row(
81        "AddressBook",
82        "urn:ietf:params:jmap:contacts",
83        false,
84        true,
85        true,
86        "RFC 9610",
87    ),
88    row(
89        "Calendar",
90        "urn:ietf:params:jmap:calendars",
91        false,
92        true,
93        true,
94        "draft-ietf-jmap-calendars-34",
95    ),
96    row(
97        "CalendarEvent",
98        "urn:ietf:params:jmap:calendars",
99        true,
100        true,
101        true,
102        "draft-ietf-jmap-calendars-34",
103    ),
104    row(
105        "CalendarEventNotification",
106        "urn:ietf:params:jmap:calendars",
107        false,
108        true,
109        false,
110        "draft-ietf-jmap-calendars-34",
111    ),
112    row(
113        "Chat",
114        "urn:ietf:params:jmap:chat",
115        true,
116        true,
117        true,
118        "draft-atwood-jmap-chat-00",
119    ),
120    row(
121        "ChatBan",
122        "urn:ietf:params:jmap:chat",
123        false,
124        true,
125        true,
126        "draft-atwood-jmap-chat-00",
127    ),
128    row(
129        "ChatContact",
130        "urn:ietf:params:jmap:chat",
131        false,
132        true,
133        true,
134        "draft-atwood-jmap-chat-00",
135    ),
136    row(
137        "Consent",
138        "urn:ietf:params:jmap:chat:mimi",
139        false,
140        true,
141        false,
142        "draft-atwood-jmap-chat-mimi-00",
143    ),
144    row(
145        "ContactCard",
146        "urn:ietf:params:jmap:contacts",
147        true,
148        true,
149        true,
150        "RFC 9610",
151    ),
152    row(
153        "Core",
154        "urn:ietf:params:jmap:core",
155        false,
156        false,
157        false,
158        "RFC 8620",
159    ),
160    row(
161        "CustomEmoji",
162        "urn:ietf:params:jmap:chat",
163        true,
164        true,
165        true,
166        "draft-atwood-jmap-chat-00",
167    ),
168    row(
169        "Email",
170        "urn:ietf:params:jmap:mail",
171        true,
172        true,
173        true,
174        "RFC 8621",
175    ),
176    row(
177        "EmailDelivery",
178        "urn:ietf:params:jmap:mail",
179        false,
180        true,
181        false,
182        "RFC 8621",
183    ),
184    row(
185        "EmailSubmission",
186        "urn:ietf:params:jmap:submission",
187        false,
188        true,
189        false,
190        "RFC 8621",
191    ),
192    row(
193        "FileNode",
194        "urn:ietf:params:jmap:filenode",
195        true,
196        true,
197        true,
198        "draft-ietf-jmap-filenode-20",
199    ),
200    row(
201        "Graph",
202        "urn:ietf:params:jmap:graph",
203        false,
204        true,
205        true,
206        "draft-atwood-jmap-graph-00",
207    ),
208    row(
209        "GraphEdge",
210        "urn:ietf:params:jmap:graph",
211        false,
212        true,
213        true,
214        "draft-atwood-jmap-graph-00",
215    ),
216    row(
217        "GraphNode",
218        "urn:ietf:params:jmap:graph",
219        true,
220        true,
221        true,
222        "draft-atwood-jmap-graph-00",
223    ),
224    row(
225        "GraphNodeOp",
226        "urn:ietf:params:jmap:graph:edit",
227        false,
228        true,
229        false,
230        "draft-atwood-jmap-graph-edit-00",
231    ),
232    row(
233        "Identity",
234        "urn:ietf:params:jmap:submission",
235        false,
236        true,
237        true,
238        "RFC 8621",
239    ),
240    row(
241        "KeyPackage",
242        "urn:ietf:params:jmap:chat:mimi",
243        false,
244        true,
245        false,
246        "draft-atwood-jmap-chat-mimi-00",
247    ),
248    row(
249        "MDN",
250        "urn:ietf:params:jmap:mdn",
251        false,
252        false,
253        false,
254        "RFC 9007",
255    ),
256    row(
257        "Mailbox",
258        "urn:ietf:params:jmap:mail",
259        true,
260        true,
261        true,
262        "RFC 8621",
263    ),
264    row(
265        "Message",
266        "urn:ietf:params:jmap:chat",
267        true,
268        true,
269        true,
270        "draft-atwood-jmap-chat-00",
271    ),
272    row(
273        "ParticipantIdentity",
274        "urn:ietf:params:jmap:calendars",
275        false,
276        true,
277        true,
278        "draft-ietf-jmap-calendars-34",
279    ),
280    row(
281        "PresenceStatus",
282        "urn:ietf:params:jmap:chat",
283        false,
284        true,
285        false,
286        "draft-atwood-jmap-chat-00",
287    ),
288    row(
289        "Principal",
290        "urn:ietf:params:jmap:principals",
291        false,
292        true,
293        false,
294        "RFC 9670",
295    ),
296    row(
297        "PushSubscription",
298        "urn:ietf:params:jmap:core",
299        false,
300        false,
301        false,
302        "RFC 8620",
303    ),
304    row(
305        "Quota",
306        "urn:ietf:params:jmap:quota",
307        false,
308        true,
309        false,
310        "RFC 9425",
311    ),
312    row(
313        "ReadPosition",
314        "urn:ietf:params:jmap:chat",
315        false,
316        true,
317        false,
318        "draft-atwood-jmap-chat-00",
319    ),
320    row(
321        "SceneAsset",
322        "urn:ietf:params:jmap:scene",
323        true,
324        true,
325        true,
326        "draft-atwood-jmap-scene-00",
327    ),
328    row(
329        "SceneAvatar",
330        "urn:ietf:params:jmap:scene",
331        true,
332        true,
333        false,
334        "draft-atwood-jmap-scene-00",
335    ),
336    row(
337        "SceneObject",
338        "urn:ietf:params:jmap:scene",
339        true,
340        true,
341        true,
342        "draft-atwood-jmap-scene-00",
343    ),
344    row(
345        "SceneRegion",
346        "urn:ietf:params:jmap:scene",
347        false,
348        true,
349        true,
350        "draft-atwood-jmap-scene-00",
351    ),
352    row(
353        "SearchSnippet",
354        "urn:ietf:params:jmap:mail",
355        false,
356        false,
357        false,
358        "RFC 8621",
359    ),
360    row(
361        "ShareNotification",
362        "urn:ietf:params:jmap:principals",
363        false,
364        true,
365        false,
366        "RFC 9670",
367    ),
368    row(
369        "SieveScript",
370        "urn:ietf:params:jmap:sieve",
371        true,
372        true,
373        true,
374        "RFC 9661",
375    ),
376    row(
377        "Space",
378        "urn:ietf:params:jmap:chat",
379        true,
380        true,
381        true,
382        "draft-atwood-jmap-chat-00",
383    ),
384    row(
385        "SpaceBan",
386        "urn:ietf:params:jmap:chat",
387        false,
388        true,
389        true,
390        "draft-atwood-jmap-chat-00",
391    ),
392    row(
393        "SpaceInvite",
394        "urn:ietf:params:jmap:chat",
395        false,
396        true,
397        true,
398        "draft-atwood-jmap-chat-00",
399    ),
400    row(
401        "Task",
402        "urn:ietf:params:jmap:tasks",
403        true,
404        true,
405        true,
406        "crate-jmap local Tasks profile",
407    ),
408    row(
409        "TaskList",
410        "urn:ietf:params:jmap:tasks",
411        false,
412        true,
413        true,
414        "crate-jmap local Tasks profile",
415    ),
416    row(
417        "TaskNotification",
418        "urn:ietf:params:jmap:tasks",
419        false,
420        true,
421        false,
422        "crate-jmap local Tasks profile",
423    ),
424    row(
425        "Thread",
426        "urn:ietf:params:jmap:mail",
427        true,
428        true,
429        false,
430        "RFC 8621",
431    ),
432    row(
433        "VTCCall",
434        "urn:ietf:params:jmap:vtc",
435        false,
436        true,
437        true,
438        "draft-atwood-jmap-vtc-00",
439    ),
440    row(
441        "VTCLivestream",
442        "urn:ietf:params:jmap:vtc",
443        false,
444        true,
445        true,
446        "draft-atwood-jmap-vtc-00",
447    ),
448    row(
449        "VTCParticipant",
450        "urn:ietf:params:jmap:vtc",
451        false,
452        true,
453        false,
454        "draft-atwood-jmap-vtc-00",
455    ),
456    row(
457        "VTCRecording",
458        "urn:ietf:params:jmap:vtc",
459        true,
460        true,
461        true,
462        "draft-atwood-jmap-vtc-00",
463    ),
464    row(
465        "VacationResponse",
466        "urn:ietf:params:jmap:vacationresponse",
467        false,
468        true,
469        true,
470        "RFC 8621",
471    ),
472];
473
474/// The registry row for `type_name`, compared case-sensitively as type
475/// names are; `None` when the type is not registered.
476pub fn data_type(type_name: &str) -> Option<&'static DataTypeEntry> {
477    DATA_TYPES
478        .binary_search_by(|e| e.type_name.cmp(type_name))
479        .ok()
480        .map(|i| &DATA_TYPES[i])
481}