commit 99dc005aba80b8f217461da0b47bfd8be4d7a506 · anil.recoil.org/ocaml-jmap

+3 -1

AGENT.md

···

       55
       55
        
           a cross reference URL where relevant by linking to a URL of the form

     

       56
       56
        
           "https://datatracker.ietf.org/doc/html/rfc8620#section-1.1" for the online

     

       57
       57
        
           version of the RFCs stored in specs/

     

       58
       58
       -
       14. Add an ocamldoc-format tutorial on how to use the library to index.mld along with cross references

     

       58
       58
       +
       14. DONE. Add an ocamldoc-format tutorial on how to use the library to index.mld along with cross references

     

       59
       59
        
           into the various libraries. Put corresponding executable files into bin/ so that they can be

     

       60
       60
        
           build tested and run as well. Assume the pattern of the JMAP_API_TOKEN environment variable being

     

       61
       61
        
           set can be counted on to be present when they are run.

     

       62
       62
       +
       15. Add a README.md to this repository that describes what this is. Note explicitly in the

     

       63
       63
       +
           README that this is largely an AI-generated interface and has not been audited carefully.

+3 -83

README.md

···

       1
       1
        
       # JMAP OCaml Client

     

       2
       2
        
       

     

       3
       3
       -
       A type-safe OCaml interface to the JMAP protocol ([RFC8620](https://datatracker.ietf.org/doc/html/rfc8620)) and JMAP Mail extension ([RFC8621](https://datatracker.ietf.org/doc/html/rfc8621)).

     

       3
       3
       +
       An OCaml interface to the JMAP protocol ([RFC8620](https://datatracker.ietf.org/doc/html/rfc8620)) and JMAP Mail extension ([RFC8621](https://datatracker.ietf.org/doc/html/rfc8621)).

     

       4
       4
        
       

     

       5
       5
        
       **Note:** This library is largely AI-generated and has not been audited carefully. It's a proof-of-concept implementation of the JMAP specification.

     

       6
       6
        
       

     
···

       19
       19
        
       Add to your project with opam:

     

       20
       20
        
       

     

       21
       21
        
       ```

     

       22
       22
       -
       opam install jmap

     

       23
       23
       -
       ```

     

       24
       24
       -
       

     

       25
       25
       -
       Or pin the development version:

     

       26
       26
       -
       

     

       27
       27
       -
       ```

     

       28
       28
       -
       opam pin add jmap.dev git+https://github.com/example/jmap-ocaml.git

     

       29
       29
       -
       ```

     

       30
       30
       -
       

     

       31
       31
       -
       ## Quick Start

     

       32
       32
       -
       

     

       33
       33
       -
       ```ocaml

     

       34
       34
       -
       open Lwt.Syntax

     

       35
       35
       -
       open Jmap

     

       36
       36
       -
       open Jmap_mail

     

       37
       37
       -
       

     

       38
       38
       -
       (* Authentication *)

     

       39
       39
       -
       let token = Sys.getenv "JMAP_API_TOKEN" in

     

       40
       40
       -
       let* result = Jmap_mail.login_with_token 

     

       41
       41
       -
         ~uri:"https://api.fastmail.com/jmap/session" 

     

       42
       42
       -
         ~api_token:token

     

       43
       43
       -
       in

     

       44
       44
       -
       

     

       45
       45
       -
       match result with

     

       46
       46
       -
       | Error err -> 

     

       47
       47
       -
           Printf.eprintf "Authentication failed\n";

     

       48
       48
       -
           exit 1

     

       49
       49
       -
           

     

       50
       50
       -
       | Ok conn ->

     

       51
       51
       -
           (* Get primary account ID *)

     

       52
       52
       -
           let mail_capability = Jmap_mail.Capability.to_string Jmap_mail.Capability.Mail in

     

       53
       53
       -
           let account_id = List.assoc mail_capability conn.session.primary_accounts in

     

       54
       54
       -
           

     

       55
       55
       -
           (* Get mailboxes *)

     

       56
       56
       -
           let* mailboxes_result = Jmap_mail.get_mailboxes conn ~account_id in

     

       57
       57
       -
           

     

       58
       58
       -
           match mailboxes_result with

     

       59
       59
       -
           | Error err -> 

     

       60
       60
       -
               Printf.eprintf "Failed to get mailboxes\n";

     

       61
       61
       -
               exit 1

     

       62
       62
       -
               

     

       63
       63
       -
           | Ok mailboxes ->

     

       64
       64
       -
               (* Find the inbox *)

     

       65
       65
       -
               let inbox = List.find_opt (fun m -> 

     

       66
       66
       -
                 m.Types.role = Some Types.Inbox

     

       67
       67
       -
               ) mailboxes in

     

       68
       68
       -
               

     

       69
       69
       -
               match inbox with

     

       70
       70
       -
               | None -> 

     

       71
       71
       -
                   Printf.eprintf "No inbox found\n";

     

       72
       72
       -
                   exit 1

     

       73
       73
       -
                   

     

       74
       74
       -
               | Some inbox ->

     

       75
       75
       -
                   (* Get recent emails *)

     

       76
       76
       -
                   let* emails_result = Jmap_mail.get_messages_in_mailbox

     

       77
       77
       -
                     conn

     

       78
       78
       -
                     ~account_id

     

       79
       79
       -
                     ~mailbox_id:inbox.Types.id

     

       80
       80
       -
                     ~limit:10

     

       81
       81
       -
                     ()

     

       82
       82
       -
                   in

     

       83
       83
       -
                   

     

       84
       84
       -
                   match emails_result with

     

       85
       85
       -
                   | Error err -> 

     

       86
       86
       -
                       Printf.eprintf "Failed to get emails\n";

     

       87
       87
       -
                       exit 1

     

       88
       88
       -
                       

     

       89
       89
       -
                   | Ok emails ->

     

       90
       90
       -
                       (* Display emails *)

     

       91
       91
       -
                       List.iter (fun email ->

     

       92
       92
       -
                         Printf.printf "%s - %s\n" 

     

       93
       93
       -
                           (Option.value ~default:"<unknown>" 

     

       94
       94
       -
                             (Option.map (fun addrs -> 

     

       95
       95
       -
                               match addrs with

     

       96
       96
       -
                               | [] -> "<unknown>"

     

       97
       97
       -
                               | addr::_ -> addr.Types.email

     

       98
       98
       -
                             ) email.Types.from))

     

       99
       99
       -
                           (Option.value ~default:"<no subject>" email.Types.subject)

     

       100
       100
       -
                       ) emails;

     

       101
       101
       -
                       

     

       102
       102
       -
                       Lwt.return_unit

     

       22
       22
       +
       opam install .

     

       103
       23
        
       ```

     

       104
       24
        
       

     

       105
       25
        
       ## Features

     
···

       148
       68
        
       - [RFC8620: The JSON Meta Application Protocol (JMAP)](https://datatracker.ietf.org/doc/html/rfc8620)

     

       149
       69
        
       - [RFC8621: The JSON Meta Application Protocol (JMAP) for Mail](https://datatracker.ietf.org/doc/html/rfc8621)

     

       150
       70
        
       - [Message Flag and Mailbox Attribute Extension](https://datatracker.ietf.org/doc/html/draft-ietf-mailmaint-messageflag-mailboxattribute-02)

     

       151
       151
       -
       - [Fastmail Developer Documentation](https://www.fastmail.com/dev/)
     

       71
       71
       +
       - [Fastmail Developer Documentation](https://www.fastmail.com/dev/)