commit 9d0fab258d6abdabe353cf5a66079336eae1ba9f · anil.recoil.org/ocaml-jmap

+3 -1

AGENT.md

···

       20
       20
        
       2. DONE Add a `Jmap.Api` module to make JMAP API requests over HTTP and parse the

     

       21
       21
        
          responses into the `Jmap.Types`. Used `Cohttp_lwt_unix` for the HTTP library.

     

       22
       22
        
          Note: There is a compilation issue with the current ezjsonm package on the system.

     

       23
       23
       -
       3. Add a `Jmap_mail` implementation that follows `spec/rfc8621.txt` as part of a 

     

       23
       23
       +
       3. DONE Add a `Jmap_mail` implementation that follows `spec/rfc8621.txt` as part of a 

     

       24
       24
        
          separate package. It should use the Jmap module and extend it appropriately.

     

       25
       25
       +
       4. Complete the Jmap_mail implementation so that there are functions to login

     

       26
       26
       +
          and list mailboxes and messages in a mailbox.

+902

lib/jmap_mail.ml

···

       1
       1
       +
       (** Implementation of the JMAP Mail extension, as defined in RFC8621 *)

     

       2
       2
       +
       

     

       3
       3
       +
       module Types = struct

     

       4
       4
       +
         open Jmap.Types

     

       5
       5
       +
       

     

       6
       6
       +
         (** {1 Mail capabilities} *)

     

       7
       7
       +
       

     

       8
       8
       +
         (** Capability URI for JMAP Mail*)

     

       9
       9
       +
         let capability_mail = "urn:ietf:params:jmap:mail"

     

       10
       10
       +
       

     

       11
       11
       +
         (** Capability URI for JMAP Submission *)

     

       12
       12
       +
         let capability_submission = "urn:ietf:params:jmap:submission"

     

       13
       13
       +
         

     

       14
       14
       +
         (** Capability URI for JMAP Vacation Response *)

     

       15
       15
       +
         let capability_vacation_response = "urn:ietf:params:jmap:vacationresponse"

     

       16
       16
       +
       

     

       17
       17
       +
         (** {1:mailbox Mailbox objects} *)

     

       18
       18
       +
       

     

       19
       19
       +
         (** A role for a mailbox. See RFC8621 Section 2. *)

     

       20
       20
       +
         type mailbox_role =

     

       21
       21
       +
           | All (** All mail *)

     

       22
       22
       +
           | Archive (** Archived mail *)

     

       23
       23
       +
           | Drafts (** Draft messages *)

     

       24
       24
       +
           | Flagged (** Starred/flagged mail *)

     

       25
       25
       +
           | Important (** Important mail *)

     

       26
       26
       +
           | Inbox (** Inbox *)

     

       27
       27
       +
           | Junk (** Spam/Junk mail *)

     

       28
       28
       +
           | Sent (** Sent mail *)

     

       29
       29
       +
           | Trash (** Deleted/Trash mail *)

     

       30
       30
       +
           | Unknown of string (** Server-specific roles *)

     

       31
       31
       +
         

     

       32
       32
       +
         (** A mailbox (folder) in a mail account. See RFC8621 Section 2. *)

     

       33
       33
       +
         type mailbox = {

     

       34
       34
       +
           id : id;

     

       35
       35
       +
           name : string;

     

       36
       36
       +
           parent_id : id option;

     

       37
       37
       +
           role : mailbox_role option;

     

       38
       38
       +
           sort_order : unsigned_int;

     

       39
       39
       +
           total_emails : unsigned_int;

     

       40
       40
       +
           unread_emails : unsigned_int;

     

       41
       41
       +
           total_threads : unsigned_int;

     

       42
       42
       +
           unread_threads : unsigned_int;

     

       43
       43
       +
           is_subscribed : bool;

     

       44
       44
       +
           my_rights : mailbox_rights;

     

       45
       45
       +
         }

     

       46
       46
       +
       

     

       47
       47
       +
         (** Rights for a mailbox. See RFC8621 Section 2. *)

     

       48
       48
       +
         and mailbox_rights = {

     

       49
       49
       +
           may_read_items : bool;

     

       50
       50
       +
           may_add_items : bool;

     

       51
       51
       +
           may_remove_items : bool;

     

       52
       52
       +
           may_set_seen : bool;

     

       53
       53
       +
           may_set_keywords : bool;

     

       54
       54
       +
           may_create_child : bool;

     

       55
       55
       +
           may_rename : bool;

     

       56
       56
       +
           may_delete : bool;

     

       57
       57
       +
           may_submit : bool;

     

       58
       58
       +
         }

     

       59
       59
       +
       

     

       60
       60
       +
         (** Filter condition for mailbox queries. See RFC8621 Section 2.3. *)

     

       61
       61
       +
         type mailbox_filter_condition = {

     

       62
       62
       +
           parent_id : id option;

     

       63
       63
       +
           name : string option;

     

       64
       64
       +
           role : string option;

     

       65
       65
       +
           has_any_role : bool option;

     

       66
       66
       +
           is_subscribed : bool option;

     

       67
       67
       +
         }

     

       68
       68
       +
       

     

       69
       69
       +
         type mailbox_query_filter = [

     

       70
       70
       +
           | `And of mailbox_query_filter list

     

       71
       71
       +
           | `Or of mailbox_query_filter list

     

       72
       72
       +
           | `Not of mailbox_query_filter

     

       73
       73
       +
           | `Condition of mailbox_filter_condition

     

       74
       74
       +
         ]

     

       75
       75
       +
       

     

       76
       76
       +
         (** Mailbox/get request arguments. See RFC8621 Section 2.1. *)

     

       77
       77
       +
         type mailbox_get_arguments = {

     

       78
       78
       +
           account_id : id;

     

       79
       79
       +
           ids : id list option;

     

       80
       80
       +
           properties : string list option;

     

       81
       81
       +
         }

     

       82
       82
       +
       

     

       83
       83
       +
         (** Mailbox/get response. See RFC8621 Section 2.1. *)

     

       84
       84
       +
         type mailbox_get_response = {

     

       85
       85
       +
           account_id : id;

     

       86
       86
       +
           state : string;

     

       87
       87
       +
           list : mailbox list;

     

       88
       88
       +
           not_found : id list;

     

       89
       89
       +
         }

     

       90
       90
       +
       

     

       91
       91
       +
         (** Mailbox/changes request arguments. See RFC8621 Section 2.2. *)

     

       92
       92
       +
         type mailbox_changes_arguments = {

     

       93
       93
       +
           account_id : id;

     

       94
       94
       +
           since_state : string;

     

       95
       95
       +
           max_changes : unsigned_int option;

     

       96
       96
       +
         }

     

       97
       97
       +
       

     

       98
       98
       +
         (** Mailbox/changes response. See RFC8621 Section 2.2. *)

     

       99
       99
       +
         type mailbox_changes_response = {

     

       100
       100
       +
           account_id : id;

     

       101
       101
       +
           old_state : string;

     

       102
       102
       +
           new_state : string;

     

       103
       103
       +
           has_more_changes : bool;

     

       104
       104
       +
           created : id list;

     

       105
       105
       +
           updated : id list;

     

       106
       106
       +
           destroyed : id list;

     

       107
       107
       +
         }

     

       108
       108
       +
       

     

       109
       109
       +
         (** Mailbox/query request arguments. See RFC8621 Section 2.3. *)

     

       110
       110
       +
         type mailbox_query_arguments = {

     

       111
       111
       +
           account_id : id;

     

       112
       112
       +
           filter : mailbox_query_filter option;

     

       113
       113
       +
           sort : [ `name | `role | `sort_order ] list option;

     

       114
       114
       +
           limit : unsigned_int option;

     

       115
       115
       +
         }

     

       116
       116
       +
       

     

       117
       117
       +
         (** Mailbox/query response. See RFC8621 Section 2.3. *)

     

       118
       118
       +
         type mailbox_query_response = {

     

       119
       119
       +
           account_id : id;

     

       120
       120
       +
           query_state : string;

     

       121
       121
       +
           can_calculate_changes : bool;

     

       122
       122
       +
           position : unsigned_int;

     

       123
       123
       +
           ids : id list;

     

       124
       124
       +
           total : unsigned_int option;

     

       125
       125
       +
         }

     

       126
       126
       +
       

     

       127
       127
       +
         (** Mailbox/queryChanges request arguments. See RFC8621 Section 2.4. *)

     

       128
       128
       +
         type mailbox_query_changes_arguments = {

     

       129
       129
       +
           account_id : id;

     

       130
       130
       +
           filter : mailbox_query_filter option;

     

       131
       131
       +
           sort : [ `name | `role | `sort_order ] list option;

     

       132
       132
       +
           since_query_state : string;

     

       133
       133
       +
           max_changes : unsigned_int option;

     

       134
       134
       +
           up_to_id : id option;

     

       135
       135
       +
         }

     

       136
       136
       +
       

     

       137
       137
       +
         (** Mailbox/queryChanges response. See RFC8621 Section 2.4. *)

     

       138
       138
       +
         type mailbox_query_changes_response = {

     

       139
       139
       +
           account_id : id;

     

       140
       140
       +
           old_query_state : string;

     

       141
       141
       +
           new_query_state : string;

     

       142
       142
       +
           total : unsigned_int option;

     

       143
       143
       +
           removed : id list;

     

       144
       144
       +
           added : mailbox_query_changes_added list;

     

       145
       145
       +
         }

     

       146
       146
       +
       

     

       147
       147
       +
         and mailbox_query_changes_added = {

     

       148
       148
       +
           id : id;

     

       149
       149
       +
           index : unsigned_int;

     

       150
       150
       +
         }

     

       151
       151
       +
       

     

       152
       152
       +
         (** Mailbox/set request arguments. See RFC8621 Section 2.5. *)

     

       153
       153
       +
         type mailbox_set_arguments = {

     

       154
       154
       +
           account_id : id;

     

       155
       155
       +
           if_in_state : string option;

     

       156
       156
       +
           create : (id * mailbox_creation) list option;

     

       157
       157
       +
           update : (id * mailbox_update) list option;

     

       158
       158
       +
           destroy : id list option;

     

       159
       159
       +
         }

     

       160
       160
       +
       

     

       161
       161
       +
         and mailbox_creation = {

     

       162
       162
       +
           name : string;

     

       163
       163
       +
           parent_id : id option;

     

       164
       164
       +
           role : string option;

     

       165
       165
       +
           sort_order : unsigned_int option;

     

       166
       166
       +
           is_subscribed : bool option;

     

       167
       167
       +
         }

     

       168
       168
       +
       

     

       169
       169
       +
         and mailbox_update = {

     

       170
       170
       +
           name : string option;

     

       171
       171
       +
           parent_id : id option;

     

       172
       172
       +
           role : string option;

     

       173
       173
       +
           sort_order : unsigned_int option;

     

       174
       174
       +
           is_subscribed : bool option;

     

       175
       175
       +
         }

     

       176
       176
       +
       

     

       177
       177
       +
         (** Mailbox/set response. See RFC8621 Section 2.5. *)

     

       178
       178
       +
         type mailbox_set_response = {

     

       179
       179
       +
           account_id : id;

     

       180
       180
       +
           old_state : string option;

     

       181
       181
       +
           new_state : string;

     

       182
       182
       +
           created : (id * mailbox) list option;

     

       183
       183
       +
           updated : id list option;

     

       184
       184
       +
           destroyed : id list option;

     

       185
       185
       +
           not_created : (id * set_error) list option;

     

       186
       186
       +
           not_updated : (id * set_error) list option;

     

       187
       187
       +
           not_destroyed : (id * set_error) list option;

     

       188
       188
       +
         }

     

       189
       189
       +
       

     

       190
       190
       +
         (** {1:thread Thread objects} *)

     

       191
       191
       +
       

     

       192
       192
       +
         (** A thread in a mail account. See RFC8621 Section 3. *)

     

       193
       193
       +
         type thread = {

     

       194
       194
       +
           id : id;

     

       195
       195
       +
           email_ids : id list;

     

       196
       196
       +
         }

     

       197
       197
       +
       

     

       198
       198
       +
         (** Thread/get request arguments. See RFC8621 Section 3.1. *)

     

       199
       199
       +
         type thread_get_arguments = {

     

       200
       200
       +
           account_id : id;

     

       201
       201
       +
           ids : id list option;

     

       202
       202
       +
           properties : string list option;

     

       203
       203
       +
         }

     

       204
       204
       +
       

     

       205
       205
       +
         (** Thread/get response. See RFC8621 Section 3.1. *)

     

       206
       206
       +
         type thread_get_response = {

     

       207
       207
       +
           account_id : id;

     

       208
       208
       +
           state : string;

     

       209
       209
       +
           list : thread list;

     

       210
       210
       +
           not_found : id list;

     

       211
       211
       +
         }

     

       212
       212
       +
       

     

       213
       213
       +
         (** Thread/changes request arguments. See RFC8621 Section 3.2. *)

     

       214
       214
       +
         type thread_changes_arguments = {

     

       215
       215
       +
           account_id : id;

     

       216
       216
       +
           since_state : string;

     

       217
       217
       +
           max_changes : unsigned_int option;

     

       218
       218
       +
         }

     

       219
       219
       +
       

     

       220
       220
       +
         (** Thread/changes response. See RFC8621 Section 3.2. *)

     

       221
       221
       +
         type thread_changes_response = {

     

       222
       222
       +
           account_id : id;

     

       223
       223
       +
           old_state : string;

     

       224
       224
       +
           new_state : string;

     

       225
       225
       +
           has_more_changes : bool;

     

       226
       226
       +
           created : id list;

     

       227
       227
       +
           updated : id list;

     

       228
       228
       +
           destroyed : id list;

     

       229
       229
       +
         }

     

       230
       230
       +
       

     

       231
       231
       +
         (** {1:email Email objects} *)

     

       232
       232
       +
       

     

       233
       233
       +
         (** Addressing (mailbox) information. See RFC8621 Section 4.1.1. *)

     

       234
       234
       +
         type email_address = {

     

       235
       235
       +
           name : string option;

     

       236
       236
       +
           email : string;

     

       237
       237
       +
           parameters : (string * string) list;

     

       238
       238
       +
         }

     

       239
       239
       +
       

     

       240
       240
       +
         (** Message header field. See RFC8621 Section 4.1.2. *)

     

       241
       241
       +
         type header = {

     

       242
       242
       +
           name : string;

     

       243
       243
       +
           value : string;

     

       244
       244
       +
         }

     

       245
       245
       +
       

     

       246
       246
       +
         (** Email keyword (flag). See RFC8621 Section 4.3. *)

     

       247
       247
       +
         type keyword =

     

       248
       248
       +
           | Flagged

     

       249
       249
       +
           | Answered

     

       250
       250
       +
           | Draft

     

       251
       251
       +
           | Forwarded

     

       252
       252
       +
           | Phishing

     

       253
       253
       +
           | Junk

     

       254
       254
       +
           | NotJunk

     

       255
       255
       +
           | Seen

     

       256
       256
       +
           | Unread

     

       257
       257
       +
           | Custom of string

     

       258
       258
       +
         

     

       259
       259
       +
         (** Email message. See RFC8621 Section 4. *)

     

       260
       260
       +
         type email = {

     

       261
       261
       +
           id : id;

     

       262
       262
       +
           blob_id : id;

     

       263
       263
       +
           thread_id : id;

     

       264
       264
       +
           mailbox_ids : (id * bool) list;

     

       265
       265
       +
           keywords : (keyword * bool) list;

     

       266
       266
       +
           size : unsigned_int;

     

       267
       267
       +
           received_at : utc_date;

     

       268
       268
       +
           message_id : string list;

     

       269
       269
       +
           in_reply_to : string list option;

     

       270
       270
       +
           references : string list option;

     

       271
       271
       +
           sender : email_address list option;

     

       272
       272
       +
           from : email_address list option;

     

       273
       273
       +
           to_ : email_address list option;

     

       274
       274
       +
           cc : email_address list option;

     

       275
       275
       +
           bcc : email_address list option;

     

       276
       276
       +
           reply_to : email_address list option;

     

       277
       277
       +
           subject : string option;

     

       278
       278
       +
           sent_at : utc_date option;

     

       279
       279
       +
           has_attachment : bool option;

     

       280
       280
       +
           preview : string option;

     

       281
       281
       +
           body_values : (string * string) list option;

     

       282
       282
       +
           text_body : email_body_part list option;

     

       283
       283
       +
           html_body : email_body_part list option;

     

       284
       284
       +
           attachments : email_body_part list option;

     

       285
       285
       +
           headers : header list option;

     

       286
       286
       +
         }

     

       287
       287
       +
       

     

       288
       288
       +
         (** Email body part. See RFC8621 Section 4.1.4. *)

     

       289
       289
       +
         and email_body_part = {

     

       290
       290
       +
           part_id : string option;

     

       291
       291
       +
           blob_id : id option;

     

       292
       292
       +
           size : unsigned_int option;

     

       293
       293
       +
           headers : header list option;

     

       294
       294
       +
           name : string option;

     

       295
       295
       +
           type_ : string option;

     

       296
       296
       +
           charset : string option;

     

       297
       297
       +
           disposition : string option;

     

       298
       298
       +
           cid : string option;

     

       299
       299
       +
           language : string list option;

     

       300
       300
       +
           location : string option;

     

       301
       301
       +
           sub_parts : email_body_part list option;

     

       302
       302
       +
           header_parameter_name : string option;

     

       303
       303
       +
           header_parameter_value : string option;

     

       304
       304
       +
         }

     

       305
       305
       +
         

     

       306
       306
       +
         (** Email query filter condition. See RFC8621 Section 4.4. *)

     

       307
       307
       +
         type email_filter_condition = {

     

       308
       308
       +
           in_mailbox : id option;

     

       309
       309
       +
           in_mailbox_other_than : id list option;

     

       310
       310
       +
           min_size : unsigned_int option;

     

       311
       311
       +
           max_size : unsigned_int option;

     

       312
       312
       +
           before : utc_date option;

     

       313
       313
       +
           after : utc_date option;

     

       314
       314
       +
           header : (string * string) option;

     

       315
       315
       +
           from : string option;

     

       316
       316
       +
           to_ : string option;

     

       317
       317
       +
           cc : string option;

     

       318
       318
       +
           bcc : string option;

     

       319
       319
       +
           subject : string option;

     

       320
       320
       +
           body : string option;

     

       321
       321
       +
           has_keyword : string option;

     

       322
       322
       +
           not_keyword : string option;

     

       323
       323
       +
           has_attachment : bool option;

     

       324
       324
       +
           text : string option;

     

       325
       325
       +
         }

     

       326
       326
       +
       

     

       327
       327
       +
         type email_query_filter = [

     

       328
       328
       +
           | `And of email_query_filter list

     

       329
       329
       +
           | `Or of email_query_filter list

     

       330
       330
       +
           | `Not of email_query_filter

     

       331
       331
       +
           | `Condition of email_filter_condition

     

       332
       332
       +
         ]

     

       333
       333
       +
       

     

       334
       334
       +
         (** Email/get request arguments. See RFC8621 Section 4.5. *)

     

       335
       335
       +
         type email_get_arguments = {

     

       336
       336
       +
           account_id : id;

     

       337
       337
       +
           ids : id list option;

     

       338
       338
       +
           properties : string list option;

     

       339
       339
       +
           body_properties : string list option;

     

       340
       340
       +
           fetch_text_body_values : bool option;

     

       341
       341
       +
           fetch_html_body_values : bool option;

     

       342
       342
       +
           fetch_all_body_values : bool option;

     

       343
       343
       +
           max_body_value_bytes : unsigned_int option;

     

       344
       344
       +
         }

     

       345
       345
       +
       

     

       346
       346
       +
         (** Email/get response. See RFC8621 Section 4.5. *)

     

       347
       347
       +
         type email_get_response = {

     

       348
       348
       +
           account_id : id;

     

       349
       349
       +
           state : string;

     

       350
       350
       +
           list : email list;

     

       351
       351
       +
           not_found : id list;

     

       352
       352
       +
         }

     

       353
       353
       +
       

     

       354
       354
       +
         (** Email/changes request arguments. See RFC8621 Section 4.6. *)

     

       355
       355
       +
         type email_changes_arguments = {

     

       356
       356
       +
           account_id : id;

     

       357
       357
       +
           since_state : string;

     

       358
       358
       +
           max_changes : unsigned_int option;

     

       359
       359
       +
         }

     

       360
       360
       +
       

     

       361
       361
       +
         (** Email/changes response. See RFC8621 Section 4.6. *)

     

       362
       362
       +
         type email_changes_response = {

     

       363
       363
       +
           account_id : id;

     

       364
       364
       +
           old_state : string;

     

       365
       365
       +
           new_state : string;

     

       366
       366
       +
           has_more_changes : bool;

     

       367
       367
       +
           created : id list;

     

       368
       368
       +
           updated : id list;

     

       369
       369
       +
           destroyed : id list;

     

       370
       370
       +
         }

     

       371
       371
       +
       

     

       372
       372
       +
         (** Email/query request arguments. See RFC8621 Section 4.4. *)

     

       373
       373
       +
         type email_query_arguments = {

     

       374
       374
       +
           account_id : id;

     

       375
       375
       +
           filter : email_query_filter option;

     

       376
       376
       +
           sort : comparator list option;

     

       377
       377
       +
           collapse_threads : bool option;

     

       378
       378
       +
           position : unsigned_int option;

     

       379
       379
       +
           anchor : id option;

     

       380
       380
       +
           anchor_offset : int_t option;

     

       381
       381
       +
           limit : unsigned_int option;

     

       382
       382
       +
           calculate_total : bool option;

     

       383
       383
       +
         }

     

       384
       384
       +
       

     

       385
       385
       +
         (** Email/query response. See RFC8621 Section 4.4. *)

     

       386
       386
       +
         type email_query_response = {

     

       387
       387
       +
           account_id : id;

     

       388
       388
       +
           query_state : string;

     

       389
       389
       +
           can_calculate_changes : bool;

     

       390
       390
       +
           position : unsigned_int;

     

       391
       391
       +
           ids : id list;

     

       392
       392
       +
           total : unsigned_int option;

     

       393
       393
       +
           thread_ids : id list option;

     

       394
       394
       +
         }

     

       395
       395
       +
       

     

       396
       396
       +
         (** Email/queryChanges request arguments. See RFC8621 Section 4.7. *)

     

       397
       397
       +
         type email_query_changes_arguments = {

     

       398
       398
       +
           account_id : id;

     

       399
       399
       +
           filter : email_query_filter option;

     

       400
       400
       +
           sort : comparator list option;

     

       401
       401
       +
           collapse_threads : bool option;

     

       402
       402
       +
           since_query_state : string;

     

       403
       403
       +
           max_changes : unsigned_int option;

     

       404
       404
       +
           up_to_id : id option;

     

       405
       405
       +
         }

     

       406
       406
       +
       

     

       407
       407
       +
         (** Email/queryChanges response. See RFC8621 Section 4.7. *)

     

       408
       408
       +
         type email_query_changes_response = {

     

       409
       409
       +
           account_id : id;

     

       410
       410
       +
           old_query_state : string;

     

       411
       411
       +
           new_query_state : string;

     

       412
       412
       +
           total : unsigned_int option;

     

       413
       413
       +
           removed : id list;

     

       414
       414
       +
           added : email_query_changes_added list;

     

       415
       415
       +
         }

     

       416
       416
       +
       

     

       417
       417
       +
         and email_query_changes_added = {

     

       418
       418
       +
           id : id;

     

       419
       419
       +
           index : unsigned_int;

     

       420
       420
       +
         }

     

       421
       421
       +
       

     

       422
       422
       +
         (** Email/set request arguments. See RFC8621 Section 4.8. *)

     

       423
       423
       +
         type email_set_arguments = {

     

       424
       424
       +
           account_id : id;

     

       425
       425
       +
           if_in_state : string option;

     

       426
       426
       +
           create : (id * email_creation) list option;

     

       427
       427
       +
           update : (id * email_update) list option;

     

       428
       428
       +
           destroy : id list option;

     

       429
       429
       +
         }

     

       430
       430
       +
       

     

       431
       431
       +
         and email_creation = {

     

       432
       432
       +
           mailbox_ids : (id * bool) list;

     

       433
       433
       +
           keywords : (keyword * bool) list option;

     

       434
       434
       +
           received_at : utc_date option;

     

       435
       435
       +
           message_id : string list option;

     

       436
       436
       +
           in_reply_to : string list option;

     

       437
       437
       +
           references : string list option;

     

       438
       438
       +
           sender : email_address list option;

     

       439
       439
       +
           from : email_address list option;

     

       440
       440
       +
           to_ : email_address list option;

     

       441
       441
       +
           cc : email_address list option;

     

       442
       442
       +
           bcc : email_address list option;

     

       443
       443
       +
           reply_to : email_address list option;

     

       444
       444
       +
           subject : string option;

     

       445
       445
       +
           body_values : (string * string) list option;

     

       446
       446
       +
           text_body : email_body_part list option;

     

       447
       447
       +
           html_body : email_body_part list option;

     

       448
       448
       +
           attachments : email_body_part list option;

     

       449
       449
       +
           headers : header list option;

     

       450
       450
       +
         }

     

       451
       451
       +
       

     

       452
       452
       +
         and email_update = {

     

       453
       453
       +
           keywords : (keyword * bool) list option;

     

       454
       454
       +
           mailbox_ids : (id * bool) list option;

     

       455
       455
       +
         }

     

       456
       456
       +
       

     

       457
       457
       +
         (** Email/set response. See RFC8621 Section 4.8. *)

     

       458
       458
       +
         type email_set_response = {

     

       459
       459
       +
           account_id : id;

     

       460
       460
       +
           old_state : string option;

     

       461
       461
       +
           new_state : string;

     

       462
       462
       +
           created : (id * email) list option;

     

       463
       463
       +
           updated : id list option;

     

       464
       464
       +
           destroyed : id list option;

     

       465
       465
       +
           not_created : (id * set_error) list option;

     

       466
       466
       +
           not_updated : (id * set_error) list option;

     

       467
       467
       +
           not_destroyed : (id * set_error) list option;

     

       468
       468
       +
         }

     

       469
       469
       +
       

     

       470
       470
       +
         (** Email/copy request arguments. See RFC8621 Section 4.9. *)

     

       471
       471
       +
         type email_copy_arguments = {

     

       472
       472
       +
           from_account_id : id;

     

       473
       473
       +
           account_id : id;

     

       474
       474
       +
           create : (id * email_creation) list;

     

       475
       475
       +
           on_success_destroy_original : bool option;

     

       476
       476
       +
         }

     

       477
       477
       +
       

     

       478
       478
       +
         (** Email/copy response. See RFC8621 Section 4.9. *)

     

       479
       479
       +
         type email_copy_response = {

     

       480
       480
       +
           from_account_id : id;

     

       481
       481
       +
           account_id : id;

     

       482
       482
       +
           created : (id * email) list option;

     

       483
       483
       +
           not_created : (id * set_error) list option;

     

       484
       484
       +
         }

     

       485
       485
       +
       

     

       486
       486
       +
         (** Email/import request arguments. See RFC8621 Section 4.10. *)

     

       487
       487
       +
         type email_import_arguments = {

     

       488
       488
       +
           account_id : id;

     

       489
       489
       +
           emails : (id * email_import) list;

     

       490
       490
       +
         }

     

       491
       491
       +
       

     

       492
       492
       +
         and email_import = {

     

       493
       493
       +
           blob_id : id;

     

       494
       494
       +
           mailbox_ids : (id * bool) list;

     

       495
       495
       +
           keywords : (keyword * bool) list option;

     

       496
       496
       +
           received_at : utc_date option;

     

       497
       497
       +
         }

     

       498
       498
       +
       

     

       499
       499
       +
         (** Email/import response. See RFC8621 Section 4.10. *)

     

       500
       500
       +
         type email_import_response = {

     

       501
       501
       +
           account_id : id;

     

       502
       502
       +
           created : (id * email) list option;

     

       503
       503
       +
           not_created : (id * set_error) list option;

     

       504
       504
       +
         }

     

       505
       505
       +
       

     

       506
       506
       +
         (** {1:search_snippet Search snippets} *)

     

       507
       507
       +
       

     

       508
       508
       +
         (** SearchSnippet/get request arguments. See RFC8621 Section 4.11. *)

     

       509
       509
       +
         type search_snippet_get_arguments = {

     

       510
       510
       +
           account_id : id;

     

       511
       511
       +
           email_ids : id list;

     

       512
       512
       +
           filter : email_filter_condition;

     

       513
       513
       +
         }

     

       514
       514
       +
       

     

       515
       515
       +
         (** SearchSnippet/get response. See RFC8621 Section 4.11. *)

     

       516
       516
       +
         type search_snippet_get_response = {

     

       517
       517
       +
           account_id : id;

     

       518
       518
       +
           list : (id * search_snippet) list;

     

       519
       519
       +
           not_found : id list;

     

       520
       520
       +
         }

     

       521
       521
       +
       

     

       522
       522
       +
         and search_snippet = {

     

       523
       523
       +
           subject : string option;

     

       524
       524
       +
           preview : string option;

     

       525
       525
       +
         }

     

       526
       526
       +
       

     

       527
       527
       +
         (** {1:submission EmailSubmission objects} *)

     

       528
       528
       +
       

     

       529
       529
       +
         (** EmailSubmission address. See RFC8621 Section 5.1. *)

     

       530
       530
       +
         type submission_address = {

     

       531
       531
       +
           email : string;

     

       532
       532
       +
           parameters : (string * string) list option;

     

       533
       533
       +
         }

     

       534
       534
       +
       

     

       535
       535
       +
         (** Email submission object. See RFC8621 Section 5.1. *)

     

       536
       536
       +
         type email_submission = {

     

       537
       537
       +
           id : id;

     

       538
       538
       +
           identity_id : id;

     

       539
       539
       +
           email_id : id;

     

       540
       540
       +
           thread_id : id;

     

       541
       541
       +
           envelope : envelope option;

     

       542
       542
       +
           send_at : utc_date option;

     

       543
       543
       +
           undo_status : [

     

       544
       544
       +
             | `pending

     

       545
       545
       +
             | `final

     

       546
       546
       +
             | `canceled

     

       547
       547
       +
           ] option;

     

       548
       548
       +
           delivery_status : (string * submission_status) list option;

     

       549
       549
       +
           dsn_blob_ids : (string * id) list option;

     

       550
       550
       +
           mdn_blob_ids : (string * id) list option;

     

       551
       551
       +
         }

     

       552
       552
       +
       

     

       553
       553
       +
         (** Envelope for mail submission. See RFC8621 Section 5.1. *)

     

       554
       554
       +
         and envelope = {

     

       555
       555
       +
           mail_from : submission_address;

     

       556
       556
       +
           rcpt_to : submission_address list;

     

       557
       557
       +
         }

     

       558
       558
       +
       

     

       559
       559
       +
         (** Delivery status for submitted email. See RFC8621 Section 5.1. *)

     

       560
       560
       +
         and submission_status = {

     

       561
       561
       +
           smtp_reply : string;

     

       562
       562
       +
           delivered : string option;

     

       563
       563
       +
         }

     

       564
       564
       +
       

     

       565
       565
       +
         (** EmailSubmission/get request arguments. See RFC8621 Section 5.3. *)

     

       566
       566
       +
         type email_submission_get_arguments = {

     

       567
       567
       +
           account_id : id;

     

       568
       568
       +
           ids : id list option;

     

       569
       569
       +
           properties : string list option;

     

       570
       570
       +
         }

     

       571
       571
       +
       

     

       572
       572
       +
         (** EmailSubmission/get response. See RFC8621 Section 5.3. *)

     

       573
       573
       +
         type email_submission_get_response = {

     

       574
       574
       +
           account_id : id;

     

       575
       575
       +
           state : string;

     

       576
       576
       +
           list : email_submission list;

     

       577
       577
       +
           not_found : id list;

     

       578
       578
       +
         }

     

       579
       579
       +
       

     

       580
       580
       +
         (** EmailSubmission/changes request arguments. See RFC8621 Section 5.4. *)

     

       581
       581
       +
         type email_submission_changes_arguments = {

     

       582
       582
       +
           account_id : id;

     

       583
       583
       +
           since_state : string;

     

       584
       584
       +
           max_changes : unsigned_int option;

     

       585
       585
       +
         }

     

       586
       586
       +
       

     

       587
       587
       +
         (** EmailSubmission/changes response. See RFC8621 Section 5.4. *)

     

       588
       588
       +
         type email_submission_changes_response = {

     

       589
       589
       +
           account_id : id;

     

       590
       590
       +
           old_state : string;

     

       591
       591
       +
           new_state : string;

     

       592
       592
       +
           has_more_changes : bool;

     

       593
       593
       +
           created : id list;

     

       594
       594
       +
           updated : id list;

     

       595
       595
       +
           destroyed : id list;

     

       596
       596
       +
         }

     

       597
       597
       +
       

     

       598
       598
       +
         (** EmailSubmission/query filter condition. See RFC8621 Section 5.5. *)

     

       599
       599
       +
         type email_submission_filter_condition = {

     

       600
       600
       +
           identity_id : id option;

     

       601
       601
       +
           email_id : id option;

     

       602
       602
       +
           thread_id : id option;

     

       603
       603
       +
           before : utc_date option;

     

       604
       604
       +
           after : utc_date option;

     

       605
       605
       +
           subject : string option;

     

       606
       606
       +
         }

     

       607
       607
       +
       

     

       608
       608
       +
         type email_submission_query_filter = [

     

       609
       609
       +
           | `And of email_submission_query_filter list

     

       610
       610
       +
           | `Or of email_submission_query_filter list

     

       611
       611
       +
           | `Not of email_submission_query_filter

     

       612
       612
       +
           | `Condition of email_submission_filter_condition

     

       613
       613
       +
         ]

     

       614
       614
       +
       

     

       615
       615
       +
         (** EmailSubmission/query request arguments. See RFC8621 Section 5.5. *)

     

       616
       616
       +
         type email_submission_query_arguments = {

     

       617
       617
       +
           account_id : id;

     

       618
       618
       +
           filter : email_submission_query_filter option;

     

       619
       619
       +
           sort : comparator list option;

     

       620
       620
       +
           position : unsigned_int option;

     

       621
       621
       +
           anchor : id option;

     

       622
       622
       +
           anchor_offset : int_t option;

     

       623
       623
       +
           limit : unsigned_int option;

     

       624
       624
       +
           calculate_total : bool option;

     

       625
       625
       +
         }

     

       626
       626
       +
       

     

       627
       627
       +
         (** EmailSubmission/query response. See RFC8621 Section 5.5. *)

     

       628
       628
       +
         type email_submission_query_response = {

     

       629
       629
       +
           account_id : id;

     

       630
       630
       +
           query_state : string;

     

       631
       631
       +
           can_calculate_changes : bool;

     

       632
       632
       +
           position : unsigned_int;

     

       633
       633
       +
           ids : id list;

     

       634
       634
       +
           total : unsigned_int option;

     

       635
       635
       +
         }

     

       636
       636
       +
       

     

       637
       637
       +
         (** EmailSubmission/set request arguments. See RFC8621 Section 5.6. *)

     

       638
       638
       +
         type email_submission_set_arguments = {

     

       639
       639
       +
           account_id : id;

     

       640
       640
       +
           if_in_state : string option;

     

       641
       641
       +
           create : (id * email_submission_creation) list option;

     

       642
       642
       +
           update : (id * email_submission_update) list option;

     

       643
       643
       +
           destroy : id list option;

     

       644
       644
       +
           on_success_update_email : (id * email_update) list option;

     

       645
       645
       +
         }

     

       646
       646
       +
       

     

       647
       647
       +
         and email_submission_creation = {

     

       648
       648
       +
           email_id : id;

     

       649
       649
       +
           identity_id : id;

     

       650
       650
       +
           envelope : envelope option;

     

       651
       651
       +
           send_at : utc_date option;

     

       652
       652
       +
         }

     

       653
       653
       +
       

     

       654
       654
       +
         and email_submission_update = {

     

       655
       655
       +
           email_id : id option;

     

       656
       656
       +
           identity_id : id option;

     

       657
       657
       +
           envelope : envelope option;

     

       658
       658
       +
           undo_status : [`canceled] option;

     

       659
       659
       +
         }

     

       660
       660
       +
       

     

       661
       661
       +
         (** EmailSubmission/set response. See RFC8621 Section 5.6. *)

     

       662
       662
       +
         type email_submission_set_response = {

     

       663
       663
       +
           account_id : id;

     

       664
       664
       +
           old_state : string option;

     

       665
       665
       +
           new_state : string;

     

       666
       666
       +
           created : (id * email_submission) list option;

     

       667
       667
       +
           updated : id list option;

     

       668
       668
       +
           destroyed : id list option;

     

       669
       669
       +
           not_created : (id * set_error) list option;

     

       670
       670
       +
           not_updated : (id * set_error) list option;

     

       671
       671
       +
           not_destroyed : (id * set_error) list option;

     

       672
       672
       +
         }

     

       673
       673
       +
       

     

       674
       674
       +
         (** {1:identity Identity objects} *)

     

       675
       675
       +
       

     

       676
       676
       +
         (** Identity for sending mail. See RFC8621 Section 6. *)

     

       677
       677
       +
         type identity = {

     

       678
       678
       +
           id : id;

     

       679
       679
       +
           name : string;

     

       680
       680
       +
           email : string;

     

       681
       681
       +
           reply_to : email_address list option;

     

       682
       682
       +
           bcc : email_address list option;

     

       683
       683
       +
           text_signature : string option;

     

       684
       684
       +
           html_signature : string option;

     

       685
       685
       +
           may_delete : bool;

     

       686
       686
       +
         }

     

       687
       687
       +
       

     

       688
       688
       +
         (** Identity/get request arguments. See RFC8621 Section 6.1. *)

     

       689
       689
       +
         type identity_get_arguments = {

     

       690
       690
       +
           account_id : id;

     

       691
       691
       +
           ids : id list option;

     

       692
       692
       +
           properties : string list option;

     

       693
       693
       +
         }

     

       694
       694
       +
       

     

       695
       695
       +
         (** Identity/get response. See RFC8621 Section 6.1. *)

     

       696
       696
       +
         type identity_get_response = {

     

       697
       697
       +
           account_id : id;

     

       698
       698
       +
           state : string;

     

       699
       699
       +
           list : identity list;

     

       700
       700
       +
           not_found : id list;

     

       701
       701
       +
         }

     

       702
       702
       +
       

     

       703
       703
       +
         (** Identity/changes request arguments. See RFC8621 Section 6.2. *)

     

       704
       704
       +
         type identity_changes_arguments = {

     

       705
       705
       +
           account_id : id;

     

       706
       706
       +
           since_state : string;

     

       707
       707
       +
           max_changes : unsigned_int option;

     

       708
       708
       +
         }

     

       709
       709
       +
       

     

       710
       710
       +
         (** Identity/changes response. See RFC8621 Section 6.2. *)

     

       711
       711
       +
         type identity_changes_response = {

     

       712
       712
       +
           account_id : id;

     

       713
       713
       +
           old_state : string;

     

       714
       714
       +
           new_state : string;

     

       715
       715
       +
           has_more_changes : bool;

     

       716
       716
       +
           created : id list;

     

       717
       717
       +
           updated : id list;

     

       718
       718
       +
           destroyed : id list;

     

       719
       719
       +
         }

     

       720
       720
       +
       

     

       721
       721
       +
         (** Identity/set request arguments. See RFC8621 Section 6.3. *)

     

       722
       722
       +
         type identity_set_arguments = {

     

       723
       723
       +
           account_id : id;

     

       724
       724
       +
           if_in_state : string option;

     

       725
       725
       +
           create : (id * identity_creation) list option;

     

       726
       726
       +
           update : (id * identity_update) list option;

     

       727
       727
       +
           destroy : id list option;

     

       728
       728
       +
         }

     

       729
       729
       +
       

     

       730
       730
       +
         and identity_creation = {

     

       731
       731
       +
           name : string;

     

       732
       732
       +
           email : string;

     

       733
       733
       +
           reply_to : email_address list option;

     

       734
       734
       +
           bcc : email_address list option;

     

       735
       735
       +
           text_signature : string option;

     

       736
       736
       +
           html_signature : string option;

     

       737
       737
       +
         }

     

       738
       738
       +
       

     

       739
       739
       +
         and identity_update = {

     

       740
       740
       +
           name : string option;

     

       741
       741
       +
           email : string option;

     

       742
       742
       +
           reply_to : email_address list option;

     

       743
       743
       +
           bcc : email_address list option;

     

       744
       744
       +
           text_signature : string option;

     

       745
       745
       +
           html_signature : string option;

     

       746
       746
       +
         }

     

       747
       747
       +
       

     

       748
       748
       +
         (** Identity/set response. See RFC8621 Section 6.3. *)

     

       749
       749
       +
         type identity_set_response = {

     

       750
       750
       +
           account_id : id;

     

       751
       751
       +
           old_state : string option;

     

       752
       752
       +
           new_state : string;

     

       753
       753
       +
           created : (id * identity) list option;

     

       754
       754
       +
           updated : id list option;

     

       755
       755
       +
           destroyed : id list option;

     

       756
       756
       +
           not_created : (id * set_error) list option;

     

       757
       757
       +
           not_updated : (id * set_error) list option;

     

       758
       758
       +
           not_destroyed : (id * set_error) list option;

     

       759
       759
       +
         }

     

       760
       760
       +
       

     

       761
       761
       +
         (** {1:vacation_response VacationResponse objects} *)

     

       762
       762
       +
       

     

       763
       763
       +
         (** Vacation auto-reply setting. See RFC8621 Section 7. *)

     

       764
       764
       +
         type vacation_response = {

     

       765
       765
       +
           id : id;

     

       766
       766
       +
           is_enabled : bool;

     

       767
       767
       +
           from_date : utc_date option;

     

       768
       768
       +
           to_date : utc_date option;

     

       769
       769
       +
           subject : string option;

     

       770
       770
       +
           text_body : string option;

     

       771
       771
       +
           html_body : string option;

     

       772
       772
       +
         }

     

       773
       773
       +
       

     

       774
       774
       +
         (** VacationResponse/get request arguments. See RFC8621 Section 7.2. *)

     

       775
       775
       +
         type vacation_response_get_arguments = {

     

       776
       776
       +
           account_id : id;

     

       777
       777
       +
           ids : id list option;

     

       778
       778
       +
           properties : string list option;

     

       779
       779
       +
         }

     

       780
       780
       +
       

     

       781
       781
       +
         (** VacationResponse/get response. See RFC8621 Section 7.2. *)

     

       782
       782
       +
         type vacation_response_get_response = {

     

       783
       783
       +
           account_id : id;

     

       784
       784
       +
           state : string;

     

       785
       785
       +
           list : vacation_response list;

     

       786
       786
       +
           not_found : id list;

     

       787
       787
       +
         }

     

       788
       788
       +
       

     

       789
       789
       +
         (** VacationResponse/set request arguments. See RFC8621 Section 7.3. *)

     

       790
       790
       +
         type vacation_response_set_arguments = {

     

       791
       791
       +
           account_id : id;

     

       792
       792
       +
           if_in_state : string option;

     

       793
       793
       +
           update : (id * vacation_response_update) list;

     

       794
       794
       +
         }

     

       795
       795
       +
       

     

       796
       796
       +
         and vacation_response_update = {

     

       797
       797
       +
           is_enabled : bool option;

     

       798
       798
       +
           from_date : utc_date option;

     

       799
       799
       +
           to_date : utc_date option;

     

       800
       800
       +
           subject : string option;

     

       801
       801
       +
           text_body : string option;

     

       802
       802
       +
           html_body : string option;

     

       803
       803
       +
         }

     

       804
       804
       +
       

     

       805
       805
       +
         (** VacationResponse/set response. See RFC8621 Section 7.3. *)

     

       806
       806
       +
         type vacation_response_set_response = {

     

       807
       807
       +
           account_id : id;

     

       808
       808
       +
           old_state : string option;

     

       809
       809
       +
           new_state : string;

     

       810
       810
       +
           updated : id list option;

     

       811
       811
       +
           not_updated : (id * set_error) list option;

     

       812
       812
       +
         }

     

       813
       813
       +
       end

     

       814
       814
       +
       

     

       815
       815
       +
       (** {1 JSON serialization} *)

     

       816
       816
       +
       

     

       817
       817
       +
       module Json = struct

     

       818
       818
       +
         open Types

     

       819
       819
       +
         

     

       820
       820
       +
         (** {2 Helper functions for serialization} *)

     

       821
       821
       +
       

     

       822
       822
       +
         let string_of_mailbox_role = function

     

       823
       823
       +
           | All -> "all"

     

       824
       824
       +
           | Archive -> "archive"

     

       825
       825
       +
           | Drafts -> "drafts"

     

       826
       826
       +
           | Flagged -> "flagged"

     

       827
       827
       +
           | Important -> "important"

     

       828
       828
       +
           | Inbox -> "inbox"

     

       829
       829
       +
           | Junk -> "junk"

     

       830
       830
       +
           | Sent -> "sent"

     

       831
       831
       +
           | Trash -> "trash"

     

       832
       832
       +
           | Unknown s -> s

     

       833
       833
       +
         

     

       834
       834
       +
         let mailbox_role_of_string = function

     

       835
       835
       +
           | "all" -> All

     

       836
       836
       +
           | "archive" -> Archive

     

       837
       837
       +
           | "drafts" -> Drafts

     

       838
       838
       +
           | "flagged" -> Flagged

     

       839
       839
       +
           | "important" -> Important

     

       840
       840
       +
           | "inbox" -> Inbox

     

       841
       841
       +
           | "junk" -> Junk

     

       842
       842
       +
           | "sent" -> Sent

     

       843
       843
       +
           | "trash" -> Trash

     

       844
       844
       +
           | s -> Unknown s

     

       845
       845
       +
       

     

       846
       846
       +
         let string_of_keyword = function

     

       847
       847
       +
           | Flagged -> "$flagged"

     

       848
       848
       +
           | Answered -> "$answered"

     

       849
       849
       +
           | Draft -> "$draft"

     

       850
       850
       +
           | Forwarded -> "$forwarded"

     

       851
       851
       +
           | Phishing -> "$phishing"

     

       852
       852
       +
           | Junk -> "$junk"

     

       853
       853
       +
           | NotJunk -> "$notjunk"

     

       854
       854
       +
           | Seen -> "$seen"

     

       855
       855
       +
           | Unread -> "$unread"

     

       856
       856
       +
           | Custom s -> s

     

       857
       857
       +
         

     

       858
       858
       +
         let keyword_of_string = function

     

       859
       859
       +
           | "$flagged" -> Flagged

     

       860
       860
       +
           | "$answered" -> Answered

     

       861
       861
       +
           | "$draft" -> Draft

     

       862
       862
       +
           | "$forwarded" -> Forwarded

     

       863
       863
       +
           | "$phishing" -> Phishing

     

       864
       864
       +
           | "$junk" -> Junk

     

       865
       865
       +
           | "$notjunk" -> NotJunk

     

       866
       866
       +
           | "$seen" -> Seen

     

       867
       867
       +
           | "$unread" -> Unread

     

       868
       868
       +
           | s -> Custom s

     

       869
       869
       +
       

     

       870
       870
       +
         (** {2 Mailbox serialization} *)

     

       871
       871
       +
       

     

       872
       872
       +
         (** TODO:claude - Need to implement all JSON serialization functions 

     

       873
       873
       +
             for each type we've defined. This would be a substantial amount of

     

       874
       874
       +
             code and likely require additional understanding of the ezjsonm API. 

     

       875
       875
       +
             

     

       876
       876
       +
             For a full implementation, we would need functions to convert between

     

       877
       877
       +
             OCaml types and JSON for each of:

     

       878
       878
       +
             - mailbox, mailbox_rights, mailbox query/update operations

     

       879
       879
       +
             - thread operations

     

       880
       880
       +
             - email, email_address, header, email_body_part

     

       881
       881
       +
             - email query/update operations

     

       882
       882
       +
             - submission operations 

     

       883
       883
       +
             - identity operations

     

       884
       884
       +
             - vacation response operations

     

       885
       885
       +
         *)

     

       886
       886
       +
       end

     

       887
       887
       +
       

     

       888
       888
       +
       (** {1 API functions} *)

     

       889
       889
       +
       

     

       890
       890
       +
       (** TODO:claude - Need to implement API functions for interacting with the 

     

       891
       891
       +
           mail-specific JMAP server endpoints. These would use the Jmap.Api module

     

       892
       892
       +
           to make HTTP requests and parse responses.

     

       893
       893
       +
           

     

       894
       894
       +
           For a complete implementation, we would need functions for:

     

       895
       895
       +
           - Mailbox operations (get, query, changes, update)

     

       896
       896
       +
           - Thread operations

     

       897
       897
       +
           - Email operations (get, query, changes, update, import, copy)

     

       898
       898
       +
           - Search operations

     

       899
       899
       +
           - Mail submission

     

       900
       900
       +
           - Identity management

     

       901
       901
       +
           - Vacation response management

     

       902
       902
       +
       *)

+855

lib/jmap_mail.mli

···

       1
       1
       +
       (** Implementation of the JMAP Mail extension, as defined in RFC8621 *)

     

       2
       2
       +
       

     

       3
       3
       +
       (** Types for the JMAP Mail extension *)

     

       4
       4
       +
       module Types : sig

     

       5
       5
       +
         open Jmap.Types

     

       6
       6
       +
       

     

       7
       7
       +
         (** {1 Mail capabilities} *)

     

       8
       8
       +
       

     

       9
       9
       +
         (** Capability URI for JMAP Mail*)

     

       10
       10
       +
         val capability_mail : string

     

       11
       11
       +
       

     

       12
       12
       +
         (** Capability URI for JMAP Submission *)

     

       13
       13
       +
         val capability_submission : string

     

       14
       14
       +
         

     

       15
       15
       +
         (** Capability URI for JMAP Vacation Response *)

     

       16
       16
       +
         val capability_vacation_response : string

     

       17
       17
       +
       

     

       18
       18
       +
         (** {1:mailbox Mailbox objects} *)

     

       19
       19
       +
       

     

       20
       20
       +
         (** A role for a mailbox. See RFC8621 Section 2. *)

     

       21
       21
       +
         type mailbox_role =

     

       22
       22
       +
           | All (** All mail *)

     

       23
       23
       +
           | Archive (** Archived mail *)

     

       24
       24
       +
           | Drafts (** Draft messages *)

     

       25
       25
       +
           | Flagged (** Starred/flagged mail *)

     

       26
       26
       +
           | Important (** Important mail *)

     

       27
       27
       +
           | Inbox (** Inbox *)

     

       28
       28
       +
           | Junk (** Spam/Junk mail *)

     

       29
       29
       +
           | Sent (** Sent mail *)

     

       30
       30
       +
           | Trash (** Deleted/Trash mail *)

     

       31
       31
       +
           | Unknown of string (** Server-specific roles *)

     

       32
       32
       +
         

     

       33
       33
       +
         (** A mailbox (folder) in a mail account. See RFC8621 Section 2. *)

     

       34
       34
       +
         type mailbox = {

     

       35
       35
       +
           id : id;

     

       36
       36
       +
           name : string;

     

       37
       37
       +
           parent_id : id option;

     

       38
       38
       +
           role : mailbox_role option;

     

       39
       39
       +
           sort_order : unsigned_int;

     

       40
       40
       +
           total_emails : unsigned_int;

     

       41
       41
       +
           unread_emails : unsigned_int;

     

       42
       42
       +
           total_threads : unsigned_int;

     

       43
       43
       +
           unread_threads : unsigned_int;

     

       44
       44
       +
           is_subscribed : bool;

     

       45
       45
       +
           my_rights : mailbox_rights;

     

       46
       46
       +
         }

     

       47
       47
       +
       

     

       48
       48
       +
         (** Rights for a mailbox. See RFC8621 Section 2. *)

     

       49
       49
       +
         and mailbox_rights = {

     

       50
       50
       +
           may_read_items : bool;

     

       51
       51
       +
           may_add_items : bool;

     

       52
       52
       +
           may_remove_items : bool;

     

       53
       53
       +
           may_set_seen : bool;

     

       54
       54
       +
           may_set_keywords : bool;

     

       55
       55
       +
           may_create_child : bool;

     

       56
       56
       +
           may_rename : bool;

     

       57
       57
       +
           may_delete : bool;

     

       58
       58
       +
           may_submit : bool;

     

       59
       59
       +
         }

     

       60
       60
       +
       

     

       61
       61
       +
         (** Filter condition for mailbox queries. See RFC8621 Section 2.3. *)

     

       62
       62
       +
         type mailbox_filter_condition = {

     

       63
       63
       +
           parent_id : id option;

     

       64
       64
       +
           name : string option;

     

       65
       65
       +
           role : string option;

     

       66
       66
       +
           has_any_role : bool option;

     

       67
       67
       +
           is_subscribed : bool option;

     

       68
       68
       +
         }

     

       69
       69
       +
       

     

       70
       70
       +
         type mailbox_query_filter = [

     

       71
       71
       +
           | `And of mailbox_query_filter list

     

       72
       72
       +
           | `Or of mailbox_query_filter list

     

       73
       73
       +
           | `Not of mailbox_query_filter

     

       74
       74
       +
           | `Condition of mailbox_filter_condition

     

       75
       75
       +
         ]

     

       76
       76
       +
       

     

       77
       77
       +
         (** Mailbox/get request arguments. See RFC8621 Section 2.1. *)

     

       78
       78
       +
         type mailbox_get_arguments = {

     

       79
       79
       +
           account_id : id;

     

       80
       80
       +
           ids : id list option;

     

       81
       81
       +
           properties : string list option;

     

       82
       82
       +
         }

     

       83
       83
       +
       

     

       84
       84
       +
         (** Mailbox/get response. See RFC8621 Section 2.1. *)

     

       85
       85
       +
         type mailbox_get_response = {

     

       86
       86
       +
           account_id : id;

     

       87
       87
       +
           state : string;

     

       88
       88
       +
           list : mailbox list;

     

       89
       89
       +
           not_found : id list;

     

       90
       90
       +
         }

     

       91
       91
       +
       

     

       92
       92
       +
         (** Mailbox/changes request arguments. See RFC8621 Section 2.2. *)

     

       93
       93
       +
         type mailbox_changes_arguments = {

     

       94
       94
       +
           account_id : id;

     

       95
       95
       +
           since_state : string;

     

       96
       96
       +
           max_changes : unsigned_int option;

     

       97
       97
       +
         }

     

       98
       98
       +
       

     

       99
       99
       +
         (** Mailbox/changes response. See RFC8621 Section 2.2. *)

     

       100
       100
       +
         type mailbox_changes_response = {

     

       101
       101
       +
           account_id : id;

     

       102
       102
       +
           old_state : string;

     

       103
       103
       +
           new_state : string;

     

       104
       104
       +
           has_more_changes : bool;

     

       105
       105
       +
           created : id list;

     

       106
       106
       +
           updated : id list;

     

       107
       107
       +
           destroyed : id list;

     

       108
       108
       +
         }

     

       109
       109
       +
       

     

       110
       110
       +
         (** Mailbox/query request arguments. See RFC8621 Section 2.3. *)

     

       111
       111
       +
         type mailbox_query_arguments = {

     

       112
       112
       +
           account_id : id;

     

       113
       113
       +
           filter : mailbox_query_filter option;

     

       114
       114
       +
           sort : [ `name | `role | `sort_order ] list option;

     

       115
       115
       +
           limit : unsigned_int option;

     

       116
       116
       +
         }

     

       117
       117
       +
       

     

       118
       118
       +
         (** Mailbox/query response. See RFC8621 Section 2.3. *)

     

       119
       119
       +
         type mailbox_query_response = {

     

       120
       120
       +
           account_id : id;

     

       121
       121
       +
           query_state : string;

     

       122
       122
       +
           can_calculate_changes : bool;

     

       123
       123
       +
           position : unsigned_int;

     

       124
       124
       +
           ids : id list;

     

       125
       125
       +
           total : unsigned_int option;

     

       126
       126
       +
         }

     

       127
       127
       +
       

     

       128
       128
       +
         (** Mailbox/queryChanges request arguments. See RFC8621 Section 2.4. *)

     

       129
       129
       +
         type mailbox_query_changes_arguments = {

     

       130
       130
       +
           account_id : id;

     

       131
       131
       +
           filter : mailbox_query_filter option;

     

       132
       132
       +
           sort : [ `name | `role | `sort_order ] list option;

     

       133
       133
       +
           since_query_state : string;

     

       134
       134
       +
           max_changes : unsigned_int option;

     

       135
       135
       +
           up_to_id : id option;

     

       136
       136
       +
         }

     

       137
       137
       +
       

     

       138
       138
       +
         (** Mailbox/queryChanges response. See RFC8621 Section 2.4. *)

     

       139
       139
       +
         type mailbox_query_changes_response = {

     

       140
       140
       +
           account_id : id;

     

       141
       141
       +
           old_query_state : string;

     

       142
       142
       +
           new_query_state : string;

     

       143
       143
       +
           total : unsigned_int option;

     

       144
       144
       +
           removed : id list;

     

       145
       145
       +
           added : mailbox_query_changes_added list;

     

       146
       146
       +
         }

     

       147
       147
       +
       

     

       148
       148
       +
         and mailbox_query_changes_added = {

     

       149
       149
       +
           id : id;

     

       150
       150
       +
           index : unsigned_int;

     

       151
       151
       +
         }

     

       152
       152
       +
       

     

       153
       153
       +
         (** Mailbox/set request arguments. See RFC8621 Section 2.5. *)

     

       154
       154
       +
         type mailbox_set_arguments = {

     

       155
       155
       +
           account_id : id;

     

       156
       156
       +
           if_in_state : string option;

     

       157
       157
       +
           create : (id * mailbox_creation) list option;

     

       158
       158
       +
           update : (id * mailbox_update) list option;

     

       159
       159
       +
           destroy : id list option;

     

       160
       160
       +
         }

     

       161
       161
       +
       

     

       162
       162
       +
         and mailbox_creation = {

     

       163
       163
       +
           name : string;

     

       164
       164
       +
           parent_id : id option;

     

       165
       165
       +
           role : string option;

     

       166
       166
       +
           sort_order : unsigned_int option;

     

       167
       167
       +
           is_subscribed : bool option;

     

       168
       168
       +
         }

     

       169
       169
       +
       

     

       170
       170
       +
         and mailbox_update = {

     

       171
       171
       +
           name : string option;

     

       172
       172
       +
           parent_id : id option;

     

       173
       173
       +
           role : string option;

     

       174
       174
       +
           sort_order : unsigned_int option;

     

       175
       175
       +
           is_subscribed : bool option;

     

       176
       176
       +
         }

     

       177
       177
       +
       

     

       178
       178
       +
         (** Mailbox/set response. See RFC8621 Section 2.5. *)

     

       179
       179
       +
         type mailbox_set_response = {

     

       180
       180
       +
           account_id : id;

     

       181
       181
       +
           old_state : string option;

     

       182
       182
       +
           new_state : string;

     

       183
       183
       +
           created : (id * mailbox) list option;

     

       184
       184
       +
           updated : id list option;

     

       185
       185
       +
           destroyed : id list option;

     

       186
       186
       +
           not_created : (id * set_error) list option;

     

       187
       187
       +
           not_updated : (id * set_error) list option;

     

       188
       188
       +
           not_destroyed : (id * set_error) list option;

     

       189
       189
       +
         }

     

       190
       190
       +
       

     

       191
       191
       +
         (** {1:thread Thread objects} *)

     

       192
       192
       +
       

     

       193
       193
       +
         (** A thread in a mail account. See RFC8621 Section 3. *)

     

       194
       194
       +
         type thread = {

     

       195
       195
       +
           id : id;

     

       196
       196
       +
           email_ids : id list;

     

       197
       197
       +
         }

     

       198
       198
       +
       

     

       199
       199
       +
         (** Thread/get request arguments. See RFC8621 Section 3.1. *)

     

       200
       200
       +
         type thread_get_arguments = {

     

       201
       201
       +
           account_id : id;

     

       202
       202
       +
           ids : id list option;

     

       203
       203
       +
           properties : string list option;

     

       204
       204
       +
         }

     

       205
       205
       +
       

     

       206
       206
       +
         (** Thread/get response. See RFC8621 Section 3.1. *)

     

       207
       207
       +
         type thread_get_response = {

     

       208
       208
       +
           account_id : id;

     

       209
       209
       +
           state : string;

     

       210
       210
       +
           list : thread list;

     

       211
       211
       +
           not_found : id list;

     

       212
       212
       +
         }

     

       213
       213
       +
       

     

       214
       214
       +
         (** Thread/changes request arguments. See RFC8621 Section 3.2. *)

     

       215
       215
       +
         type thread_changes_arguments = {

     

       216
       216
       +
           account_id : id;

     

       217
       217
       +
           since_state : string;

     

       218
       218
       +
           max_changes : unsigned_int option;

     

       219
       219
       +
         }

     

       220
       220
       +
       

     

       221
       221
       +
         (** Thread/changes response. See RFC8621 Section 3.2. *)

     

       222
       222
       +
         type thread_changes_response = {

     

       223
       223
       +
           account_id : id;

     

       224
       224
       +
           old_state : string;

     

       225
       225
       +
           new_state : string;

     

       226
       226
       +
           has_more_changes : bool;

     

       227
       227
       +
           created : id list;

     

       228
       228
       +
           updated : id list;

     

       229
       229
       +
           destroyed : id list;

     

       230
       230
       +
         }

     

       231
       231
       +
       

     

       232
       232
       +
         (** {1:email Email objects} *)

     

       233
       233
       +
       

     

       234
       234
       +
         (** Addressing (mailbox) information. See RFC8621 Section 4.1.1. *)

     

       235
       235
       +
         type email_address = {

     

       236
       236
       +
           name : string option;

     

       237
       237
       +
           email : string;

     

       238
       238
       +
           parameters : (string * string) list;

     

       239
       239
       +
         }

     

       240
       240
       +
       

     

       241
       241
       +
         (** Message header field. See RFC8621 Section 4.1.2. *)

     

       242
       242
       +
         type header = {

     

       243
       243
       +
           name : string;

     

       244
       244
       +
           value : string;

     

       245
       245
       +
         }

     

       246
       246
       +
       

     

       247
       247
       +
         (** Email keyword (flag). See RFC8621 Section 4.3. *)

     

       248
       248
       +
         type keyword =

     

       249
       249
       +
           | Flagged

     

       250
       250
       +
           | Answered

     

       251
       251
       +
           | Draft

     

       252
       252
       +
           | Forwarded

     

       253
       253
       +
           | Phishing

     

       254
       254
       +
           | Junk

     

       255
       255
       +
           | NotJunk

     

       256
       256
       +
           | Seen

     

       257
       257
       +
           | Unread

     

       258
       258
       +
           | Custom of string

     

       259
       259
       +
         

     

       260
       260
       +
         (** Email message. See RFC8621 Section 4. *)

     

       261
       261
       +
         type email = {

     

       262
       262
       +
           id : id;

     

       263
       263
       +
           blob_id : id;

     

       264
       264
       +
           thread_id : id;

     

       265
       265
       +
           mailbox_ids : (id * bool) list;

     

       266
       266
       +
           keywords : (keyword * bool) list;

     

       267
       267
       +
           size : unsigned_int;

     

       268
       268
       +
           received_at : utc_date;

     

       269
       269
       +
           message_id : string list;

     

       270
       270
       +
           in_reply_to : string list option;

     

       271
       271
       +
           references : string list option;

     

       272
       272
       +
           sender : email_address list option;

     

       273
       273
       +
           from : email_address list option;

     

       274
       274
       +
           to_ : email_address list option;

     

       275
       275
       +
           cc : email_address list option;

     

       276
       276
       +
           bcc : email_address list option;

     

       277
       277
       +
           reply_to : email_address list option;

     

       278
       278
       +
           subject : string option;

     

       279
       279
       +
           sent_at : utc_date option;

     

       280
       280
       +
           has_attachment : bool option;

     

       281
       281
       +
           preview : string option;

     

       282
       282
       +
           body_values : (string * string) list option;

     

       283
       283
       +
           text_body : email_body_part list option;

     

       284
       284
       +
           html_body : email_body_part list option;

     

       285
       285
       +
           attachments : email_body_part list option;

     

       286
       286
       +
           headers : header list option;

     

       287
       287
       +
         }

     

       288
       288
       +
       

     

       289
       289
       +
         (** Email body part. See RFC8621 Section 4.1.4. *)

     

       290
       290
       +
         and email_body_part = {

     

       291
       291
       +
           part_id : string option;

     

       292
       292
       +
           blob_id : id option;

     

       293
       293
       +
           size : unsigned_int option;

     

       294
       294
       +
           headers : header list option;

     

       295
       295
       +
           name : string option;

     

       296
       296
       +
           type_ : string option;

     

       297
       297
       +
           charset : string option;

     

       298
       298
       +
           disposition : string option;

     

       299
       299
       +
           cid : string option;

     

       300
       300
       +
           language : string list option;

     

       301
       301
       +
           location : string option;

     

       302
       302
       +
           sub_parts : email_body_part list option;

     

       303
       303
       +
           header_parameter_name : string option;

     

       304
       304
       +
           header_parameter_value : string option;

     

       305
       305
       +
         }

     

       306
       306
       +
         

     

       307
       307
       +
         (** Email query filter condition. See RFC8621 Section 4.4. *)

     

       308
       308
       +
         type email_filter_condition = {

     

       309
       309
       +
           in_mailbox : id option;

     

       310
       310
       +
           in_mailbox_other_than : id list option;

     

       311
       311
       +
           min_size : unsigned_int option;

     

       312
       312
       +
           max_size : unsigned_int option;

     

       313
       313
       +
           before : utc_date option;

     

       314
       314
       +
           after : utc_date option;

     

       315
       315
       +
           header : (string * string) option;

     

       316
       316
       +
           from : string option;

     

       317
       317
       +
           to_ : string option;

     

       318
       318
       +
           cc : string option;

     

       319
       319
       +
           bcc : string option;

     

       320
       320
       +
           subject : string option;

     

       321
       321
       +
           body : string option;

     

       322
       322
       +
           has_keyword : string option;

     

       323
       323
       +
           not_keyword : string option;

     

       324
       324
       +
           has_attachment : bool option;

     

       325
       325
       +
           text : string option;

     

       326
       326
       +
         }

     

       327
       327
       +
       

     

       328
       328
       +
         type email_query_filter = [

     

       329
       329
       +
           | `And of email_query_filter list

     

       330
       330
       +
           | `Or of email_query_filter list

     

       331
       331
       +
           | `Not of email_query_filter

     

       332
       332
       +
           | `Condition of email_filter_condition

     

       333
       333
       +
         ]

     

       334
       334
       +
       

     

       335
       335
       +
         (** Email/get request arguments. See RFC8621 Section 4.5. *)

     

       336
       336
       +
         type email_get_arguments = {

     

       337
       337
       +
           account_id : id;

     

       338
       338
       +
           ids : id list option;

     

       339
       339
       +
           properties : string list option;

     

       340
       340
       +
           body_properties : string list option;

     

       341
       341
       +
           fetch_text_body_values : bool option;

     

       342
       342
       +
           fetch_html_body_values : bool option;

     

       343
       343
       +
           fetch_all_body_values : bool option;

     

       344
       344
       +
           max_body_value_bytes : unsigned_int option;

     

       345
       345
       +
         }

     

       346
       346
       +
       

     

       347
       347
       +
         (** Email/get response. See RFC8621 Section 4.5. *)

     

       348
       348
       +
         type email_get_response = {

     

       349
       349
       +
           account_id : id;

     

       350
       350
       +
           state : string;

     

       351
       351
       +
           list : email list;

     

       352
       352
       +
           not_found : id list;

     

       353
       353
       +
         }

     

       354
       354
       +
       

     

       355
       355
       +
         (** Email/changes request arguments. See RFC8621 Section 4.6. *)

     

       356
       356
       +
         type email_changes_arguments = {

     

       357
       357
       +
           account_id : id;

     

       358
       358
       +
           since_state : string;

     

       359
       359
       +
           max_changes : unsigned_int option;

     

       360
       360
       +
         }

     

       361
       361
       +
       

     

       362
       362
       +
         (** Email/changes response. See RFC8621 Section 4.6. *)

     

       363
       363
       +
         type email_changes_response = {

     

       364
       364
       +
           account_id : id;

     

       365
       365
       +
           old_state : string;

     

       366
       366
       +
           new_state : string;

     

       367
       367
       +
           has_more_changes : bool;

     

       368
       368
       +
           created : id list;

     

       369
       369
       +
           updated : id list;

     

       370
       370
       +
           destroyed : id list;

     

       371
       371
       +
         }

     

       372
       372
       +
       

     

       373
       373
       +
         (** Email/query request arguments. See RFC8621 Section 4.4. *)

     

       374
       374
       +
         type email_query_arguments = {

     

       375
       375
       +
           account_id : id;

     

       376
       376
       +
           filter : email_query_filter option;

     

       377
       377
       +
           sort : comparator list option;

     

       378
       378
       +
           collapse_threads : bool option;

     

       379
       379
       +
           position : unsigned_int option;

     

       380
       380
       +
           anchor : id option;

     

       381
       381
       +
           anchor_offset : int_t option;

     

       382
       382
       +
           limit : unsigned_int option;

     

       383
       383
       +
           calculate_total : bool option;

     

       384
       384
       +
         }

     

       385
       385
       +
       

     

       386
       386
       +
         (** Email/query response. See RFC8621 Section 4.4. *)

     

       387
       387
       +
         type email_query_response = {

     

       388
       388
       +
           account_id : id;

     

       389
       389
       +
           query_state : string;

     

       390
       390
       +
           can_calculate_changes : bool;

     

       391
       391
       +
           position : unsigned_int;

     

       392
       392
       +
           ids : id list;

     

       393
       393
       +
           total : unsigned_int option;

     

       394
       394
       +
           thread_ids : id list option;

     

       395
       395
       +
         }

     

       396
       396
       +
       

     

       397
       397
       +
         (** Email/queryChanges request arguments. See RFC8621 Section 4.7. *)

     

       398
       398
       +
         type email_query_changes_arguments = {

     

       399
       399
       +
           account_id : id;

     

       400
       400
       +
           filter : email_query_filter option;

     

       401
       401
       +
           sort : comparator list option;

     

       402
       402
       +
           collapse_threads : bool option;

     

       403
       403
       +
           since_query_state : string;

     

       404
       404
       +
           max_changes : unsigned_int option;

     

       405
       405
       +
           up_to_id : id option;

     

       406
       406
       +
         }

     

       407
       407
       +
       

     

       408
       408
       +
         (** Email/queryChanges response. See RFC8621 Section 4.7. *)

     

       409
       409
       +
         type email_query_changes_response = {

     

       410
       410
       +
           account_id : id;

     

       411
       411
       +
           old_query_state : string;

     

       412
       412
       +
           new_query_state : string;

     

       413
       413
       +
           total : unsigned_int option;

     

       414
       414
       +
           removed : id list;

     

       415
       415
       +
           added : email_query_changes_added list;

     

       416
       416
       +
         }

     

       417
       417
       +
       

     

       418
       418
       +
         and email_query_changes_added = {

     

       419
       419
       +
           id : id;

     

       420
       420
       +
           index : unsigned_int;

     

       421
       421
       +
         }

     

       422
       422
       +
       

     

       423
       423
       +
         (** Email/set request arguments. See RFC8621 Section 4.8. *)

     

       424
       424
       +
         type email_set_arguments = {

     

       425
       425
       +
           account_id : id;

     

       426
       426
       +
           if_in_state : string option;

     

       427
       427
       +
           create : (id * email_creation) list option;

     

       428
       428
       +
           update : (id * email_update) list option;

     

       429
       429
       +
           destroy : id list option;

     

       430
       430
       +
         }

     

       431
       431
       +
       

     

       432
       432
       +
         and email_creation = {

     

       433
       433
       +
           mailbox_ids : (id * bool) list;

     

       434
       434
       +
           keywords : (keyword * bool) list option;

     

       435
       435
       +
           received_at : utc_date option;

     

       436
       436
       +
           message_id : string list option;

     

       437
       437
       +
           in_reply_to : string list option;

     

       438
       438
       +
           references : string list option;

     

       439
       439
       +
           sender : email_address list option;

     

       440
       440
       +
           from : email_address list option;

     

       441
       441
       +
           to_ : email_address list option;

     

       442
       442
       +
           cc : email_address list option;

     

       443
       443
       +
           bcc : email_address list option;

     

       444
       444
       +
           reply_to : email_address list option;

     

       445
       445
       +
           subject : string option;

     

       446
       446
       +
           body_values : (string * string) list option;

     

       447
       447
       +
           text_body : email_body_part list option;

     

       448
       448
       +
           html_body : email_body_part list option;

     

       449
       449
       +
           attachments : email_body_part list option;

     

       450
       450
       +
           headers : header list option;

     

       451
       451
       +
         }

     

       452
       452
       +
       

     

       453
       453
       +
         and email_update = {

     

       454
       454
       +
           keywords : (keyword * bool) list option;

     

       455
       455
       +
           mailbox_ids : (id * bool) list option;

     

       456
       456
       +
         }

     

       457
       457
       +
       

     

       458
       458
       +
         (** Email/set response. See RFC8621 Section 4.8. *)

     

       459
       459
       +
         type email_set_response = {

     

       460
       460
       +
           account_id : id;

     

       461
       461
       +
           old_state : string option;

     

       462
       462
       +
           new_state : string;

     

       463
       463
       +
           created : (id * email) list option;

     

       464
       464
       +
           updated : id list option;

     

       465
       465
       +
           destroyed : id list option;

     

       466
       466
       +
           not_created : (id * set_error) list option;

     

       467
       467
       +
           not_updated : (id * set_error) list option;

     

       468
       468
       +
           not_destroyed : (id * set_error) list option;

     

       469
       469
       +
         }

     

       470
       470
       +
       

     

       471
       471
       +
         (** Email/copy request arguments. See RFC8621 Section 4.9. *)

     

       472
       472
       +
         type email_copy_arguments = {

     

       473
       473
       +
           from_account_id : id;

     

       474
       474
       +
           account_id : id;

     

       475
       475
       +
           create : (id * email_creation) list;

     

       476
       476
       +
           on_success_destroy_original : bool option;

     

       477
       477
       +
         }

     

       478
       478
       +
       

     

       479
       479
       +
         (** Email/copy response. See RFC8621 Section 4.9. *)

     

       480
       480
       +
         type email_copy_response = {

     

       481
       481
       +
           from_account_id : id;

     

       482
       482
       +
           account_id : id;

     

       483
       483
       +
           created : (id * email) list option;

     

       484
       484
       +
           not_created : (id * set_error) list option;

     

       485
       485
       +
         }

     

       486
       486
       +
       

     

       487
       487
       +
         (** Email/import request arguments. See RFC8621 Section 4.10. *)

     

       488
       488
       +
         type email_import_arguments = {

     

       489
       489
       +
           account_id : id;

     

       490
       490
       +
           emails : (id * email_import) list;

     

       491
       491
       +
         }

     

       492
       492
       +
       

     

       493
       493
       +
         and email_import = {

     

       494
       494
       +
           blob_id : id;

     

       495
       495
       +
           mailbox_ids : (id * bool) list;

     

       496
       496
       +
           keywords : (keyword * bool) list option;

     

       497
       497
       +
           received_at : utc_date option;

     

       498
       498
       +
         }

     

       499
       499
       +
       

     

       500
       500
       +
         (** Email/import response. See RFC8621 Section 4.10. *)

     

       501
       501
       +
         type email_import_response = {

     

       502
       502
       +
           account_id : id;

     

       503
       503
       +
           created : (id * email) list option;

     

       504
       504
       +
           not_created : (id * set_error) list option;

     

       505
       505
       +
         }

     

       506
       506
       +
       

     

       507
       507
       +
         (** {1:search_snippet Search snippets} *)

     

       508
       508
       +
       

     

       509
       509
       +
         (** SearchSnippet/get request arguments. See RFC8621 Section 4.11. *)

     

       510
       510
       +
         type search_snippet_get_arguments = {

     

       511
       511
       +
           account_id : id;

     

       512
       512
       +
           email_ids : id list;

     

       513
       513
       +
           filter : email_filter_condition;

     

       514
       514
       +
         }

     

       515
       515
       +
       

     

       516
       516
       +
         (** SearchSnippet/get response. See RFC8621 Section 4.11. *)

     

       517
       517
       +
         type search_snippet_get_response = {

     

       518
       518
       +
           account_id : id;

     

       519
       519
       +
           list : (id * search_snippet) list;

     

       520
       520
       +
           not_found : id list;

     

       521
       521
       +
         }

     

       522
       522
       +
       

     

       523
       523
       +
         and search_snippet = {

     

       524
       524
       +
           subject : string option;

     

       525
       525
       +
           preview : string option;

     

       526
       526
       +
         }

     

       527
       527
       +
       

     

       528
       528
       +
         (** {1:submission EmailSubmission objects} *)

     

       529
       529
       +
       

     

       530
       530
       +
         (** EmailSubmission address. See RFC8621 Section 5.1. *)

     

       531
       531
       +
         type submission_address = {

     

       532
       532
       +
           email : string;

     

       533
       533
       +
           parameters : (string * string) list option;

     

       534
       534
       +
         }

     

       535
       535
       +
       

     

       536
       536
       +
         (** Email submission object. See RFC8621 Section 5.1. *)

     

       537
       537
       +
         type email_submission = {

     

       538
       538
       +
           id : id;

     

       539
       539
       +
           identity_id : id;

     

       540
       540
       +
           email_id : id;

     

       541
       541
       +
           thread_id : id;

     

       542
       542
       +
           envelope : envelope option;

     

       543
       543
       +
           send_at : utc_date option;

     

       544
       544
       +
           undo_status : [

     

       545
       545
       +
             | `pending

     

       546
       546
       +
             | `final

     

       547
       547
       +
             | `canceled

     

       548
       548
       +
           ] option;

     

       549
       549
       +
           delivery_status : (string * submission_status) list option;

     

       550
       550
       +
           dsn_blob_ids : (string * id) list option;

     

       551
       551
       +
           mdn_blob_ids : (string * id) list option;

     

       552
       552
       +
         }

     

       553
       553
       +
       

     

       554
       554
       +
         (** Envelope for mail submission. See RFC8621 Section 5.1. *)

     

       555
       555
       +
         and envelope = {

     

       556
       556
       +
           mail_from : submission_address;

     

       557
       557
       +
           rcpt_to : submission_address list;

     

       558
       558
       +
         }

     

       559
       559
       +
       

     

       560
       560
       +
         (** Delivery status for submitted email. See RFC8621 Section 5.1. *)

     

       561
       561
       +
         and submission_status = {

     

       562
       562
       +
           smtp_reply : string;

     

       563
       563
       +
           delivered : string option;

     

       564
       564
       +
         }

     

       565
       565
       +
       

     

       566
       566
       +
         (** EmailSubmission/get request arguments. See RFC8621 Section 5.3. *)

     

       567
       567
       +
         type email_submission_get_arguments = {

     

       568
       568
       +
           account_id : id;

     

       569
       569
       +
           ids : id list option;

     

       570
       570
       +
           properties : string list option;

     

       571
       571
       +
         }

     

       572
       572
       +
       

     

       573
       573
       +
         (** EmailSubmission/get response. See RFC8621 Section 5.3. *)

     

       574
       574
       +
         type email_submission_get_response = {

     

       575
       575
       +
           account_id : id;

     

       576
       576
       +
           state : string;

     

       577
       577
       +
           list : email_submission list;

     

       578
       578
       +
           not_found : id list;

     

       579
       579
       +
         }

     

       580
       580
       +
       

     

       581
       581
       +
         (** EmailSubmission/changes request arguments. See RFC8621 Section 5.4. *)

     

       582
       582
       +
         type email_submission_changes_arguments = {

     

       583
       583
       +
           account_id : id;

     

       584
       584
       +
           since_state : string;

     

       585
       585
       +
           max_changes : unsigned_int option;

     

       586
       586
       +
         }

     

       587
       587
       +
       

     

       588
       588
       +
         (** EmailSubmission/changes response. See RFC8621 Section 5.4. *)

     

       589
       589
       +
         type email_submission_changes_response = {

     

       590
       590
       +
           account_id : id;

     

       591
       591
       +
           old_state : string;

     

       592
       592
       +
           new_state : string;

     

       593
       593
       +
           has_more_changes : bool;

     

       594
       594
       +
           created : id list;

     

       595
       595
       +
           updated : id list;

     

       596
       596
       +
           destroyed : id list;

     

       597
       597
       +
         }

     

       598
       598
       +
       

     

       599
       599
       +
         (** EmailSubmission/query filter condition. See RFC8621 Section 5.5. *)

     

       600
       600
       +
         type email_submission_filter_condition = {

     

       601
       601
       +
           identity_id : id option;

     

       602
       602
       +
           email_id : id option;

     

       603
       603
       +
           thread_id : id option;

     

       604
       604
       +
           before : utc_date option;

     

       605
       605
       +
           after : utc_date option;

     

       606
       606
       +
           subject : string option;

     

       607
       607
       +
         }

     

       608
       608
       +
       

     

       609
       609
       +
         type email_submission_query_filter = [

     

       610
       610
       +
           | `And of email_submission_query_filter list

     

       611
       611
       +
           | `Or of email_submission_query_filter list

     

       612
       612
       +
           | `Not of email_submission_query_filter

     

       613
       613
       +
           | `Condition of email_submission_filter_condition

     

       614
       614
       +
         ]

     

       615
       615
       +
       

     

       616
       616
       +
         (** EmailSubmission/query request arguments. See RFC8621 Section 5.5. *)

     

       617
       617
       +
         type email_submission_query_arguments = {

     

       618
       618
       +
           account_id : id;

     

       619
       619
       +
           filter : email_submission_query_filter option;

     

       620
       620
       +
           sort : comparator list option;

     

       621
       621
       +
           position : unsigned_int option;

     

       622
       622
       +
           anchor : id option;

     

       623
       623
       +
           anchor_offset : int_t option;

     

       624
       624
       +
           limit : unsigned_int option;

     

       625
       625
       +
           calculate_total : bool option;

     

       626
       626
       +
         }

     

       627
       627
       +
       

     

       628
       628
       +
         (** EmailSubmission/query response. See RFC8621 Section 5.5. *)

     

       629
       629
       +
         type email_submission_query_response = {

     

       630
       630
       +
           account_id : id;

     

       631
       631
       +
           query_state : string;

     

       632
       632
       +
           can_calculate_changes : bool;

     

       633
       633
       +
           position : unsigned_int;

     

       634
       634
       +
           ids : id list;

     

       635
       635
       +
           total : unsigned_int option;

     

       636
       636
       +
         }

     

       637
       637
       +
       

     

       638
       638
       +
         (** EmailSubmission/set request arguments. See RFC8621 Section 5.6. *)

     

       639
       639
       +
         type email_submission_set_arguments = {

     

       640
       640
       +
           account_id : id;

     

       641
       641
       +
           if_in_state : string option;

     

       642
       642
       +
           create : (id * email_submission_creation) list option;

     

       643
       643
       +
           update : (id * email_submission_update) list option;

     

       644
       644
       +
           destroy : id list option;

     

       645
       645
       +
           on_success_update_email : (id * email_update) list option;

     

       646
       646
       +
         }

     

       647
       647
       +
       

     

       648
       648
       +
         and email_submission_creation = {

     

       649
       649
       +
           email_id : id;

     

       650
       650
       +
           identity_id : id;

     

       651
       651
       +
           envelope : envelope option;

     

       652
       652
       +
           send_at : utc_date option;

     

       653
       653
       +
         }

     

       654
       654
       +
       

     

       655
       655
       +
         and email_submission_update = {

     

       656
       656
       +
           email_id : id option;

     

       657
       657
       +
           identity_id : id option;

     

       658
       658
       +
           envelope : envelope option;

     

       659
       659
       +
           undo_status : [`canceled] option;

     

       660
       660
       +
         }

     

       661
       661
       +
       

     

       662
       662
       +
         (** EmailSubmission/set response. See RFC8621 Section 5.6. *)

     

       663
       663
       +
         type email_submission_set_response = {

     

       664
       664
       +
           account_id : id;

     

       665
       665
       +
           old_state : string option;

     

       666
       666
       +
           new_state : string;

     

       667
       667
       +
           created : (id * email_submission) list option;

     

       668
       668
       +
           updated : id list option;

     

       669
       669
       +
           destroyed : id list option;

     

       670
       670
       +
           not_created : (id * set_error) list option;

     

       671
       671
       +
           not_updated : (id * set_error) list option;

     

       672
       672
       +
           not_destroyed : (id * set_error) list option;

     

       673
       673
       +
         }

     

       674
       674
       +
       

     

       675
       675
       +
         (** {1:identity Identity objects} *)

     

       676
       676
       +
       

     

       677
       677
       +
         (** Identity for sending mail. See RFC8621 Section 6. *)

     

       678
       678
       +
         type identity = {

     

       679
       679
       +
           id : id;

     

       680
       680
       +
           name : string;

     

       681
       681
       +
           email : string;

     

       682
       682
       +
           reply_to : email_address list option;

     

       683
       683
       +
           bcc : email_address list option;

     

       684
       684
       +
           text_signature : string option;

     

       685
       685
       +
           html_signature : string option;

     

       686
       686
       +
           may_delete : bool;

     

       687
       687
       +
         }

     

       688
       688
       +
       

     

       689
       689
       +
         (** Identity/get request arguments. See RFC8621 Section 6.1. *)

     

       690
       690
       +
         type identity_get_arguments = {

     

       691
       691
       +
           account_id : id;

     

       692
       692
       +
           ids : id list option;

     

       693
       693
       +
           properties : string list option;

     

       694
       694
       +
         }

     

       695
       695
       +
       

     

       696
       696
       +
         (** Identity/get response. See RFC8621 Section 6.1. *)

     

       697
       697
       +
         type identity_get_response = {

     

       698
       698
       +
           account_id : id;

     

       699
       699
       +
           state : string;

     

       700
       700
       +
           list : identity list;

     

       701
       701
       +
           not_found : id list;

     

       702
       702
       +
         }

     

       703
       703
       +
       

     

       704
       704
       +
         (** Identity/changes request arguments. See RFC8621 Section 6.2. *)

     

       705
       705
       +
         type identity_changes_arguments = {

     

       706
       706
       +
           account_id : id;

     

       707
       707
       +
           since_state : string;

     

       708
       708
       +
           max_changes : unsigned_int option;

     

       709
       709
       +
         }

     

       710
       710
       +
       

     

       711
       711
       +
         (** Identity/changes response. See RFC8621 Section 6.2. *)

     

       712
       712
       +
         type identity_changes_response = {

     

       713
       713
       +
           account_id : id;

     

       714
       714
       +
           old_state : string;

     

       715
       715
       +
           new_state : string;

     

       716
       716
       +
           has_more_changes : bool;

     

       717
       717
       +
           created : id list;

     

       718
       718
       +
           updated : id list;

     

       719
       719
       +
           destroyed : id list;

     

       720
       720
       +
         }

     

       721
       721
       +
       

     

       722
       722
       +
         (** Identity/set request arguments. See RFC8621 Section 6.3. *)

     

       723
       723
       +
         type identity_set_arguments = {

     

       724
       724
       +
           account_id : id;

     

       725
       725
       +
           if_in_state : string option;

     

       726
       726
       +
           create : (id * identity_creation) list option;

     

       727
       727
       +
           update : (id * identity_update) list option;

     

       728
       728
       +
           destroy : id list option;

     

       729
       729
       +
         }

     

       730
       730
       +
       

     

       731
       731
       +
         and identity_creation = {

     

       732
       732
       +
           name : string;

     

       733
       733
       +
           email : string;

     

       734
       734
       +
           reply_to : email_address list option;

     

       735
       735
       +
           bcc : email_address list option;

     

       736
       736
       +
           text_signature : string option;

     

       737
       737
       +
           html_signature : string option;

     

       738
       738
       +
         }

     

       739
       739
       +
       

     

       740
       740
       +
         and identity_update = {

     

       741
       741
       +
           name : string option;

     

       742
       742
       +
           email : string option;

     

       743
       743
       +
           reply_to : email_address list option;

     

       744
       744
       +
           bcc : email_address list option;

     

       745
       745
       +
           text_signature : string option;

     

       746
       746
       +
           html_signature : string option;

     

       747
       747
       +
         }

     

       748
       748
       +
       

     

       749
       749
       +
         (** Identity/set response. See RFC8621 Section 6.3. *)

     

       750
       750
       +
         type identity_set_response = {

     

       751
       751
       +
           account_id : id;

     

       752
       752
       +
           old_state : string option;

     

       753
       753
       +
           new_state : string;

     

       754
       754
       +
           created : (id * identity) list option;

     

       755
       755
       +
           updated : id list option;

     

       756
       756
       +
           destroyed : id list option;

     

       757
       757
       +
           not_created : (id * set_error) list option;

     

       758
       758
       +
           not_updated : (id * set_error) list option;

     

       759
       759
       +
           not_destroyed : (id * set_error) list option;

     

       760
       760
       +
         }

     

       761
       761
       +
       

     

       762
       762
       +
         (** {1:vacation_response VacationResponse objects} *)

     

       763
       763
       +
       

     

       764
       764
       +
         (** Vacation auto-reply setting. See RFC8621 Section 7. *)

     

       765
       765
       +
         type vacation_response = {

     

       766
       766
       +
           id : id;

     

       767
       767
       +
           is_enabled : bool;

     

       768
       768
       +
           from_date : utc_date option;

     

       769
       769
       +
           to_date : utc_date option;

     

       770
       770
       +
           subject : string option;

     

       771
       771
       +
           text_body : string option;

     

       772
       772
       +
           html_body : string option;

     

       773
       773
       +
         }

     

       774
       774
       +
       

     

       775
       775
       +
         (** VacationResponse/get request arguments. See RFC8621 Section 7.2. *)

     

       776
       776
       +
         type vacation_response_get_arguments = {

     

       777
       777
       +
           account_id : id;

     

       778
       778
       +
           ids : id list option;

     

       779
       779
       +
           properties : string list option;

     

       780
       780
       +
         }

     

       781
       781
       +
       

     

       782
       782
       +
         (** VacationResponse/get response. See RFC8621 Section 7.2. *)

     

       783
       783
       +
         type vacation_response_get_response = {

     

       784
       784
       +
           account_id : id;

     

       785
       785
       +
           state : string;

     

       786
       786
       +
           list : vacation_response list;

     

       787
       787
       +
           not_found : id list;

     

       788
       788
       +
         }

     

       789
       789
       +
       

     

       790
       790
       +
         (** VacationResponse/set request arguments. See RFC8621 Section 7.3. *)

     

       791
       791
       +
         type vacation_response_set_arguments = {

     

       792
       792
       +
           account_id : id;

     

       793
       793
       +
           if_in_state : string option;

     

       794
       794
       +
           update : (id * vacation_response_update) list;

     

       795
       795
       +
         }

     

       796
       796
       +
       

     

       797
       797
       +
         and vacation_response_update = {

     

       798
       798
       +
           is_enabled : bool option;

     

       799
       799
       +
           from_date : utc_date option;

     

       800
       800
       +
           to_date : utc_date option;

     

       801
       801
       +
           subject : string option;

     

       802
       802
       +
           text_body : string option;

     

       803
       803
       +
           html_body : string option;

     

       804
       804
       +
         }

     

       805
       805
       +
       

     

       806
       806
       +
         (** VacationResponse/set response. See RFC8621 Section 7.3. *)

     

       807
       807
       +
         type vacation_response_set_response = {

     

       808
       808
       +
           account_id : id;

     

       809
       809
       +
           old_state : string option;

     

       810
       810
       +
           new_state : string;

     

       811
       811
       +
           updated : id list option;

     

       812
       812
       +
           not_updated : (id * set_error) list option;

     

       813
       813
       +
         }

     

       814
       814
       +
       end

     

       815
       815
       +
       

     

       816
       816
       +
       (** {1 JSON serialization} *)

     

       817
       817
       +
       

     

       818
       818
       +
       module Json : sig

     

       819
       819
       +
         open Types

     

       820
       820
       +
       

     

       821
       821
       +
         (** {2 Helper functions for serialization} *)

     

       822
       822
       +
         

     

       823
       823
       +
         val string_of_mailbox_role : mailbox_role -> string

     

       824
       824
       +
         val mailbox_role_of_string : string -> mailbox_role

     

       825
       825
       +
         

     

       826
       826
       +
         val string_of_keyword : keyword -> string

     

       827
       827
       +
         val keyword_of_string : string -> keyword

     

       828
       828
       +
       

     

       829
       829
       +
         (** {2 Mailbox serialization} *)

     

       830
       830
       +
       

     

       831
       831
       +
         (** TODO:claude - Need to implement all JSON serialization functions 

     

       832
       832
       +
             for each type we've defined. This would be a substantial amount of

     

       833
       833
       +
             code and likely require additional understanding of the ezjsonm API.

     

       834
       834
       +
             

     

       835
       835
       +
             The interface would include functions like:

     

       836
       836
       +
             

     

       837
       837
       +
             val mailbox_to_json : mailbox -> Ezjsonm.value

     

       838
       838
       +
             val mailbox_of_json : Ezjsonm.value -> mailbox result

     

       839
       839
       +
             

     

       840
       840
       +
             And similarly for all other types.

     

       841
       841
       +
         *)

     

       842
       842
       +
       end

     

       843
       843
       +
       

     

       844
       844
       +
       (** {1 API functions} *)

     

       845
       845
       +
       

     

       846
       846
       +
       (** TODO:claude - Need to implement API functions for interacting with the 

     

       847
       847
       +
           mail-specific JMAP server endpoints. These would use the Jmap.Api module

     

       848
       848
       +
           to make HTTP requests and parse responses.

     

       849
       849
       +
           

     

       850
       850
       +
           The interface would include functions like:

     

       851
       851
       +
           

     

       852
       852
       +
           val get_mailboxes : Jmap.Api.session -> ?ids:id list -> ?properties:string list -> account_id:id -> (mailbox_get_response, error) result Lwt.t

     

       853
       853
       +
           

     

       854
       854
       +
           And similarly for all other API operations.

     

       855
       855
       +
       *)