@digipair/skill-imap 0.96.0 → 0.97.1

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.
Files changed (3) hide show
  1. package/index.esm.js +5 -5
  2. package/package.json +1 -1
  3. package/schema.json +1586 -1191
package/schema.json CHANGED
@@ -10,7 +10,9 @@
10
10
  "paths": {
11
11
  "/parseOne": {
12
12
  "post": {
13
- "tags": ["service"],
13
+ "tags": [
14
+ "service"
15
+ ],
14
16
  "summary": "Parse a message",
15
17
  "parameters": [
16
18
  {
@@ -41,1239 +43,1632 @@
41
43
  }
42
44
  }
43
45
  ],
44
- "x-events": []
45
- }
46
- },
47
- "/parseAll": {
48
- "post": {
49
- "tags": ["service"],
50
- "summary": "Parse messages",
51
- "parameters": [
52
- {
53
- "name": "client",
54
- "summary": "Client",
55
- "required": false,
56
- "description": "IMAP Client",
57
- "schema": {
58
- "type": "object"
59
- }
60
- },
61
- {
62
- "name": "messages",
63
- "summary": "Messages",
64
- "required": true,
65
- "description": "List of messages to parse",
66
- "schema": {
67
- "type": "array",
68
- "items": {
69
- "type": "object"
46
+ "responses": {
47
+ "200": {
48
+ "description": "Parsed email message with content and attachments",
49
+ "content": {
50
+ "application/json": {
51
+ "schema": {
52
+ "type": "object",
53
+ "properties": {
54
+ "uid": {
55
+ "type": "number",
56
+ "description": "Message UID"
57
+ },
58
+ "seq": {
59
+ "type": "number",
60
+ "description": "Message sequence number"
61
+ },
62
+ "envelope": {
63
+ "type": "object",
64
+ "description": "Email envelope information",
65
+ "properties": {
66
+ "subject": {
67
+ "type": "string",
68
+ "description": "Email subject"
69
+ },
70
+ "from": {
71
+ "type": "array",
72
+ "description": "From addresses"
73
+ },
74
+ "to": {
75
+ "type": "array",
76
+ "description": "To addresses"
77
+ },
78
+ "date": {
79
+ "type": "string",
80
+ "format": "date-time",
81
+ "description": "Email date"
82
+ }
83
+ }
84
+ },
85
+ "contentText": {
86
+ "type": "string",
87
+ "description": "Plain text content of the email"
88
+ },
89
+ "contentHtml": {
90
+ "type": "string",
91
+ "description": "HTML content of the email"
92
+ },
93
+ "attachments": {
94
+ "type": "array",
95
+ "description": "Email attachments",
96
+ "items": {
97
+ "type": "object",
98
+ "properties": {
99
+ "meta": {
100
+ "type": "object",
101
+ "description": "Attachment metadata",
102
+ "properties": {
103
+ "filename": {
104
+ "type": "string",
105
+ "description": "Attachment filename"
106
+ },
107
+ "contentType": {
108
+ "type": "string",
109
+ "description": "MIME content type"
110
+ },
111
+ "size": {
112
+ "type": "number",
113
+ "description": "Size in bytes"
114
+ }
115
+ }
116
+ },
117
+ "content": {
118
+ "type": "string",
119
+ "description": "Base64-encoded attachment content"
120
+ }
121
+ }
122
+ }
123
+ }
124
+ }
125
+ "uid": 123,
126
+ "seq": 1,
127
+ "envelope": {
128
+ "subject": "Test Email",
129
+ "from": [
130
+ {
131
+ "address": "sender@example.com",
132
+ "name": "Sender"
133
+ }
134
+ ],
135
+ "to": [
136
+ {
137
+ "address": "recipient@example.com",
138
+ "name": "Recipient"
139
+ }
140
+ ],
141
+ "date": "2023-01-15T10:30:00Z"
142
+ },
143
+ "contentText": "Hello, this is a test email.",
144
+ "contentHtml": "<p>Hello, this is a test email.</p>",
145
+ "attachments": []
146
+ }
70
147
  }
71
148
  }
72
- },
73
- {
74
- "name": "attachments",
75
- "summary": "Attachments",
76
- "required": false,
77
- "description": "Attachments",
78
- "schema": {
79
- "type": "string"
80
- }
81
149
  }
82
- ],
83
- "x-events": []
84
- }
85
- },
86
- "/connect": {
87
- "post": {
88
- "tags": ["service"],
89
- "summary": "Connect the client",
90
- "parameters": [
91
- {
92
- "name": "config",
93
- "summary": "Configuration",
94
- "required": false,
95
- "description": "IMAP client configuration",
96
- "schema": {
97
- "type": "object"
98
- }
99
- },
100
- {
101
- "name": "configExecute",
102
- "summary": "Configuration execute",
103
- "required": false,
104
- "description": "Configuration execute",
105
- "schema": {
106
- "type": "array",
107
- "items": {
108
- "$ref": "https://schemas.digipair.ai/pinsSettings"
109
- }
110
- }
111
- },
112
- {
113
- "name": "load",
114
- "summary": "Loading",
115
- "required": false,
116
- "description": "Loading mailboxes",
117
- "schema": {
118
- "type": "array",
119
- "items": {
120
- "$ref": "https://schemas.digipair.ai/pinsSettings"
121
- }
122
- }
123
- },
124
- {
125
- "name": "close",
126
- "summary": "Closing",
127
- "required": false,
128
- "description": "Closing mailboxes",
129
- "schema": {
130
- "type": "array",
131
- "items": {
132
- "$ref": "https://schemas.digipair.ai/pinsSettings"
133
- }
134
- }
135
- },
136
- {
137
- "name": "error",
138
- "summary": "Error",
139
- "required": false,
140
- "description": "Error handling",
141
- "schema": {
142
- "type": "array",
143
- "items": {
144
- "$ref": "https://schemas.digipair.ai/pinsSettings"
145
- }
146
- }
147
- },
148
- {
149
- "name": "exists",
150
- "summary": "Exists",
151
- "required": false,
152
- "description": "Check existence of mailboxes",
153
- "schema": {
154
- "type": "array",
155
- "items": {
156
- "$ref": "https://schemas.digipair.ai/pinsSettings"
157
- }
158
- }
159
- },
160
- {
161
- "name": "expunge",
162
- "summary": "Expunge",
163
- "required": false,
164
- "description": "Expunge mailboxes",
165
- "schema": {
166
- "type": "array",
167
- "items": {
168
- "$ref": "https://schemas.digipair.ai/pinsSettings"
169
- }
170
- }
171
- },
172
- {
173
- "name": "flags",
174
- "summary": "Flags",
175
- "required": false,
176
- "description": "Flag management",
177
- "schema": {
178
- "type": "array",
179
- "items": {
180
- "$ref": "https://schemas.digipair.ai/pinsSettings"
181
- }
182
- }
183
- },
184
- {
185
- "name": "log",
186
- "summary": "Log",
187
- "required": false,
188
- "description": "Log",
189
- "schema": {
190
- "type": "array",
191
- "items": {
192
- "$ref": "https://schemas.digipair.ai/pinsSettings"
193
- }
194
- }
195
- },
196
- {
197
- "name": "mailboxClose",
198
- "summary": "Log",
199
- "required": false,
200
- "description": "Log",
201
- "schema": {
202
- "type": "array",
203
- "items": {
204
- "$ref": "https://schemas.digipair.ai/pinsSettings"
205
- }
206
- }
207
- },
208
- {
209
- "name": "mailboxOpen",
210
- "summary": "Log",
211
- "required": false,
212
- "description": "Log",
213
- "schema": {
214
- "type": "array",
215
- "items": {
216
- "$ref": "https://schemas.digipair.ai/pinsSettings"
217
- }
218
- }
150
+ }
151
+ },
152
+ "x-events": []
153
+ }
154
+ },
155
+ "/parseAll": {
156
+ "post": {
157
+ "tags": [
158
+ "service"
159
+ ],
160
+ "summary": "Parse messages",
161
+ "parameters": [
162
+ {
163
+ "name": "client",
164
+ "summary": "Client",
165
+ "required": false,
166
+ "description": "IMAP Client",
167
+ "schema": {
168
+ "type": "object"
219
169
  }
220
- ],
221
- "x-events": []
222
- }
223
- },
224
- "/search": {
225
- "post": {
226
- "tags": ["service"],
227
- "summary": "Search messages",
228
- "parameters": [
229
- {
230
- "name": "client",
231
- "summary": "Client",
232
- "required": false,
233
- "description": "IMAP Client",
234
- "schema": {
235
- "type": "object"
236
- }
237
- },
238
- {
239
- "name": "query",
240
- "summary": "Query",
241
- "required": true,
242
- "description": "Search query",
243
- "schema": {
244
- "type": "object"
245
- }
246
- },
247
- {
248
- "name": "options",
249
- "summary": "Options",
250
- "required": false,
251
- "description": "Options",
252
- "schema": {
170
+ },
171
+ {
172
+ "name": "messages",
173
+ "summary": "Messages",
174
+ "required": true,
175
+ "description": "List of messages to parse",
176
+ "schema": {
177
+ "type": "array",
178
+ "items": {
253
179
  "type": "object"
254
180
  }
255
181
  }
256
- ],
257
- "x-events": []
258
- }
259
- },
260
- "/getMailboxLock": {
261
- "post": {
262
- "tags": ["service"],
263
- "summary": "Retrieve the locked IMAP mailbox",
264
- "parameters": [
265
- {
266
- "name": "client",
267
- "summary": "Client",
268
- "required": false,
269
- "description": "IMAP Client",
270
- "schema": {
271
- "type": "object"
272
- }
273
- },
274
- {
275
- "name": "path",
276
- "summary": "Path",
277
- "required": false,
278
- "description": "Mailbox path",
279
- "schema": {
280
- "type": "string"
281
- }
282
- },
283
- {
284
- "name": "options",
285
- "summary": "Options",
286
- "required": false,
287
- "description": "Options",
288
- "schema": {
289
- "type": "object"
182
+ },
183
+ {
184
+ "name": "attachments",
185
+ "summary": "Attachments",
186
+ "required": false,
187
+ "description": "Attachments",
188
+ "schema": {
189
+ "type": "string"
190
+ }
191
+ }
192
+ ],
193
+ "responses": {
194
+ "200": {
195
+ "description": "Array of parsed email messages with content and attachments",
196
+ "content": {
197
+ "application/json": {
198
+ "schema": {
199
+ "type": "array",
200
+ "items": {
201
+ "$ref": "#/components/schemas/ParsedMessage"
202
+ }
203
+ {
204
+ "uid": 123,
205
+ "seq": 1,
206
+ "envelope": {
207
+ "subject": "Test Email 1",
208
+ "from": [
209
+ {
210
+ "address": "sender1@example.com",
211
+ "name": "Sender 1"
212
+ }
213
+ ],
214
+ "date": "2023-01-15T10:30:00Z"
215
+ },
216
+ "contentText": "Hello, this is test email 1.",
217
+ "attachments": []
218
+ },
219
+ {
220
+ "uid": 124,
221
+ "seq": 2,
222
+ "envelope": {
223
+ "subject": "Test Email 2",
224
+ "from": [
225
+ {
226
+ "address": "sender2@example.com",
227
+ "name": "Sender 2"
228
+ }
229
+ ],
230
+ "date": "2023-01-15T11:30:00Z"
231
+ },
232
+ "contentText": "Hello, this is test email 2.",
233
+ "attachments": []
234
+ }
235
+ ]
290
236
  }
291
237
  }
292
- ],
293
- "x-events": []
238
+ }
294
239
  }
295
240
  },
296
- "/getQuota": {
297
- "post": {
298
- "tags": ["service"],
299
- "summary": "Retrieve the mailbox quota",
300
- "parameters": [
301
- {
302
- "name": "client",
303
- "summary": "Client",
304
- "required": false,
305
- "description": "IMAP Client",
306
- "schema": {
307
- "type": "object"
308
- }
309
- },
310
- {
311
- "name": "path",
312
- "summary": "Path",
313
- "required": true,
314
- "description": "Mailbox path",
315
- "schema": {
316
- "type": "string"
317
- }
241
+ "x-events": []
242
+ }
243
+ },
244
+ "/connect": {
245
+ "post": {
246
+ "tags": [
247
+ "service"
248
+ ],
249
+ "summary": "Connect the client",
250
+ "parameters": [
251
+ {
252
+ "name": "config",
253
+ "summary": "Configuration",
254
+ "required": false,
255
+ "description": "IMAP client configuration",
256
+ "schema": {
257
+ "type": "object"
258
+ }
259
+ },
260
+ {
261
+ "name": "configExecute",
262
+ "summary": "Configuration execute",
263
+ "required": false,
264
+ "description": "Configuration execute",
265
+ "schema": {
266
+ "type": "array",
267
+ "items": {
268
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
318
269
  }
319
- ],
320
- "x-events": []
270
+ }
271
+ },
272
+ {
273
+ "name": "load",
274
+ "summary": "Loading",
275
+ "required": false,
276
+ "description": "Loading mailboxes",
277
+ "schema": {
278
+ "type": "array",
279
+ "items": {
280
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
281
+ }
282
+ }
283
+ },
284
+ {
285
+ "name": "close",
286
+ "summary": "Closing",
287
+ "required": false,
288
+ "description": "Closing mailboxes",
289
+ "schema": {
290
+ "type": "array",
291
+ "items": {
292
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
293
+ }
294
+ }
295
+ },
296
+ {
297
+ "name": "error",
298
+ "summary": "Error",
299
+ "required": false,
300
+ "description": "Error handling",
301
+ "schema": {
302
+ "type": "array",
303
+ "items": {
304
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
305
+ }
306
+ }
307
+ },
308
+ {
309
+ "name": "exists",
310
+ "summary": "Exists",
311
+ "required": false,
312
+ "description": "Check existence of mailboxes",
313
+ "schema": {
314
+ "type": "array",
315
+ "items": {
316
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
317
+ }
318
+ }
319
+ },
320
+ {
321
+ "name": "expunge",
322
+ "summary": "Expunge",
323
+ "required": false,
324
+ "description": "Expunge mailboxes",
325
+ "schema": {
326
+ "type": "array",
327
+ "items": {
328
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
329
+ }
330
+ }
331
+ },
332
+ {
333
+ "name": "flags",
334
+ "summary": "Flags",
335
+ "required": false,
336
+ "description": "Flag management",
337
+ "schema": {
338
+ "type": "array",
339
+ "items": {
340
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
341
+ }
342
+ }
343
+ },
344
+ {
345
+ "name": "log",
346
+ "summary": "Log",
347
+ "required": false,
348
+ "description": "Log",
349
+ "schema": {
350
+ "type": "array",
351
+ "items": {
352
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
353
+ }
354
+ }
355
+ },
356
+ {
357
+ "name": "mailboxClose",
358
+ "summary": "Log",
359
+ "required": false,
360
+ "description": "Log",
361
+ "schema": {
362
+ "type": "array",
363
+ "items": {
364
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
365
+ }
366
+ }
367
+ },
368
+ {
369
+ "name": "mailboxOpen",
370
+ "summary": "Log",
371
+ "required": false,
372
+ "description": "Log",
373
+ "schema": {
374
+ "type": "array",
375
+ "items": {
376
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
377
+ }
378
+ }
321
379
  }
322
- },
323
- "/idle": {
324
- "post": {
325
- "tags": ["service"],
326
- "summary": "Wait for messages",
327
- "parameters": [
328
- {
329
- "name": "client",
330
- "summary": "Client",
331
- "required": false,
332
- "description": "IMAP Client",
333
- "schema": {
334
- "type": "object"
380
+ ],
381
+ "responses": {
382
+ "200": {
383
+ "description": "IMAP service instance with established connection",
384
+ "content": {
385
+ "application/json": {
386
+ "schema": {
387
+ "type": "object",
388
+ "description": "IMAP service instance",
389
+ "properties": {
390
+ "imap": {
391
+ "type": "object",
392
+ "description": "ImapFlow client instance"
393
+ },
394
+ "forceClose": {
395
+ "type": "boolean",
396
+ "description": "Force close flag"
397
+ }
398
+ }
399
+ "imap": {},
400
+ "forceClose": false
335
401
  }
336
402
  }
337
- ],
338
- "x-events": []
403
+ }
404
+ }
405
+ }
406
+ },
407
+ "x-events": []
408
+ }
409
+ },
410
+ "/search": {
411
+ "post": {
412
+ "tags": [
413
+ "service"
414
+ ],
415
+ "summary": "Search messages",
416
+ "parameters": [
417
+ {
418
+ "name": "client",
419
+ "summary": "Client",
420
+ "required": false,
421
+ "description": "IMAP Client",
422
+ "schema": {
423
+ "type": "object"
339
424
  }
340
425
  },
341
- "/list": {
342
- "post": {
343
- "tags": ["service"],
344
- "summary": "List mailboxes",
345
- "parameters": [
346
- {
347
- "name": "client",
348
- "summary": "Client",
349
- "required": false,
350
- "description": "IMAP Client",
351
- "schema": {
352
- "type": "object"
353
- }
354
- },
355
- {
356
- "name": "options",
357
- "summary": "Options",
358
- "required": false,
359
- "description": "Options",
360
- "schema": {
361
- "type": "object"
362
- }
363
- }
364
- ],
365
- "x-events": []
426
+ {
427
+ "name": "query",
428
+ "summary": "Query",
429
+ "required": true,
430
+ "description": "Search query",
431
+ "schema": {
432
+ "type": "object"
366
433
  }
367
434
  },
368
- "/listTree": {
369
- "post": {
370
- "tags": ["service"],
371
- "summary": "List mailboxes in a tree",
372
- "parameters": [
373
- {
374
- "name": "client",
375
- "summary": "Client",
376
- "required": false,
377
- "description": "IMAP Client",
378
- "schema": {
379
- "type": "object"
380
- }
381
- },
382
- {
383
- "name": "options",
384
- "summary": "Options",
385
- "required": false,
386
- "description": "Options",
387
- "schema": {
388
- "type": "object"
435
+ {
436
+ "name": "options",
437
+ "summary": "Options",
438
+ "required": false,
439
+ "description": "Options",
440
+ "schema": {
441
+ "type": "object"
442
+ }
443
+ }
444
+ ],
445
+ "responses": {
446
+ "200": {
447
+ "description": "Array of message UIDs matching the search criteria",
448
+ "content": {
449
+ "application/json": {
450
+ "schema": {
451
+ "type": "array",
452
+ "items": {
453
+ "type": "number",
454
+ "description": "Message UID"
389
455
  }
390
456
  }
391
- ],
392
- "x-events": []
457
+ }
458
+ }
459
+ }
460
+ },
461
+ "x-events": []
462
+ }
463
+ },
464
+ "/getMailboxLock": {
465
+ "post": {
466
+ "tags": [
467
+ "service"
468
+ ],
469
+ "summary": "Retrieve the locked IMAP mailbox",
470
+ "parameters": [
471
+ {
472
+ "name": "client",
473
+ "summary": "Client",
474
+ "required": false,
475
+ "description": "IMAP Client",
476
+ "schema": {
477
+ "type": "object"
393
478
  }
394
479
  },
395
- "/logout": {
396
- "post": {
397
- "tags": ["service"],
398
- "summary": "Disconnect the client",
399
- "parameters": [
400
- {
401
- "name": "client",
402
- "summary": "Client",
403
- "required": false,
404
- "description": "IMAP Client",
405
- "schema": {
406
- "type": "object"
407
- }
408
- }
409
- ],
410
- "x-events": []
480
+ {
481
+ "name": "path",
482
+ "summary": "Path",
483
+ "required": false,
484
+ "description": "Mailbox path",
485
+ "schema": {
486
+ "type": "string"
411
487
  }
412
488
  },
413
- "/mailboxClose": {
414
- "post": {
415
- "tags": ["service"],
416
- "summary": "Close the mailbox",
417
- "parameters": [
418
- {
419
- "name": "client",
420
- "summary": "Client",
421
- "required": false,
422
- "description": "IMAP Client",
423
- "schema": {
424
- "type": "object"
425
- }
426
- }
427
- ],
428
- "x-events": []
489
+ {
490
+ "name": "options",
491
+ "summary": "Options",
492
+ "required": false,
493
+ "description": "Options",
494
+ "schema": {
495
+ "type": "object"
496
+ }
497
+ }
498
+ ],
499
+ "x-events": []
500
+ }
501
+ },
502
+ "/getQuota": {
503
+ "post": {
504
+ "tags": [
505
+ "service"
506
+ ],
507
+ "summary": "Retrieve the mailbox quota",
508
+ "parameters": [
509
+ {
510
+ "name": "client",
511
+ "summary": "Client",
512
+ "required": false,
513
+ "description": "IMAP Client",
514
+ "schema": {
515
+ "type": "object"
429
516
  }
430
517
  },
431
- "/mailboxCreate": {
432
- "post": {
433
- "tags": ["service"],
434
- "summary": "Create a mailbox",
435
- "parameters": [
436
- {
437
- "name": "client",
438
- "summary": "Client",
439
- "required": false,
440
- "description": "IMAP Client",
441
- "schema": {
442
- "type": "object"
443
- }
444
- },
445
- {
446
- "name": "path",
447
- "summary": "Path",
448
- "required": true,
449
- "description": "Mailbox path",
450
- "schema": {
451
- "type": "string"
452
- }
453
- }
454
- ],
455
- "x-events": []
456
- }
457
- },
458
- "/mailboxDelete": {
459
- "post": {
460
- "tags": ["service"],
461
- "summary": "Delete a mailbox",
462
- "parameters": [
463
- {
464
- "name": "client",
465
- "summary": "Client",
466
- "required": false,
467
- "description": "IMAP Client",
468
- "schema": {
469
- "type": "object"
470
- }
471
- },
472
- {
473
- "name": "path",
474
- "summary": "Path",
475
- "required": true,
476
- "description": "Mailbox path",
477
- "schema": {
478
- "type": "string"
479
- }
480
- }
481
- ],
482
- "x-events": []
518
+ {
519
+ "name": "path",
520
+ "summary": "Path",
521
+ "required": true,
522
+ "description": "Mailbox path",
523
+ "schema": {
524
+ "type": "string"
483
525
  }
484
- },
485
- "/mailboxOpen": {
486
- "post": {
487
- "tags": ["service"],
488
- "summary": "Open a mailbox",
489
- "parameters": [
490
- {
491
- "name": "client",
492
- "summary": "Client",
493
- "required": false,
494
- "description": "IMAP Client",
495
- "schema": {
496
- "type": "object"
497
- }
498
- },
499
- {
500
- "name": "path",
501
- "summary": "Path",
502
- "required": false,
503
- "description": "Mailbox path",
504
- "schema": {
505
- "type": "string"
506
- }
507
- },
508
- {
509
- "name": "options",
510
- "summary": "Options",
511
- "required": false,
512
- "description": "Options",
513
- "schema": {
514
- "type": "object"
515
- }
516
- }
517
- ],
518
- "x-events": []
519
- }
520
- },
521
- "/mailboxRename": {
522
- "post": {
523
- "tags": ["service"],
524
- "summary": "Rename a mailbox",
525
- "parameters": [
526
- {
527
- "name": "client",
528
- "summary": "Client",
529
- "required": false,
530
- "description": "IMAP Client",
531
- "schema": {
532
- "type": "object"
533
- }
534
- },
535
- {
536
- "name": "path",
537
- "summary": "Path",
538
- "required": true,
539
- "description": "Mailbox path",
540
- "schema": {
541
- "type": "string"
542
- }
543
- },
544
- {
545
- "name": "newPath",
546
- "summary": "New Path",
547
- "required": true,
548
- "description": "New mailbox path",
549
- "schema": {
550
- "type": "string"
551
- }
552
- }
553
- ],
554
- "x-events": []
555
- }
556
- },
557
- "/mailboxSubscribe": {
558
- "post": {
559
- "tags": ["service"],
560
- "summary": "Subscribe to a mailbox",
561
- "parameters": [
562
- {
563
- "name": "client",
564
- "summary": "Client",
565
- "required": false,
566
- "description": "IMAP Client",
567
- "schema": {
568
- "type": "object"
569
- }
570
- },
571
- {
572
- "name": "path",
573
- "summary": "Path",
574
- "required": true,
575
- "description": "Mailbox path",
576
- "schema": {
577
- "type": "string"
578
- }
579
- }
580
- ],
581
- "x-events": []
582
- }
583
- },
584
- "/mailboxUnsubscribe": {
585
- "post": {
586
- "tags": ["service"],
587
- "summary": "Unsubscribe from a mailbox",
588
- "parameters": [
589
- {
590
- "name": "client",
591
- "summary": "Client",
592
- "required": false,
593
- "description": "IMAP Client",
594
- "schema": {
595
- "type": "object"
596
- }
597
- },
598
- {
599
- "name": "path",
600
- "summary": "Path",
601
- "required": true,
602
- "description": "Mailbox path",
603
- "schema": {
604
- "type": "string"
605
- }
606
- }
607
- ],
608
- "x-events": []
609
- }
610
- },
611
- "/messageCopy": {
612
- "post": {
613
- "tags": ["service"],
614
- "summary": "Copy a message",
615
- "parameters": [
616
- {
617
- "name": "client",
618
- "summary": "Client",
619
- "required": false,
620
- "description": "IMAP Client",
621
- "schema": {
622
- "type": "object"
623
- }
624
- },
625
- {
626
- "name": "range",
627
- "summary": "Range",
628
- "required": true,
629
- "description": "Message range",
630
- "schema": {
631
- "type": "object"
632
- }
633
- },
634
- {
635
- "name": "destination",
636
- "summary": "Destination",
637
- "required": true,
638
- "description": "Destination",
639
- "schema": {
640
- "type": "string"
641
- }
642
- },
643
- {
644
- "name": "options",
645
- "summary": "Options",
646
- "required": false,
647
- "description": "Options",
648
- "schema": {
649
- "type": "object"
650
- }
651
- }
652
- ],
653
- "x-events": []
654
- }
655
- },
656
- "/messageDelete": {
657
- "post": {
658
- "tags": ["service"],
659
- "summary": "Delete a message",
660
- "parameters": [
661
- {
662
- "name": "client",
663
- "summary": "Client",
664
- "required": false,
665
- "description": "IMAP Client",
666
- "schema": {
667
- "type": "object"
668
- }
669
- },
670
- {
671
- "name": "range",
672
- "summary": "Range",
673
- "required": true,
674
- "description": "Message range",
675
- "schema": {
676
- "type": "object"
677
- }
678
- },
679
- {
680
- "name": "options",
681
- "summary": "Options",
682
- "required": false,
683
- "description": "Options",
684
- "schema": {
685
- "type": "object"
686
- }
687
- }
688
- ],
689
- "x-events": []
690
- }
691
- },
692
- "/messageFlagsAdd": {
693
- "post": {
694
- "tags": ["service"],
695
- "summary": "Add flags to a message",
696
- "parameters": [
697
- {
698
- "name": "client",
699
- "summary": "Client",
700
- "required": false,
701
- "description": "IMAP Client",
702
- "schema": {
703
- "type": "object"
704
- }
705
- },
706
- {
707
- "name": "range",
708
- "summary": "Range",
709
- "required": true,
710
- "description": "Message range",
711
- "schema": {
712
- "type": "object"
713
- }
714
- },
715
- {
716
- "name": "flags",
717
- "summary": "Flags",
718
- "required": true,
719
- "description": "Flags to add",
720
- "schema": {
721
- "type": "array",
722
- "items": {
723
- "type": "string"
724
- }
725
- }
726
- },
727
- {
728
- "name": "options",
729
- "summary": "Options",
730
- "required": false,
731
- "description": "Options",
732
- "schema": {
733
- "type": "object"
734
- }
735
- }
736
- ],
737
- "x-events": []
738
- }
739
- },
740
- "/messageFlagsRemove": {
741
- "post": {
742
- "tags": ["service"],
743
- "summary": "Remove flags from a message",
744
- "parameters": [
745
- {
746
- "name": "client",
747
- "summary": "Client",
748
- "required": false,
749
- "description": "IMAP Client",
750
- "schema": {
751
- "type": "object"
752
- }
753
- },
754
- {
755
- "name": "range",
756
- "summary": "Range",
757
- "required": true,
758
- "description": "Message range",
759
- "schema": {
760
- "type": "object"
761
- }
762
- },
763
- {
764
- "name": "flags",
765
- "summary": "Flags",
766
- "required": true,
767
- "description": "Flags to remove",
768
- "schema": {
769
- "type": "array",
770
- "items": {
771
- "type": "string"
772
- }
773
- }
774
- },
775
- {
776
- "name": "options",
777
- "summary": "Options",
778
- "required": false,
779
- "description": "Options",
780
- "schema": {
781
- "type": "object"
782
- }
783
- }
784
- ],
785
- "x-events": []
786
- }
787
- },
788
- "/messageFlagsSet": {
789
- "post": {
790
- "tags": ["service"],
791
- "summary": "Set flags for a message",
792
- "parameters": [
793
- {
794
- "name": "client",
795
- "summary": "Client",
796
- "required": false,
797
- "description": "IMAP Client",
798
- "schema": {
799
- "type": "object"
800
- }
801
- },
802
- {
803
- "name": "range",
804
- "summary": "Range",
805
- "required": true,
806
- "description": "Message range",
807
- "schema": {
808
- "type": "object"
809
- }
810
- },
811
- {
812
- "name": "flags",
813
- "summary": "Flags",
814
- "required": true,
815
- "description": "Flags to set",
816
- "schema": {
817
- "type": "array",
818
- "items": {
819
- "type": "string"
820
- }
821
- }
822
- },
823
- {
824
- "name": "options",
825
- "summary": "Options",
826
- "required": false,
827
- "description": "Options",
828
- "schema": {
829
- "type": "object"
830
- }
831
- }
832
- ],
833
- "x-events": []
834
- }
835
- },
836
- "/messageMove": {
837
- "post": {
838
- "tags": ["service"],
839
- "summary": "Move a message",
840
- "parameters": [
841
- {
842
- "name": "client",
843
- "summary": "Client",
844
- "required": false,
845
- "description": "IMAP Client",
846
- "schema": {
847
- "type": "object"
848
- }
849
- },
850
- {
851
- "name": "range",
852
- "summary": "Range",
853
- "required": true,
854
- "description": "Message range",
855
- "schema": {
856
- "type": "object"
857
- }
858
- },
859
- {
860
- "name": "destination",
861
- "summary": "Destination",
862
- "required": true,
863
- "description": "Destination",
864
- "schema": {
865
- "type": "string"
866
- }
867
- },
868
- {
869
- "name": "options",
870
- "summary": "Options",
871
- "required": false,
872
- "description": "Options",
873
- "schema": {
874
- "type": "object"
875
- }
876
- }
877
- ],
878
- "x-events": []
526
+ }
527
+ ],
528
+ "x-events": []
529
+ }
530
+ },
531
+ "/idle": {
532
+ "post": {
533
+ "tags": [
534
+ "service"
535
+ ],
536
+ "summary": "Wait for messages",
537
+ "parameters": [
538
+ {
539
+ "name": "client",
540
+ "summary": "Client",
541
+ "required": false,
542
+ "description": "IMAP Client",
543
+ "schema": {
544
+ "type": "object"
879
545
  }
880
- },
881
- "/noop": {
882
- "post": {
883
- "tags": ["service"],
884
- "summary": "No operation",
885
- "parameters": [
886
- {
887
- "name": "client",
888
- "summary": "Client",
889
- "required": false,
890
- "description": "IMAP Client",
891
- "schema": {
892
- "type": "object"
893
- }
894
- }
895
- ],
896
- "x-events": []
546
+ }
547
+ ],
548
+ "x-events": []
549
+ }
550
+ },
551
+ "/list": {
552
+ "post": {
553
+ "tags": [
554
+ "service"
555
+ ],
556
+ "summary": "List mailboxes",
557
+ "parameters": [
558
+ {
559
+ "name": "client",
560
+ "summary": "Client",
561
+ "required": false,
562
+ "description": "IMAP Client",
563
+ "schema": {
564
+ "type": "object"
897
565
  }
898
566
  },
899
- "/setFlagColor": {
900
- "post": {
901
- "tags": ["service"],
902
- "summary": "Set the color of a flag",
903
- "parameters": [
904
- {
905
- "name": "client",
906
- "summary": "Client",
907
- "required": false,
908
- "description": "IMAP Client",
909
- "schema": {
910
- "type": "object"
911
- }
912
- },
913
- {
914
- "name": "flag",
915
- "summary": "Flag",
916
- "required": true,
917
- "description": "Flag",
918
- "schema": {
919
- "type": "string"
920
- }
921
- },
922
- {
923
- "name": "color",
924
- "summary": "Color",
925
- "required": true,
926
- "description": "Flag color",
927
- "schema": {
928
- "type": "string"
929
- }
930
- }
931
- ],
932
- "x-events": []
567
+ {
568
+ "name": "options",
569
+ "summary": "Options",
570
+ "required": false,
571
+ "description": "Options",
572
+ "schema": {
573
+ "type": "object"
933
574
  }
934
- },
935
- "/status": {
936
- "post": {
937
- "tags": ["service"],
938
- "summary": "Retrieve the mailbox status",
939
- "parameters": [
940
- {
941
- "name": "client",
942
- "summary": "Client",
943
- "required": false,
944
- "description": "IMAP Client",
945
- "schema": {
946
- "type": "object"
947
- }
948
- },
949
- {
950
- "name": "path",
951
- "summary": "Path",
952
- "required": true,
953
- "description": "Mailbox path",
954
- "schema": {
955
- "type": "string"
956
- }
957
- },
958
- {
959
- "name": "query",
960
- "summary": "Query",
961
- "required": false,
962
- "description": "Query",
963
- "schema": {
964
- "type": "object"
965
- }
966
- }
967
- ],
968
- "x-events": []
575
+ }
576
+ ],
577
+ "responses": {
578
+ "200": {
579
+ "description": "Array of mailbox information objects",
580
+ "content": {
581
+ "application/json": {
582
+ "schema": {
583
+ "type": "array",
584
+ "items": {
585
+ "$ref": "#/components/schemas/MailboxInfo"
586
+ }
587
+ {
588
+ "path": "INBOX",
589
+ "name": "INBOX",
590
+ "flags": [
591
+ "\\HasNoChildren"
592
+ ],
593
+ "specialUse": null
594
+ },
595
+ {
596
+ "path": "INBOX/Sent",
597
+ "name": "Sent",
598
+ "flags": [
599
+ "\\HasNoChildren",
600
+ "\\Sent"
601
+ ],
602
+ "specialUse": "\\Sent"
603
+ }
604
+ ]
605
+ }
969
606
  }
970
- },
971
- "/append": {
972
- "post": {
973
- "tags": ["service"],
974
- "summary": "Add a message",
975
- "parameters": [
976
- {
977
- "name": "client",
978
- "summary": "Client",
979
- "required": false,
980
- "description": "IMAP Client",
981
- "schema": {
982
- "type": "object"
983
- }
984
- },
985
- {
986
- "name": "path",
987
- "summary": "Path",
988
- "required": true,
989
- "description": "Mailbox path",
990
- "schema": {
991
- "type": "string"
992
- }
993
- },
994
- {
995
- "name": "content",
996
- "summary": "Content",
997
- "required": true,
998
- "description": "Message content",
999
- "schema": {
1000
- "type": "string"
1001
- }
1002
- },
1003
- {
1004
- "name": "flags",
1005
- "summary": "Flags",
1006
- "required": false,
1007
- "description": "Flags",
1008
- "schema": {
1009
- "type": "array",
1010
- "items": {
1011
- "type": "string"
1012
- }
1013
- }
1014
- },
1015
- {
1016
- "name": "idate",
1017
- "summary": "Date",
1018
- "required": false,
1019
- "description": "Message date",
1020
- "schema": {
1021
- "type": "number"
1022
- }
1023
- }
1024
- ],
1025
- "x-events": []
607
+ }
608
+ }
609
+ },
610
+ "x-events": []
611
+ }
612
+ },
613
+ "/listTree": {
614
+ "post": {
615
+ "tags": [
616
+ "service"
617
+ ],
618
+ "summary": "List mailboxes in a tree",
619
+ "parameters": [
620
+ {
621
+ "name": "client",
622
+ "summary": "Client",
623
+ "required": false,
624
+ "description": "IMAP Client",
625
+ "schema": {
626
+ "type": "object"
627
+ }
628
+ },
629
+ {
630
+ "name": "options",
631
+ "summary": "Options",
632
+ "required": false,
633
+ "description": "Options",
634
+ "schema": {
635
+ "type": "object"
636
+ }
637
+ }
638
+ ],
639
+ "x-events": []
640
+ }
641
+ },
642
+ "/logout": {
643
+ "post": {
644
+ "tags": [
645
+ "service"
646
+ ],
647
+ "summary": "Disconnect the client",
648
+ "parameters": [
649
+ {
650
+ "name": "client",
651
+ "summary": "Client",
652
+ "required": false,
653
+ "description": "IMAP Client",
654
+ "schema": {
655
+ "type": "object"
656
+ }
657
+ }
658
+ ],
659
+ "x-events": []
660
+ }
661
+ },
662
+ "/mailboxClose": {
663
+ "post": {
664
+ "tags": [
665
+ "service"
666
+ ],
667
+ "summary": "Close the mailbox",
668
+ "parameters": [
669
+ {
670
+ "name": "client",
671
+ "summary": "Client",
672
+ "required": false,
673
+ "description": "IMAP Client",
674
+ "schema": {
675
+ "type": "object"
676
+ }
677
+ }
678
+ ],
679
+ "x-events": []
680
+ }
681
+ },
682
+ "/mailboxCreate": {
683
+ "post": {
684
+ "tags": [
685
+ "service"
686
+ ],
687
+ "summary": "Create a mailbox",
688
+ "parameters": [
689
+ {
690
+ "name": "client",
691
+ "summary": "Client",
692
+ "required": false,
693
+ "description": "IMAP Client",
694
+ "schema": {
695
+ "type": "object"
696
+ }
697
+ },
698
+ {
699
+ "name": "path",
700
+ "summary": "Path",
701
+ "required": true,
702
+ "description": "Mailbox path",
703
+ "schema": {
704
+ "type": "string"
705
+ }
706
+ }
707
+ ],
708
+ "x-events": []
709
+ }
710
+ },
711
+ "/mailboxDelete": {
712
+ "post": {
713
+ "tags": [
714
+ "service"
715
+ ],
716
+ "summary": "Delete a mailbox",
717
+ "parameters": [
718
+ {
719
+ "name": "client",
720
+ "summary": "Client",
721
+ "required": false,
722
+ "description": "IMAP Client",
723
+ "schema": {
724
+ "type": "object"
725
+ }
726
+ },
727
+ {
728
+ "name": "path",
729
+ "summary": "Path",
730
+ "required": true,
731
+ "description": "Mailbox path",
732
+ "schema": {
733
+ "type": "string"
734
+ }
735
+ }
736
+ ],
737
+ "x-events": []
738
+ }
739
+ },
740
+ "/mailboxOpen": {
741
+ "post": {
742
+ "tags": [
743
+ "service"
744
+ ],
745
+ "summary": "Open a mailbox",
746
+ "parameters": [
747
+ {
748
+ "name": "client",
749
+ "summary": "Client",
750
+ "required": false,
751
+ "description": "IMAP Client",
752
+ "schema": {
753
+ "type": "object"
754
+ }
755
+ },
756
+ {
757
+ "name": "path",
758
+ "summary": "Path",
759
+ "required": false,
760
+ "description": "Mailbox path",
761
+ "schema": {
762
+ "type": "string"
763
+ }
764
+ },
765
+ {
766
+ "name": "options",
767
+ "summary": "Options",
768
+ "required": false,
769
+ "description": "Options",
770
+ "schema": {
771
+ "type": "object"
772
+ }
773
+ }
774
+ ],
775
+ "x-events": []
776
+ }
777
+ },
778
+ "/mailboxRename": {
779
+ "post": {
780
+ "tags": [
781
+ "service"
782
+ ],
783
+ "summary": "Rename a mailbox",
784
+ "parameters": [
785
+ {
786
+ "name": "client",
787
+ "summary": "Client",
788
+ "required": false,
789
+ "description": "IMAP Client",
790
+ "schema": {
791
+ "type": "object"
792
+ }
793
+ },
794
+ {
795
+ "name": "path",
796
+ "summary": "Path",
797
+ "required": true,
798
+ "description": "Mailbox path",
799
+ "schema": {
800
+ "type": "string"
801
+ }
802
+ },
803
+ {
804
+ "name": "newPath",
805
+ "summary": "New Path",
806
+ "required": true,
807
+ "description": "New mailbox path",
808
+ "schema": {
809
+ "type": "string"
810
+ }
811
+ }
812
+ ],
813
+ "x-events": []
814
+ }
815
+ },
816
+ "/mailboxSubscribe": {
817
+ "post": {
818
+ "tags": [
819
+ "service"
820
+ ],
821
+ "summary": "Subscribe to a mailbox",
822
+ "parameters": [
823
+ {
824
+ "name": "client",
825
+ "summary": "Client",
826
+ "required": false,
827
+ "description": "IMAP Client",
828
+ "schema": {
829
+ "type": "object"
830
+ }
831
+ },
832
+ {
833
+ "name": "path",
834
+ "summary": "Path",
835
+ "required": true,
836
+ "description": "Mailbox path",
837
+ "schema": {
838
+ "type": "string"
839
+ }
840
+ }
841
+ ],
842
+ "x-events": []
843
+ }
844
+ },
845
+ "/mailboxUnsubscribe": {
846
+ "post": {
847
+ "tags": [
848
+ "service"
849
+ ],
850
+ "summary": "Unsubscribe from a mailbox",
851
+ "parameters": [
852
+ {
853
+ "name": "client",
854
+ "summary": "Client",
855
+ "required": false,
856
+ "description": "IMAP Client",
857
+ "schema": {
858
+ "type": "object"
859
+ }
860
+ },
861
+ {
862
+ "name": "path",
863
+ "summary": "Path",
864
+ "required": true,
865
+ "description": "Mailbox path",
866
+ "schema": {
867
+ "type": "string"
868
+ }
869
+ }
870
+ ],
871
+ "x-events": []
872
+ }
873
+ },
874
+ "/messageCopy": {
875
+ "post": {
876
+ "tags": [
877
+ "service"
878
+ ],
879
+ "summary": "Copy a message",
880
+ "parameters": [
881
+ {
882
+ "name": "client",
883
+ "summary": "Client",
884
+ "required": false,
885
+ "description": "IMAP Client",
886
+ "schema": {
887
+ "type": "object"
888
+ }
889
+ },
890
+ {
891
+ "name": "range",
892
+ "summary": "Range",
893
+ "required": true,
894
+ "description": "Message range",
895
+ "schema": {
896
+ "type": "object"
897
+ }
898
+ },
899
+ {
900
+ "name": "destination",
901
+ "summary": "Destination",
902
+ "required": true,
903
+ "description": "Destination",
904
+ "schema": {
905
+ "type": "string"
906
+ }
907
+ },
908
+ {
909
+ "name": "options",
910
+ "summary": "Options",
911
+ "required": false,
912
+ "description": "Options",
913
+ "schema": {
914
+ "type": "object"
915
+ }
916
+ }
917
+ ],
918
+ "x-events": []
919
+ }
920
+ },
921
+ "/messageDelete": {
922
+ "post": {
923
+ "tags": [
924
+ "service"
925
+ ],
926
+ "summary": "Delete a message",
927
+ "parameters": [
928
+ {
929
+ "name": "client",
930
+ "summary": "Client",
931
+ "required": false,
932
+ "description": "IMAP Client",
933
+ "schema": {
934
+ "type": "object"
935
+ }
936
+ },
937
+ {
938
+ "name": "range",
939
+ "summary": "Range",
940
+ "required": true,
941
+ "description": "Message range",
942
+ "schema": {
943
+ "type": "object"
944
+ }
945
+ },
946
+ {
947
+ "name": "options",
948
+ "summary": "Options",
949
+ "required": false,
950
+ "description": "Options",
951
+ "schema": {
952
+ "type": "object"
953
+ }
954
+ }
955
+ ],
956
+ "x-events": []
957
+ }
958
+ },
959
+ "/messageFlagsAdd": {
960
+ "post": {
961
+ "tags": [
962
+ "service"
963
+ ],
964
+ "summary": "Add flags to a message",
965
+ "parameters": [
966
+ {
967
+ "name": "client",
968
+ "summary": "Client",
969
+ "required": false,
970
+ "description": "IMAP Client",
971
+ "schema": {
972
+ "type": "object"
973
+ }
974
+ },
975
+ {
976
+ "name": "range",
977
+ "summary": "Range",
978
+ "required": true,
979
+ "description": "Message range",
980
+ "schema": {
981
+ "type": "object"
982
+ }
983
+ },
984
+ {
985
+ "name": "flags",
986
+ "summary": "Flags",
987
+ "required": true,
988
+ "description": "Flags to add",
989
+ "schema": {
990
+ "type": "array",
991
+ "items": {
992
+ "type": "string"
1026
993
  }
1027
- },
1028
- "/close": {
1029
- "post": {
1030
- "tags": ["service"],
1031
- "summary": "Close the client",
1032
- "parameters": [
1033
- {
1034
- "name": "client",
1035
- "summary": "Client",
1036
- "required": false,
1037
- "description": "IMAP Client",
1038
- "schema": {
1039
- "type": "object"
1040
- }
1041
- }
1042
- ],
1043
- "x-events": []
994
+ }
995
+ },
996
+ {
997
+ "name": "options",
998
+ "summary": "Options",
999
+ "required": false,
1000
+ "description": "Options",
1001
+ "schema": {
1002
+ "type": "object"
1003
+ }
1004
+ }
1005
+ ],
1006
+ "x-events": []
1007
+ }
1008
+ },
1009
+ "/messageFlagsRemove": {
1010
+ "post": {
1011
+ "tags": [
1012
+ "service"
1013
+ ],
1014
+ "summary": "Remove flags from a message",
1015
+ "parameters": [
1016
+ {
1017
+ "name": "client",
1018
+ "summary": "Client",
1019
+ "required": false,
1020
+ "description": "IMAP Client",
1021
+ "schema": {
1022
+ "type": "object"
1023
+ }
1024
+ },
1025
+ {
1026
+ "name": "range",
1027
+ "summary": "Range",
1028
+ "required": true,
1029
+ "description": "Message range",
1030
+ "schema": {
1031
+ "type": "object"
1032
+ }
1033
+ },
1034
+ {
1035
+ "name": "flags",
1036
+ "summary": "Flags",
1037
+ "required": true,
1038
+ "description": "Flags to remove",
1039
+ "schema": {
1040
+ "type": "array",
1041
+ "items": {
1042
+ "type": "string"
1044
1043
  }
1045
- },
1046
- "/download": {
1047
- "post": {
1048
- "tags": ["service"],
1049
- "summary": "Download a message",
1050
- "parameters": [
1051
- {
1052
- "name": "client",
1053
- "summary": "Client",
1054
- "required": false,
1055
- "description": "IMAP Client",
1056
- "schema": {
1057
- "type": "object"
1058
- }
1059
- },
1060
- {
1061
- "name": "range",
1062
- "summary": "Range",
1063
- "required": true,
1064
- "description": "Message range",
1065
- "schema": {
1066
- "type": "object"
1067
- }
1068
- },
1069
- {
1070
- "name": "part",
1071
- "summary": "Part",
1072
- "required": false,
1073
- "description": "Message part",
1074
- "schema": {
1075
- "type": "string"
1076
- }
1077
- },
1078
- {
1079
- "name": "options",
1080
- "summary": "Options",
1081
- "required": false,
1082
- "description": "Options",
1083
- "schema": {
1084
- "type": "object"
1085
- }
1086
- }
1087
- ],
1088
- "x-events": []
1044
+ }
1045
+ },
1046
+ {
1047
+ "name": "options",
1048
+ "summary": "Options",
1049
+ "required": false,
1050
+ "description": "Options",
1051
+ "schema": {
1052
+ "type": "object"
1053
+ }
1054
+ }
1055
+ ],
1056
+ "x-events": []
1057
+ }
1058
+ },
1059
+ "/messageFlagsSet": {
1060
+ "post": {
1061
+ "tags": [
1062
+ "service"
1063
+ ],
1064
+ "summary": "Set flags for a message",
1065
+ "parameters": [
1066
+ {
1067
+ "name": "client",
1068
+ "summary": "Client",
1069
+ "required": false,
1070
+ "description": "IMAP Client",
1071
+ "schema": {
1072
+ "type": "object"
1073
+ }
1074
+ },
1075
+ {
1076
+ "name": "range",
1077
+ "summary": "Range",
1078
+ "required": true,
1079
+ "description": "Message range",
1080
+ "schema": {
1081
+ "type": "object"
1082
+ }
1083
+ },
1084
+ {
1085
+ "name": "flags",
1086
+ "summary": "Flags",
1087
+ "required": true,
1088
+ "description": "Flags to set",
1089
+ "schema": {
1090
+ "type": "array",
1091
+ "items": {
1092
+ "type": "string"
1089
1093
  }
1090
- },
1091
- "/downloadMany": {
1092
- "post": {
1093
- "tags": ["service"],
1094
- "summary": "Download multiple messages",
1095
- "parameters": [
1096
- {
1097
- "name": "client",
1098
- "summary": "Client",
1099
- "required": false,
1100
- "description": "IMAP Client",
1101
- "schema": {
1102
- "type": "object"
1103
- }
1104
- },
1105
- {
1106
- "name": "range",
1107
- "summary": "Range",
1108
- "required": true,
1109
- "description": "Message range",
1110
- "schema": {
1111
- "type": "object"
1112
- }
1113
- },
1114
- {
1115
- "name": "parts",
1116
- "summary": "Parts",
1117
- "required": true,
1118
- "description": "Message parts",
1119
- "schema": {
1120
- "type": "array",
1121
- "items": {
1122
- "type": "string"
1123
- }
1124
- }
1125
- },
1126
- {
1127
- "name": "options",
1128
- "summary": "Options",
1129
- "required": false,
1130
- "description": "Options",
1131
- "schema": {
1132
- "type": "object"
1133
- }
1134
- }
1135
- ],
1136
- "x-events": []
1094
+ }
1095
+ },
1096
+ {
1097
+ "name": "options",
1098
+ "summary": "Options",
1099
+ "required": false,
1100
+ "description": "Options",
1101
+ "schema": {
1102
+ "type": "object"
1103
+ }
1104
+ }
1105
+ ],
1106
+ "x-events": []
1107
+ }
1108
+ },
1109
+ "/messageMove": {
1110
+ "post": {
1111
+ "tags": [
1112
+ "service"
1113
+ ],
1114
+ "summary": "Move a message",
1115
+ "parameters": [
1116
+ {
1117
+ "name": "client",
1118
+ "summary": "Client",
1119
+ "required": false,
1120
+ "description": "IMAP Client",
1121
+ "schema": {
1122
+ "type": "object"
1123
+ }
1124
+ },
1125
+ {
1126
+ "name": "range",
1127
+ "summary": "Range",
1128
+ "required": true,
1129
+ "description": "Message range",
1130
+ "schema": {
1131
+ "type": "object"
1132
+ }
1133
+ },
1134
+ {
1135
+ "name": "destination",
1136
+ "summary": "Destination",
1137
+ "required": true,
1138
+ "description": "Destination",
1139
+ "schema": {
1140
+ "type": "string"
1141
+ }
1142
+ },
1143
+ {
1144
+ "name": "options",
1145
+ "summary": "Options",
1146
+ "required": false,
1147
+ "description": "Options",
1148
+ "schema": {
1149
+ "type": "object"
1150
+ }
1151
+ }
1152
+ ],
1153
+ "x-events": []
1154
+ }
1155
+ },
1156
+ "/noop": {
1157
+ "post": {
1158
+ "tags": [
1159
+ "service"
1160
+ ],
1161
+ "summary": "No operation",
1162
+ "parameters": [
1163
+ {
1164
+ "name": "client",
1165
+ "summary": "Client",
1166
+ "required": false,
1167
+ "description": "IMAP Client",
1168
+ "schema": {
1169
+ "type": "object"
1170
+ }
1171
+ }
1172
+ ],
1173
+ "x-events": []
1174
+ }
1175
+ },
1176
+ "/setFlagColor": {
1177
+ "post": {
1178
+ "tags": [
1179
+ "service"
1180
+ ],
1181
+ "summary": "Set the color of a flag",
1182
+ "parameters": [
1183
+ {
1184
+ "name": "client",
1185
+ "summary": "Client",
1186
+ "required": false,
1187
+ "description": "IMAP Client",
1188
+ "schema": {
1189
+ "type": "object"
1190
+ }
1191
+ },
1192
+ {
1193
+ "name": "flag",
1194
+ "summary": "Flag",
1195
+ "required": true,
1196
+ "description": "Flag",
1197
+ "schema": {
1198
+ "type": "string"
1199
+ }
1200
+ },
1201
+ {
1202
+ "name": "color",
1203
+ "summary": "Color",
1204
+ "required": true,
1205
+ "description": "Flag color",
1206
+ "schema": {
1207
+ "type": "string"
1208
+ }
1209
+ }
1210
+ ],
1211
+ "x-events": []
1212
+ }
1213
+ },
1214
+ "/status": {
1215
+ "post": {
1216
+ "tags": [
1217
+ "service"
1218
+ ],
1219
+ "summary": "Retrieve the mailbox status",
1220
+ "parameters": [
1221
+ {
1222
+ "name": "client",
1223
+ "summary": "Client",
1224
+ "required": false,
1225
+ "description": "IMAP Client",
1226
+ "schema": {
1227
+ "type": "object"
1228
+ }
1229
+ },
1230
+ {
1231
+ "name": "path",
1232
+ "summary": "Path",
1233
+ "required": true,
1234
+ "description": "Mailbox path",
1235
+ "schema": {
1236
+ "type": "string"
1237
+ }
1238
+ },
1239
+ {
1240
+ "name": "query",
1241
+ "summary": "Query",
1242
+ "required": false,
1243
+ "description": "Query",
1244
+ "schema": {
1245
+ "type": "object"
1246
+ }
1247
+ }
1248
+ ],
1249
+ "x-events": []
1250
+ }
1251
+ },
1252
+ "/append": {
1253
+ "post": {
1254
+ "tags": [
1255
+ "service"
1256
+ ],
1257
+ "summary": "Add a message",
1258
+ "parameters": [
1259
+ {
1260
+ "name": "client",
1261
+ "summary": "Client",
1262
+ "required": false,
1263
+ "description": "IMAP Client",
1264
+ "schema": {
1265
+ "type": "object"
1266
+ }
1267
+ },
1268
+ {
1269
+ "name": "path",
1270
+ "summary": "Path",
1271
+ "required": true,
1272
+ "description": "Mailbox path",
1273
+ "schema": {
1274
+ "type": "string"
1275
+ }
1276
+ },
1277
+ {
1278
+ "name": "content",
1279
+ "summary": "Content",
1280
+ "required": true,
1281
+ "description": "Message content",
1282
+ "schema": {
1283
+ "type": "string"
1284
+ }
1285
+ },
1286
+ {
1287
+ "name": "flags",
1288
+ "summary": "Flags",
1289
+ "required": false,
1290
+ "description": "Flags",
1291
+ "schema": {
1292
+ "type": "array",
1293
+ "items": {
1294
+ "type": "string"
1137
1295
  }
1138
- },
1139
- "/fetch": {
1140
- "post": {
1141
- "tags": ["service"],
1142
- "summary": "Retrieve messages",
1143
- "parameters": [
1144
- {
1145
- "name": "client",
1146
- "summary": "Client",
1147
- "required": false,
1148
- "description": "IMAP Client",
1149
- "schema": {
1150
- "type": "object"
1151
- }
1152
- },
1153
- {
1154
- "name": "range",
1155
- "summary": "Range",
1156
- "required": true,
1157
- "description": "Message range",
1158
- "schema": {
1159
- "type": "object"
1160
- }
1161
- },
1162
- {
1163
- "name": "query",
1164
- "summary": "Query",
1165
- "required": true,
1166
- "description": "Search query",
1167
- "schema": {
1168
- "type": "object"
1169
- }
1170
- },
1171
- {
1172
- "name": "options",
1173
- "summary": "Options",
1174
- "required": false,
1175
- "description": "Options",
1176
- "schema": {
1177
- "type": "object"
1178
- }
1179
- }
1180
- ],
1181
- "x-events": []
1296
+ }
1297
+ },
1298
+ {
1299
+ "name": "idate",
1300
+ "summary": "Date",
1301
+ "required": false,
1302
+ "description": "Message date",
1303
+ "schema": {
1304
+ "type": "number"
1305
+ }
1306
+ }
1307
+ ],
1308
+ "x-events": []
1309
+ }
1310
+ },
1311
+ "/close": {
1312
+ "post": {
1313
+ "tags": [
1314
+ "service"
1315
+ ],
1316
+ "summary": "Close the client",
1317
+ "parameters": [
1318
+ {
1319
+ "name": "client",
1320
+ "summary": "Client",
1321
+ "required": false,
1322
+ "description": "IMAP Client",
1323
+ "schema": {
1324
+ "type": "object"
1325
+ }
1326
+ }
1327
+ ],
1328
+ "x-events": []
1329
+ }
1330
+ },
1331
+ "/download": {
1332
+ "post": {
1333
+ "tags": [
1334
+ "service"
1335
+ ],
1336
+ "summary": "Download a message",
1337
+ "parameters": [
1338
+ {
1339
+ "name": "client",
1340
+ "summary": "Client",
1341
+ "required": false,
1342
+ "description": "IMAP Client",
1343
+ "schema": {
1344
+ "type": "object"
1345
+ }
1346
+ },
1347
+ {
1348
+ "name": "range",
1349
+ "summary": "Range",
1350
+ "required": true,
1351
+ "description": "Message range",
1352
+ "schema": {
1353
+ "type": "object"
1354
+ }
1355
+ },
1356
+ {
1357
+ "name": "part",
1358
+ "summary": "Part",
1359
+ "required": false,
1360
+ "description": "Message part",
1361
+ "schema": {
1362
+ "type": "string"
1363
+ }
1364
+ },
1365
+ {
1366
+ "name": "options",
1367
+ "summary": "Options",
1368
+ "required": false,
1369
+ "description": "Options",
1370
+ "schema": {
1371
+ "type": "object"
1372
+ }
1373
+ }
1374
+ ],
1375
+ "x-events": []
1376
+ }
1377
+ },
1378
+ "/downloadMany": {
1379
+ "post": {
1380
+ "tags": [
1381
+ "service"
1382
+ ],
1383
+ "summary": "Download multiple messages",
1384
+ "parameters": [
1385
+ {
1386
+ "name": "client",
1387
+ "summary": "Client",
1388
+ "required": false,
1389
+ "description": "IMAP Client",
1390
+ "schema": {
1391
+ "type": "object"
1392
+ }
1393
+ },
1394
+ {
1395
+ "name": "range",
1396
+ "summary": "Range",
1397
+ "required": true,
1398
+ "description": "Message range",
1399
+ "schema": {
1400
+ "type": "object"
1401
+ }
1402
+ },
1403
+ {
1404
+ "name": "parts",
1405
+ "summary": "Parts",
1406
+ "required": true,
1407
+ "description": "Message parts",
1408
+ "schema": {
1409
+ "type": "array",
1410
+ "items": {
1411
+ "type": "string"
1182
1412
  }
1183
- },
1184
- "/fetchAll": {
1185
- "post": {
1186
- "tags": ["service"],
1187
- "summary": "Retrieve all messages",
1188
- "parameters": [
1189
- {
1190
- "name": "client",
1191
- "summary": "Client",
1192
- "required": false,
1193
- "description": "IMAP Client",
1194
- "schema": {
1195
- "type": "object"
1196
- }
1197
- },
1198
- {
1199
- "name": "range",
1200
- "summary": "Range",
1201
- "required": true,
1202
- "description": "Message range",
1203
- "schema": {
1204
- "type": "object"
1205
- }
1206
- },
1207
- {
1208
- "name": "query",
1209
- "summary": "Query",
1210
- "required": true,
1211
- "description": "Search query",
1212
- "schema": {
1213
- "type": "object"
1214
- }
1215
- },
1216
- {
1217
- "name": "options",
1218
- "summary": "Options",
1219
- "required": false,
1220
- "description": "Options",
1221
- "schema": {
1222
- "type": "object"
1223
- }
1224
- }
1225
- ],
1226
- "x-events": []
1413
+ }
1414
+ },
1415
+ {
1416
+ "name": "options",
1417
+ "summary": "Options",
1418
+ "required": false,
1419
+ "description": "Options",
1420
+ "schema": {
1421
+ "type": "object"
1422
+ }
1423
+ }
1424
+ ],
1425
+ "x-events": []
1426
+ }
1427
+ },
1428
+ "/fetch": {
1429
+ "post": {
1430
+ "tags": [
1431
+ "service"
1432
+ ],
1433
+ "summary": "Retrieve messages",
1434
+ "parameters": [
1435
+ {
1436
+ "name": "client",
1437
+ "summary": "Client",
1438
+ "required": false,
1439
+ "description": "IMAP Client",
1440
+ "schema": {
1441
+ "type": "object"
1442
+ }
1443
+ },
1444
+ {
1445
+ "name": "range",
1446
+ "summary": "Range",
1447
+ "required": true,
1448
+ "description": "Message range",
1449
+ "schema": {
1450
+ "type": "object"
1451
+ }
1452
+ },
1453
+ {
1454
+ "name": "query",
1455
+ "summary": "Query",
1456
+ "required": true,
1457
+ "description": "Search query",
1458
+ "schema": {
1459
+ "type": "object"
1460
+ }
1461
+ },
1462
+ {
1463
+ "name": "options",
1464
+ "summary": "Options",
1465
+ "required": false,
1466
+ "description": "Options",
1467
+ "schema": {
1468
+ "type": "object"
1469
+ }
1470
+ }
1471
+ ],
1472
+ "x-events": []
1473
+ }
1474
+ },
1475
+ "/fetchAll": {
1476
+ "post": {
1477
+ "tags": [
1478
+ "service"
1479
+ ],
1480
+ "summary": "Retrieve all messages",
1481
+ "parameters": [
1482
+ {
1483
+ "name": "client",
1484
+ "summary": "Client",
1485
+ "required": false,
1486
+ "description": "IMAP Client",
1487
+ "schema": {
1488
+ "type": "object"
1489
+ }
1490
+ },
1491
+ {
1492
+ "name": "range",
1493
+ "summary": "Range",
1494
+ "required": true,
1495
+ "description": "Message range",
1496
+ "schema": {
1497
+ "type": "object"
1498
+ }
1499
+ },
1500
+ {
1501
+ "name": "query",
1502
+ "summary": "Query",
1503
+ "required": true,
1504
+ "description": "Search query",
1505
+ "schema": {
1506
+ "type": "object"
1507
+ }
1508
+ },
1509
+ {
1510
+ "name": "options",
1511
+ "summary": "Options",
1512
+ "required": false,
1513
+ "description": "Options",
1514
+ "schema": {
1515
+ "type": "object"
1516
+ }
1517
+ }
1518
+ ],
1519
+ "x-events": []
1520
+ }
1521
+ },
1522
+ "/fetchOne": {
1523
+ "post": {
1524
+ "tags": [
1525
+ "service"
1526
+ ],
1527
+ "summary": "Retrieve a message",
1528
+ "parameters": [
1529
+ {
1530
+ "name": "client",
1531
+ "summary": "Client",
1532
+ "required": false,
1533
+ "description": "IMAP Client",
1534
+ "schema": {
1535
+ "type": "object"
1536
+ }
1537
+ },
1538
+ {
1539
+ "name": "seq",
1540
+ "summary": "Sequence",
1541
+ "required": true,
1542
+ "description": "Message sequence",
1543
+ "schema": {
1544
+ "type": "number"
1545
+ }
1546
+ },
1547
+ {
1548
+ "name": "query",
1549
+ "summary": "Query",
1550
+ "required": true,
1551
+ "description": "Search query",
1552
+ "schema": {
1553
+ "type": "object"
1554
+ }
1555
+ },
1556
+ {
1557
+ "name": "options",
1558
+ "summary": "Options",
1559
+ "required": false,
1560
+ "description": "Options",
1561
+ "schema": {
1562
+ "type": "object"
1563
+ }
1564
+ }
1565
+ ],
1566
+ "x-events": []
1567
+ }
1568
+ }
1569
+ },
1570
+ "components": {
1571
+ "schemas": {
1572
+ "ParsedMessage": {
1573
+ "type": "object",
1574
+ "properties": {
1575
+ "uid": {
1576
+ "type": "number",
1577
+ "description": "Message UID"
1578
+ },
1579
+ "seq": {
1580
+ "type": "number",
1581
+ "description": "Message sequence number"
1582
+ },
1583
+ "envelope": {
1584
+ "type": "object",
1585
+ "description": "Email envelope information",
1586
+ "properties": {
1587
+ "subject": {
1588
+ "type": "string",
1589
+ "description": "Email subject"
1590
+ },
1591
+ "from": {
1592
+ "type": "array",
1593
+ "description": "From addresses"
1594
+ },
1595
+ "to": {
1596
+ "type": "array",
1597
+ "description": "To addresses"
1598
+ },
1599
+ "date": {
1600
+ "type": "string",
1601
+ "format": "date-time",
1602
+ "description": "Email date"
1227
1603
  }
1228
- },
1229
- "/fetchOne": {
1230
- "post": {
1231
- "tags": ["service"],
1232
- "summary": "Retrieve a message",
1233
- "parameters": [
1234
- {
1235
- "name": "client",
1236
- "summary": "Client",
1237
- "required": false,
1238
- "description": "IMAP Client",
1239
- "schema": {
1240
- "type": "object"
1241
- }
1242
- },
1243
- {
1244
- "name": "seq",
1245
- "summary": "Sequence",
1246
- "required": true,
1247
- "description": "Message sequence",
1248
- "schema": {
1249
- "type": "number"
1250
- }
1251
- },
1252
- {
1253
- "name": "query",
1254
- "summary": "Query",
1255
- "required": true,
1256
- "description": "Search query",
1257
- "schema": {
1258
- "type": "object"
1259
- }
1260
- },
1261
- {
1262
- "name": "options",
1263
- "summary": "Options",
1264
- "required": false,
1265
- "description": "Options",
1266
- "schema": {
1267
- "type": "object"
1604
+ }
1605
+ },
1606
+ "contentText": {
1607
+ "type": "string",
1608
+ "description": "Plain text content of the email"
1609
+ },
1610
+ "contentHtml": {
1611
+ "type": "string",
1612
+ "description": "HTML content of the email"
1613
+ },
1614
+ "attachments": {
1615
+ "type": "array",
1616
+ "description": "Email attachments",
1617
+ "items": {
1618
+ "type": "object",
1619
+ "properties": {
1620
+ "meta": {
1621
+ "type": "object",
1622
+ "description": "Attachment metadata",
1623
+ "properties": {
1624
+ "filename": {
1625
+ "type": "string",
1626
+ "description": "Attachment filename"
1627
+ },
1628
+ "contentType": {
1629
+ "type": "string",
1630
+ "description": "MIME content type"
1631
+ },
1632
+ "size": {
1633
+ "type": "number",
1634
+ "description": "Size in bytes"
1268
1635
  }
1269
1636
  }
1270
- ],
1271
- "x-events": []
1637
+ },
1638
+ "content": {
1639
+ "type": "string",
1640
+ "description": "Base64-encoded attachment content"
1641
+ }
1272
1642
  }
1273
1643
  }
1644
+ }
1645
+ }
1646
+ },
1647
+ "MailboxInfo": {
1648
+ "type": "object",
1649
+ "properties": {
1650
+ "path": {
1651
+ "type": "string",
1652
+ "description": "Mailbox path"
1274
1653
  },
1275
- "components": {
1276
- "schemas": {}
1654
+ "name": {
1655
+ "type": "string",
1656
+ "description": "Mailbox name"
1277
1657
  },
1278
- "x-scene-blocks": {}
1658
+ "flags": {
1659
+ "type": "array",
1660
+ "items": {
1661
+ "type": "string"
1662
+ },
1663
+ "description": "Mailbox flags"
1664
+ },
1665
+ "specialUse": {
1666
+ "type": "string",
1667
+ "description": "Special use attribute"
1668
+ }
1669
+ }
1670
+ }
1279
1671
  }
1672
+ },
1673
+ "x-scene-blocks": {}
1674
+ }