jon.recoil.org
forked from
anil.recoil.org/ocaml-jmap
this repo has no description
Enhance documentation with odoc extension plugins
- Convert RFC URL references to semantic @rfc tags across cookeio, imap, jmap
- Add security admonition warning to cookeio cookie documentation
- Add MSC protocol flow diagram to imap.mli showing IMAP session sequence
- Add Mermaid sequence diagram to jmap.mli showing JMAP request batching
Uses the new odoc-rfc-extension, odoc-admonition-extension, odoc-msc-extension,
and odoc-mermaid-extension plugins to generate styled, linked documentation.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
+1
-1
bin/fastmail_send.ml
+1
-1
bin/fastmail_send.ml
···
11
11
- JMAP_API_TOKEN: Required. The Fastmail API token for authentication.
12
12
- JMAP_FROM_EMAIL: Optional. The sender's email address. If not provided, uses the first identity.
13
13
14
-
@see <https://datatracker.ietf.org/doc/html/rfc8621#section-7> RFC8621 Section 7
14
+
@rfc 8621 Section 7
15
15
*)
16
16
17
17
open Lwt.Syntax
+18
lib/core/jmap.mli
+18
lib/core/jmap.mli
···
9
9
(RFC 8620/8621), combining the protocol and mail layers with abstract
10
10
types and polymorphic variants.
11
11
12
+
{2 Request Flow}
13
+
14
+
JMAP uses batched requests where method calls can reference results
15
+
from previous calls in the same batch:
16
+
17
+
{@mermaid[
18
+
sequenceDiagram
19
+
participant C as Client
20
+
participant S as JMAP Server
21
+
22
+
C->>S: POST /jmap (batch request)
23
+
Note over C,S: Mailbox/get #0
24
+
Note over C,S: Email/query #1 (refs #0)
25
+
Note over C,S: Email/get #2 (refs #1)
26
+
S->>C: Response
27
+
Note over C,S: methodResponses array
28
+
]}
29
+
12
30
{2 Quick Start}
13
31
14
32
{[
+2
-3
lib/proto/proto_date.mli
+2
-3
lib/proto/proto_date.mli
···
7
7
8
8
JMAP uses RFC 3339 formatted date-time strings.
9
9
10
-
See {{:https://datatracker.ietf.org/doc/html/rfc8620#section-1.4} RFC 8620 Section 1.4}.
11
-
12
-
@canonical Jmap.Proto.Date *)
10
+
@canonical Jmap.Proto.Date
11
+
@rfc 8620 Section 1.4 *)
13
12
14
13
(** RFC 3339 date-time.
15
14
+2
-3
lib/proto/proto_id.mli
+2
-3
lib/proto/proto_id.mli
···
8
8
An Id is a string of 1-255 octets from the URL-safe base64 alphabet
9
9
(A-Za-z0-9_-), plus the ASCII alphanumeric characters.
10
10
11
-
See {{:https://datatracker.ietf.org/doc/html/rfc8620#section-1.2} RFC 8620 Section 1.2}.
12
-
13
-
@canonical Jmap.Proto.Id *)
11
+
@canonical Jmap.Proto.Id
12
+
@rfc 8620 Section 1.2 *)
14
13
15
14
type t
16
15
(** The type of JMAP identifiers. *)
+2
-3
lib/proto/proto_int53.mli
+2
-3
lib/proto/proto_int53.mli
···
9
9
IEEE 754 double-precision floating point format without loss of precision.
10
10
The safe range is -2^53+1 to 2^53-1.
11
11
12
-
See {{:https://datatracker.ietf.org/doc/html/rfc8620#section-1.3} RFC 8620 Section 1.3}.
13
-
14
-
@canonical Jmap.Proto.Int53 *)
12
+
@canonical Jmap.Proto.Int53
13
+
@rfc 8620 Section 1.3 *)
15
14
16
15
(** 53-bit signed integer.
17
16