@digipair/skill-imap 0.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/schema.json ADDED
@@ -0,0 +1,889 @@
1
+ {
2
+ "openapi": "3.0.0",
3
+ "info": {
4
+ "title": "@digipair/skill-imap",
5
+ "summary": "IMAP email management",
6
+ "description": "This skill allows managing IMAP emails.",
7
+ "version": "0.1.0",
8
+ "x-icon": "📨"
9
+ },
10
+ "paths": {
11
+ "/connect": {
12
+ "post": {
13
+ "tags": ["service"],
14
+ "summary": "Connect the client",
15
+ "parameters": [
16
+ {
17
+ "name": "config",
18
+ "summary": "Configuration",
19
+ "required": true,
20
+ "description": "IMAP client configuration",
21
+ "schema": {
22
+ "type": "object"
23
+ }
24
+ },
25
+ {
26
+ "name": "load",
27
+ "summary": "Loading",
28
+ "required": false,
29
+ "description": "Loading mailboxes",
30
+ "schema": {
31
+ "type": "array",
32
+ "items": {
33
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
34
+ }
35
+ }
36
+ },
37
+ {
38
+ "name": "close",
39
+ "summary": "Closing",
40
+ "required": false,
41
+ "description": "Closing mailboxes",
42
+ "schema": {
43
+ "type": "array",
44
+ "items": {
45
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
46
+ }
47
+ }
48
+ },
49
+ {
50
+ "name": "error",
51
+ "summary": "Error",
52
+ "required": false,
53
+ "description": "Error handling",
54
+ "schema": {
55
+ "type": "array",
56
+ "items": {
57
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
58
+ }
59
+ }
60
+ },
61
+ {
62
+ "name": "exists",
63
+ "summary": "Exists",
64
+ "required": false,
65
+ "description": "Check existence of mailboxes",
66
+ "schema": {
67
+ "type": "array",
68
+ "items": {
69
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
70
+ }
71
+ }
72
+ },
73
+ {
74
+ "name": "expunge",
75
+ "summary": "Expunge",
76
+ "required": false,
77
+ "description": "Expunge mailboxes",
78
+ "schema": {
79
+ "type": "array",
80
+ "items": {
81
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
82
+ }
83
+ }
84
+ },
85
+ {
86
+ "name": "flags",
87
+ "summary": "Flags",
88
+ "required": false,
89
+ "description": "Flag management",
90
+ "schema": {
91
+ "type": "array",
92
+ "items": {
93
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
94
+ }
95
+ }
96
+ },
97
+ {
98
+ "name": "log",
99
+ "summary": "Log",
100
+ "required": false,
101
+ "description": "Log",
102
+ "schema": {
103
+ "type": "array",
104
+ "items": {
105
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
106
+ }
107
+ }
108
+ },
109
+ {
110
+ "name": "mailboxClose",
111
+ "summary": "Log",
112
+ "required": false,
113
+ "description": "Log",
114
+ "schema": {
115
+ "type": "array",
116
+ "items": {
117
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
118
+ }
119
+ }
120
+ },
121
+ {
122
+ "name": "mailboxOpen",
123
+ "summary": "Log",
124
+ "required": false,
125
+ "description": "Log",
126
+ "schema": {
127
+ "type": "array",
128
+ "items": {
129
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
130
+ }
131
+ }
132
+ }
133
+ ],
134
+ "x-events": []
135
+ }
136
+ },
137
+ "/search": {
138
+ "post": {
139
+ "tags": ["service"],
140
+ "summary": "Search messages",
141
+ "parameters": [
142
+ {
143
+ "name": "client",
144
+ "summary": "Client",
145
+ "required": false,
146
+ "description": "IMAP client",
147
+ "schema": {
148
+ "type": "object"
149
+ }
150
+ },
151
+ {
152
+ "name": "query",
153
+ "summary": "Query",
154
+ "required": true,
155
+ "description": "Search query",
156
+ "schema": {
157
+ "type": "object"
158
+ }
159
+ },
160
+ {
161
+ "name": "attachments",
162
+ "summary": "Attachments",
163
+ "required": false,
164
+ "description": "Attachments",
165
+ "schema": {
166
+ "type": "string"
167
+ }
168
+ }
169
+ ],
170
+ "x-events": []
171
+ }
172
+ },
173
+ "/getMailboxLock": {
174
+ "post": {
175
+ "tags": ["service"],
176
+ "summary": "Retrieve locked IMAP mailbox",
177
+ "parameters": [
178
+ {
179
+ "name": "client",
180
+ "summary": "Client",
181
+ "required": false,
182
+ "description": "IMAP client",
183
+ "schema": {
184
+ "type": "object"
185
+ }
186
+ },
187
+ {
188
+ "name": "path",
189
+ "summary": "Path",
190
+ "required": false,
191
+ "description": "Mailbox path",
192
+ "schema": {
193
+ "type": "string"
194
+ }
195
+ },
196
+ {
197
+ "name": "options",
198
+ "summary": "Options",
199
+ "required": false,
200
+ "description": "Options",
201
+ "schema": {
202
+ "type": "object"
203
+ }
204
+ }
205
+ ],
206
+ "x-events": []
207
+ }
208
+ },
209
+ "/getQuota": {
210
+ "post": {
211
+ "tags": ["service"],
212
+ "summary": "Retrieve mailbox quota",
213
+ "parameters": [
214
+ {
215
+ "name": "client",
216
+ "summary": "Client",
217
+ "required": false,
218
+ "description": "IMAP client",
219
+ "schema": {
220
+ "type": "object"
221
+ }
222
+ },
223
+ {
224
+ "name": "path",
225
+ "summary": "Path",
226
+ "required": true,
227
+ "description": "Mailbox path",
228
+ "schema": {
229
+ "type": "string"
230
+ }
231
+ }
232
+ ],
233
+ "x-events": []
234
+ }
235
+ },
236
+ "/idle": {
237
+ "post": {
238
+ "tags": ["service"],
239
+ "summary": "Wait for messages",
240
+ "parameters": [
241
+ {
242
+ "name": "client",
243
+ "summary": "Client",
244
+ "required": false,
245
+ "description": "IMAP client",
246
+ "schema": {
247
+ "type": "object"
248
+ }
249
+ }
250
+ ],
251
+ "x-events": []
252
+ }
253
+ },
254
+ "/list": {
255
+ "post": {
256
+ "tags": ["service"],
257
+ "summary": "List mailboxes",
258
+ "parameters": [
259
+ {
260
+ "name": "client",
261
+ "summary": "Client",
262
+ "required": false,
263
+ "description": "IMAP client",
264
+ "schema": {
265
+ "type": "object"
266
+ }
267
+ },
268
+ {
269
+ "name": "options",
270
+ "summary": "Options",
271
+ "required": false,
272
+ "description": "Options",
273
+ "schema": {
274
+ "type": "object"
275
+ }
276
+ }
277
+ ],
278
+ "x-events": []
279
+ }
280
+ },
281
+ "/listTree": {
282
+ "post": {
283
+ "tags": ["service"],
284
+ "summary": "List mailboxes in tree",
285
+ "parameters": [
286
+ {
287
+ "name": "client",
288
+ "summary": "Client",
289
+ "required": false,
290
+ "description": "IMAP client",
291
+ "schema": {
292
+ "type": "object"
293
+ }
294
+ },
295
+ {
296
+ "name": "options",
297
+ "summary": "Options",
298
+ "required": false,
299
+ "description": "Options",
300
+ "schema": {
301
+ "type": "object"
302
+ }
303
+ }
304
+ ],
305
+ "x-events": []
306
+ }
307
+ },
308
+ "/logout": {
309
+ "post": {
310
+ "tags": ["service"],
311
+ "summary": "Disconnect the client",
312
+ "parameters": [
313
+ {
314
+ "name": "client",
315
+ "summary": "Client",
316
+ "required": false,
317
+ "description": "IMAP client",
318
+ "schema": {
319
+ "type": "object"
320
+ }
321
+ }
322
+ ],
323
+ "x-events": []
324
+ }
325
+ },
326
+ "/mailboxClose": {
327
+ "post": {
328
+ "tags": ["service"],
329
+ "summary": "Close the mailbox",
330
+ "parameters": [
331
+ {
332
+ "name": "client",
333
+ "summary": "Client",
334
+ "required": false,
335
+ "description": "IMAP client",
336
+ "schema": {
337
+ "type": "object"
338
+ }
339
+ }
340
+ ],
341
+ "x-events": []
342
+ }
343
+ },
344
+ "/mailboxCreate": {
345
+ "post": {
346
+ "tags": ["service"],
347
+ "summary": "Create a mailbox",
348
+ "parameters": [
349
+ {
350
+ "name": "client",
351
+ "summary": "Client",
352
+ "required": false,
353
+ "description": "IMAP client",
354
+ "schema": {
355
+ "type": "object"
356
+ }
357
+ },
358
+ {
359
+ "name": "path",
360
+ "summary": "Path",
361
+ "required": true,
362
+ "description": "Mailbox path",
363
+ "schema": {
364
+ "type": "string"
365
+ }
366
+ }
367
+ ],
368
+ "x-events": []
369
+ }
370
+ },
371
+ "/mailboxDelete": {
372
+ "post": {
373
+ "tags": ["service"],
374
+ "summary": "Delete a mailbox",
375
+ "parameters": [
376
+ {
377
+ "name": "client",
378
+ "summary": "Client",
379
+ "required": false,
380
+ "description": "IMAP client",
381
+ "schema": {
382
+ "type": "object"
383
+ }
384
+ },
385
+ {
386
+ "name": "path",
387
+ "summary": "Path",
388
+ "required": true,
389
+ "description": "Mailbox path",
390
+ "schema": {
391
+ "type": "string"
392
+ }
393
+ }
394
+ ],
395
+ "x-events": []
396
+ }
397
+ },
398
+ "/mailboxOpen": {
399
+ "post": {
400
+ "tags": ["service"],
401
+ "summary": "Open a mailbox",
402
+ "parameters": [
403
+ {
404
+ "name": "client",
405
+ "summary": "Client",
406
+ "required": false,
407
+ "description": "IMAP client",
408
+ "schema": {
409
+ "type": "object"
410
+ }
411
+ },
412
+ {
413
+ "name": "path",
414
+ "summary": "Path",
415
+ "required": true,
416
+ "description": "Mailbox path",
417
+ "schema": {
418
+ "type": "string"
419
+ }
420
+ },
421
+ {
422
+ "name": "options",
423
+ "summary": "Options",
424
+ "required": false,
425
+ "description": "Options",
426
+ "schema": {
427
+ "type": "object"
428
+ }
429
+ }
430
+ ],
431
+ "x-events": []
432
+ }
433
+ },
434
+ "/mailboxRename": {
435
+ "post": {
436
+ "tags": ["service"],
437
+ "summary": "Rename a mailbox",
438
+ "parameters": [
439
+ {
440
+ "name": "client",
441
+ "summary": "Client",
442
+ "required": false,
443
+ "description": "IMAP client",
444
+ "schema": {
445
+ "type": "object"
446
+ }
447
+ },
448
+ {
449
+ "name": "path",
450
+ "summary": "Path",
451
+ "required": true,
452
+ "description": "Mailbox path",
453
+ "schema": {
454
+ "type": "string"
455
+ }
456
+ },
457
+ {
458
+ "name": "newPath",
459
+ "summary": "New Path",
460
+ "required": true,
461
+ "description": "New mailbox path",
462
+ "schema": {
463
+ "type": "string"
464
+ }
465
+ }
466
+ ],
467
+ "x-events": []
468
+ }
469
+ },
470
+ "/mailboxSubscribe": {
471
+ "post": {
472
+ "tags": ["service"],
473
+ "summary": "Subscribe to a mailbox",
474
+ "parameters": [
475
+ {
476
+ "name": "client",
477
+ "summary": "Client",
478
+ "required": false,
479
+ "description": "IMAP client",
480
+ "schema": {
481
+ "type": "object"
482
+ }
483
+ },
484
+ {
485
+ "name": "path",
486
+ "summary": "Path",
487
+ "required": true,
488
+ "description": "Mailbox path",
489
+ "schema": {
490
+ "type": "string"
491
+ }
492
+ }
493
+ ],
494
+ "x-events": []
495
+ }
496
+ },
497
+ "/mailboxUnsubscribe": {
498
+ "post": {
499
+ "tags": ["service"],
500
+ "summary": "Unsubscribe from a mailbox",
501
+ "parameters": [
502
+ {
503
+ "name": "client",
504
+ "summary": "Client",
505
+ "required": false,
506
+ "description": "IMAP client",
507
+ "schema": {
508
+ "type": "object"
509
+ }
510
+ },
511
+ {
512
+ "name": "path",
513
+ "summary": "Path",
514
+ "required": true,
515
+ "description": "Mailbox path",
516
+ "schema": {
517
+ "type": "string"
518
+ }
519
+ }
520
+ ],
521
+ "x-events": []
522
+ }
523
+ },
524
+ "/messageCopy": {
525
+ "post": {
526
+ "tags": ["service"],
527
+ "summary": "Copy a message",
528
+ "parameters": [
529
+ {
530
+ "name": "client",
531
+ "summary": "Client",
532
+ "required": false,
533
+ "description": "IMAP client",
534
+ "schema": {
535
+ "type": "object"
536
+ }
537
+ },
538
+ {
539
+ "name": "range",
540
+ "summary": "Range",
541
+ "required": true,
542
+ "description": "Message range",
543
+ "schema": {
544
+ "type": "object"
545
+ }
546
+ },
547
+ {
548
+ "name": "destination",
549
+ "summary": "Destination",
550
+ "required": true,
551
+ "description": "Destination",
552
+ "schema": {
553
+ "type": "string"
554
+ }
555
+ },
556
+ {
557
+ "name": "options",
558
+ "summary": "Options",
559
+ "required": false,
560
+ "description": "Options",
561
+ "schema": {
562
+ "type": "object"
563
+ }
564
+ }
565
+ ],
566
+ "x-events": []
567
+ }
568
+ },
569
+ "/messageDelete": {
570
+ "post": {
571
+ "tags": ["service"],
572
+ "summary": "Delete a message",
573
+ "parameters": [
574
+ {
575
+ "name": "client",
576
+ "summary": "Client",
577
+ "required": false,
578
+ "description": "IMAP client",
579
+ "schema": {
580
+ "type": "object"
581
+ }
582
+ },
583
+ {
584
+ "name": "range",
585
+ "summary": "Range",
586
+ "required": true,
587
+ "description": "Message range",
588
+ "schema": {
589
+ "type": "object"
590
+ }
591
+ },
592
+ {
593
+ "name": "options",
594
+ "summary": "Options",
595
+ "required": false,
596
+ "description": "Options",
597
+ "schema": {
598
+ "type": "object"
599
+ }
600
+ }
601
+ ],
602
+ "x-events": []
603
+ }
604
+ },
605
+ "/messageFlagsAdd": {
606
+ "post": {
607
+ "tags": ["service"],
608
+ "summary": "Add flags to a message",
609
+ "parameters": [
610
+ {
611
+ "name": "client",
612
+ "summary": "Client",
613
+ "required": false,
614
+ "description": "IMAP client",
615
+ "schema": {
616
+ "type": "object"
617
+ }
618
+ },
619
+ {
620
+ "name": "range",
621
+ "summary": "Range",
622
+ "required": true,
623
+ "description": "Message range",
624
+ "schema": {
625
+ "type": "object"
626
+ }
627
+ },
628
+ {
629
+ "name": "flags",
630
+ "summary": "Flags",
631
+ "required": true,
632
+ "description": "Flags to add",
633
+ "schema": {
634
+ "type": "array",
635
+ "items": {
636
+ "type": "string"
637
+ }
638
+ }
639
+ },
640
+ {
641
+ "name": "options",
642
+ "summary": "Options",
643
+ "required": false,
644
+ "description": "Options",
645
+ "schema": {
646
+ "type": "object"
647
+ }
648
+ }
649
+ ],
650
+ "x-events": []
651
+ }
652
+ },
653
+ "/messageFlagsRemove": {
654
+ "post": {
655
+ "tags": ["service"],
656
+ "summary": "Remove flags from a message",
657
+ "parameters": [
658
+ {
659
+ "name": "client",
660
+ "summary": "Client",
661
+ "required": false,
662
+ "description": "IMAP client",
663
+ "schema": {
664
+ "type": "object"
665
+ }
666
+ },
667
+ {
668
+ "name": "range",
669
+ "summary": "Range",
670
+ "required": true,
671
+ "description": "Message range",
672
+ "schema": {
673
+ "type": "object"
674
+ }
675
+ },
676
+ {
677
+ "name": "flags",
678
+ "summary": "Flags",
679
+ "required": true,
680
+ "description": "Flags to remove",
681
+ "schema": {
682
+ "type": "array",
683
+ "items": {
684
+ "type": "string"
685
+ }
686
+ }
687
+ },
688
+ {
689
+ "name": "options",
690
+ "summary": "Options",
691
+ "required": false,
692
+ "description": "Options",
693
+ "schema": {
694
+ "type": "object"
695
+ }
696
+ }
697
+ ],
698
+ "x-events": []
699
+ }
700
+ },
701
+ "/messageFlagsSet": {
702
+ "post": {
703
+ "tags": ["service"],
704
+ "summary": "Set message flags",
705
+ "parameters": [
706
+ {
707
+ "name": "client",
708
+ "summary": "Client",
709
+ "required": false,
710
+ "description": "IMAP client",
711
+ "schema": {
712
+ "type": "object"
713
+ }
714
+ },
715
+ {
716
+ "name": "range",
717
+ "summary": "Range",
718
+ "required": true,
719
+ "description": "Message range",
720
+ "schema": {
721
+ "type": "object"
722
+ }
723
+ },
724
+ {
725
+ "name": "flags",
726
+ "summary": "Flags",
727
+ "required": true,
728
+ "description": "Flags to set",
729
+ "schema": {
730
+ "type": "array",
731
+ "items": {
732
+ "type": "string"
733
+ }
734
+ }
735
+ },
736
+ {
737
+ "name": "options",
738
+ "summary": "Options",
739
+ "required": false,
740
+ "description": "Options",
741
+ "schema": {
742
+ "type": "object"
743
+ }
744
+ }
745
+ ],
746
+ "x-events": []
747
+ }
748
+ },
749
+ "/messageMove": {
750
+ "post": {
751
+ "tags": ["service"],
752
+ "summary": "Move a message",
753
+ "parameters": [
754
+ {
755
+ "name": "client",
756
+ "summary": "Client",
757
+ "required": false,
758
+ "description": "IMAP client",
759
+ "schema": {
760
+ "type": "object"
761
+ }
762
+ },
763
+ {
764
+ "name": "range",
765
+ "summary": "Range",
766
+ "required": true,
767
+ "description": "Message range",
768
+ "schema": {
769
+ "type": "object"
770
+ }
771
+ },
772
+ {
773
+ "name": "destination",
774
+ "summary": "Destination",
775
+ "required": true,
776
+ "description": "Destination",
777
+ "schema": {
778
+ "type": "string"
779
+ }
780
+ },
781
+ {
782
+ "name": "options",
783
+ "summary": "Options",
784
+ "required": false,
785
+ "description": "Options",
786
+ "schema": {
787
+ "type": "object"
788
+ }
789
+ }
790
+ ],
791
+ "x-events": []
792
+ }
793
+ },
794
+ "/noop": {
795
+ "post": {
796
+ "tags": ["service"],
797
+ "summary": "No operation",
798
+ "parameters": [
799
+ {
800
+ "name": "client",
801
+ "summary": "Client",
802
+ "required": false,
803
+ "description": "IMAP client",
804
+ "schema": {
805
+ "type": "object"
806
+ }
807
+ }
808
+ ],
809
+ "x-events": []
810
+ }
811
+ },
812
+ "/setFlagColor": {
813
+ "post": {
814
+ "tags": ["service"],
815
+ "summary": "Set flag color",
816
+ "parameters": [
817
+ {
818
+ "name": "client",
819
+ "summary": "Client",
820
+ "required": false,
821
+ "description": "IMAP client",
822
+ "schema": {
823
+ "type": "object"
824
+ }
825
+ },
826
+ {
827
+ "name": "flag",
828
+ "summary": "Flag",
829
+ "required": true,
830
+ "description": "Flag",
831
+ "schema": {
832
+ "type": "string"
833
+ }
834
+ },
835
+ {
836
+ "name": "color",
837
+ "summary": "Color",
838
+ "required": true,
839
+ "description": "Flag color",
840
+ "schema": {
841
+ "type": "string"
842
+ }
843
+ }
844
+ ],
845
+ "x-events": []
846
+ }
847
+ },
848
+ "/status": {
849
+ "post": {
850
+ "tags": ["service"],
851
+ "summary": "Retrieve mailbox status",
852
+ "parameters": [
853
+ {
854
+ "name": "client",
855
+ "summary": "Client",
856
+ "required": false,
857
+ "description": "IMAP client",
858
+ "schema": {
859
+ "type": "object"
860
+ }
861
+ },
862
+ {
863
+ "name": "path",
864
+ "summary": "Path",
865
+ "required": true,
866
+ "description": "Mailbox path",
867
+ "schema": {
868
+ "type": "string"
869
+ }
870
+ },
871
+ {
872
+ "name": "query",
873
+ "summary": "Query",
874
+ "required": false,
875
+ "description": "Query",
876
+ "schema": {
877
+ "type": "object"
878
+ }
879
+ }
880
+ ],
881
+ "x-events": []
882
+ }
883
+ }
884
+ },
885
+ "components": {
886
+ "schemas": {}
887
+ },
888
+ "x-scene-blocks": {}
889
+ }