commit 79ea0c98ef2a2a7349b0a71ff1d59907a29f0adb · anil.recoil.org/gemini-codegen-test

+43 -52

output/jmap.mli

···

       27
        
       module Methods = Jmap_methods

     

       28
        
       module Binary = Jmap_binary

     

       29
        
       module Push = Jmap_push

     

       30
       -
       

     

       31
       -
       (** {1 Mail Extension (RFC 8621)} *)

     

       32
       -
       

     

       33
       -
       module Email = Jmap_email

     

       34
       -
       

     

       35
       -
       (** {1 Unix Implementation Interface} *)

     

       36
       -
       

     

       37
       -
       module Unix = Jmap_unix

     

       38
       -
       

     

       39
       -
       (** {1 Example Usage Sketch}

     

       40
        
       

     

       0
        
       
     

       41
        
       {[ 

     

       42
        
         (* OCaml 5.1 required for Lwt let operators *) 

     

       43
        
         open Lwt.Syntax 

     
···

       54
        
           in 

     

       55
        
           (* Construct the filter *) 

     

       56
        
           let filter : filter = 

     

       57
       -
             Filter_operator {

     

       58
       -
               operator = `AND;

     

       59
       -
               conditions = [

     

       60
        
                 Filter_condition (Yojson.Safe.to_basic (`Assoc [

     

       61
        
                   ("from", `String sender_email);

     

       62
        
                 ]));

     
···

       65
        
                   ("value", `Bool false);

     

       66
        
                 ]));

     

       67
        
               ]

     

       68
       -
             }

     

       69
        
           in

     

       70
        
           (* Prepare the Email/query invocation *) 

     

       71
       -
           let query_args : email_query_args = { 

     

       72
       -
               query_account_id = primary_mail_account_id;

     

       73
       -
               query_filter = Some filter;

     

       74
       -
               query_sort = Some [ { property = "receivedAt"; is_ascending = Some false; collation = None; keyword = None; other_fields = Hashtbl.create 0 } ];

     

       75
       -
               query_position = Some 0;

     

       76
       -
               query_anchor = None;

     

       77
       -
               query_anchor_offset = None;

     

       78
       -
               query_limit = Some 20; (* Get latest 20 *)

     

       79
       -
               query_calculate_total = Some false;

     

       80
       -
               query_collapse_threads = Some false;

     

       81
       -
               query_sort_as_tree = None;

     

       82
       -
               query_filter_as_tree = None;

     

       83
       -
           } in

     

       84
       -
           let query_invocation : invocation = {

     

       85
       -
             method_name = "Email/query";

     

       86
       -
             arguments = (* Yojson conversion of query_args needed here *);

     

       87
       -
             method_call_id = "q1";

     

       88
       -
           } in

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       89
        
       

     

       90
        
           (* Prepare the Email/get invocation using a back-reference *) 

     

       91
       -
           let get_args : email_get_args = {

     

       92
       -
             get_account_id = primary_mail_account_id;

     

       93
       -
             get_ids = None; (* Use back-reference instead *)

     

       94
       -
             get_properties = Some ["id"; "subject"; "receivedAt"; "from"];

     

       95
       -
             get_body_properties = None;

     

       96
       -
             get_fetch_text_body_values = None;

     

       97
       -
             get_fetch_html_body_values = None;

     

       98
       -
             get_fetch_all_body_values = None;

     

       99
       -
             get_max_body_value_bytes = None;

     

       100
       -
           } in

     

       101
       -
           let get_invocation : invocation = {

     

       102
       -
             method_name = "Email/get";

     

       103
       -
             arguments = (* Yojson conversion of get_args, with ids replaced by a ResultReference to q1 needed here *);

     

       104
       -
             method_call_id = "g1";

     

       105
       -
           } in

     

       106
        
       

     

       107
        
           (* Prepare the JMAP request *) 

     

       108
       -
           let request : request = { 

     

       109
       -
             using = [ Jmap.Session.capability_core; Email.capability_mail ];

     

       110
       -
             method_calls = [ query_invocation; get_invocation ];

     

       111
       -
             created_ids = None;

     

       112
       -
           } in

     

       113
        
       

     

       114
        
           (* Send the request *) 

     

       115
        
           let* response = Jmap.Unix.request ctx request in

···

       27
        
       module Methods = Jmap_methods

     

       28
        
       module Binary = Jmap_binary

     

       29
        
       module Push = Jmap_push

     

       30
       +
       module Vacation = Jmap_vacation

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       31
        
       

     

       32
       +
       (**

     

       33
        
       {[ 

     

       34
        
         (* OCaml 5.1 required for Lwt let operators *) 

     

       35
        
         open Lwt.Syntax 

     
···

       46
        
           in 

     

       47
        
           (* Construct the filter *) 

     

       48
        
           let filter : filter = 

     

       49
       +
             Filter_operator (Filter_operator.v

     

       50
       +
               ~operator:`AND

     

       51
       +
               ~conditions:[

     

       52
        
                 Filter_condition (Yojson.Safe.to_basic (`Assoc [

     

       53
        
                   ("from", `String sender_email);

     

       54
        
                 ]));

     
···

       57
        
                   ("value", `Bool false);

     

       58
        
                 ]));

     

       59
        
               ]

     

       60
       +
               ())

     

       61
        
           in

     

       62
        
           (* Prepare the Email/query invocation *) 

     

       63
       +
           let query_args = Query_args.v 

     

       64
       +
             ~account_id:primary_mail_account_id

     

       65
       +
             ~filter

     

       66
       +
             ~sort:[

     

       67
       +
               Comparator.v

     

       68
       +
                 ~property:"receivedAt" 

     

       69
       +
                 ~is_ascending:false

     

       70
       +
                 ()

     

       71
       +
             ]

     

       72
       +
             ~position:0

     

       73
       +
             ~limit:20 (* Get latest 20 *)

     

       74
       +
             ~calculate_total:false

     

       75
       +
             ~collapse_threads:false

     

       76
       +
             ()

     

       77
       +
           in

     

       78
       +
           let query_invocation = Invocation.v 

     

       79
       +
             ~method_name:"Email/query"

     

       80
       +
             ~arguments:(* Yojson conversion of query_args needed here *)

     

       81
       +
             ~method_call_id:"q1"

     

       82
       +
             ()

     

       83
       +
           in

     

       84
        
       

     

       85
        
           (* Prepare the Email/get invocation using a back-reference *) 

     

       86
       +
           let get_args = Get_args.v

     

       87
       +
             ~account_id:primary_mail_account_id

     

       88
       +
             ~properties:["id"; "subject"; "receivedAt"; "from"]

     

       89
       +
             ()

     

       90
       +
           in

     

       91
       +
           let get_invocation = Invocation.v

     

       92
       +
             ~method_name:"Email/get"

     

       93
       +
             ~arguments:(* Yojson conversion of get_args, with ids replaced by a ResultReference to q1 needed here *)

     

       94
       +
             ~method_call_id:"g1"

     

       95
       +
             ()

     

       96
       +
           in

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       97
        
       

     

       98
        
           (* Prepare the JMAP request *) 

     

       99
       +
           let request = Request.v

     

       100
       +
             ~using:[ capability_core; Email.capability_mail ]

     

       101
       +
             ~method_calls:[ query_invocation; get_invocation ]

     

       102
       +
             ()

     

       103
       +
           in

     

       104
        
       

     

       105
        
           (* Send the request *) 

     

       106
        
           let* response = Jmap.Unix.request ctx request in

+46 -17

output/jmap_binary.mli

···

       6
        
       

     

       7
        
       (** Response from uploading binary data.

     

       8
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-6.1> RFC 8620, Section 6.1 *)

     

       9
       -
       type upload_response = {

     

       10
       -
         upload_resp_account_id : id;

     

       11
       -
         upload_resp_blob_id : id;

     

       12
       -
         upload_resp_type : string;

     

       13
       -
         upload_resp_size : uint;

     

       14
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       15
        
       

     

       16
        
       (** Arguments for Blob/copy.

     

       17
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-6.3> RFC 8620, Section 6.3 *)

     

       18
       -
       type blob_copy_args = {

     

       19
       -
         blob_copy_from_account_id : id;

     

       20
       -
         blob_copy_account_id : id;

     

       21
       -
         blob_copy_blob_ids : id list;

     

       22
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       23
        
       

     

       24
        
       (** Response for Blob/copy.

     

       25
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-6.3> RFC 8620, Section 6.3 *)

     

       26
       -
       type blob_copy_response = {

     

       27
       -
         blob_copy_resp_from_account_id : id;

     

       28
       -
         blob_copy_resp_account_id : id;

     

       29
       -
         blob_copy_resp_copied : id id_map option;

     

       30
       -
         blob_copy_resp_not_copied : set_error id_map option;

     

       31
       -
       }
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0

···

       6
        
       

     

       7
        
       (** Response from uploading binary data.

     

       8
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-6.1> RFC 8620, Section 6.1 *)

     

       9
       +
       module Upload_response : sig

     

       10
       +
         type t

     

       11
       +
         

     

       12
       +
         val account_id : t -> id

     

       13
       +
         val blob_id : t -> id

     

       14
       +
         val type_ : t -> string

     

       15
       +
         val size : t -> uint

     

       16
       +
         

     

       17
       +
         val v :

     

       18
       +
           account_id:id ->

     

       19
       +
           blob_id:id ->

     

       20
       +
           type_:string ->

     

       21
       +
           size:uint ->

     

       22
       +
           unit ->

     

       23
       +
           t

     

       24
       +
       end

     

       25
        
       

     

       26
        
       (** Arguments for Blob/copy.

     

       27
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-6.3> RFC 8620, Section 6.3 *)

     

       28
       +
       module Blob_copy_args : sig

     

       29
       +
         type t

     

       30
       +
         

     

       31
       +
         val from_account_id : t -> id

     

       32
       +
         val account_id : t -> id

     

       33
       +
         val blob_ids : t -> id list

     

       34
       +
         

     

       35
       +
         val v :

     

       36
       +
           from_account_id:id ->

     

       37
       +
           account_id:id ->

     

       38
       +
           blob_ids:id list ->

     

       39
       +
           unit ->

     

       40
       +
           t

     

       41
       +
       end

     

       42
        
       

     

       43
        
       (** Response for Blob/copy.

     

       44
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-6.3> RFC 8620, Section 6.3 *)

     

       45
       +
       module Blob_copy_response : sig

     

       46
       +
         type t

     

       47
       +
         

     

       48
       +
         val from_account_id : t -> id

     

       49
       +
         val account_id : t -> id

     

       50
       +
         val copied : t -> id id_map option

     

       51
       +
         val not_copied : t -> Set_error.t id_map option

     

       52
       +
         

     

       53
       +
         val v :

     

       54
       +
           from_account_id:id ->

     

       55
       +
           account_id:id ->

     

       56
       +
           ?copied:id id_map ->

     

       57
       +
           ?not_copied:Set_error.t id_map ->

     

       58
       +
           unit ->

     

       59
       +
           t

     

       60
       +
       end

+68 -34

output/jmap_error.mli

···

       2
        
       

     

       3
        
       open Jmap_types

     

       4
        
       

     

       5
       -
       (** Problem details object for HTTP-level errors.

     

       6
       -
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.1> RFC 8620, Section 3.6.1

     

       7
       -
           @see <https://www.rfc-editor.org/rfc/rfc7807.html> RFC 7807 *)

     

       8
       -
       type problem_details = {

     

       9
       -
         problem_type : string; (** The "type" field from RFC 7807. *)

     

       10
       -
         status : int option; (** The "status" field. *)

     

       11
       -
         detail : string option; (** The "detail" field. *)

     

       12
       -
         limit : string option; (** For "urn:ietf:params:jmap:error:limit" *)

     

       13
       -
         other_fields : Yojson.Safe.t string_map; (** Catch-all for extra fields *)

     

       14
       -
       }

     

       15
       -
       

     

       16
        
       (** Standard Method-level error types.

     

       17
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.2> RFC 8620, Section 3.6.2 *)

     

       18
        
       type method_error_type = [

     
···

       38
        
         | `Other_method_error of string (* For future or custom errors *)

     

       39
        
       ]

     

       40
        
       

     

       41
       -
       (** Description for method errors. May contain additional details.

     

       42
       -
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.2> RFC 8620, Section 3.6.2 *)

     

       43
       -
       type method_error_description = {

     

       44
       -
         description : string option;

     

       45
       -
       }

     

       46
       -
       

     

       47
       -
       (** Represents a method-level error response invocation part.

     

       48
       -
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.2> RFC 8620, Section 3.6.2 *)

     

       49
       -
       type method_error = {

     

       50
       -
         err_type : method_error_type;

     

       51
       -
         err_description : method_error_description option;

     

       52
       -
       }

     

       53
       -
       

     

       54
        
       (** Standard SetError types.

     

       55
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.3> RFC 8620, Section 5.3 *)

     

       56
        
       type set_error_type = [

     
···

       80
        
         | `Other_set_error of string (* For future or custom errors *)

     

       81
        
       ]

     

       82
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       83
        
       (** SetError object.

     

       84
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.3> RFC 8620, Section 5.3 *)

     

       85
       -
       type set_error = {

     

       86
       -
         set_err_type : set_error_type;

     

       87
       -
         set_err_description : string option;

     

       88
       -
         set_err_properties : string list option; (** For InvalidProperties *)

     

       89
       -
         set_err_existing_id : id option; (** For AlreadyExists *)

     

       90
       -
         set_err_max_recipients : uint option; (** For TooManyRecipients *)

     

       91
       -
         set_err_invalid_recipients : string list option; (** For InvalidRecipients *)

     

       92
       -
         set_err_max_size : uint option; (** For TooLarge *)

     

       93
       -
         set_err_not_found_blob_ids : id list option; (** For BlobNotFound *)

     

       94
       -
       }
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0

···

       2
        
       

     

       3
        
       open Jmap_types

     

       4
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       5
        
       (** Standard Method-level error types.

     

       6
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.2> RFC 8620, Section 3.6.2 *)

     

       7
        
       type method_error_type = [

     
···

       27
        
         | `Other_method_error of string (* For future or custom errors *)

     

       28
        
       ]

     

       29
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       30
        
       (** Standard SetError types.

     

       31
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.3> RFC 8620, Section 5.3 *)

     

       32
        
       type set_error_type = [

     
···

       56
        
         | `Other_set_error of string (* For future or custom errors *)

     

       57
        
       ]

     

       58
        
       

     

       59
       +
       (** Problem details object for HTTP-level errors.

     

       60
       +
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.1> RFC 8620, Section 3.6.1

     

       61
       +
           @see <https://www.rfc-editor.org/rfc/rfc7807.html> RFC 7807 *)

     

       62
       +
       module Problem_details : sig

     

       63
       +
         type t

     

       64
       +
       

     

       65
       +
         val problem_type : t -> string

     

       66
       +
         val status : t -> int option

     

       67
       +
         val detail : t -> string option

     

       68
       +
         val limit : t -> string option

     

       69
       +
         val other_fields : t -> Yojson.Safe.t string_map

     

       70
       +
         

     

       71
       +
         val v : 

     

       72
       +
           ?status:int ->

     

       73
       +
           ?detail:string ->

     

       74
       +
           ?limit:string ->

     

       75
       +
           ?other_fields:Yojson.Safe.t string_map ->

     

       76
       +
           string ->

     

       77
       +
           t

     

       78
       +
       end

     

       79
       +
       

     

       80
       +
       (** Description for method errors. May contain additional details.

     

       81
       +
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.2> RFC 8620, Section 3.6.2 *)

     

       82
       +
       module Method_error_description : sig

     

       83
       +
         type t

     

       84
       +
         

     

       85
       +
         val description : t -> string option

     

       86
       +
         

     

       87
       +
         val v : ?description:string -> unit -> t

     

       88
       +
       end

     

       89
       +
       

     

       90
       +
       (** Represents a method-level error response invocation part.

     

       91
       +
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.2> RFC 8620, Section 3.6.2 *)

     

       92
       +
       module Method_error : sig

     

       93
       +
         type t

     

       94
       +
         

     

       95
       +
         val type_ : t -> method_error_type

     

       96
       +
         val description : t -> Method_error_description.t option

     

       97
       +
         

     

       98
       +
         val v : 

     

       99
       +
           ?description:Method_error_description.t ->

     

       100
       +
           method_error_type ->

     

       101
       +
           t

     

       102
       +
       end

     

       103
       +
       

     

       104
        
       (** SetError object.

     

       105
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.3> RFC 8620, Section 5.3 *)

     

       106
       +
       module Set_error : sig

     

       107
       +
         type t

     

       108
       +
         

     

       109
       +
         val type_ : t -> set_error_type

     

       110
       +
         val description : t -> string option

     

       111
       +
         val properties : t -> string list option

     

       112
       +
         val existing_id : t -> id option

     

       113
       +
         val max_recipients : t -> uint option

     

       114
       +
         val invalid_recipients : t -> string list option

     

       115
       +
         val max_size : t -> uint option

     

       116
       +
         val not_found_blob_ids : t -> id list option

     

       117
       +
         

     

       118
       +
         val v :

     

       119
       +
           ?description:string ->

     

       120
       +
           ?properties:string list ->

     

       121
       +
           ?existing_id:id ->

     

       122
       +
           ?max_recipients:uint ->

     

       123
       +
           ?invalid_recipients:string list ->

     

       124
       +
           ?max_size:uint ->

     

       125
       +
           ?not_found_blob_ids:id list ->

     

       126
       +
           set_error_type ->

     

       127
       +
           t

     

       128
       +
       end

+24 -12

output/jmap_identity.mli

···

       46
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-6.3> RFC 8621, Section 6.3 *)

     

       47
        
       type identity_updated_info = identity (* Contains only changed server-set props *)

     

       48
        
       

     

       49
       -
       (** Identity/get: Args type (specialized from ['record get_args]). *)

     

       50
       -
       type identity_get_args = identity get_args

     

       0
        
       
     

       0
        
       
     

       51
        
       

     

       52
       -
       (** Identity/get: Response type (specialized from ['record get_response]). *)

     

       53
       -
       type identity_get_response = identity get_response

     

       0
        
       
     

       0
        
       
     

       54
        
       

     

       55
       -
       (** Identity/changes: Args type (specialized from [changes_args]). *)

     

       56
       -
       type identity_changes_args = changes_args

     

       0
        
       
     

       0
        
       
     

       57
        
       

     

       58
       -
       (** Identity/changes: Response type (specialized from [changes_response]). *)

     

       59
       -
       type identity_changes_response = changes_response

     

       0
        
       
     

       0
        
       
     

       60
        
       

     

       61
       -
       (** Identity/set: Args type (specialized from [('c, 'u) set_args]). *)

     

       62
       -
       type identity_set_args = (identity_create, identity_update) set_args

     

       0
        
       
     

       0
        
       
     

       63
        
       

     

       64
       -
       (** Identity/set: Response type (specialized from [('c, 'u) set_response]). *)

     

       65
       -
       type identity_set_response = (identity_created_info, identity_updated_info) set_response
     

       0
        
       
     

       0

···

       46
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-6.3> RFC 8621, Section 6.3 *)

     

       47
        
       type identity_updated_info = identity (* Contains only changed server-set props *)

     

       48
        
       

     

       49
       +
       (** Identity/get: Args type (specialized from ['record Get_args.t]). *)

     

       50
       +
       module Identity_get_args : sig

     

       51
       +
         type t = identity Get_args.t

     

       52
       +
       end

     

       53
        
       

     

       54
       +
       (** Identity/get: Response type (specialized from ['record Get_response.t]). *)

     

       55
       +
       module Identity_get_response : sig

     

       56
       +
         type t = identity Get_response.t

     

       57
       +
       end

     

       58
        
       

     

       59
       +
       (** Identity/changes: Args type (specialized from [Changes_args.t]). *)

     

       60
       +
       module Identity_changes_args : sig

     

       61
       +
         type t = Changes_args.t

     

       62
       +
       end

     

       63
        
       

     

       64
       +
       (** Identity/changes: Response type (specialized from [Changes_response.t]). *)

     

       65
       +
       module Identity_changes_response : sig

     

       66
       +
         type t = Changes_response.t

     

       67
       +
       end

     

       68
        
       

     

       69
       +
       (** Identity/set: Args type (specialized from [('c, 'u) Set_args.t]). *)

     

       70
       +
       module Identity_set_args : sig

     

       71
       +
         type t = (identity_create, identity_update) Set_args.t

     

       72
       +
       end

     

       73
        
       

     

       74
       +
       (** Identity/set: Response type (specialized from [('c, 'u) Set_response.t]). *)

     

       75
       +
       module Identity_set_response : sig

     

       76
       +
         type t = (identity_created_info, identity_updated_info) Set_response.t

     

       77
       +
       end

+40 -20

output/jmap_mailbox.mli

···

       78
        
         filter_is_subscribed : bool option;

     

       79
        
       }

     

       80
        
       

     

       81
       -
       (** Mailbox/get: Args type (specialized from ['record get_args]). *)

     

       82
       -
       type mailbox_get_args = mailbox get_args

     

       0
        
       
     

       0
        
       
     

       83
        
       

     

       84
       -
       (** Mailbox/get: Response type (specialized from ['record get_response]). *)

     

       85
       -
       type mailbox_get_response = mailbox get_response

     

       0
        
       
     

       0
        
       
     

       86
        
       

     

       87
       -
       (** Mailbox/changes: Args type (specialized from [changes_args]). *)

     

       88
       -
       type mailbox_changes_args = changes_args

     

       0
        
       
     

       0
        
       
     

       89
        
       

     

       90
       -
       (** Mailbox/changes: Response type (specialized from [changes_response]). *)

     

       91
       -
       type mailbox_changes_response = changes_response

     

       0
        
       
     

       0
        
       
     

       92
        
       

     

       93
       -
       (** Mailbox/query: Args type (specialized from [query_args]). *)

     

       94
       -
       type mailbox_query_args = query_args

     

       0
        
       
     

       0
        
       
     

       95
        
       

     

       96
       -
       (** Mailbox/query: Response type (specialized from [query_response]). *)

     

       97
       -
       type mailbox_query_response = query_response

     

       0
        
       
     

       0
        
       
     

       98
        
       

     

       99
       -
       (** Mailbox/queryChanges: Args type (specialized from [query_changes_args]). *)

     

       100
       -
       type mailbox_query_changes_args = query_changes_args

     

       0
        
       
     

       0
        
       
     

       101
        
       

     

       102
       -
       (** Mailbox/queryChanges: Response type (specialized from [query_changes_response]). *)

     

       103
       -
       type mailbox_query_changes_response = query_changes_response

     

       0
        
       
     

       0
        
       
     

       104
        
       

     

       105
       -
       (** Mailbox/set: Args type (specialized from [('c, 'u) set_args]). *)

     

       106
       -
       type mailbox_set_args = (mailbox_create, mailbox_update) set_args

     

       0
        
       
     

       0
        
       
     

       107
        
       

     

       108
       -
       (** Mailbox/set: Response type (specialized from [('c, 'u) set_response]). *)

     

       109
       -
       type mailbox_set_response = (mailbox_created_info, mailbox_updated_info) set_response
     

       0
        
       
     

       0

···

       78
        
         filter_is_subscribed : bool option;

     

       79
        
       }

     

       80
        
       

     

       81
       +
       (** Mailbox/get: Args type (specialized from ['record Get_args.t]). *)

     

       82
       +
       module Mailbox_get_args : sig

     

       83
       +
         type t = mailbox Get_args.t

     

       84
       +
       end

     

       85
        
       

     

       86
       +
       (** Mailbox/get: Response type (specialized from ['record Get_response.t]). *)

     

       87
       +
       module Mailbox_get_response : sig

     

       88
       +
         type t = mailbox Get_response.t

     

       89
       +
       end

     

       90
        
       

     

       91
       +
       (** Mailbox/changes: Args type (specialized from [Changes_args.t]). *)

     

       92
       +
       module Mailbox_changes_args : sig

     

       93
       +
         type t = Changes_args.t

     

       94
       +
       end

     

       95
        
       

     

       96
       +
       (** Mailbox/changes: Response type (specialized from [Changes_response.t]). *)

     

       97
       +
       module Mailbox_changes_response : sig

     

       98
       +
         type t = Changes_response.t

     

       99
       +
       end

     

       100
        
       

     

       101
       +
       (** Mailbox/query: Args type (specialized from [Query_args.t]). *)

     

       102
       +
       module Mailbox_query_args : sig

     

       103
       +
         type t = Query_args.t

     

       104
       +
       end

     

       105
        
       

     

       106
       +
       (** Mailbox/query: Response type (specialized from [Query_response.t]). *)

     

       107
       +
       module Mailbox_query_response : sig

     

       108
       +
         type t = Query_response.t

     

       109
       +
       end

     

       110
        
       

     

       111
       +
       (** Mailbox/queryChanges: Args type (specialized from [Query_changes_args.t]). *)

     

       112
       +
       module Mailbox_query_changes_args : sig

     

       113
       +
         type t = Query_changes_args.t

     

       114
       +
       end

     

       115
        
       

     

       116
       +
       (** Mailbox/queryChanges: Response type (specialized from [Query_changes_response.t]). *)

     

       117
       +
       module Mailbox_query_changes_response : sig

     

       118
       +
         type t = Query_changes_response.t

     

       119
       +
       end

     

       120
        
       

     

       121
       +
       (** Mailbox/set: Args type (specialized from [('c, 'u) Set_args.t]). *)

     

       122
       +
       module Mailbox_set_args : sig

     

       123
       +
         type t = (mailbox_create, mailbox_update) Set_args.t

     

       124
       +
       end

     

       125
        
       

     

       126
       +
       (** Mailbox/set: Response type (specialized from [('c, 'u) Set_response.t]). *)

     

       127
       +
       module Mailbox_set_response : sig

     

       128
       +
         type t = (mailbox_created_info, mailbox_updated_info) Set_response.t

     

       129
       +
       end

+296 -127

output/jmap_methods.mli

···

       10
        
       

     

       11
        
       (** Arguments for /get methods.

     

       12
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.1> RFC 8620, Section 5.1 *)

     

       13
       -
       type 'record get_args = {

     

       14
       -
         get_account_id : id;

     

       15
       -
         get_ids : id list option;

     

       16
       -
         get_properties : string list option;

     

       17
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       18
        
       

     

       19
        
       (** Response for /get methods.

     

       20
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.1> RFC 8620, Section 5.1 *)

     

       21
       -
       type 'record get_response = {

     

       22
       -
         get_resp_account_id : id;

     

       23
       -
         get_resp_state : string;

     

       24
       -
         get_resp_list : 'record list;

     

       25
       -
         get_resp_not_found : id list;

     

       26
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       27
        
       

     

       28
        
       (** Arguments for /changes methods.

     

       29
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.2> RFC 8620, Section 5.2 *)

     

       30
       -
       type changes_args = {

     

       31
       -
         changes_account_id : id;

     

       32
       -
         changes_since_state : string;

     

       33
       -
         changes_max_changes : uint option;

     

       34
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       35
        
       

     

       36
        
       (** Response for /changes methods.

     

       37
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.2> RFC 8620, Section 5.2 *)

     

       38
       -
       type changes_response = {

     

       39
       -
         changes_resp_account_id : id;

     

       40
       -
         changes_resp_old_state : string;

     

       41
       -
         changes_resp_new_state : string;

     

       42
       -
         changes_resp_has_more_changes : bool;

     

       43
       -
         changes_resp_created : id list;

     

       44
       -
         changes_resp_updated : id list;

     

       45
       -
         changes_resp_destroyed : id list;

     

       46
       -
         changes_resp_updated_properties : string list option; (* Mailbox/changes specific *)

     

       47
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       48
        
       

     

       49
        
       (** Patch object for /set update.

     

       50
        
           A list of (JSON Pointer path, value) pairs.

     
···

       55
        
           ['create_record] is the record type without server-set/immutable fields.

     

       56
        
           ['update_record] is the patch object type (usually [patch_object]).

     

       57
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.3> RFC 8620, Section 5.3 *)

     

       58
       -
       type ('create_record, 'update_record) set_args = {

     

       59
       -
         set_account_id : id;

     

       60
       -
         set_if_in_state : string option;

     

       61
       -
         set_create : 'create_record id_map option;

     

       62
       -
         set_update : 'update_record id_map option;

     

       63
       -
         set_destroy : id list option;

     

       64
       -
         set_on_success_destroy_original : bool option; (* For /copy *)

     

       65
       -
         set_destroy_from_if_in_state : string option; (* For /copy *)

     

       66
       -
         set_on_destroy_remove_emails : bool option; (* For Mailbox/set *)

     

       67
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       68
        
       

     

       69
        
       (** Response for /set methods.

     

       70
        
           ['created_record_info] is the server-set info for created records.

     

       71
        
           ['updated_record_info] is the server-set/computed info for updated records.

     

       72
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.3> RFC 8620, Section 5.3 *)

     

       73
       -
       type ('created_record_info, 'updated_record_info) set_response = {

     

       74
       -
         set_resp_account_id : id;

     

       75
       -
         set_resp_old_state : string option;

     

       76
       -
         set_resp_new_state : string;

     

       77
       -
         set_resp_created : 'created_record_info id_map option;

     

       78
       -
         set_resp_updated : 'updated_record_info option id_map option;

     

       79
       -
         set_resp_destroyed : id list option;

     

       80
       -
         set_resp_not_created : set_error id_map option;

     

       81
       -
         set_resp_not_updated : set_error id_map option;

     

       82
       -
         set_resp_not_destroyed : set_error id_map option;

     

       83
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       84
        
       

     

       85
        
       (** Arguments for /copy methods.

     

       86
        
           ['copy_record_override] contains the record id and override properties.

     

       87
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.4> RFC 8620, Section 5.4 *)

     

       88
       -
       type 'copy_record_override copy_args = {

     

       89
       -
         copy_from_account_id : id;

     

       90
       -
         copy_if_from_in_state : string option;

     

       91
       -
         copy_account_id : id;

     

       92
       -
         copy_if_in_state : string option;

     

       93
       -
         copy_create : 'copy_record_override id_map; (* Map from creation id *)

     

       94
       -
         copy_on_success_destroy_original : bool; (* default: false *)

     

       95
       -
         copy_destroy_from_if_in_state : string option;

     

       96
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       97
        
       

     

       98
        
       (** Response for /copy methods.

     

       99
        
           ['created_record_info] is the server-set info for the created copy.

     

       100
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.4> RFC 8620, Section 5.4 *)

     

       101
       -
       type 'created_record_info copy_response = {

     

       102
       -
         copy_resp_from_account_id : id;

     

       103
       -
         copy_resp_account_id : id;

     

       104
       -
         copy_resp_old_state : string option;

     

       105
       -
         copy_resp_new_state : string;

     

       106
       -
         copy_resp_created : 'created_record_info id_map option;

     

       107
       -
         copy_resp_not_created : set_error id_map option;

     

       108
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       109
        
       

     

       110
       -
       (** Base filter operator type.

     

       111
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.5> RFC 8620, Section 5.5 *)

     

       112
       -
       type filter_operator = {

     

       113
       -
         operator : [ `AND | `OR | `NOT ];

     

       114
       -
         conditions : filter list;

     

       115
       -
       }

     

       116
       -
       

     

       117
       -
       (** Represents either a filter operator or a filter condition.

     

       118
       -
           ['condition] is the type of the specific FilterCondition object.

     

       119
       -
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.5> RFC 8620, Section 5.5 *)

     

       120
       -
       and filter = 

     

       121
       -
         | Filter_operator of filter_operator

     

       122
       -
         | Filter_condition of Yojson.Safe.t (* Placeholder for specific condition type *)

     

       123
        
       

     

       124
        
       (** Comparator for sorting.

     

       125
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.5> RFC 8620, Section 5.5 *)

     

       126
       -
       type comparator = {

     

       127
       -
         property : string;

     

       128
       -
         is_ascending : bool option; (* default: true *)

     

       129
       -
         collation : string option;

     

       130
       -
         keyword : string option; (* For Email/query keyword sorts *)

     

       131
       -
         other_fields : Yojson.Safe.t string_map; (** Catch-all for extra fields *)

     

       132
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       133
        
       

     

       134
        
       (** Arguments for /query methods.

     

       135
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.5> RFC 8620, Section 5.5 *)

     

       136
       -
       type query_args = {

     

       137
       -
         query_account_id : id;

     

       138
       -
         query_filter : filter option;

     

       139
       -
         query_sort : comparator list option;

     

       140
       -
         query_position : jint option; (* default: 0 *)

     

       141
       -
         query_anchor : id option;

     

       142
       -
         query_anchor_offset : jint option; (* default: 0 *)

     

       143
       -
         query_limit : uint option;

     

       144
       -
         query_calculate_total : bool option; (* default: false *)

     

       145
       -
         query_collapse_threads : bool option; (* For Email/query *)

     

       146
       -
         query_sort_as_tree : bool option; (* For Mailbox/query *)

     

       147
       -
         query_filter_as_tree : bool option; (* For Mailbox/query *)

     

       148
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       149
        
       

     

       150
        
       (** Response for /query methods.

     

       151
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.5> RFC 8620, Section 5.5 *)

     

       152
       -
       type query_response = {

     

       153
       -
         query_resp_account_id : id;

     

       154
       -
         query_resp_query_state : string;

     

       155
       -
         query_resp_can_calculate_changes : bool;

     

       156
       -
         query_resp_position : uint;

     

       157
       -
         query_resp_ids : id list;

     

       158
       -
         query_resp_total : uint option;

     

       159
       -
         query_resp_limit : uint option;

     

       160
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       161
        
       

     

       162
        
       (** Item indicating an added record in /queryChanges.

     

       163
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.6> RFC 8620, Section 5.6 *)

     

       164
       -
       type added_item = {

     

       165
       -
         added_item_id : id;

     

       166
       -
         added_item_index : uint;

     

       167
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       168
        
       

     

       169
        
       (** Arguments for /queryChanges methods.

     

       170
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.6> RFC 8620, Section 5.6 *)

     

       171
       -
       type query_changes_args = {

     

       172
       -
         query_changes_account_id : id;

     

       173
       -
         query_changes_filter : filter option;

     

       174
       -
         query_changes_sort : comparator list option;

     

       175
       -
         query_changes_since_query_state : string;

     

       176
       -
         query_changes_max_changes : uint option;

     

       177
       -
         query_changes_up_to_id : id option;

     

       178
       -
         query_changes_calculate_total : bool option; (* default: false *)

     

       179
       -
         query_changes_collapse_threads : bool option; (* For Email/queryChanges *)

     

       180
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       181
        
       

     

       182
        
       (** Response for /queryChanges methods.

     

       183
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.6> RFC 8620, Section 5.6 *)

     

       184
       -
       type query_changes_response = {

     

       185
       -
         query_changes_resp_account_id : id;

     

       186
       -
         query_changes_resp_old_query_state : string;

     

       187
       -
         query_changes_resp_new_query_state : string;

     

       188
       -
         query_changes_resp_total : uint option;

     

       189
       -
         query_changes_resp_removed : id list;

     

       190
       -
         query_changes_resp_added : added_item list;

     

       191
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       192
        
       

     

       193
        
       (** Core/echo method: Arguments are mirrored in the response.

     

       194
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-4> RFC 8620, Section 4 *)

···

       10
        
       

     

       11
        
       (** Arguments for /get methods.

     

       12
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.1> RFC 8620, Section 5.1 *)

     

       13
       +
       module Get_args : sig

     

       14
       +
         type 'record t

     

       15
       +
         

     

       16
       +
         val account_id : 'record t -> id

     

       17
       +
         val ids : 'record t -> id list option

     

       18
       +
         val properties : 'record t -> string list option

     

       19
       +
         

     

       20
       +
         val v :

     

       21
       +
           account_id:id ->

     

       22
       +
           ?ids:id list ->

     

       23
       +
           ?properties:string list ->

     

       24
       +
           unit ->

     

       25
       +
           'record t

     

       26
       +
       end

     

       27
        
       

     

       28
        
       (** Response for /get methods.

     

       29
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.1> RFC 8620, Section 5.1 *)

     

       30
       +
       module Get_response : sig

     

       31
       +
         type 'record t

     

       32
       +
         

     

       33
       +
         val account_id : 'record t -> id

     

       34
       +
         val state : 'record t -> string

     

       35
       +
         val list : 'record t -> 'record list

     

       36
       +
         val not_found : 'record t -> id list

     

       37
       +
         

     

       38
       +
         val v :

     

       39
       +
           account_id:id ->

     

       40
       +
           state:string ->

     

       41
       +
           list:'record list ->

     

       42
       +
           not_found:id list ->

     

       43
       +
           unit ->

     

       44
       +
           'record t

     

       45
       +
       end

     

       46
        
       

     

       47
        
       (** Arguments for /changes methods.

     

       48
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.2> RFC 8620, Section 5.2 *)

     

       49
       +
       module Changes_args : sig

     

       50
       +
         type t

     

       51
       +
         

     

       52
       +
         val account_id : t -> id

     

       53
       +
         val since_state : t -> string

     

       54
       +
         val max_changes : t -> uint option

     

       55
       +
         

     

       56
       +
         val v :

     

       57
       +
           account_id:id ->

     

       58
       +
           since_state:string ->

     

       59
       +
           ?max_changes:uint ->

     

       60
       +
           unit ->

     

       61
       +
           t

     

       62
       +
       end

     

       63
        
       

     

       64
        
       (** Response for /changes methods.

     

       65
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.2> RFC 8620, Section 5.2 *)

     

       66
       +
       module Changes_response : sig

     

       67
       +
         type t

     

       68
       +
         

     

       69
       +
         val account_id : t -> id

     

       70
       +
         val old_state : t -> string

     

       71
       +
         val new_state : t -> string

     

       72
       +
         val has_more_changes : t -> bool

     

       73
       +
         val created : t -> id list

     

       74
       +
         val updated : t -> id list

     

       75
       +
         val destroyed : t -> id list

     

       76
       +
         val updated_properties : t -> string list option

     

       77
       +
         

     

       78
       +
         val v :

     

       79
       +
           account_id:id ->

     

       80
       +
           old_state:string ->

     

       81
       +
           new_state:string ->

     

       82
       +
           has_more_changes:bool ->

     

       83
       +
           created:id list ->

     

       84
       +
           updated:id list ->

     

       85
       +
           destroyed:id list ->

     

       86
       +
           ?updated_properties:string list ->

     

       87
       +
           unit ->

     

       88
       +
           t

     

       89
       +
       end

     

       90
        
       

     

       91
        
       (** Patch object for /set update.

     

       92
        
           A list of (JSON Pointer path, value) pairs.

     
···

       97
        
           ['create_record] is the record type without server-set/immutable fields.

     

       98
        
           ['update_record] is the patch object type (usually [patch_object]).

     

       99
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.3> RFC 8620, Section 5.3 *)

     

       100
       +
       module Set_args : sig

     

       101
       +
         type ('create_record, 'update_record) t

     

       102
       +
         

     

       103
       +
         val account_id : ('a, 'b) t -> id

     

       104
       +
         val if_in_state : ('a, 'b) t -> string option

     

       105
       +
         val create : ('a, 'b) t -> 'a id_map option

     

       106
       +
         val update : ('a, 'b) t -> 'b id_map option

     

       107
       +
         val destroy : ('a, 'b) t -> id list option

     

       108
       +
         val on_success_destroy_original : ('a, 'b) t -> bool option

     

       109
       +
         val destroy_from_if_in_state : ('a, 'b) t -> string option

     

       110
       +
         val on_destroy_remove_emails : ('a, 'b) t -> bool option

     

       111
       +
         

     

       112
       +
         val v :

     

       113
       +
           account_id:id ->

     

       114
       +
           ?if_in_state:string ->

     

       115
       +
           ?create:'a id_map ->

     

       116
       +
           ?update:'b id_map ->

     

       117
       +
           ?destroy:id list ->

     

       118
       +
           ?on_success_destroy_original:bool ->

     

       119
       +
           ?destroy_from_if_in_state:string ->

     

       120
       +
           ?on_destroy_remove_emails:bool ->

     

       121
       +
           unit ->

     

       122
       +
           ('a, 'b) t

     

       123
       +
       end

     

       124
        
       

     

       125
        
       (** Response for /set methods.

     

       126
        
           ['created_record_info] is the server-set info for created records.

     

       127
        
           ['updated_record_info] is the server-set/computed info for updated records.

     

       128
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.3> RFC 8620, Section 5.3 *)

     

       129
       +
       module Set_response : sig

     

       130
       +
         type ('created_record_info, 'updated_record_info) t

     

       131
       +
         

     

       132
       +
         val account_id : ('a, 'b) t -> id

     

       133
       +
         val old_state : ('a, 'b) t -> string option

     

       134
       +
         val new_state : ('a, 'b) t -> string

     

       135
       +
         val created : ('a, 'b) t -> 'a id_map option

     

       136
       +
         val updated : ('a, 'b) t -> 'b option id_map option

     

       137
       +
         val destroyed : ('a, 'b) t -> id list option

     

       138
       +
         val not_created : ('a, 'b) t -> Set_error.t id_map option

     

       139
       +
         val not_updated : ('a, 'b) t -> Set_error.t id_map option

     

       140
       +
         val not_destroyed : ('a, 'b) t -> Set_error.t id_map option

     

       141
       +
         

     

       142
       +
         val v :

     

       143
       +
           account_id:id ->

     

       144
       +
           ?old_state:string ->

     

       145
       +
           new_state:string ->

     

       146
       +
           ?created:'a id_map ->

     

       147
       +
           ?updated:'b option id_map ->

     

       148
       +
           ?destroyed:id list ->

     

       149
       +
           ?not_created:Set_error.t id_map ->

     

       150
       +
           ?not_updated:Set_error.t id_map ->

     

       151
       +
           ?not_destroyed:Set_error.t id_map ->

     

       152
       +
           unit ->

     

       153
       +
           ('a, 'b) t

     

       154
       +
       end

     

       155
        
       

     

       156
        
       (** Arguments for /copy methods.

     

       157
        
           ['copy_record_override] contains the record id and override properties.

     

       158
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.4> RFC 8620, Section 5.4 *)

     

       159
       +
       module Copy_args : sig

     

       160
       +
         type 'copy_record_override t

     

       161
       +
         

     

       162
       +
         val from_account_id : 'a t -> id

     

       163
       +
         val if_from_in_state : 'a t -> string option

     

       164
       +
         val account_id : 'a t -> id

     

       165
       +
         val if_in_state : 'a t -> string option

     

       166
       +
         val create : 'a t -> 'a id_map

     

       167
       +
         val on_success_destroy_original : 'a t -> bool

     

       168
       +
         val destroy_from_if_in_state : 'a t -> string option

     

       169
       +
         

     

       170
       +
         val v :

     

       171
       +
           from_account_id:id ->

     

       172
       +
           ?if_from_in_state:string ->

     

       173
       +
           account_id:id ->

     

       174
       +
           ?if_in_state:string ->

     

       175
       +
           create:'a id_map ->

     

       176
       +
           ?on_success_destroy_original:bool ->

     

       177
       +
           ?destroy_from_if_in_state:string ->

     

       178
       +
           unit ->

     

       179
       +
           'a t

     

       180
       +
       end

     

       181
        
       

     

       182
        
       (** Response for /copy methods.

     

       183
        
           ['created_record_info] is the server-set info for the created copy.

     

       184
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.4> RFC 8620, Section 5.4 *)

     

       185
       +
       module Copy_response : sig

     

       186
       +
         type 'created_record_info t

     

       187
       +
         

     

       188
       +
         val from_account_id : 'a t -> id

     

       189
       +
         val account_id : 'a t -> id

     

       190
       +
         val old_state : 'a t -> string option

     

       191
       +
         val new_state : 'a t -> string

     

       192
       +
         val created : 'a t -> 'a id_map option

     

       193
       +
         val not_created : 'a t -> Set_error.t id_map option

     

       194
       +
         

     

       195
       +
         val v :

     

       196
       +
           from_account_id:id ->

     

       197
       +
           account_id:id ->

     

       198
       +
           ?old_state:string ->

     

       199
       +
           new_state:string ->

     

       200
       +
           ?created:'a id_map ->

     

       201
       +
           ?not_created:Set_error.t id_map ->

     

       202
       +
           unit ->

     

       203
       +
           'a t

     

       204
       +
       end

     

       205
        
       

     

       206
       +
       (** Module for filter types.

     

       207
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.5> RFC 8620, Section 5.5 *)

     

       208
       +
       module Filter : sig

     

       209
       +
         type t

     

       210
       +
         

     

       211
       +
         (** Create a filter from a condition (raw JSON) *)

     

       212
       +
         val condition : Yojson.Safe.t -> t

     

       213
       +
         

     

       214
       +
         (** Create a filter from a logical operator and a list of filters *)

     

       215
       +
         val operator : [ `AND | `OR | `NOT ] -> t list -> t

     

       216
       +
       end

     

       0
        
       
     

       0
        
       
     

       217
        
       

     

       218
        
       (** Comparator for sorting.

     

       219
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.5> RFC 8620, Section 5.5 *)

     

       220
       +
       module Comparator : sig

     

       221
       +
         type t

     

       222
       +
         

     

       223
       +
         val property : t -> string

     

       224
       +
         val is_ascending : t -> bool option

     

       225
       +
         val collation : t -> string option

     

       226
       +
         val keyword : t -> string option

     

       227
       +
         val other_fields : t -> Yojson.Safe.t string_map

     

       228
       +
         

     

       229
       +
         val v :

     

       230
       +
           property:string ->

     

       231
       +
           ?is_ascending:bool ->

     

       232
       +
           ?collation:string ->

     

       233
       +
           ?keyword:string ->

     

       234
       +
           ?other_fields:Yojson.Safe.t string_map ->

     

       235
       +
           unit ->

     

       236
       +
           t

     

       237
       +
       end

     

       238
        
       

     

       239
        
       (** Arguments for /query methods.

     

       240
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.5> RFC 8620, Section 5.5 *)

     

       241
       +
       module Query_args : sig

     

       242
       +
         type t

     

       243
       +
         

     

       244
       +
         val account_id : t -> id

     

       245
       +
         val filter : t -> Filter.t option

     

       246
       +
         val sort : t -> Comparator.t list option

     

       247
       +
         val position : t -> jint option

     

       248
       +
         val anchor : t -> id option

     

       249
       +
         val anchor_offset : t -> jint option

     

       250
       +
         val limit : t -> uint option

     

       251
       +
         val calculate_total : t -> bool option

     

       252
       +
         val collapse_threads : t -> bool option

     

       253
       +
         val sort_as_tree : t -> bool option

     

       254
       +
         val filter_as_tree : t -> bool option

     

       255
       +
         

     

       256
       +
         val v :

     

       257
       +
           account_id:id ->

     

       258
       +
           ?filter:Filter.t ->

     

       259
       +
           ?sort:Comparator.t list ->

     

       260
       +
           ?position:jint ->

     

       261
       +
           ?anchor:id ->

     

       262
       +
           ?anchor_offset:jint ->

     

       263
       +
           ?limit:uint ->

     

       264
       +
           ?calculate_total:bool ->

     

       265
       +
           ?collapse_threads:bool ->

     

       266
       +
           ?sort_as_tree:bool ->

     

       267
       +
           ?filter_as_tree:bool ->

     

       268
       +
           unit ->

     

       269
       +
           t

     

       270
       +
       end

     

       271
        
       

     

       272
        
       (** Response for /query methods.

     

       273
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.5> RFC 8620, Section 5.5 *)

     

       274
       +
       module Query_response : sig

     

       275
       +
         type t

     

       276
       +
         

     

       277
       +
         val account_id : t -> id

     

       278
       +
         val query_state : t -> string

     

       279
       +
         val can_calculate_changes : t -> bool

     

       280
       +
         val position : t -> uint

     

       281
       +
         val ids : t -> id list

     

       282
       +
         val total : t -> uint option

     

       283
       +
         val limit : t -> uint option

     

       284
       +
         

     

       285
       +
         val v :

     

       286
       +
           account_id:id ->

     

       287
       +
           query_state:string ->

     

       288
       +
           can_calculate_changes:bool ->

     

       289
       +
           position:uint ->

     

       290
       +
           ids:id list ->

     

       291
       +
           ?total:uint ->

     

       292
       +
           ?limit:uint ->

     

       293
       +
           unit ->

     

       294
       +
           t

     

       295
       +
       end

     

       296
        
       

     

       297
        
       (** Item indicating an added record in /queryChanges.

     

       298
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.6> RFC 8620, Section 5.6 *)

     

       299
       +
       module Added_item : sig

     

       300
       +
         type t

     

       301
       +
         

     

       302
       +
         val id : t -> id

     

       303
       +
         val index : t -> uint

     

       304
       +
         

     

       305
       +
         val v :

     

       306
       +
           id:id ->

     

       307
       +
           index:uint ->

     

       308
       +
           unit ->

     

       309
       +
           t

     

       310
       +
       end

     

       311
        
       

     

       312
        
       (** Arguments for /queryChanges methods.

     

       313
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.6> RFC 8620, Section 5.6 *)

     

       314
       +
       module Query_changes_args : sig

     

       315
       +
         type t

     

       316
       +
         

     

       317
       +
         val account_id : t -> id

     

       318
       +
         val filter : t -> Filter.t option

     

       319
       +
         val sort : t -> Comparator.t list option

     

       320
       +
         val since_query_state : t -> string

     

       321
       +
         val max_changes : t -> uint option

     

       322
       +
         val up_to_id : t -> id option

     

       323
       +
         val calculate_total : t -> bool option

     

       324
       +
         val collapse_threads : t -> bool option

     

       325
       +
         

     

       326
       +
         val v :

     

       327
       +
           account_id:id ->

     

       328
       +
           ?filter:Filter.t ->

     

       329
       +
           ?sort:Comparator.t list ->

     

       330
       +
           since_query_state:string ->

     

       331
       +
           ?max_changes:uint ->

     

       332
       +
           ?up_to_id:id ->

     

       333
       +
           ?calculate_total:bool ->

     

       334
       +
           ?collapse_threads:bool ->

     

       335
       +
           unit ->

     

       336
       +
           t

     

       337
       +
       end

     

       338
        
       

     

       339
        
       (** Response for /queryChanges methods.

     

       340
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-5.6> RFC 8620, Section 5.6 *)

     

       341
       +
       module Query_changes_response : sig

     

       342
       +
         type t

     

       343
       +
         

     

       344
       +
         val account_id : t -> id

     

       345
       +
         val old_query_state : t -> string

     

       346
       +
         val new_query_state : t -> string

     

       347
       +
         val total : t -> uint option

     

       348
       +
         val removed : t -> id list

     

       349
       +
         val added : t -> Added_item.t list

     

       350
       +
         

     

       351
       +
         val v :

     

       352
       +
           account_id:id ->

     

       353
       +
           old_query_state:string ->

     

       354
       +
           new_query_state:string ->

     

       355
       +
           ?total:uint ->

     

       356
       +
           removed:id list ->

     

       357
       +
           added:Added_item.t list ->

     

       358
       +
           unit ->

     

       359
       +
           t

     

       360
       +
       end

     

       361
        
       

     

       362
        
       (** Core/echo method: Arguments are mirrored in the response.

     

       363
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-4> RFC 8620, Section 4 *)

+174 -60

output/jmap_push.mli

···

       11
        
       

     

       12
        
       (** StateChange object.

     

       13
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.1> RFC 8620, Section 7.1 *)

     

       14
       -
       type state_change = {

     

       15
       -
         (* type field is implicitly "StateChange" *)

     

       16
       -
         changed : type_state id_map;

     

       17
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       18
        
       

     

       19
        
       (** PushSubscription encryption keys.

     

       20
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2> RFC 8620, Section 7.2 *)

     

       21
       -
       type push_encryption_keys = {

     

       22
       -
         p256dh : string; (** P-256 ECDH public key (URL-safe base64) *)

     

       23
       -
         auth : string; (** Authentication secret (URL-safe base64) *)

     

       24
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       25
        
       

     

       26
        
       (** PushSubscription object.

     

       27
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2> RFC 8620, Section 7.2 *)

     

       28
       -
       type push_subscription = {

     

       29
       -
         push_sub_id : id; (** server-set, immutable *)

     

       30
       -
         device_client_id : string; (** immutable *)

     

       31
       -
         url : Uri.t; (** immutable *)

     

       32
       -
         keys : push_encryption_keys option; (** immutable *)

     

       33
       -
         verification_code : string option;

     

       34
       -
         expires : utc_date option;

     

       35
       -
         types : string list option;

     

       36
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       37
        
       

     

       38
        
       (** PushSubscription object for creation (omits server-set fields).

     

       39
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2> RFC 8620, Section 7.2 *)

     

       40
       -
       type push_subscription_create = {

     

       41
       -
         push_sub_create_device_client_id : string;

     

       42
       -
         push_sub_create_url : Uri.t;

     

       43
       -
         push_sub_create_keys : push_encryption_keys option;

     

       44
       -
         push_sub_create_expires : utc_date option;

     

       45
       -
         push_sub_create_types : string list option;

     

       46
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       47
        
       

     

       48
        
       (** PushSubscription object for update patch.

     

       49
        
           Only verification_code and expires can be updated.

     
···

       54
        
       (** Arguments for PushSubscription/get.

     

       55
        
           Extends standard /get args.

     

       56
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.1> RFC 8620, Section 7.2.1 *)

     

       57
       -
       type push_subscription_get_args = {

     

       58
       -
         push_sub_get_ids : id list option;

     

       59
       -
         push_sub_get_properties : string list option;

     

       60
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       61
        
       

     

       62
        
       (** Response for PushSubscription/get.

     

       63
        
           Extends standard /get response.

     

       64
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.1> RFC 8620, Section 7.2.1 *)

     

       65
       -
       type push_subscription_get_response = {

     

       66
       -
         push_sub_get_resp_list : push_subscription list;

     

       67
       -
         push_sub_get_resp_not_found : id list;

     

       68
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       69
        
       

     

       70
        
       (** Arguments for PushSubscription/set.

     

       71
        
           Extends standard /set args.

     

       72
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       73
       -
       type push_subscription_set_args = {

     

       74
       -
         push_sub_set_create : push_subscription_create id_map option;

     

       75
       -
         push_sub_set_update : push_subscription_update id_map option;

     

       76
       -
         push_sub_set_destroy : id list option;

     

       77
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       78
        
       

     

       79
        
       (** Server-set information for created PushSubscription.

     

       80
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       81
       -
       type push_subscription_created_info = {

     

       82
       -
         push_sub_created_id : id;

     

       83
       -
         push_sub_created_expires : utc_date option;

     

       84
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       85
        
       

     

       86
        
       (** Server-set information for updated PushSubscription.

     

       87
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       88
       -
       type push_subscription_updated_info = {

     

       89
       -
          push_sub_updated_expires : utc_date option;

     

       90
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       91
        
       

     

       92
        
       (** Response for PushSubscription/set.

     

       93
        
           Extends standard /set response.

     

       94
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       95
       -
       type push_subscription_set_response = {

     

       96
       -
         push_sub_set_resp_created : push_subscription_created_info id_map option;

     

       97
       -
         push_sub_set_resp_updated : push_subscription_updated_info option id_map option;

     

       98
       -
         push_sub_set_resp_destroyed : id list option;

     

       99
       -
         push_sub_set_resp_not_created : set_error id_map option;

     

       100
       -
         push_sub_set_resp_not_updated : set_error id_map option;

     

       101
       -
         push_sub_set_resp_not_destroyed : set_error id_map option;

     

       102
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       103
        
       

     

       104
        
       (** PushVerification object.

     

       105
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       106
       -
       type push_verification = {

     

       107
       -
         (* type field is implicitly "PushVerification" *)

     

       108
       -
         push_verification_push_subscription_id : id;

     

       109
       -
         push_verification_verification_code : string;

     

       110
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       111
        
       

     

       112
        
       (** Data for EventSource ping event.

     

       113
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.3> RFC 8620, Section 7.3 *)

     

       114
       -
       type event_source_ping_data = {

     

       115
       -
         interval : uint;

     

       116
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0

···

       11
        
       

     

       12
        
       (** StateChange object.

     

       13
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.1> RFC 8620, Section 7.1 *)

     

       14
       +
       module State_change : sig

     

       15
       +
         type t

     

       16
       +
         

     

       17
       +
         val changed : t -> type_state id_map

     

       18
       +
         

     

       19
       +
         val v :

     

       20
       +
           changed:type_state id_map ->

     

       21
       +
           unit ->

     

       22
       +
           t

     

       23
       +
       end

     

       24
        
       

     

       25
        
       (** PushSubscription encryption keys.

     

       26
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2> RFC 8620, Section 7.2 *)

     

       27
       +
       module Push_encryption_keys : sig

     

       28
       +
         type t

     

       29
       +
         

     

       30
       +
         (** P-256 ECDH public key (URL-safe base64) *)

     

       31
       +
         val p256dh : t -> string

     

       32
       +
         

     

       33
       +
         (** Authentication secret (URL-safe base64) *)

     

       34
       +
         val auth : t -> string

     

       35
       +
         

     

       36
       +
         val v :

     

       37
       +
           p256dh:string ->

     

       38
       +
           auth:string ->

     

       39
       +
           unit ->

     

       40
       +
           t

     

       41
       +
       end

     

       42
        
       

     

       43
        
       (** PushSubscription object.

     

       44
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2> RFC 8620, Section 7.2 *)

     

       45
       +
       module Push_subscription : sig

     

       46
       +
         type t

     

       47
       +
         

     

       48
       +
         (** Id of the subscription (server-set, immutable) *)

     

       49
       +
         val id : t -> id

     

       50
       +
         

     

       51
       +
         (** Device client id (immutable) *)

     

       52
       +
         val device_client_id : t -> string

     

       53
       +
         

     

       54
       +
         (** Notification URL (immutable) *)

     

       55
       +
         val url : t -> Uri.t

     

       56
       +
         

     

       57
       +
         (** Encryption keys (immutable) *)

     

       58
       +
         val keys : t -> Push_encryption_keys.t option

     

       59
       +
         val verification_code : t -> string option

     

       60
       +
         val expires : t -> utc_date option

     

       61
       +
         val types : t -> string list option

     

       62
       +
         

     

       63
       +
         val v :

     

       64
       +
           id:id ->

     

       65
       +
           device_client_id:string ->

     

       66
       +
           url:Uri.t ->

     

       67
       +
           ?keys:Push_encryption_keys.t ->

     

       68
       +
           ?verification_code:string ->

     

       69
       +
           ?expires:utc_date ->

     

       70
       +
           ?types:string list ->

     

       71
       +
           unit ->

     

       72
       +
           t

     

       73
       +
       end

     

       74
        
       

     

       75
        
       (** PushSubscription object for creation (omits server-set fields).

     

       76
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2> RFC 8620, Section 7.2 *)

     

       77
       +
       module Push_subscription_create : sig

     

       78
       +
         type t

     

       79
       +
         

     

       80
       +
         val device_client_id : t -> string

     

       81
       +
         val url : t -> Uri.t

     

       82
       +
         val keys : t -> Push_encryption_keys.t option

     

       83
       +
         val expires : t -> utc_date option

     

       84
       +
         val types : t -> string list option

     

       85
       +
         

     

       86
       +
         val v :

     

       87
       +
           device_client_id:string ->

     

       88
       +
           url:Uri.t ->

     

       89
       +
           ?keys:Push_encryption_keys.t ->

     

       90
       +
           ?expires:utc_date ->

     

       91
       +
           ?types:string list ->

     

       92
       +
           unit ->

     

       93
       +
           t

     

       94
       +
       end

     

       95
        
       

     

       96
        
       (** PushSubscription object for update patch.

     

       97
        
           Only verification_code and expires can be updated.

     
···

       102
        
       (** Arguments for PushSubscription/get.

     

       103
        
           Extends standard /get args.

     

       104
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.1> RFC 8620, Section 7.2.1 *)

     

       105
       +
       module Push_subscription_get_args : sig

     

       106
       +
         type t

     

       107
       +
         

     

       108
       +
         val ids : t -> id list option

     

       109
       +
         val properties : t -> string list option

     

       110
       +
         

     

       111
       +
         val v :

     

       112
       +
           ?ids:id list ->

     

       113
       +
           ?properties:string list ->

     

       114
       +
           unit ->

     

       115
       +
           t

     

       116
       +
       end

     

       117
        
       

     

       118
        
       (** Response for PushSubscription/get.

     

       119
        
           Extends standard /get response.

     

       120
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.1> RFC 8620, Section 7.2.1 *)

     

       121
       +
       module Push_subscription_get_response : sig

     

       122
       +
         type t

     

       123
       +
         

     

       124
       +
         val list : t -> Push_subscription.t list

     

       125
       +
         val not_found : t -> id list

     

       126
       +
         

     

       127
       +
         val v :

     

       128
       +
           list:Push_subscription.t list ->

     

       129
       +
           not_found:id list ->

     

       130
       +
           unit ->

     

       131
       +
           t

     

       132
       +
       end

     

       133
        
       

     

       134
        
       (** Arguments for PushSubscription/set.

     

       135
        
           Extends standard /set args.

     

       136
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       137
       +
       module Push_subscription_set_args : sig

     

       138
       +
         type t

     

       139
       +
         

     

       140
       +
         val create : t -> Push_subscription_create.t id_map option

     

       141
       +
         val update : t -> push_subscription_update id_map option

     

       142
       +
         val destroy : t -> id list option

     

       143
       +
         

     

       144
       +
         val v :

     

       145
       +
           ?create:Push_subscription_create.t id_map ->

     

       146
       +
           ?update:push_subscription_update id_map ->

     

       147
       +
           ?destroy:id list ->

     

       148
       +
           unit ->

     

       149
       +
           t

     

       150
       +
       end

     

       151
        
       

     

       152
        
       (** Server-set information for created PushSubscription.

     

       153
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       154
       +
       module Push_subscription_created_info : sig

     

       155
       +
         type t

     

       156
       +
         

     

       157
       +
         val id : t -> id

     

       158
       +
         val expires : t -> utc_date option

     

       159
       +
         

     

       160
       +
         val v :

     

       161
       +
           id:id ->

     

       162
       +
           ?expires:utc_date ->

     

       163
       +
           unit ->

     

       164
       +
           t

     

       165
       +
       end

     

       166
        
       

     

       167
        
       (** Server-set information for updated PushSubscription.

     

       168
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       169
       +
       module Push_subscription_updated_info : sig

     

       170
       +
         type t

     

       171
       +
         

     

       172
       +
         val expires : t -> utc_date option

     

       173
       +
         

     

       174
       +
         val v :

     

       175
       +
           ?expires:utc_date ->

     

       176
       +
           unit ->

     

       177
       +
           t

     

       178
       +
       end

     

       179
        
       

     

       180
        
       (** Response for PushSubscription/set.

     

       181
        
           Extends standard /set response.

     

       182
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       183
       +
       module Push_subscription_set_response : sig

     

       184
       +
         type t

     

       185
       +
         

     

       186
       +
         val created : t -> Push_subscription_created_info.t id_map option

     

       187
       +
         val updated : t -> Push_subscription_updated_info.t option id_map option

     

       188
       +
         val destroyed : t -> id list option

     

       189
       +
         val not_created : t -> Set_error.t id_map option

     

       190
       +
         val not_updated : t -> Set_error.t id_map option

     

       191
       +
         val not_destroyed : t -> Set_error.t id_map option

     

       192
       +
         

     

       193
       +
         val v :

     

       194
       +
           ?created:Push_subscription_created_info.t id_map ->

     

       195
       +
           ?updated:Push_subscription_updated_info.t option id_map ->

     

       196
       +
           ?destroyed:id list ->

     

       197
       +
           ?not_created:Set_error.t id_map ->

     

       198
       +
           ?not_updated:Set_error.t id_map ->

     

       199
       +
           ?not_destroyed:Set_error.t id_map ->

     

       200
       +
           unit ->

     

       201
       +
           t

     

       202
       +
       end

     

       203
        
       

     

       204
        
       (** PushVerification object.

     

       205
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.2.2> RFC 8620, Section 7.2.2 *)

     

       206
       +
       module Push_verification : sig

     

       207
       +
         type t

     

       208
       +
         

     

       209
       +
         val push_subscription_id : t -> id

     

       210
       +
         val verification_code : t -> string

     

       211
       +
         

     

       212
       +
         val v :

     

       213
       +
           push_subscription_id:id ->

     

       214
       +
           verification_code:string ->

     

       215
       +
           unit ->

     

       216
       +
           t

     

       217
       +
       end

     

       218
        
       

     

       219
        
       (** Data for EventSource ping event.

     

       220
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-7.3> RFC 8620, Section 7.3 *)

     

       221
       +
       module Event_source_ping_data : sig

     

       222
       +
         type t

     

       223
       +
         

     

       224
       +
         val interval : t -> uint

     

       225
       +
         

     

       226
       +
         val v :

     

       227
       +
           interval:uint ->

     

       228
       +
           unit ->

     

       229
       +
           t

     

       230
       +
       end

+21 -15

output/jmap_search_snippet.mli

···

       7
        
       (** SearchSnippet object.

     

       8
        
           Note: Does not have an 'id' property.

     

       9
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-5> RFC 8621, Section 5 *)

     

       10
       -
       type search_snippet = {

     

       11
       -
         snippet_email_id : id;

     

       12
       -
         snippet_subject : string option;

     

       13
       -
         snippet_preview : string option;

     

       14
       -
       }

     

       0
        
       
     

       0
        
       
     

       15
        
       

     

       16
        
       (** SearchSnippet/get: Args type.

     

       17
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-5.1> RFC 8621, Section 5.1 *)

     

       18
       -
       type search_snippet_get_args = {

     

       19
       -
         snippet_get_account_id : id;

     

       20
       -
         snippet_get_filter : filter option;

     

       21
       -
         snippet_get_email_ids : id list;

     

       22
       -
       }

     

       0
        
       
     

       0
        
       
     

       23
        
       

     

       24
        
       (** SearchSnippet/get: Response type.

     

       25
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-5.1> RFC 8621, Section 5.1 *)

     

       26
       -
       type search_snippet_get_response = {

     

       27
       -
         snippet_get_resp_account_id : id;

     

       28
       -
         snippet_get_resp_list : search_snippet list;

     

       29
       -
         snippet_get_resp_not_found : id list option;

     

       30
       -
       }
     

       0
        
       
     

       0

···

       7
        
       (** SearchSnippet object.

     

       8
        
           Note: Does not have an 'id' property.

     

       9
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-5> RFC 8621, Section 5 *)

     

       10
       +
       module Search_snippet : sig

     

       11
       +
         type t = {

     

       12
       +
           snippet_email_id : id;

     

       13
       +
           snippet_subject : string option;

     

       14
       +
           snippet_preview : string option;

     

       15
       +
         }

     

       16
       +
       end

     

       17
        
       

     

       18
        
       (** SearchSnippet/get: Args type.

     

       19
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-5.1> RFC 8621, Section 5.1 *)

     

       20
       +
       module Search_snippet_get_args : sig

     

       21
       +
         type t = {

     

       22
       +
           snippet_get_account_id : id;

     

       23
       +
           snippet_get_filter : Filter.t option;

     

       24
       +
           snippet_get_email_ids : id list;

     

       25
       +
         }

     

       26
       +
       end

     

       27
        
       

     

       28
        
       (** SearchSnippet/get: Response type.

     

       29
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-5.1> RFC 8621, Section 5.1 *)

     

       30
       +
       module Search_snippet_get_response : sig

     

       31
       +
         type t = {

     

       32
       +
           snippet_get_resp_account_id : id;

     

       33
       +
           snippet_get_resp_list : Search_snippet.t list;

     

       34
       +
           snippet_get_resp_not_found : id list option;

     

       35
       +
         }

     

       36
       +
       end

+73 -34

output/jmap_session.mli

···

       3
        
       

     

       4
        
       open Jmap_types

     

       5
        
       

     

       6
       -
       (** Core capability information.

     

       7
       -
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       8
       -
       type core_capability = {

     

       9
       -
         max_size_upload : uint;

     

       10
       -
         max_concurrent_upload : uint;

     

       11
       -
         max_size_request : uint;

     

       12
       -
         max_concurrent_requests : uint;

     

       13
       -
         max_calls_in_request : uint;

     

       14
       -
         max_objects_in_get : uint;

     

       15
       -
         max_objects_in_set : uint;

     

       16
       -
         collation_algorithms : string list;

     

       17
       -
       }

     

       18
       -
       

     

       19
        
       (** Account capability information.

     

       20
        
           The value is capability-specific.

     

       21
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       22
        
       type account_capability_value = Yojson.Safe.t

     

       23
        
       

     

       24
       -
       (** An Account object.

     

       25
       -
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       26
       -
       type account = {

     

       27
       -
         acc_name : string;

     

       28
       -
         is_personal : bool;

     

       29
       -
         is_read_only : bool;

     

       30
       -
         account_capabilities : account_capability_value string_map;

     

       31
       -
       }

     

       32
       -
       

     

       33
        
       (** Server capability information.

     

       34
        
           The value is capability-specific.

     

       35
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       36
        
       type server_capability_value = Yojson.Safe.t

     

       37
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       38
        
       (** The Session object.

     

       39
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       40
       -
       type session = {

     

       41
       -
         capabilities : server_capability_value string_map;

     

       42
       -
         accounts : account id_map;

     

       43
       -
         primary_accounts : id string_map;

     

       44
       -
         username : string;

     

       45
       -
         api_url : Uri.t;

     

       46
       -
         download_url : Uri.t; (** Must be a Level 1 URI Template *) 

     

       47
       -
         upload_url : Uri.t; (** Must be a Level 1 URI Template *)

     

       48
       -
         event_source_url : Uri.t; (** Must be a Level 1 URI Template *)

     

       49
       -
         state : string;

     

       50
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       51
        
       

     

       52
        
       (** Function to perform service autodiscovery.

     

       53
        
           Returns the session URL if found.

     
···

       56
        
       

     

       57
        
       (** Function to fetch the session object from a given URL.

     

       58
        
           Requires authentication handling (details TBD/outside this signature). *)

     

       59
       -
       val get_session : url:Uri.t -> session

···

       3
        
       

     

       4
        
       open Jmap_types

     

       5
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       6
        
       (** Account capability information.

     

       7
        
           The value is capability-specific.

     

       8
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       9
        
       type account_capability_value = Yojson.Safe.t

     

       10
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       11
        
       (** Server capability information.

     

       12
        
           The value is capability-specific.

     

       13
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       14
        
       type server_capability_value = Yojson.Safe.t

     

       15
        
       

     

       16
       +
       (** Core capability information.

     

       17
       +
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       18
       +
       module Core_capability : sig

     

       19
       +
         type t

     

       20
       +
         

     

       21
       +
         val max_size_upload : t -> uint

     

       22
       +
         val max_concurrent_upload : t -> uint

     

       23
       +
         val max_size_request : t -> uint

     

       24
       +
         val max_concurrent_requests : t -> uint

     

       25
       +
         val max_calls_in_request : t -> uint

     

       26
       +
         val max_objects_in_get : t -> uint

     

       27
       +
         val max_objects_in_set : t -> uint

     

       28
       +
         val collation_algorithms : t -> string list

     

       29
       +
         

     

       30
       +
         val v :

     

       31
       +
           max_size_upload:uint ->

     

       32
       +
           max_concurrent_upload:uint ->

     

       33
       +
           max_size_request:uint ->

     

       34
       +
           max_concurrent_requests:uint ->

     

       35
       +
           max_calls_in_request:uint ->

     

       36
       +
           max_objects_in_get:uint ->

     

       37
       +
           max_objects_in_set:uint ->

     

       38
       +
           collation_algorithms:string list ->

     

       39
       +
           unit ->

     

       40
       +
           t

     

       41
       +
       end

     

       42
       +
       

     

       43
       +
       (** An Account object.

     

       44
       +
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       45
       +
       module Account : sig

     

       46
       +
         type t

     

       47
       +
         

     

       48
       +
         val name : t -> string

     

       49
       +
         val is_personal : t -> bool

     

       50
       +
         val is_read_only : t -> bool

     

       51
       +
         val account_capabilities : t -> account_capability_value string_map

     

       52
       +
         

     

       53
       +
         val v :

     

       54
       +
           name:string ->

     

       55
       +
           ?is_personal:bool ->

     

       56
       +
           ?is_read_only:bool ->

     

       57
       +
           ?account_capabilities:account_capability_value string_map ->

     

       58
       +
           unit ->

     

       59
       +
           t

     

       60
       +
       end

     

       61
       +
       

     

       62
        
       (** The Session object.

     

       63
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-2> RFC 8620, Section 2 *)

     

       64
       +
       module Session : sig

     

       65
       +
         type t

     

       66
       +
         

     

       67
       +
         val capabilities : t -> server_capability_value string_map

     

       68
       +
         val accounts : t -> Account.t id_map

     

       69
       +
         val primary_accounts : t -> id string_map

     

       70
       +
         val username : t -> string

     

       71
       +
         val api_url : t -> Uri.t

     

       72
       +
         val download_url : t -> Uri.t

     

       73
       +
         val upload_url : t -> Uri.t

     

       74
       +
         val event_source_url : t -> Uri.t

     

       75
       +
         val state : t -> string

     

       76
       +
         

     

       77
       +
         val v :

     

       78
       +
           capabilities:server_capability_value string_map ->

     

       79
       +
           accounts:Account.t id_map ->

     

       80
       +
           primary_accounts:id string_map ->

     

       81
       +
           username:string ->

     

       82
       +
           api_url:Uri.t ->

     

       83
       +
           download_url:Uri.t ->

     

       84
       +
           upload_url:Uri.t ->

     

       85
       +
           event_source_url:Uri.t ->

     

       86
       +
           state:string ->

     

       87
       +
           unit ->

     

       88
       +
           t

     

       89
       +
       end

     

       90
        
       

     

       91
        
       (** Function to perform service autodiscovery.

     

       92
        
           Returns the session URL if found.

     
···

       95
        
       

     

       96
        
       (** Function to fetch the session object from a given URL.

     

       97
        
           Requires authentication handling (details TBD/outside this signature). *)

     

       98
       +
       val get_session : url:Uri.t -> Session.t

+36 -18

output/jmap_submission.mli

···

       78
        
         filter_after : utc_date option;

     

       79
        
       }

     

       80
        
       

     

       81
       -
       (** EmailSubmission/get: Args type (specialized from ['record get_args]). *)

     

       82
       -
       type email_submission_get_args = email_submission get_args

     

       0
        
       
     

       0
        
       
     

       83
        
       

     

       84
       -
       (** EmailSubmission/get: Response type (specialized from ['record get_response]). *)

     

       85
       -
       type email_submission_get_response = email_submission get_response

     

       0
        
       
     

       0
        
       
     

       86
        
       

     

       87
       -
       (** EmailSubmission/changes: Args type (specialized from [changes_args]). *)

     

       88
       -
       type email_submission_changes_args = changes_args

     

       0
        
       
     

       0
        
       
     

       89
        
       

     

       90
       -
       (** EmailSubmission/changes: Response type (specialized from [changes_response]). *)

     

       91
       -
       type email_submission_changes_response = changes_response

     

       0
        
       
     

       0
        
       
     

       92
        
       

     

       93
       -
       (** EmailSubmission/query: Args type (specialized from [query_args]). *)

     

       94
       -
       type email_submission_query_args = query_args

     

       0
        
       
     

       0
        
       
     

       95
        
       

     

       96
       -
       (** EmailSubmission/query: Response type (specialized from [query_response]). *)

     

       97
       -
       type email_submission_query_response = query_response

     

       0
        
       
     

       0
        
       
     

       98
        
       

     

       99
       -
       (** EmailSubmission/queryChanges: Args type (specialized from [query_changes_args]). *)

     

       100
       -
       type email_submission_query_changes_args = query_changes_args

     

       0
        
       
     

       0
        
       
     

       101
        
       

     

       102
       -
       (** EmailSubmission/queryChanges: Response type (specialized from [query_changes_response]). *)

     

       103
       -
       type email_submission_query_changes_response = query_changes_response

     

       0
        
       
     

       0
        
       
     

       104
        
       

     

       105
        
       (** EmailSubmission/set: Args type (specialized from [('c, 'u) set_args]).

     

       106
        
           Includes onSuccess arguments.

     
···

       114
        
         set_on_success_destroy_email : id list option;

     

       115
        
       }

     

       116
        
       

     

       117
       -
       (** EmailSubmission/set: Response type (specialized from [('c, 'u) set_response]). *)

     

       118
       -
       type email_submission_set_response = (email_submission_created_info, email_submission_updated_info) set_response

     

       0
        
       
     

       0

···

       78
        
         filter_after : utc_date option;

     

       79
        
       }

     

       80
        
       

     

       81
       +
       (** EmailSubmission/get: Args type (specialized from ['record Get_args.t]). *)

     

       82
       +
       module Email_submission_get_args : sig

     

       83
       +
         type t = email_submission Get_args.t

     

       84
       +
       end

     

       85
        
       

     

       86
       +
       (** EmailSubmission/get: Response type (specialized from ['record Get_response.t]). *)

     

       87
       +
       module Email_submission_get_response : sig

     

       88
       +
         type t = email_submission Get_response.t

     

       89
       +
       end

     

       90
        
       

     

       91
       +
       (** EmailSubmission/changes: Args type (specialized from [Changes_args.t]). *)

     

       92
       +
       module Email_submission_changes_args : sig

     

       93
       +
         type t = Changes_args.t

     

       94
       +
       end

     

       95
        
       

     

       96
       +
       (** EmailSubmission/changes: Response type (specialized from [Changes_response.t]). *)

     

       97
       +
       module Email_submission_changes_response : sig

     

       98
       +
         type t = Changes_response.t

     

       99
       +
       end

     

       100
        
       

     

       101
       +
       (** EmailSubmission/query: Args type (specialized from [Query_args.t]). *)

     

       102
       +
       module Email_submission_query_args : sig

     

       103
       +
         type t = Query_args.t

     

       104
       +
       end

     

       105
        
       

     

       106
       +
       (** EmailSubmission/query: Response type (specialized from [Query_response.t]). *)

     

       107
       +
       module Email_submission_query_response : sig

     

       108
       +
         type t = Query_response.t

     

       109
       +
       end

     

       110
        
       

     

       111
       +
       (** EmailSubmission/queryChanges: Args type (specialized from [Query_changes_args.t]). *)

     

       112
       +
       module Email_submission_query_changes_args : sig

     

       113
       +
         type t = Query_changes_args.t

     

       114
       +
       end

     

       115
        
       

     

       116
       +
       (** EmailSubmission/queryChanges: Response type (specialized from [Query_changes_response.t]). *)

     

       117
       +
       module Email_submission_query_changes_response : sig

     

       118
       +
         type t = Query_changes_response.t

     

       119
       +
       end

     

       120
        
       

     

       121
        
       (** EmailSubmission/set: Args type (specialized from [('c, 'u) set_args]).

     

       122
        
           Includes onSuccess arguments.

     
···

       130
        
         set_on_success_destroy_email : id list option;

     

       131
        
       }

     

       132
        
       

     

       133
       +
       (** EmailSubmission/set: Response type (specialized from [('c, 'u) Set_response.t]). *)

     

       134
       +
       module Email_submission_set_response : sig

     

       135
       +
         type t = (email_submission_created_info, email_submission_updated_info) Set_response.t

     

       136
       +
       end

+24 -12

output/jmap_thread.mli

···

       6
        
       

     

       7
        
       (** Thread object.

     

       8
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-3> RFC 8621, Section 3 *)

     

       9
       -
       type thread = {

     

       10
       -
         thread_id : id; (** immutable, server-set *)

     

       11
       -
         email_ids : id list; (** server-set *)

     

       12
       -
       }

     

       13
        
       

     

       14
       -
       (** Thread/get: Args type (specialized from ['record get_args]). *)

     

       15
       -
       type thread_get_args = thread get_args

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       16
        
       

     

       17
       -
       (** Thread/get: Response type (specialized from ['record get_response]). *)

     

       18
       -
       type thread_get_response = thread get_response

     

       0
        
       
     

       0
        
       
     

       19
        
       

     

       20
       -
       (** Thread/changes: Args type (specialized from [changes_args]). *)

     

       21
       -
       type thread_changes_args = changes_args

     

       0
        
       
     

       0
        
       
     

       22
        
       

     

       23
       -
       (** Thread/changes: Response type (specialized from [changes_response]). *)

     

       24
       -
       type thread_changes_response = changes_response
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0

···

       6
        
       

     

       7
        
       (** Thread object.

     

       8
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-3> RFC 8621, Section 3 *)

     

       9
       +
       module Thread : sig

     

       10
       +
         type t

     

       0
        
       
     

       0
        
       
     

       11
        
       

     

       12
       +
         val id : t -> id

     

       13
       +
         val email_ids : t -> id list

     

       14
       +
         

     

       15
       +
         val v : id:id -> email_ids:id list -> t

     

       16
       +
       end

     

       17
        
       

     

       18
       +
       (** Thread/get: Args type (specialized from ['record Get_args.t]). *)

     

       19
       +
       module Thread_get_args : sig

     

       20
       +
         type t = Thread.t Get_args.t

     

       21
       +
       end

     

       22
        
       

     

       23
       +
       (** Thread/get: Response type (specialized from ['record Get_response.t]). *)

     

       24
       +
       module Thread_get_response : sig

     

       25
       +
         type t = Thread.t Get_response.t

     

       26
       +
       end

     

       27
        
       

     

       28
       +
       (** Thread/changes: Args type (specialized from [Changes_args.t]). *)

     

       29
       +
       module Thread_changes_args : sig

     

       30
       +
         type t = Changes_args.t

     

       31
       +
       end

     

       32
       +
       

     

       33
       +
       (** Thread/changes: Response type (specialized from [Changes_response.t]). *)

     

       34
       +
       module Thread_changes_response : sig

     

       35
       +
         type t = Changes_response.t

     

       36
       +
       end

+5 -5

output/jmap_unix.mli

···

       16
        
       type event_source_connection

     

       17
        
       

     

       18
        
       (** Exception raised for JMAP communication errors. *)

     

       19
       -
       exception Jmap_error of Jmap_error.problem_details

     

       20
        
       

     

       21
        
       (** Connect to a JMAP server and retrieve the session.

     

       22
        
           This handles discovery (if needed) and authentication (mechanism TBD).

     
···

       32
        
         host:string -> 

     

       33
        
         ?port:int -> 

     

       34
        
         credentials:'a -> 

     

       35
       -
         (context * session)

     

       36
        
       

     

       37
        
       (** Perform a JMAP API request.

     

       38
        
           @param ctx The connection context.

     

       39
        
           @param request The JMAP request object.

     

       40
        
       *)

     

       41
       -
       val request : context -> request -> response

     

       42
        
       

     

       43
        
       (** Upload binary data.

     

       44
        
           @param ctx The connection context.

     
···

       51
        
         account_id:id -> 

     

       52
        
         content_type:string -> 

     

       53
        
         data_stream:string Seq.t -> 

     

       54
       -
         Jmap_binary.upload_response

     

       55
        
       

     

       56
        
       (** Download binary data.

     

       57
        
           @param ctx The connection context.

     
···

       82
        
         ?close_after:[`State | `No] -> 

     

       83
        
         ?ping:uint ->

     

       84
        
         (event_source_connection * 

     

       85
       -
          ([`State of state_change | `Ping of event_source_ping_data ] Seq.t))

     

       86
        
       

     

       87
        
       (** Close an EventSource connection.

     

       88
        
           @param conn The EventSource connection handle.

···

       16
        
       type event_source_connection

     

       17
        
       

     

       18
        
       (** Exception raised for JMAP communication errors. *)

     

       19
       +
       exception Jmap_error of Jmap_error.Problem_details.t

     

       20
        
       

     

       21
        
       (** Connect to a JMAP server and retrieve the session.

     

       22
        
           This handles discovery (if needed) and authentication (mechanism TBD).

     
···

       32
        
         host:string -> 

     

       33
        
         ?port:int -> 

     

       34
        
         credentials:'a -> 

     

       35
       +
         (context * Session.t)

     

       36
        
       

     

       37
        
       (** Perform a JMAP API request.

     

       38
        
           @param ctx The connection context.

     

       39
        
           @param request The JMAP request object.

     

       40
        
       *)

     

       41
       +
       val request : context -> Request.t -> Response.t

     

       42
        
       

     

       43
        
       (** Upload binary data.

     

       44
        
           @param ctx The connection context.

     
···

       51
        
         account_id:id -> 

     

       52
        
         content_type:string -> 

     

       53
        
         data_stream:string Seq.t -> 

     

       54
       +
         Jmap_binary.Upload_response.t

     

       55
        
       

     

       56
        
       (** Download binary data.

     

       57
        
           @param ctx The connection context.

     
···

       82
        
         ?close_after:[`State | `No] -> 

     

       83
        
         ?ping:uint ->

     

       84
        
         (event_source_connection * 

     

       85
       +
          ([`State of State_change.t | `Ping of Event_source_ping_data.t ] Seq.t))

     

       86
        
       

     

       87
        
       (** Close an EventSource connection.

     

       88
        
           @param conn The EventSource connection handle.

+76 -23

output/jmap_vacation.mli

···

       8
        
       (** VacationResponse object.

     

       9
        
           Note: id is always "singleton".

     

       10
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-8> RFC 8621, Section 8 *)

     

       11
       -
       type vacation_response_obj = {

     

       12
       -
         vacation_id : id; (** immutable, server-set, MUST be "singleton" *)

     

       13
       -
         is_enabled : bool;

     

       14
       -
         from_date : utc_date option;

     

       15
       -
         to_date : utc_date option;

     

       16
       -
         subject : string option;

     

       17
       -
         text_body : string option;

     

       18
       -
         html_body : string option;

     

       19
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       20
        
       

     

       21
        
       (** VacationResponse object for update.

     

       22
        
           Patch object, specific structure not enforced here.

     
···

       24
        
       type vacation_response_update = patch_object

     

       25
        
       

     

       26
        
       (** VacationResponse/get: Args type (specialized from ['record get_args]). *)

     

       27
       -
       type vacation_response_get_args = vacation_response_obj get_args

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       28
        
       

     

       29
        
       (** VacationResponse/get: Response type (specialized from ['record get_response]). *)

     

       30
       -
       type vacation_response_get_response = vacation_response_obj get_response

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       31
        
       

     

       32
        
       (** VacationResponse/set: Args type.

     

       33
        
           Only allows update, id must be "singleton".

     

       34
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-8.2> RFC 8621, Section 8.2 *)

     

       35
       -
       type vacation_response_set_args = {

     

       36
       -
         set_account_id : id;

     

       37
       -
         set_if_in_state : string option;

     

       38
       -
         set_update : vacation_response_update id_map option;

     

       39
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       40
        
       

     

       41
        
       (** VacationResponse/set: Response type.

     

       42
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-8.2> RFC 8621, Section 8.2 *)

     

       43
       -
       type vacation_response_set_response = {

     

       44
       -
         set_resp_account_id : id;

     

       45
       -
         set_resp_old_state : string option;

     

       46
       -
         set_resp_new_state : string;

     

       47
       -
         set_resp_updated : vacation_response_obj option id_map option;

     

       48
       -
         set_resp_not_updated : set_error id_map option;

     

       49
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0

···

       8
        
       (** VacationResponse object.

     

       9
        
           Note: id is always "singleton".

     

       10
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-8> RFC 8621, Section 8 *)

     

       11
       +
       module Vacation_response : sig

     

       12
       +
         type t

     

       13
       +
         

     

       14
       +
         (** Id of the vacation response (immutable, server-set, MUST be "singleton") *)

     

       15
       +
         val id : t -> id

     

       16
       +
         val is_enabled : t -> bool

     

       17
       +
         val from_date : t -> utc_date option

     

       18
       +
         val to_date : t -> utc_date option

     

       19
       +
         val subject : t -> string option

     

       20
       +
         val text_body : t -> string option

     

       21
       +
         val html_body : t -> string option

     

       22
       +
         

     

       23
       +
         val v :

     

       24
       +
           id:id ->

     

       25
       +
           is_enabled:bool ->

     

       26
       +
           ?from_date:utc_date ->

     

       27
       +
           ?to_date:utc_date ->

     

       28
       +
           ?subject:string ->

     

       29
       +
           ?text_body:string ->

     

       30
       +
           ?html_body:string ->

     

       31
       +
           unit ->

     

       32
       +
           t

     

       33
       +
       end

     

       34
        
       

     

       35
        
       (** VacationResponse object for update.

     

       36
        
           Patch object, specific structure not enforced here.

     
···

       38
        
       type vacation_response_update = patch_object

     

       39
        
       

     

       40
        
       (** VacationResponse/get: Args type (specialized from ['record get_args]). *)

     

       41
       +
       module Vacation_response_get_args : sig

     

       42
       +
         type t = Vacation_response.t Get_args.t

     

       43
       +
         

     

       44
       +
         val v :

     

       45
       +
           account_id:id ->

     

       46
       +
           ?ids:id list ->

     

       47
       +
           ?properties:string list ->

     

       48
       +
           unit ->

     

       49
       +
           t

     

       50
       +
       end

     

       51
        
       

     

       52
        
       (** VacationResponse/get: Response type (specialized from ['record get_response]). *)

     

       53
       +
       module Vacation_response_get_response : sig 

     

       54
       +
         type t = Vacation_response.t Get_response.t

     

       55
       +
         

     

       56
       +
         val v :

     

       57
       +
           account_id:id ->

     

       58
       +
           state:string ->

     

       59
       +
           list:Vacation_response.t list ->

     

       60
       +
           not_found:id list ->

     

       61
       +
           unit ->

     

       62
       +
           t

     

       63
       +
       end

     

       64
        
       

     

       65
        
       (** VacationResponse/set: Args type.

     

       66
        
           Only allows update, id must be "singleton".

     

       67
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-8.2> RFC 8621, Section 8.2 *)

     

       68
       +
       module Vacation_response_set_args : sig

     

       69
       +
         type t

     

       70
       +
         

     

       71
       +
         val account_id : t -> id

     

       72
       +
         val if_in_state : t -> string option

     

       73
       +
         val update : t -> vacation_response_update id_map option

     

       74
       +
         

     

       75
       +
         val v :

     

       76
       +
           account_id:id ->

     

       77
       +
           ?if_in_state:string ->

     

       78
       +
           ?update:vacation_response_update id_map ->

     

       79
       +
           unit ->

     

       80
       +
           t

     

       81
       +
       end

     

       82
        
       

     

       83
        
       (** VacationResponse/set: Response type.

     

       84
        
           @see <https://www.rfc-editor.org/rfc/rfc8621.html#section-8.2> RFC 8621, Section 8.2 *)

     

       85
       +
       module Vacation_response_set_response : sig

     

       86
       +
         type t

     

       87
       +
         

     

       88
       +
         val account_id : t -> id

     

       89
       +
         val old_state : t -> string option

     

       90
       +
         val new_state : t -> string

     

       91
       +
         val updated : t -> Vacation_response.t option id_map option

     

       92
       +
         val not_updated : t -> Set_error.t id_map option

     

       93
       +
         

     

       94
       +
         val v :

     

       95
       +
           account_id:id ->

     

       96
       +
           ?old_state:string ->

     

       97
       +
           new_state:string ->

     

       98
       +
           ?updated:Vacation_response.t option id_map ->

     

       99
       +
           ?not_updated:Set_error.t id_map ->

     

       100
       +
           unit ->

     

       101
       +
           t

     

       102
       +
       end

+63 -27

output/jmap_wire.mli

···

       5
        
       

     

       6
        
       (** An invocation tuple within a request or response.

     

       7
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.2> RFC 8620, Section 3.2 *)

     

       8
       -
       type invocation = {

     

       9
       -
         method_name : string;

     

       10
       -
         arguments : Yojson.Safe.t;

     

       11
       -
         method_call_id : string;

     

       12
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       13
        
       

     

       14
        
       (** A reference to a previous method call's result.

     

       15
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.7> RFC 8620, Section 3.7 *)

     

       16
       -
       type result_reference = {

     

       17
       -
         result_of : string; (** The method call id of the previous call *)

     

       18
       -
         name : string; (** The required response name *)

     

       19
       -
         path : json_pointer; (** JSON Pointer path *)

     

       20
       -
       }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       21
        
       

     

       22
        
       (** The Request object.

     

       23
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.3> RFC 8620, Section 3.3 *)

     

       24
       -
       type request = {

     

       25
       -
         using : string list;

     

       26
       -
         method_calls : invocation list;

     

       27
       -
         created_ids : id id_map option;

     

       28
       -
       }

     

       29
       -
       

     

       30
       -
       (** A response invocation part, which can be a standard response or an error.

     

       31
       -
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.4> RFC 8620, Section 3.4

     

       32
       -
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.2> RFC 8620, Section 3.6.2 *)

     

       33
       -
       type response_invocation =

     

       34
       -
         | Response of invocation

     

       35
       -
         | Error of method_error * string (* string is the method_call_id *)

     

       0
        
       
     

       0
        
       
     

       36
        
       

     

       37
        
       (** The Response object.

     

       38
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.4> RFC 8620, Section 3.4 *)

     

       39
       -
       type response = {

     

       40
       -
         method_responses : response_invocation list;

     

       41
       -
         created_ids : id id_map option;

     

       42
       -
         session_state : string;

     

       43
       -
       }
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0

···

       5
        
       

     

       6
        
       (** An invocation tuple within a request or response.

     

       7
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.2> RFC 8620, Section 3.2 *)

     

       8
       +
       module Invocation : sig

     

       9
       +
         type t

     

       10
       +
         

     

       11
       +
         val method_name : t -> string

     

       12
       +
         val arguments : t -> Yojson.Safe.t

     

       13
       +
         val method_call_id : t -> string

     

       14
       +
         

     

       15
       +
         val v : 

     

       16
       +
           ?arguments:Yojson.Safe.t ->

     

       17
       +
           method_name:string ->

     

       18
       +
           method_call_id:string ->

     

       19
       +
           unit ->

     

       20
       +
           t

     

       21
       +
       end

     

       22
       +
       

     

       23
       +
       (** A response invocation part, which can be a standard response or an error.

     

       24
       +
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.4> RFC 8620, Section 3.4

     

       25
       +
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.6.2> RFC 8620, Section 3.6.2 *)

     

       26
       +
       type response_invocation =

     

       27
       +
         | Response of Invocation.t

     

       28
       +
         | Error of Method_error.t * string (* string is the method_call_id *)

     

       29
        
       

     

       30
        
       (** A reference to a previous method call's result.

     

       31
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.7> RFC 8620, Section 3.7 *)

     

       32
       +
       module Result_reference : sig

     

       33
       +
         type t

     

       34
       +
         

     

       35
       +
         val result_of : t -> string

     

       36
       +
         val name : t -> string

     

       37
       +
         val path : t -> json_pointer

     

       38
       +
         

     

       39
       +
         val v :

     

       40
       +
           result_of:string ->

     

       41
       +
           name:string ->

     

       42
       +
           path:json_pointer ->

     

       43
       +
           unit ->

     

       44
       +
           t

     

       45
       +
       end

     

       46
        
       

     

       47
        
       (** The Request object.

     

       48
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.3> RFC 8620, Section 3.3 *)

     

       49
       +
       module Request : sig

     

       50
       +
         type t

     

       51
       +
         

     

       52
       +
         val using : t -> string list

     

       53
       +
         val method_calls : t -> Invocation.t list

     

       54
       +
         val created_ids : t -> id id_map option

     

       55
       +
         

     

       56
       +
         val v :

     

       57
       +
           using:string list ->

     

       58
       +
           method_calls:Invocation.t list ->

     

       59
       +
           ?created_ids:id id_map ->

     

       60
       +
           unit ->

     

       61
       +
           t

     

       62
       +
       end

     

       63
        
       

     

       64
        
       (** The Response object.

     

       65
        
           @see <https://www.rfc-editor.org/rfc/rfc8620.html#section-3.4> RFC 8620, Section 3.4 *)

     

       66
       +
       module Response : sig

     

       67
       +
         type t

     

       68
       +
         

     

       69
       +
         val method_responses : t -> response_invocation list

     

       70
       +
         val created_ids : t -> id id_map option

     

       71
       +
         val session_state : t -> string

     

       72
       +
         

     

       73
       +
         val v :

     

       74
       +
           method_responses:response_invocation list ->

     

       75
       +
           ?created_ids:id id_map ->

     

       76
       +
           session_state:string ->

     

       77
       +
           unit ->

     

       78
       +
           t

     

       79
       +
       end