anil.recoil.org
My aggregated monorepo of OCaml code, automaintained
doc fiex
+2
-2
ocaml-jmap/lib/core/chain.mli
+2
-2
ocaml-jmap/lib/core/chain.mli
···
110
110
111
111
The first type parameter indicates the method kind (query/get/changes/set/...),
112
112
used for building result references. The second type parameter is the
113
-
parsed response type, enabling type-safe parsing via {!parse}. *)
113
+
parsed response type, enabling type-safe parsing via {!val-parse}. *)
114
114
type (_, _) handle
115
115
116
116
val call_id : (_, _) handle -> string
···
514
514
providing compile-time type safety. *)
515
515
516
516
val parse_exn : (_, 'resp) handle -> Jmap_proto.Response.t -> 'resp
517
-
(** [parse_exn handle response] is like {!parse} but raises on error. *)
517
+
(** [parse_exn handle response] is like {!val-parse} but raises on error. *)
518
518
519
519
(** {1 JSON Helpers}
520
520
+1
-1
ocaml-jmap/lib/core/jmap.mli
+1
-1
ocaml-jmap/lib/core/jmap.mli
···
26
26
{2 Module Structure}
27
27
28
28
- {!Proto} - Low-level protocol and mail types (RFC 8620/8621)
29
-
- {!Error}, {!Id}, {!Keyword}, {!Role}, {!Capability} - Core types
29
+
- {!module-Error}, {!Id}, {!Keyword}, {!Role}, {!Capability} - Core types
30
30
- {!Session}, {!Email}, {!Mailbox}, etc. - Abstract type accessors
31
31
*)
32
32
+2
-2
ocaml-jmap/lib/mail/mail_email.mli
+2
-2
ocaml-jmap/lib/mail/mail_email.mli
···
187
187
]
188
188
189
189
(** A dynamic header property request.
190
-
Use {!Mail_header.header_property} for type-safe construction. *)
190
+
Use [Mail_header.header_property] for type-safe construction. *)
191
191
type header_property = [ `Header of Mail_header.header_property ]
192
192
193
193
(** Any Email property - standard or dynamic header. *)
···
372
372
373
373
(** Extra arguments for Email/get beyond standard /get.
374
374
375
-
Note: The standard [properties] argument from {!Proto_method.get_args}
375
+
Note: The standard [properties] argument from [Proto_method.get_args]
376
376
should use {!property} variants converted via {!property_to_string}. *)
377
377
type get_args_extra = {
378
378
body_properties : body_part_property list option;
+2
-2
ocaml-jmap/lib/proto/proto_blob.mli
+2
-2
ocaml-jmap/lib/proto/proto_blob.mli
···
40
40
41
41
val expand_download_url : template:string -> download_vars -> string
42
42
(** [expand_download_url ~template vars] expands the download URL template
43
-
with the given variables. Template uses {accountId}, {blobId},
44
-
{type}, and {name} placeholders. *)
43
+
with the given variables. Template uses [\{accountId\}], [\{blobId\}],
44
+
[\{type\}], and [\{name\}] placeholders. *)
45
45
46
46
(** {1 Blob/copy} *)
47
47
+3
-3
ocaml-jmap/lib/proto/proto_invocation.mli
+3
-3
ocaml-jmap/lib/proto/proto_invocation.mli
···
37
37
result_reference
38
38
(** [result_reference_of_strings] creates a result reference, parsing
39
39
the path string into a JMAP pointer.
40
-
@raise Jsont.Error if the path is not a valid JMAP pointer. *)
40
+
@raise Jsont.exception-Error if the path is not a valid JMAP pointer. *)
41
41
42
42
val result_reference_jsont : result_reference Jsont.t
43
43
···
59
59
This is the most common pattern in JMAP where result references are
60
60
used to pass IDs between method calls.
61
61
62
-
@raise Jsont.Error if resolution fails or the result is not a string list. *)
62
+
@raise Jsont.exception-Error if resolution fails or the result is not a string list. *)
63
63
64
64
val resolve :
65
65
result_reference ->
···
69
69
(** [resolve ref ~responses codec] resolves the result reference and
70
70
decodes the extracted value with [codec].
71
71
72
-
@raise Jsont.Error if resolution fails or decoding fails. *)
72
+
@raise Jsont.exception-Error if resolution fails or decoding fails. *)
73
73
74
74
(** {1 Invocations} *)
75
75