@epilot/message-client 0.0.1 → 1.0.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/dist/definition.js +1 -1
- package/dist/openapi.d.ts +330 -36
- package/dist/openapi.json +2446 -746
- package/package.json +2 -2
- package/package-lock.json +0 -8340
package/dist/openapi.json
CHANGED
|
@@ -2,25 +2,36 @@
|
|
|
2
2
|
"openapi": "3.0.2",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Message API",
|
|
5
|
-
"version": "1.0.0
|
|
6
|
-
"description": "
|
|
5
|
+
"version": "1.0.0",
|
|
6
|
+
"description": "Send and receive email messages via your epilot organization\n"
|
|
7
7
|
},
|
|
8
8
|
"security": [
|
|
9
9
|
{
|
|
10
10
|
"EpilotAuth": []
|
|
11
|
+
}
|
|
12
|
+
],
|
|
13
|
+
"tags": [
|
|
14
|
+
{
|
|
15
|
+
"name": "Messages",
|
|
16
|
+
"description": "Email Messages"
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"name": "Threads",
|
|
20
|
+
"description": "Email Message Threads"
|
|
11
21
|
},
|
|
12
22
|
{
|
|
13
|
-
"
|
|
23
|
+
"name": "Attachments",
|
|
24
|
+
"description": "Email File Attachments"
|
|
14
25
|
}
|
|
15
26
|
],
|
|
16
27
|
"paths": {
|
|
17
|
-
"/messages": {
|
|
28
|
+
"/v1/message/messages": {
|
|
18
29
|
"post": {
|
|
19
30
|
"operationId": "sendMessage",
|
|
20
31
|
"summary": "sendMessage",
|
|
21
|
-
"description": "Send
|
|
32
|
+
"description": "Send an email message",
|
|
22
33
|
"tags": [
|
|
23
|
-
"
|
|
34
|
+
"Messages"
|
|
24
35
|
],
|
|
25
36
|
"requestBody": {
|
|
26
37
|
"content": {
|
|
@@ -76,7 +87,7 @@
|
|
|
76
87
|
},
|
|
77
88
|
"text": {
|
|
78
89
|
"type": "string",
|
|
79
|
-
"description": "Text body",
|
|
90
|
+
"description": "Text body. If not provided, text body is converted from HTML body using [html-to-text](https://www.npmjs.com/package/html-to-text)",
|
|
80
91
|
"example": "We at ABC GmbH would like to request a price quote for the solar panel."
|
|
81
92
|
},
|
|
82
93
|
"from": {
|
|
@@ -94,6 +105,22 @@
|
|
|
94
105
|
"type": "string",
|
|
95
106
|
"description": "Email address",
|
|
96
107
|
"example": "messaging@epilot.cloud"
|
|
108
|
+
},
|
|
109
|
+
"send_status": {
|
|
110
|
+
"type": "string",
|
|
111
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
112
|
+
"enum": [
|
|
113
|
+
"SEND",
|
|
114
|
+
"DELIVERY",
|
|
115
|
+
"REJECT",
|
|
116
|
+
"COMPLAINT",
|
|
117
|
+
"BOUNCE",
|
|
118
|
+
"ERROR"
|
|
119
|
+
]
|
|
120
|
+
},
|
|
121
|
+
"send_error": {
|
|
122
|
+
"type": "object",
|
|
123
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
97
124
|
}
|
|
98
125
|
}
|
|
99
126
|
},
|
|
@@ -112,6 +139,22 @@
|
|
|
112
139
|
"type": "string",
|
|
113
140
|
"description": "Email address",
|
|
114
141
|
"example": "messaging@epilot.cloud"
|
|
142
|
+
},
|
|
143
|
+
"send_status": {
|
|
144
|
+
"type": "string",
|
|
145
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
146
|
+
"enum": [
|
|
147
|
+
"SEND",
|
|
148
|
+
"DELIVERY",
|
|
149
|
+
"REJECT",
|
|
150
|
+
"COMPLAINT",
|
|
151
|
+
"BOUNCE",
|
|
152
|
+
"ERROR"
|
|
153
|
+
]
|
|
154
|
+
},
|
|
155
|
+
"send_error": {
|
|
156
|
+
"type": "object",
|
|
157
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
115
158
|
}
|
|
116
159
|
}
|
|
117
160
|
},
|
|
@@ -133,6 +176,22 @@
|
|
|
133
176
|
"type": "string",
|
|
134
177
|
"description": "Email address",
|
|
135
178
|
"example": "messaging@epilot.cloud"
|
|
179
|
+
},
|
|
180
|
+
"send_status": {
|
|
181
|
+
"type": "string",
|
|
182
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
183
|
+
"enum": [
|
|
184
|
+
"SEND",
|
|
185
|
+
"DELIVERY",
|
|
186
|
+
"REJECT",
|
|
187
|
+
"COMPLAINT",
|
|
188
|
+
"BOUNCE",
|
|
189
|
+
"ERROR"
|
|
190
|
+
]
|
|
191
|
+
},
|
|
192
|
+
"send_error": {
|
|
193
|
+
"type": "object",
|
|
194
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
136
195
|
}
|
|
137
196
|
}
|
|
138
197
|
}
|
|
@@ -155,6 +214,22 @@
|
|
|
155
214
|
"type": "string",
|
|
156
215
|
"description": "Email address",
|
|
157
216
|
"example": "messaging@epilot.cloud"
|
|
217
|
+
},
|
|
218
|
+
"send_status": {
|
|
219
|
+
"type": "string",
|
|
220
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
221
|
+
"enum": [
|
|
222
|
+
"SEND",
|
|
223
|
+
"DELIVERY",
|
|
224
|
+
"REJECT",
|
|
225
|
+
"COMPLAINT",
|
|
226
|
+
"BOUNCE",
|
|
227
|
+
"ERROR"
|
|
228
|
+
]
|
|
229
|
+
},
|
|
230
|
+
"send_error": {
|
|
231
|
+
"type": "object",
|
|
232
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
158
233
|
}
|
|
159
234
|
}
|
|
160
235
|
}
|
|
@@ -177,6 +252,22 @@
|
|
|
177
252
|
"type": "string",
|
|
178
253
|
"description": "Email address",
|
|
179
254
|
"example": "messaging@epilot.cloud"
|
|
255
|
+
},
|
|
256
|
+
"send_status": {
|
|
257
|
+
"type": "string",
|
|
258
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
259
|
+
"enum": [
|
|
260
|
+
"SEND",
|
|
261
|
+
"DELIVERY",
|
|
262
|
+
"REJECT",
|
|
263
|
+
"COMPLAINT",
|
|
264
|
+
"BOUNCE",
|
|
265
|
+
"ERROR"
|
|
266
|
+
]
|
|
267
|
+
},
|
|
268
|
+
"send_error": {
|
|
269
|
+
"type": "object",
|
|
270
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
180
271
|
}
|
|
181
272
|
}
|
|
182
273
|
}
|
|
@@ -242,7 +333,7 @@
|
|
|
242
333
|
},
|
|
243
334
|
"copy_to_message": {
|
|
244
335
|
"type": "boolean",
|
|
245
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `
|
|
336
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
246
337
|
"default": false
|
|
247
338
|
}
|
|
248
339
|
}
|
|
@@ -362,6 +453,22 @@
|
|
|
362
453
|
"type": "string",
|
|
363
454
|
"description": "Email address",
|
|
364
455
|
"example": "messaging@epilot.cloud"
|
|
456
|
+
},
|
|
457
|
+
"send_status": {
|
|
458
|
+
"type": "string",
|
|
459
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
460
|
+
"enum": [
|
|
461
|
+
"SEND",
|
|
462
|
+
"DELIVERY",
|
|
463
|
+
"REJECT",
|
|
464
|
+
"COMPLAINT",
|
|
465
|
+
"BOUNCE",
|
|
466
|
+
"ERROR"
|
|
467
|
+
]
|
|
468
|
+
},
|
|
469
|
+
"send_error": {
|
|
470
|
+
"type": "object",
|
|
471
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
365
472
|
}
|
|
366
473
|
}
|
|
367
474
|
},
|
|
@@ -380,6 +487,22 @@
|
|
|
380
487
|
"type": "string",
|
|
381
488
|
"description": "Email address",
|
|
382
489
|
"example": "messaging@epilot.cloud"
|
|
490
|
+
},
|
|
491
|
+
"send_status": {
|
|
492
|
+
"type": "string",
|
|
493
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
494
|
+
"enum": [
|
|
495
|
+
"SEND",
|
|
496
|
+
"DELIVERY",
|
|
497
|
+
"REJECT",
|
|
498
|
+
"COMPLAINT",
|
|
499
|
+
"BOUNCE",
|
|
500
|
+
"ERROR"
|
|
501
|
+
]
|
|
502
|
+
},
|
|
503
|
+
"send_error": {
|
|
504
|
+
"type": "object",
|
|
505
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
383
506
|
}
|
|
384
507
|
}
|
|
385
508
|
},
|
|
@@ -401,6 +524,22 @@
|
|
|
401
524
|
"type": "string",
|
|
402
525
|
"description": "Email address",
|
|
403
526
|
"example": "messaging@epilot.cloud"
|
|
527
|
+
},
|
|
528
|
+
"send_status": {
|
|
529
|
+
"type": "string",
|
|
530
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
531
|
+
"enum": [
|
|
532
|
+
"SEND",
|
|
533
|
+
"DELIVERY",
|
|
534
|
+
"REJECT",
|
|
535
|
+
"COMPLAINT",
|
|
536
|
+
"BOUNCE",
|
|
537
|
+
"ERROR"
|
|
538
|
+
]
|
|
539
|
+
},
|
|
540
|
+
"send_error": {
|
|
541
|
+
"type": "object",
|
|
542
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
404
543
|
}
|
|
405
544
|
}
|
|
406
545
|
}
|
|
@@ -423,6 +562,22 @@
|
|
|
423
562
|
"type": "string",
|
|
424
563
|
"description": "Email address",
|
|
425
564
|
"example": "messaging@epilot.cloud"
|
|
565
|
+
},
|
|
566
|
+
"send_status": {
|
|
567
|
+
"type": "string",
|
|
568
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
569
|
+
"enum": [
|
|
570
|
+
"SEND",
|
|
571
|
+
"DELIVERY",
|
|
572
|
+
"REJECT",
|
|
573
|
+
"COMPLAINT",
|
|
574
|
+
"BOUNCE",
|
|
575
|
+
"ERROR"
|
|
576
|
+
]
|
|
577
|
+
},
|
|
578
|
+
"send_error": {
|
|
579
|
+
"type": "object",
|
|
580
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
426
581
|
}
|
|
427
582
|
}
|
|
428
583
|
}
|
|
@@ -445,6 +600,22 @@
|
|
|
445
600
|
"type": "string",
|
|
446
601
|
"description": "Email address",
|
|
447
602
|
"example": "messaging@epilot.cloud"
|
|
603
|
+
},
|
|
604
|
+
"send_status": {
|
|
605
|
+
"type": "string",
|
|
606
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
607
|
+
"enum": [
|
|
608
|
+
"SEND",
|
|
609
|
+
"DELIVERY",
|
|
610
|
+
"REJECT",
|
|
611
|
+
"COMPLAINT",
|
|
612
|
+
"BOUNCE",
|
|
613
|
+
"ERROR"
|
|
614
|
+
]
|
|
615
|
+
},
|
|
616
|
+
"send_error": {
|
|
617
|
+
"type": "object",
|
|
618
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
448
619
|
}
|
|
449
620
|
}
|
|
450
621
|
}
|
|
@@ -510,7 +681,7 @@
|
|
|
510
681
|
},
|
|
511
682
|
"copy_to_message": {
|
|
512
683
|
"type": "boolean",
|
|
513
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `
|
|
684
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
514
685
|
"default": false
|
|
515
686
|
}
|
|
516
687
|
}
|
|
@@ -537,17 +708,20 @@
|
|
|
537
708
|
]
|
|
538
709
|
}
|
|
539
710
|
},
|
|
540
|
-
"
|
|
541
|
-
"type": "
|
|
542
|
-
"description": "
|
|
543
|
-
"
|
|
544
|
-
"
|
|
545
|
-
"
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
711
|
+
"send_status": {
|
|
712
|
+
"type": "array",
|
|
713
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
714
|
+
"items": {
|
|
715
|
+
"type": "string",
|
|
716
|
+
"enum": [
|
|
717
|
+
"SEND",
|
|
718
|
+
"DELIVERY",
|
|
719
|
+
"REJECT",
|
|
720
|
+
"COMPLAINT",
|
|
721
|
+
"BOUNCE",
|
|
722
|
+
"ERROR"
|
|
723
|
+
]
|
|
724
|
+
}
|
|
551
725
|
},
|
|
552
726
|
"type": {
|
|
553
727
|
"type": "string",
|
|
@@ -568,102 +742,13 @@
|
|
|
568
742
|
"description": "Forbidden"
|
|
569
743
|
}
|
|
570
744
|
}
|
|
571
|
-
}
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
"
|
|
576
|
-
"summary": "deleteMessage",
|
|
577
|
-
"description": "Immediately and permanently deletes the specified message. This operation cannot be undone.",
|
|
578
|
-
"tags": [
|
|
579
|
-
"messages"
|
|
580
|
-
],
|
|
581
|
-
"parameters": [
|
|
582
|
-
{
|
|
583
|
-
"name": "id",
|
|
584
|
-
"description": "Message ID",
|
|
585
|
-
"in": "path",
|
|
586
|
-
"required": true,
|
|
587
|
-
"schema": {
|
|
588
|
-
"type": "string"
|
|
589
|
-
}
|
|
590
|
-
}
|
|
591
|
-
],
|
|
592
|
-
"responses": {
|
|
593
|
-
"204": {
|
|
594
|
-
"description": "Success"
|
|
595
|
-
},
|
|
596
|
-
"403": {
|
|
597
|
-
"description": "Forbidden"
|
|
598
|
-
}
|
|
599
|
-
}
|
|
600
|
-
}
|
|
601
|
-
},
|
|
602
|
-
"/messages/{id}/trash": {
|
|
603
|
-
"post": {
|
|
604
|
-
"operationId": "trashMessage",
|
|
605
|
-
"summary": "trashMessage",
|
|
606
|
-
"description": "Moves the specified message to the trash.",
|
|
607
|
-
"tags": [
|
|
608
|
-
"messages"
|
|
609
|
-
],
|
|
610
|
-
"parameters": [
|
|
611
|
-
{
|
|
612
|
-
"name": "id",
|
|
613
|
-
"description": "Message ID",
|
|
614
|
-
"in": "path",
|
|
615
|
-
"required": true,
|
|
616
|
-
"schema": {
|
|
617
|
-
"type": "string"
|
|
618
|
-
}
|
|
619
|
-
}
|
|
620
|
-
],
|
|
621
|
-
"responses": {
|
|
622
|
-
"204": {
|
|
623
|
-
"description": "Success"
|
|
624
|
-
},
|
|
625
|
-
"403": {
|
|
626
|
-
"description": "Forbidden"
|
|
627
|
-
}
|
|
628
|
-
}
|
|
629
|
-
}
|
|
630
|
-
},
|
|
631
|
-
"/messages/{id}/untrash": {
|
|
632
|
-
"post": {
|
|
633
|
-
"operationId": "untrashMessage",
|
|
634
|
-
"summary": "untrashMessage",
|
|
635
|
-
"description": "Removes the specified message from the trash.",
|
|
636
|
-
"tags": [
|
|
637
|
-
"messages"
|
|
638
|
-
],
|
|
639
|
-
"parameters": [
|
|
640
|
-
{
|
|
641
|
-
"name": "id",
|
|
642
|
-
"description": "Message ID",
|
|
643
|
-
"in": "path",
|
|
644
|
-
"required": true,
|
|
645
|
-
"schema": {
|
|
646
|
-
"type": "string"
|
|
647
|
-
}
|
|
648
|
-
}
|
|
649
|
-
],
|
|
650
|
-
"responses": {
|
|
651
|
-
"204": {
|
|
652
|
-
"description": "Success"
|
|
653
|
-
},
|
|
654
|
-
"403": {
|
|
655
|
-
"description": "Forbidden"
|
|
656
|
-
}
|
|
657
|
-
}
|
|
658
|
-
}
|
|
659
|
-
},
|
|
660
|
-
"/threads:search": {
|
|
661
|
-
"post": {
|
|
662
|
-
"operationId": "searchThreads",
|
|
663
|
-
"summary": "searchThreads",
|
|
664
|
-
"description": "Search for message entity and return threads which contain matched message. If message doesn't have any reply yet, evaluate it as a thread with single message.\\\nSupports pagination. Lucene query syntax supported for complex querying.\n",
|
|
745
|
+
},
|
|
746
|
+
"put": {
|
|
747
|
+
"operationId": "updateMessage",
|
|
748
|
+
"summary": "updateMessage",
|
|
749
|
+
"description": "Update message metadata",
|
|
665
750
|
"tags": [
|
|
666
|
-
"
|
|
751
|
+
"Messages"
|
|
667
752
|
],
|
|
668
753
|
"requestBody": {
|
|
669
754
|
"content": {
|
|
@@ -671,43 +756,871 @@
|
|
|
671
756
|
"schema": {
|
|
672
757
|
"type": "object",
|
|
673
758
|
"required": [
|
|
674
|
-
"
|
|
759
|
+
"subject",
|
|
760
|
+
"from"
|
|
675
761
|
],
|
|
676
762
|
"properties": {
|
|
677
|
-
"
|
|
678
|
-
"description": "Lucene queries supported with ElasticSearch",
|
|
763
|
+
"message_id": {
|
|
679
764
|
"type": "string",
|
|
680
|
-
"
|
|
765
|
+
"description": "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
|
|
766
|
+
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
|
|
767
|
+
},
|
|
768
|
+
"sender": {
|
|
769
|
+
"type": "string",
|
|
770
|
+
"description": "Ivy User ID of user sends the message.",
|
|
771
|
+
"example": "206801"
|
|
772
|
+
},
|
|
773
|
+
"subject": {
|
|
774
|
+
"type": "string",
|
|
775
|
+
"description": "Subject",
|
|
776
|
+
"example": "Request for solar panel price"
|
|
777
|
+
},
|
|
778
|
+
"html": {
|
|
779
|
+
"type": "string",
|
|
780
|
+
"description": "HTML body",
|
|
781
|
+
"example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
|
|
782
|
+
},
|
|
783
|
+
"text": {
|
|
784
|
+
"type": "string",
|
|
785
|
+
"description": "Text body",
|
|
786
|
+
"example": "We at ABC GmbH would like to request a price quote for the solar panel."
|
|
681
787
|
},
|
|
682
788
|
"from": {
|
|
683
|
-
"type": "
|
|
684
|
-
"
|
|
685
|
-
|
|
789
|
+
"type": "object",
|
|
790
|
+
"required": [
|
|
791
|
+
"address"
|
|
792
|
+
],
|
|
793
|
+
"properties": {
|
|
794
|
+
"name": {
|
|
795
|
+
"type": "string",
|
|
796
|
+
"description": "Email address alias",
|
|
797
|
+
"example": "epilot"
|
|
798
|
+
},
|
|
799
|
+
"address": {
|
|
800
|
+
"type": "string",
|
|
801
|
+
"description": "Email address",
|
|
802
|
+
"example": "messaging@epilot.cloud"
|
|
803
|
+
},
|
|
804
|
+
"send_status": {
|
|
805
|
+
"type": "string",
|
|
806
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
807
|
+
"enum": [
|
|
808
|
+
"SEND",
|
|
809
|
+
"DELIVERY",
|
|
810
|
+
"REJECT",
|
|
811
|
+
"COMPLAINT",
|
|
812
|
+
"BOUNCE",
|
|
813
|
+
"ERROR"
|
|
814
|
+
]
|
|
815
|
+
},
|
|
816
|
+
"send_error": {
|
|
817
|
+
"type": "object",
|
|
818
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
819
|
+
}
|
|
820
|
+
}
|
|
686
821
|
},
|
|
687
|
-
"
|
|
688
|
-
"type": "
|
|
689
|
-
"
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
822
|
+
"reply_to": {
|
|
823
|
+
"type": "object",
|
|
824
|
+
"required": [
|
|
825
|
+
"address"
|
|
826
|
+
],
|
|
827
|
+
"properties": {
|
|
828
|
+
"name": {
|
|
829
|
+
"type": "string",
|
|
830
|
+
"description": "Email address alias",
|
|
831
|
+
"example": "epilot"
|
|
832
|
+
},
|
|
833
|
+
"address": {
|
|
834
|
+
"type": "string",
|
|
835
|
+
"description": "Email address",
|
|
836
|
+
"example": "messaging@epilot.cloud"
|
|
837
|
+
},
|
|
838
|
+
"send_status": {
|
|
839
|
+
"type": "string",
|
|
840
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
841
|
+
"enum": [
|
|
842
|
+
"SEND",
|
|
843
|
+
"DELIVERY",
|
|
844
|
+
"REJECT",
|
|
845
|
+
"COMPLAINT",
|
|
846
|
+
"BOUNCE",
|
|
847
|
+
"ERROR"
|
|
848
|
+
]
|
|
849
|
+
},
|
|
850
|
+
"send_error": {
|
|
851
|
+
"type": "object",
|
|
852
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
853
|
+
}
|
|
854
|
+
}
|
|
855
|
+
},
|
|
856
|
+
"to": {
|
|
857
|
+
"type": "array",
|
|
858
|
+
"description": "To email addresses",
|
|
859
|
+
"items": {
|
|
860
|
+
"type": "object",
|
|
861
|
+
"required": [
|
|
862
|
+
"address"
|
|
863
|
+
],
|
|
864
|
+
"properties": {
|
|
865
|
+
"name": {
|
|
866
|
+
"type": "string",
|
|
867
|
+
"description": "Email address alias",
|
|
868
|
+
"example": "epilot"
|
|
869
|
+
},
|
|
870
|
+
"address": {
|
|
871
|
+
"type": "string",
|
|
872
|
+
"description": "Email address",
|
|
873
|
+
"example": "messaging@epilot.cloud"
|
|
874
|
+
},
|
|
875
|
+
"send_status": {
|
|
876
|
+
"type": "string",
|
|
877
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
878
|
+
"enum": [
|
|
879
|
+
"SEND",
|
|
880
|
+
"DELIVERY",
|
|
881
|
+
"REJECT",
|
|
882
|
+
"COMPLAINT",
|
|
883
|
+
"BOUNCE",
|
|
884
|
+
"ERROR"
|
|
885
|
+
]
|
|
886
|
+
},
|
|
887
|
+
"send_error": {
|
|
888
|
+
"type": "object",
|
|
889
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
890
|
+
}
|
|
891
|
+
}
|
|
892
|
+
}
|
|
893
|
+
},
|
|
894
|
+
"cc": {
|
|
895
|
+
"type": "array",
|
|
896
|
+
"description": "Cc email addresses",
|
|
897
|
+
"items": {
|
|
898
|
+
"type": "object",
|
|
899
|
+
"required": [
|
|
900
|
+
"address"
|
|
901
|
+
],
|
|
902
|
+
"properties": {
|
|
903
|
+
"name": {
|
|
904
|
+
"type": "string",
|
|
905
|
+
"description": "Email address alias",
|
|
906
|
+
"example": "epilot"
|
|
907
|
+
},
|
|
908
|
+
"address": {
|
|
909
|
+
"type": "string",
|
|
910
|
+
"description": "Email address",
|
|
911
|
+
"example": "messaging@epilot.cloud"
|
|
912
|
+
},
|
|
913
|
+
"send_status": {
|
|
914
|
+
"type": "string",
|
|
915
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
916
|
+
"enum": [
|
|
917
|
+
"SEND",
|
|
918
|
+
"DELIVERY",
|
|
919
|
+
"REJECT",
|
|
920
|
+
"COMPLAINT",
|
|
921
|
+
"BOUNCE",
|
|
922
|
+
"ERROR"
|
|
923
|
+
]
|
|
924
|
+
},
|
|
925
|
+
"send_error": {
|
|
926
|
+
"type": "object",
|
|
927
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
928
|
+
}
|
|
929
|
+
}
|
|
930
|
+
}
|
|
931
|
+
},
|
|
932
|
+
"bcc": {
|
|
933
|
+
"type": "array",
|
|
934
|
+
"description": "Bcc email addresses",
|
|
935
|
+
"items": {
|
|
936
|
+
"type": "object",
|
|
937
|
+
"required": [
|
|
938
|
+
"address"
|
|
939
|
+
],
|
|
940
|
+
"properties": {
|
|
941
|
+
"name": {
|
|
942
|
+
"type": "string",
|
|
943
|
+
"description": "Email address alias",
|
|
944
|
+
"example": "epilot"
|
|
945
|
+
},
|
|
946
|
+
"address": {
|
|
947
|
+
"type": "string",
|
|
948
|
+
"description": "Email address",
|
|
949
|
+
"example": "messaging@epilot.cloud"
|
|
950
|
+
},
|
|
951
|
+
"send_status": {
|
|
952
|
+
"type": "string",
|
|
953
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
954
|
+
"enum": [
|
|
955
|
+
"SEND",
|
|
956
|
+
"DELIVERY",
|
|
957
|
+
"REJECT",
|
|
958
|
+
"COMPLAINT",
|
|
959
|
+
"BOUNCE",
|
|
960
|
+
"ERROR"
|
|
961
|
+
]
|
|
962
|
+
},
|
|
963
|
+
"send_error": {
|
|
964
|
+
"type": "object",
|
|
965
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
966
|
+
}
|
|
967
|
+
}
|
|
968
|
+
}
|
|
969
|
+
},
|
|
970
|
+
"attachments": {
|
|
971
|
+
"type": "array",
|
|
972
|
+
"description": "Message attachments",
|
|
973
|
+
"items": {
|
|
974
|
+
"type": "object",
|
|
975
|
+
"required": [
|
|
976
|
+
"filename",
|
|
977
|
+
"size",
|
|
978
|
+
"content_type",
|
|
979
|
+
"url",
|
|
980
|
+
"bucket",
|
|
981
|
+
"object_key"
|
|
982
|
+
],
|
|
983
|
+
"properties": {
|
|
984
|
+
"cid": {
|
|
985
|
+
"type": "string",
|
|
986
|
+
"description": "Attachment ID",
|
|
987
|
+
"example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
|
|
988
|
+
},
|
|
989
|
+
"filename": {
|
|
990
|
+
"type": "string",
|
|
991
|
+
"description": "File name",
|
|
992
|
+
"example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
993
|
+
},
|
|
994
|
+
"size": {
|
|
995
|
+
"type": "number",
|
|
996
|
+
"description": "File size in bytes",
|
|
997
|
+
"example": 451349
|
|
998
|
+
},
|
|
999
|
+
"content_type": {
|
|
1000
|
+
"type": "string",
|
|
1001
|
+
"description": "Content type",
|
|
1002
|
+
"example": "application/pdf"
|
|
1003
|
+
},
|
|
1004
|
+
"url": {
|
|
1005
|
+
"type": "string",
|
|
1006
|
+
"description": "URL to download the attachment.",
|
|
1007
|
+
"example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
1008
|
+
},
|
|
1009
|
+
"bucket": {
|
|
1010
|
+
"type": "string",
|
|
1011
|
+
"description": "S3 bucket where file is stored",
|
|
1012
|
+
"example": "893487340562-message-attachment"
|
|
1013
|
+
},
|
|
1014
|
+
"object_key": {
|
|
1015
|
+
"type": "string",
|
|
1016
|
+
"description": "S3 object apiKey",
|
|
1017
|
+
"example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
1018
|
+
},
|
|
1019
|
+
"inline": {
|
|
1020
|
+
"type": "boolean",
|
|
1021
|
+
"description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
|
|
1022
|
+
"default": false
|
|
1023
|
+
},
|
|
1024
|
+
"send_as_link": {
|
|
1025
|
+
"type": "boolean",
|
|
1026
|
+
"description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
|
|
1027
|
+
"default": false
|
|
1028
|
+
},
|
|
1029
|
+
"copy_to_message": {
|
|
1030
|
+
"type": "boolean",
|
|
1031
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
1032
|
+
"default": false
|
|
1033
|
+
}
|
|
1034
|
+
}
|
|
1035
|
+
}
|
|
1036
|
+
},
|
|
1037
|
+
"references": {
|
|
1038
|
+
"type": "string",
|
|
1039
|
+
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
|
|
1040
|
+
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1041
|
+
},
|
|
1042
|
+
"in_reply_to": {
|
|
1043
|
+
"type": "string",
|
|
1044
|
+
"description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
|
|
1045
|
+
"example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1046
|
+
},
|
|
1047
|
+
"user_read_message": {
|
|
1048
|
+
"type": "array",
|
|
1049
|
+
"description": "Ivy User ID of user read the message.",
|
|
1050
|
+
"items": {
|
|
1051
|
+
"type": "string",
|
|
1052
|
+
"example": [
|
|
1053
|
+
"206801",
|
|
1054
|
+
"200109"
|
|
1055
|
+
]
|
|
1056
|
+
}
|
|
1057
|
+
},
|
|
1058
|
+
"send_status": {
|
|
1059
|
+
"type": "array",
|
|
1060
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1061
|
+
"items": {
|
|
1062
|
+
"type": "string",
|
|
1063
|
+
"enum": [
|
|
1064
|
+
"SEND",
|
|
1065
|
+
"DELIVERY",
|
|
1066
|
+
"REJECT",
|
|
1067
|
+
"COMPLAINT",
|
|
1068
|
+
"BOUNCE",
|
|
1069
|
+
"ERROR"
|
|
1070
|
+
]
|
|
1071
|
+
}
|
|
1072
|
+
},
|
|
1073
|
+
"type": {
|
|
1074
|
+
"type": "string",
|
|
1075
|
+
"description": "Message type",
|
|
1076
|
+
"enum": [
|
|
1077
|
+
"SENT",
|
|
1078
|
+
"RECEIVED"
|
|
1079
|
+
]
|
|
1080
|
+
}
|
|
1081
|
+
}
|
|
1082
|
+
}
|
|
1083
|
+
}
|
|
1084
|
+
}
|
|
1085
|
+
},
|
|
1086
|
+
"responses": {
|
|
1087
|
+
"201": {
|
|
1088
|
+
"description": "Success",
|
|
1089
|
+
"content": {
|
|
1090
|
+
"application/json": {
|
|
1091
|
+
"schema": {
|
|
1092
|
+
"allOf": [
|
|
1093
|
+
{
|
|
1094
|
+
"type": "object",
|
|
1095
|
+
"required": [
|
|
1096
|
+
"_id",
|
|
1097
|
+
"_title",
|
|
1098
|
+
"_org",
|
|
1099
|
+
"_schema",
|
|
1100
|
+
"_created_at",
|
|
1101
|
+
"_updated_at"
|
|
1102
|
+
],
|
|
1103
|
+
"properties": {
|
|
1104
|
+
"_id": {
|
|
1105
|
+
"type": "string",
|
|
1106
|
+
"description": "Entity ID",
|
|
1107
|
+
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
1108
|
+
},
|
|
1109
|
+
"_title": {
|
|
1110
|
+
"type": "string",
|
|
1111
|
+
"description": "Entity title"
|
|
1112
|
+
},
|
|
1113
|
+
"_org": {
|
|
1114
|
+
"type": "string",
|
|
1115
|
+
"description": "Ivy Organization ID the entity belongs to",
|
|
1116
|
+
"example": "206801"
|
|
1117
|
+
},
|
|
1118
|
+
"_schema": {
|
|
1119
|
+
"type": "string",
|
|
1120
|
+
"description": "URL-friendly identifier for the entity schema",
|
|
1121
|
+
"example": "message"
|
|
1122
|
+
},
|
|
1123
|
+
"_tags": {
|
|
1124
|
+
"type": "array",
|
|
1125
|
+
"description": "Entity tags",
|
|
1126
|
+
"items": {
|
|
1127
|
+
"type": "string"
|
|
1128
|
+
},
|
|
1129
|
+
"example": [
|
|
1130
|
+
"pricing",
|
|
1131
|
+
"INBOX"
|
|
1132
|
+
]
|
|
1133
|
+
},
|
|
1134
|
+
"_created_at": {
|
|
1135
|
+
"type": "string",
|
|
1136
|
+
"description": "Created date",
|
|
1137
|
+
"format": "date-time",
|
|
1138
|
+
"example": "2021-02-09T12:41:43.662Z"
|
|
1139
|
+
},
|
|
1140
|
+
"_updated_at": {
|
|
1141
|
+
"type": "string",
|
|
1142
|
+
"description": "Updated date",
|
|
1143
|
+
"format": "date-time",
|
|
1144
|
+
"example": "2021-02-10T09:14:31.990Z"
|
|
1145
|
+
}
|
|
1146
|
+
}
|
|
1147
|
+
},
|
|
1148
|
+
{
|
|
1149
|
+
"type": "object",
|
|
1150
|
+
"required": [
|
|
1151
|
+
"subject",
|
|
1152
|
+
"from"
|
|
1153
|
+
],
|
|
1154
|
+
"properties": {
|
|
1155
|
+
"message_id": {
|
|
1156
|
+
"type": "string",
|
|
1157
|
+
"description": "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
|
|
1158
|
+
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
|
|
1159
|
+
},
|
|
1160
|
+
"sender": {
|
|
1161
|
+
"type": "string",
|
|
1162
|
+
"description": "Ivy User ID of user sends the message.",
|
|
1163
|
+
"example": "206801"
|
|
1164
|
+
},
|
|
1165
|
+
"subject": {
|
|
1166
|
+
"type": "string",
|
|
1167
|
+
"description": "Subject",
|
|
1168
|
+
"example": "Request for solar panel price"
|
|
1169
|
+
},
|
|
1170
|
+
"html": {
|
|
1171
|
+
"type": "string",
|
|
1172
|
+
"description": "HTML body",
|
|
1173
|
+
"example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
|
|
1174
|
+
},
|
|
1175
|
+
"text": {
|
|
1176
|
+
"type": "string",
|
|
1177
|
+
"description": "Text body",
|
|
1178
|
+
"example": "We at ABC GmbH would like to request a price quote for the solar panel."
|
|
1179
|
+
},
|
|
1180
|
+
"from": {
|
|
1181
|
+
"type": "object",
|
|
1182
|
+
"required": [
|
|
1183
|
+
"address"
|
|
1184
|
+
],
|
|
1185
|
+
"properties": {
|
|
1186
|
+
"name": {
|
|
1187
|
+
"type": "string",
|
|
1188
|
+
"description": "Email address alias",
|
|
1189
|
+
"example": "epilot"
|
|
1190
|
+
},
|
|
1191
|
+
"address": {
|
|
1192
|
+
"type": "string",
|
|
1193
|
+
"description": "Email address",
|
|
1194
|
+
"example": "messaging@epilot.cloud"
|
|
1195
|
+
},
|
|
1196
|
+
"send_status": {
|
|
1197
|
+
"type": "string",
|
|
1198
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1199
|
+
"enum": [
|
|
1200
|
+
"SEND",
|
|
1201
|
+
"DELIVERY",
|
|
1202
|
+
"REJECT",
|
|
1203
|
+
"COMPLAINT",
|
|
1204
|
+
"BOUNCE",
|
|
1205
|
+
"ERROR"
|
|
1206
|
+
]
|
|
1207
|
+
},
|
|
1208
|
+
"send_error": {
|
|
1209
|
+
"type": "object",
|
|
1210
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1211
|
+
}
|
|
1212
|
+
}
|
|
1213
|
+
},
|
|
1214
|
+
"reply_to": {
|
|
1215
|
+
"type": "object",
|
|
1216
|
+
"required": [
|
|
1217
|
+
"address"
|
|
1218
|
+
],
|
|
1219
|
+
"properties": {
|
|
1220
|
+
"name": {
|
|
1221
|
+
"type": "string",
|
|
1222
|
+
"description": "Email address alias",
|
|
1223
|
+
"example": "epilot"
|
|
1224
|
+
},
|
|
1225
|
+
"address": {
|
|
1226
|
+
"type": "string",
|
|
1227
|
+
"description": "Email address",
|
|
1228
|
+
"example": "messaging@epilot.cloud"
|
|
1229
|
+
},
|
|
1230
|
+
"send_status": {
|
|
1231
|
+
"type": "string",
|
|
1232
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1233
|
+
"enum": [
|
|
1234
|
+
"SEND",
|
|
1235
|
+
"DELIVERY",
|
|
1236
|
+
"REJECT",
|
|
1237
|
+
"COMPLAINT",
|
|
1238
|
+
"BOUNCE",
|
|
1239
|
+
"ERROR"
|
|
1240
|
+
]
|
|
1241
|
+
},
|
|
1242
|
+
"send_error": {
|
|
1243
|
+
"type": "object",
|
|
1244
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1245
|
+
}
|
|
1246
|
+
}
|
|
1247
|
+
},
|
|
1248
|
+
"to": {
|
|
1249
|
+
"type": "array",
|
|
1250
|
+
"description": "To email addresses",
|
|
1251
|
+
"items": {
|
|
1252
|
+
"type": "object",
|
|
1253
|
+
"required": [
|
|
1254
|
+
"address"
|
|
1255
|
+
],
|
|
1256
|
+
"properties": {
|
|
1257
|
+
"name": {
|
|
1258
|
+
"type": "string",
|
|
1259
|
+
"description": "Email address alias",
|
|
1260
|
+
"example": "epilot"
|
|
1261
|
+
},
|
|
1262
|
+
"address": {
|
|
1263
|
+
"type": "string",
|
|
1264
|
+
"description": "Email address",
|
|
1265
|
+
"example": "messaging@epilot.cloud"
|
|
1266
|
+
},
|
|
1267
|
+
"send_status": {
|
|
1268
|
+
"type": "string",
|
|
1269
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1270
|
+
"enum": [
|
|
1271
|
+
"SEND",
|
|
1272
|
+
"DELIVERY",
|
|
1273
|
+
"REJECT",
|
|
1274
|
+
"COMPLAINT",
|
|
1275
|
+
"BOUNCE",
|
|
1276
|
+
"ERROR"
|
|
1277
|
+
]
|
|
1278
|
+
},
|
|
1279
|
+
"send_error": {
|
|
1280
|
+
"type": "object",
|
|
1281
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1282
|
+
}
|
|
1283
|
+
}
|
|
1284
|
+
}
|
|
1285
|
+
},
|
|
1286
|
+
"cc": {
|
|
1287
|
+
"type": "array",
|
|
1288
|
+
"description": "Cc email addresses",
|
|
1289
|
+
"items": {
|
|
1290
|
+
"type": "object",
|
|
1291
|
+
"required": [
|
|
1292
|
+
"address"
|
|
1293
|
+
],
|
|
1294
|
+
"properties": {
|
|
1295
|
+
"name": {
|
|
1296
|
+
"type": "string",
|
|
1297
|
+
"description": "Email address alias",
|
|
1298
|
+
"example": "epilot"
|
|
1299
|
+
},
|
|
1300
|
+
"address": {
|
|
1301
|
+
"type": "string",
|
|
1302
|
+
"description": "Email address",
|
|
1303
|
+
"example": "messaging@epilot.cloud"
|
|
1304
|
+
},
|
|
1305
|
+
"send_status": {
|
|
1306
|
+
"type": "string",
|
|
1307
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1308
|
+
"enum": [
|
|
1309
|
+
"SEND",
|
|
1310
|
+
"DELIVERY",
|
|
1311
|
+
"REJECT",
|
|
1312
|
+
"COMPLAINT",
|
|
1313
|
+
"BOUNCE",
|
|
1314
|
+
"ERROR"
|
|
1315
|
+
]
|
|
1316
|
+
},
|
|
1317
|
+
"send_error": {
|
|
1318
|
+
"type": "object",
|
|
1319
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1320
|
+
}
|
|
1321
|
+
}
|
|
1322
|
+
}
|
|
1323
|
+
},
|
|
1324
|
+
"bcc": {
|
|
1325
|
+
"type": "array",
|
|
1326
|
+
"description": "Bcc email addresses",
|
|
1327
|
+
"items": {
|
|
1328
|
+
"type": "object",
|
|
1329
|
+
"required": [
|
|
1330
|
+
"address"
|
|
1331
|
+
],
|
|
1332
|
+
"properties": {
|
|
1333
|
+
"name": {
|
|
1334
|
+
"type": "string",
|
|
1335
|
+
"description": "Email address alias",
|
|
1336
|
+
"example": "epilot"
|
|
1337
|
+
},
|
|
1338
|
+
"address": {
|
|
1339
|
+
"type": "string",
|
|
1340
|
+
"description": "Email address",
|
|
1341
|
+
"example": "messaging@epilot.cloud"
|
|
1342
|
+
},
|
|
1343
|
+
"send_status": {
|
|
1344
|
+
"type": "string",
|
|
1345
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1346
|
+
"enum": [
|
|
1347
|
+
"SEND",
|
|
1348
|
+
"DELIVERY",
|
|
1349
|
+
"REJECT",
|
|
1350
|
+
"COMPLAINT",
|
|
1351
|
+
"BOUNCE",
|
|
1352
|
+
"ERROR"
|
|
1353
|
+
]
|
|
1354
|
+
},
|
|
1355
|
+
"send_error": {
|
|
1356
|
+
"type": "object",
|
|
1357
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1358
|
+
}
|
|
1359
|
+
}
|
|
1360
|
+
}
|
|
1361
|
+
},
|
|
1362
|
+
"attachments": {
|
|
1363
|
+
"type": "array",
|
|
1364
|
+
"description": "Message attachments",
|
|
1365
|
+
"items": {
|
|
1366
|
+
"type": "object",
|
|
1367
|
+
"required": [
|
|
1368
|
+
"filename",
|
|
1369
|
+
"size",
|
|
1370
|
+
"content_type",
|
|
1371
|
+
"url",
|
|
1372
|
+
"bucket",
|
|
1373
|
+
"object_key"
|
|
1374
|
+
],
|
|
1375
|
+
"properties": {
|
|
1376
|
+
"cid": {
|
|
1377
|
+
"type": "string",
|
|
1378
|
+
"description": "Attachment ID",
|
|
1379
|
+
"example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
|
|
1380
|
+
},
|
|
1381
|
+
"filename": {
|
|
1382
|
+
"type": "string",
|
|
1383
|
+
"description": "File name",
|
|
1384
|
+
"example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
1385
|
+
},
|
|
1386
|
+
"size": {
|
|
1387
|
+
"type": "number",
|
|
1388
|
+
"description": "File size in bytes",
|
|
1389
|
+
"example": 451349
|
|
1390
|
+
},
|
|
1391
|
+
"content_type": {
|
|
1392
|
+
"type": "string",
|
|
1393
|
+
"description": "Content type",
|
|
1394
|
+
"example": "application/pdf"
|
|
1395
|
+
},
|
|
1396
|
+
"url": {
|
|
1397
|
+
"type": "string",
|
|
1398
|
+
"description": "URL to download the attachment.",
|
|
1399
|
+
"example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
1400
|
+
},
|
|
1401
|
+
"bucket": {
|
|
1402
|
+
"type": "string",
|
|
1403
|
+
"description": "S3 bucket where file is stored",
|
|
1404
|
+
"example": "893487340562-message-attachment"
|
|
1405
|
+
},
|
|
1406
|
+
"object_key": {
|
|
1407
|
+
"type": "string",
|
|
1408
|
+
"description": "S3 object apiKey",
|
|
1409
|
+
"example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
1410
|
+
},
|
|
1411
|
+
"inline": {
|
|
1412
|
+
"type": "boolean",
|
|
1413
|
+
"description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
|
|
1414
|
+
"default": false
|
|
1415
|
+
},
|
|
1416
|
+
"send_as_link": {
|
|
1417
|
+
"type": "boolean",
|
|
1418
|
+
"description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
|
|
1419
|
+
"default": false
|
|
1420
|
+
},
|
|
1421
|
+
"copy_to_message": {
|
|
1422
|
+
"type": "boolean",
|
|
1423
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
1424
|
+
"default": false
|
|
1425
|
+
}
|
|
1426
|
+
}
|
|
1427
|
+
}
|
|
1428
|
+
},
|
|
1429
|
+
"references": {
|
|
1430
|
+
"type": "string",
|
|
1431
|
+
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
|
|
1432
|
+
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1433
|
+
},
|
|
1434
|
+
"in_reply_to": {
|
|
1435
|
+
"type": "string",
|
|
1436
|
+
"description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
|
|
1437
|
+
"example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1438
|
+
},
|
|
1439
|
+
"user_read_message": {
|
|
1440
|
+
"type": "array",
|
|
1441
|
+
"description": "Ivy User ID of user read the message.",
|
|
1442
|
+
"items": {
|
|
1443
|
+
"type": "string",
|
|
1444
|
+
"example": [
|
|
1445
|
+
"206801",
|
|
1446
|
+
"200109"
|
|
1447
|
+
]
|
|
1448
|
+
}
|
|
1449
|
+
},
|
|
1450
|
+
"send_status": {
|
|
1451
|
+
"type": "array",
|
|
1452
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1453
|
+
"items": {
|
|
1454
|
+
"type": "string",
|
|
1455
|
+
"enum": [
|
|
1456
|
+
"SEND",
|
|
1457
|
+
"DELIVERY",
|
|
1458
|
+
"REJECT",
|
|
1459
|
+
"COMPLAINT",
|
|
1460
|
+
"BOUNCE",
|
|
1461
|
+
"ERROR"
|
|
1462
|
+
]
|
|
1463
|
+
}
|
|
1464
|
+
},
|
|
1465
|
+
"type": {
|
|
1466
|
+
"type": "string",
|
|
1467
|
+
"description": "Message type",
|
|
1468
|
+
"enum": [
|
|
1469
|
+
"SENT",
|
|
1470
|
+
"RECEIVED"
|
|
1471
|
+
]
|
|
1472
|
+
}
|
|
1473
|
+
}
|
|
1474
|
+
}
|
|
1475
|
+
]
|
|
1476
|
+
}
|
|
1477
|
+
}
|
|
1478
|
+
}
|
|
1479
|
+
},
|
|
1480
|
+
"403": {
|
|
1481
|
+
"description": "Forbidden"
|
|
1482
|
+
}
|
|
1483
|
+
}
|
|
1484
|
+
}
|
|
1485
|
+
},
|
|
1486
|
+
"/v1/message/messages/{id}": {
|
|
1487
|
+
"delete": {
|
|
1488
|
+
"operationId": "deleteMessage",
|
|
1489
|
+
"summary": "deleteMessage",
|
|
1490
|
+
"description": "Immediately and permanently delete a message. This operation cannot be undone.",
|
|
1491
|
+
"tags": [
|
|
1492
|
+
"Messages"
|
|
1493
|
+
],
|
|
1494
|
+
"parameters": [
|
|
1495
|
+
{
|
|
1496
|
+
"name": "id",
|
|
1497
|
+
"description": "Message ID",
|
|
1498
|
+
"in": "path",
|
|
1499
|
+
"required": true,
|
|
1500
|
+
"schema": {
|
|
1501
|
+
"type": "string"
|
|
1502
|
+
}
|
|
1503
|
+
}
|
|
1504
|
+
],
|
|
1505
|
+
"responses": {
|
|
1506
|
+
"204": {
|
|
1507
|
+
"description": "Success"
|
|
1508
|
+
},
|
|
1509
|
+
"403": {
|
|
1510
|
+
"description": "Forbidden"
|
|
1511
|
+
}
|
|
1512
|
+
}
|
|
1513
|
+
}
|
|
1514
|
+
},
|
|
1515
|
+
"/v1/message/messages/{id}/trash": {
|
|
1516
|
+
"post": {
|
|
1517
|
+
"operationId": "trashMessage",
|
|
1518
|
+
"summary": "trashMessage",
|
|
1519
|
+
"description": "Move a message to the trash",
|
|
1520
|
+
"tags": [
|
|
1521
|
+
"Messages"
|
|
1522
|
+
],
|
|
1523
|
+
"parameters": [
|
|
1524
|
+
{
|
|
1525
|
+
"name": "id",
|
|
1526
|
+
"description": "Message ID",
|
|
1527
|
+
"in": "path",
|
|
1528
|
+
"required": true,
|
|
1529
|
+
"schema": {
|
|
1530
|
+
"type": "string"
|
|
1531
|
+
}
|
|
1532
|
+
}
|
|
1533
|
+
],
|
|
1534
|
+
"responses": {
|
|
1535
|
+
"204": {
|
|
1536
|
+
"description": "Success"
|
|
1537
|
+
},
|
|
1538
|
+
"403": {
|
|
1539
|
+
"description": "Forbidden"
|
|
1540
|
+
}
|
|
1541
|
+
}
|
|
1542
|
+
}
|
|
1543
|
+
},
|
|
1544
|
+
"/v1/message/messages/{id}/untrash": {
|
|
1545
|
+
"post": {
|
|
1546
|
+
"operationId": "untrashMessage",
|
|
1547
|
+
"summary": "untrashMessage",
|
|
1548
|
+
"description": "Restore a trashed message",
|
|
1549
|
+
"tags": [
|
|
1550
|
+
"Messages"
|
|
1551
|
+
],
|
|
1552
|
+
"parameters": [
|
|
1553
|
+
{
|
|
1554
|
+
"name": "id",
|
|
1555
|
+
"description": "Message ID",
|
|
1556
|
+
"in": "path",
|
|
1557
|
+
"required": true,
|
|
1558
|
+
"schema": {
|
|
1559
|
+
"type": "string"
|
|
1560
|
+
}
|
|
1561
|
+
}
|
|
1562
|
+
],
|
|
1563
|
+
"responses": {
|
|
1564
|
+
"204": {
|
|
1565
|
+
"description": "Success"
|
|
1566
|
+
},
|
|
1567
|
+
"403": {
|
|
1568
|
+
"description": "Forbidden"
|
|
1569
|
+
}
|
|
1570
|
+
}
|
|
1571
|
+
}
|
|
1572
|
+
},
|
|
1573
|
+
"/v1/message/threads:search": {
|
|
1574
|
+
"post": {
|
|
1575
|
+
"operationId": "searchThreads",
|
|
1576
|
+
"summary": "searchThreads",
|
|
1577
|
+
"description": "Search for threads of email messages.\n\nMessages with no replies yet are treated as threads with single message.\n\nLucene syntax supported.\n",
|
|
1578
|
+
"tags": [
|
|
1579
|
+
"Threads"
|
|
1580
|
+
],
|
|
1581
|
+
"requestBody": {
|
|
1582
|
+
"content": {
|
|
1583
|
+
"application/json": {
|
|
1584
|
+
"schema": {
|
|
1585
|
+
"type": "object",
|
|
1586
|
+
"required": [
|
|
1587
|
+
"q"
|
|
1588
|
+
],
|
|
1589
|
+
"properties": {
|
|
1590
|
+
"q": {
|
|
1591
|
+
"description": "Lucene query syntax supported with ElasticSearch",
|
|
1592
|
+
"type": "string",
|
|
1593
|
+
"example": "subject:\"Request for solar panel price\" AND _tags:INBOX"
|
|
1594
|
+
},
|
|
1595
|
+
"from": {
|
|
1596
|
+
"type": "integer",
|
|
1597
|
+
"minimum": 0,
|
|
1598
|
+
"default": 0
|
|
1599
|
+
},
|
|
1600
|
+
"size": {
|
|
1601
|
+
"type": "integer",
|
|
1602
|
+
"minimum": 1,
|
|
1603
|
+
"default": 10
|
|
1604
|
+
}
|
|
1605
|
+
}
|
|
1606
|
+
}
|
|
1607
|
+
}
|
|
1608
|
+
}
|
|
1609
|
+
},
|
|
1610
|
+
"responses": {
|
|
1611
|
+
"200": {
|
|
1612
|
+
"description": "Success",
|
|
1613
|
+
"content": {
|
|
1614
|
+
"application/json": {
|
|
1615
|
+
"schema": {
|
|
1616
|
+
"type": "object",
|
|
1617
|
+
"required": [
|
|
1618
|
+
"hits",
|
|
1619
|
+
"results"
|
|
1620
|
+
],
|
|
1621
|
+
"properties": {
|
|
1622
|
+
"hits": {
|
|
1623
|
+
"type": "number",
|
|
711
1624
|
"description": "Total of matched threads",
|
|
712
1625
|
"example": 14
|
|
713
1626
|
},
|
|
@@ -840,6 +1753,22 @@
|
|
|
840
1753
|
"type": "string",
|
|
841
1754
|
"description": "Email address",
|
|
842
1755
|
"example": "messaging@epilot.cloud"
|
|
1756
|
+
},
|
|
1757
|
+
"send_status": {
|
|
1758
|
+
"type": "string",
|
|
1759
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1760
|
+
"enum": [
|
|
1761
|
+
"SEND",
|
|
1762
|
+
"DELIVERY",
|
|
1763
|
+
"REJECT",
|
|
1764
|
+
"COMPLAINT",
|
|
1765
|
+
"BOUNCE",
|
|
1766
|
+
"ERROR"
|
|
1767
|
+
]
|
|
1768
|
+
},
|
|
1769
|
+
"send_error": {
|
|
1770
|
+
"type": "object",
|
|
1771
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
843
1772
|
}
|
|
844
1773
|
}
|
|
845
1774
|
},
|
|
@@ -858,6 +1787,22 @@
|
|
|
858
1787
|
"type": "string",
|
|
859
1788
|
"description": "Email address",
|
|
860
1789
|
"example": "messaging@epilot.cloud"
|
|
1790
|
+
},
|
|
1791
|
+
"send_status": {
|
|
1792
|
+
"type": "string",
|
|
1793
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1794
|
+
"enum": [
|
|
1795
|
+
"SEND",
|
|
1796
|
+
"DELIVERY",
|
|
1797
|
+
"REJECT",
|
|
1798
|
+
"COMPLAINT",
|
|
1799
|
+
"BOUNCE",
|
|
1800
|
+
"ERROR"
|
|
1801
|
+
]
|
|
1802
|
+
},
|
|
1803
|
+
"send_error": {
|
|
1804
|
+
"type": "object",
|
|
1805
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
861
1806
|
}
|
|
862
1807
|
}
|
|
863
1808
|
},
|
|
@@ -879,6 +1824,22 @@
|
|
|
879
1824
|
"type": "string",
|
|
880
1825
|
"description": "Email address",
|
|
881
1826
|
"example": "messaging@epilot.cloud"
|
|
1827
|
+
},
|
|
1828
|
+
"send_status": {
|
|
1829
|
+
"type": "string",
|
|
1830
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1831
|
+
"enum": [
|
|
1832
|
+
"SEND",
|
|
1833
|
+
"DELIVERY",
|
|
1834
|
+
"REJECT",
|
|
1835
|
+
"COMPLAINT",
|
|
1836
|
+
"BOUNCE",
|
|
1837
|
+
"ERROR"
|
|
1838
|
+
]
|
|
1839
|
+
},
|
|
1840
|
+
"send_error": {
|
|
1841
|
+
"type": "object",
|
|
1842
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
882
1843
|
}
|
|
883
1844
|
}
|
|
884
1845
|
}
|
|
@@ -901,6 +1862,22 @@
|
|
|
901
1862
|
"type": "string",
|
|
902
1863
|
"description": "Email address",
|
|
903
1864
|
"example": "messaging@epilot.cloud"
|
|
1865
|
+
},
|
|
1866
|
+
"send_status": {
|
|
1867
|
+
"type": "string",
|
|
1868
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1869
|
+
"enum": [
|
|
1870
|
+
"SEND",
|
|
1871
|
+
"DELIVERY",
|
|
1872
|
+
"REJECT",
|
|
1873
|
+
"COMPLAINT",
|
|
1874
|
+
"BOUNCE",
|
|
1875
|
+
"ERROR"
|
|
1876
|
+
]
|
|
1877
|
+
},
|
|
1878
|
+
"send_error": {
|
|
1879
|
+
"type": "object",
|
|
1880
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
904
1881
|
}
|
|
905
1882
|
}
|
|
906
1883
|
}
|
|
@@ -923,6 +1900,22 @@
|
|
|
923
1900
|
"type": "string",
|
|
924
1901
|
"description": "Email address",
|
|
925
1902
|
"example": "messaging@epilot.cloud"
|
|
1903
|
+
},
|
|
1904
|
+
"send_status": {
|
|
1905
|
+
"type": "string",
|
|
1906
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1907
|
+
"enum": [
|
|
1908
|
+
"SEND",
|
|
1909
|
+
"DELIVERY",
|
|
1910
|
+
"REJECT",
|
|
1911
|
+
"COMPLAINT",
|
|
1912
|
+
"BOUNCE",
|
|
1913
|
+
"ERROR"
|
|
1914
|
+
]
|
|
1915
|
+
},
|
|
1916
|
+
"send_error": {
|
|
1917
|
+
"type": "object",
|
|
1918
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
926
1919
|
}
|
|
927
1920
|
}
|
|
928
1921
|
}
|
|
@@ -988,7 +1981,7 @@
|
|
|
988
1981
|
},
|
|
989
1982
|
"copy_to_message": {
|
|
990
1983
|
"type": "boolean",
|
|
991
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `
|
|
1984
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
992
1985
|
"default": false
|
|
993
1986
|
}
|
|
994
1987
|
}
|
|
@@ -1015,17 +2008,20 @@
|
|
|
1015
2008
|
]
|
|
1016
2009
|
}
|
|
1017
2010
|
},
|
|
1018
|
-
"
|
|
1019
|
-
"type": "
|
|
1020
|
-
"description": "
|
|
1021
|
-
"
|
|
1022
|
-
"
|
|
1023
|
-
"
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
2011
|
+
"send_status": {
|
|
2012
|
+
"type": "array",
|
|
2013
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2014
|
+
"items": {
|
|
2015
|
+
"type": "string",
|
|
2016
|
+
"enum": [
|
|
2017
|
+
"SEND",
|
|
2018
|
+
"DELIVERY",
|
|
2019
|
+
"REJECT",
|
|
2020
|
+
"COMPLAINT",
|
|
2021
|
+
"BOUNCE",
|
|
2022
|
+
"ERROR"
|
|
2023
|
+
]
|
|
2024
|
+
}
|
|
1029
2025
|
},
|
|
1030
2026
|
"type": {
|
|
1031
2027
|
"type": "string",
|
|
@@ -1085,6 +2081,22 @@
|
|
|
1085
2081
|
"type": "string",
|
|
1086
2082
|
"description": "Email address",
|
|
1087
2083
|
"example": "messaging@epilot.cloud"
|
|
2084
|
+
},
|
|
2085
|
+
"send_status": {
|
|
2086
|
+
"type": "string",
|
|
2087
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2088
|
+
"enum": [
|
|
2089
|
+
"SEND",
|
|
2090
|
+
"DELIVERY",
|
|
2091
|
+
"REJECT",
|
|
2092
|
+
"COMPLAINT",
|
|
2093
|
+
"BOUNCE",
|
|
2094
|
+
"ERROR"
|
|
2095
|
+
]
|
|
2096
|
+
},
|
|
2097
|
+
"send_error": {
|
|
2098
|
+
"type": "object",
|
|
2099
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1088
2100
|
}
|
|
1089
2101
|
}
|
|
1090
2102
|
},
|
|
@@ -1103,6 +2115,22 @@
|
|
|
1103
2115
|
"type": "string",
|
|
1104
2116
|
"description": "Email address",
|
|
1105
2117
|
"example": "messaging@epilot.cloud"
|
|
2118
|
+
},
|
|
2119
|
+
"send_status": {
|
|
2120
|
+
"type": "string",
|
|
2121
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2122
|
+
"enum": [
|
|
2123
|
+
"SEND",
|
|
2124
|
+
"DELIVERY",
|
|
2125
|
+
"REJECT",
|
|
2126
|
+
"COMPLAINT",
|
|
2127
|
+
"BOUNCE",
|
|
2128
|
+
"ERROR"
|
|
2129
|
+
]
|
|
2130
|
+
},
|
|
2131
|
+
"send_error": {
|
|
2132
|
+
"type": "object",
|
|
2133
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1106
2134
|
}
|
|
1107
2135
|
}
|
|
1108
2136
|
},
|
|
@@ -1124,6 +2152,22 @@
|
|
|
1124
2152
|
"type": "string",
|
|
1125
2153
|
"description": "Email address",
|
|
1126
2154
|
"example": "messaging@epilot.cloud"
|
|
2155
|
+
},
|
|
2156
|
+
"send_status": {
|
|
2157
|
+
"type": "string",
|
|
2158
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2159
|
+
"enum": [
|
|
2160
|
+
"SEND",
|
|
2161
|
+
"DELIVERY",
|
|
2162
|
+
"REJECT",
|
|
2163
|
+
"COMPLAINT",
|
|
2164
|
+
"BOUNCE",
|
|
2165
|
+
"ERROR"
|
|
2166
|
+
]
|
|
2167
|
+
},
|
|
2168
|
+
"send_error": {
|
|
2169
|
+
"type": "object",
|
|
2170
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1127
2171
|
}
|
|
1128
2172
|
}
|
|
1129
2173
|
}
|
|
@@ -1146,6 +2190,22 @@
|
|
|
1146
2190
|
"type": "string",
|
|
1147
2191
|
"description": "Email address",
|
|
1148
2192
|
"example": "messaging@epilot.cloud"
|
|
2193
|
+
},
|
|
2194
|
+
"send_status": {
|
|
2195
|
+
"type": "string",
|
|
2196
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2197
|
+
"enum": [
|
|
2198
|
+
"SEND",
|
|
2199
|
+
"DELIVERY",
|
|
2200
|
+
"REJECT",
|
|
2201
|
+
"COMPLAINT",
|
|
2202
|
+
"BOUNCE",
|
|
2203
|
+
"ERROR"
|
|
2204
|
+
]
|
|
2205
|
+
},
|
|
2206
|
+
"send_error": {
|
|
2207
|
+
"type": "object",
|
|
2208
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1149
2209
|
}
|
|
1150
2210
|
}
|
|
1151
2211
|
}
|
|
@@ -1168,6 +2228,22 @@
|
|
|
1168
2228
|
"type": "string",
|
|
1169
2229
|
"description": "Email address",
|
|
1170
2230
|
"example": "messaging@epilot.cloud"
|
|
2231
|
+
},
|
|
2232
|
+
"send_status": {
|
|
2233
|
+
"type": "string",
|
|
2234
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2235
|
+
"enum": [
|
|
2236
|
+
"SEND",
|
|
2237
|
+
"DELIVERY",
|
|
2238
|
+
"REJECT",
|
|
2239
|
+
"COMPLAINT",
|
|
2240
|
+
"BOUNCE",
|
|
2241
|
+
"ERROR"
|
|
2242
|
+
]
|
|
2243
|
+
},
|
|
2244
|
+
"send_error": {
|
|
2245
|
+
"type": "object",
|
|
2246
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1171
2247
|
}
|
|
1172
2248
|
}
|
|
1173
2249
|
}
|
|
@@ -1233,600 +2309,855 @@
|
|
|
1233
2309
|
},
|
|
1234
2310
|
"copy_to_message": {
|
|
1235
2311
|
"type": "boolean",
|
|
1236
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `
|
|
2312
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
1237
2313
|
"default": false
|
|
1238
2314
|
}
|
|
1239
2315
|
}
|
|
1240
2316
|
}
|
|
1241
2317
|
},
|
|
1242
|
-
"references": {
|
|
2318
|
+
"references": {
|
|
2319
|
+
"type": "string",
|
|
2320
|
+
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
|
|
2321
|
+
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
2322
|
+
},
|
|
2323
|
+
"in_reply_to": {
|
|
2324
|
+
"type": "string",
|
|
2325
|
+
"description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
|
|
2326
|
+
"example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
2327
|
+
},
|
|
2328
|
+
"user_read_message": {
|
|
2329
|
+
"type": "array",
|
|
2330
|
+
"description": "Ivy User ID of user read the message.",
|
|
2331
|
+
"items": {
|
|
2332
|
+
"type": "string",
|
|
2333
|
+
"example": [
|
|
2334
|
+
"206801",
|
|
2335
|
+
"200109"
|
|
2336
|
+
]
|
|
2337
|
+
}
|
|
2338
|
+
},
|
|
2339
|
+
"send_status": {
|
|
2340
|
+
"type": "array",
|
|
2341
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2342
|
+
"items": {
|
|
2343
|
+
"type": "string",
|
|
2344
|
+
"enum": [
|
|
2345
|
+
"SEND",
|
|
2346
|
+
"DELIVERY",
|
|
2347
|
+
"REJECT",
|
|
2348
|
+
"COMPLAINT",
|
|
2349
|
+
"BOUNCE",
|
|
2350
|
+
"ERROR"
|
|
2351
|
+
]
|
|
2352
|
+
}
|
|
2353
|
+
},
|
|
2354
|
+
"type": {
|
|
2355
|
+
"type": "string",
|
|
2356
|
+
"description": "Message type",
|
|
2357
|
+
"enum": [
|
|
2358
|
+
"SENT",
|
|
2359
|
+
"RECEIVED"
|
|
2360
|
+
]
|
|
2361
|
+
}
|
|
2362
|
+
},
|
|
2363
|
+
"description": "Latest trash message of thread"
|
|
2364
|
+
}
|
|
2365
|
+
}
|
|
2366
|
+
}
|
|
2367
|
+
]
|
|
2368
|
+
}
|
|
2369
|
+
}
|
|
2370
|
+
}
|
|
2371
|
+
}
|
|
2372
|
+
}
|
|
2373
|
+
}
|
|
2374
|
+
},
|
|
2375
|
+
"403": {
|
|
2376
|
+
"description": "Forbidden"
|
|
2377
|
+
}
|
|
2378
|
+
}
|
|
2379
|
+
}
|
|
2380
|
+
},
|
|
2381
|
+
"/v1/message/threads": {
|
|
2382
|
+
"put": {
|
|
2383
|
+
"operationId": "updateThread",
|
|
2384
|
+
"summary": "updateThread",
|
|
2385
|
+
"description": "Modify thread metadata",
|
|
2386
|
+
"tags": [
|
|
2387
|
+
"Threads"
|
|
2388
|
+
],
|
|
2389
|
+
"responses": {
|
|
2390
|
+
"201": {
|
|
2391
|
+
"description": "Success",
|
|
2392
|
+
"content": {
|
|
2393
|
+
"application/json": {
|
|
2394
|
+
"schema": {
|
|
2395
|
+
"allOf": [
|
|
2396
|
+
{
|
|
2397
|
+
"type": "object",
|
|
2398
|
+
"required": [
|
|
2399
|
+
"_id",
|
|
2400
|
+
"_title",
|
|
2401
|
+
"_org",
|
|
2402
|
+
"_schema",
|
|
2403
|
+
"_created_at",
|
|
2404
|
+
"_updated_at"
|
|
2405
|
+
],
|
|
2406
|
+
"properties": {
|
|
2407
|
+
"_id": {
|
|
2408
|
+
"type": "string",
|
|
2409
|
+
"description": "Entity ID",
|
|
2410
|
+
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
2411
|
+
},
|
|
2412
|
+
"_title": {
|
|
2413
|
+
"type": "string",
|
|
2414
|
+
"description": "Entity title"
|
|
2415
|
+
},
|
|
2416
|
+
"_org": {
|
|
2417
|
+
"type": "string",
|
|
2418
|
+
"description": "Ivy Organization ID the entity belongs to",
|
|
2419
|
+
"example": "206801"
|
|
2420
|
+
},
|
|
2421
|
+
"_schema": {
|
|
2422
|
+
"type": "string",
|
|
2423
|
+
"description": "URL-friendly identifier for the entity schema",
|
|
2424
|
+
"example": "message"
|
|
2425
|
+
},
|
|
2426
|
+
"_tags": {
|
|
2427
|
+
"type": "array",
|
|
2428
|
+
"description": "Entity tags",
|
|
2429
|
+
"items": {
|
|
2430
|
+
"type": "string"
|
|
2431
|
+
},
|
|
2432
|
+
"example": [
|
|
2433
|
+
"pricing",
|
|
2434
|
+
"INBOX"
|
|
2435
|
+
]
|
|
2436
|
+
},
|
|
2437
|
+
"_created_at": {
|
|
2438
|
+
"type": "string",
|
|
2439
|
+
"description": "Created date",
|
|
2440
|
+
"format": "date-time",
|
|
2441
|
+
"example": "2021-02-09T12:41:43.662Z"
|
|
2442
|
+
},
|
|
2443
|
+
"_updated_at": {
|
|
2444
|
+
"type": "string",
|
|
2445
|
+
"description": "Updated date",
|
|
2446
|
+
"format": "date-time",
|
|
2447
|
+
"example": "2021-02-10T09:14:31.990Z"
|
|
2448
|
+
}
|
|
2449
|
+
}
|
|
2450
|
+
},
|
|
2451
|
+
{
|
|
2452
|
+
"description": "Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.",
|
|
2453
|
+
"required": [
|
|
2454
|
+
"topic"
|
|
2455
|
+
],
|
|
2456
|
+
"properties": {
|
|
2457
|
+
"topic": {
|
|
2458
|
+
"type": "string",
|
|
2459
|
+
"description": "Message topic (e.g. which service sends the message or message category)",
|
|
2460
|
+
"example": "CUSTOMER_MESSAGE"
|
|
2461
|
+
},
|
|
2462
|
+
"assigned_to": {
|
|
2463
|
+
"type": "array",
|
|
2464
|
+
"description": "Ivy User ID of who the message is assigned to. Default is the user who sends message.",
|
|
2465
|
+
"items": {
|
|
2466
|
+
"type": "string",
|
|
2467
|
+
"example": [
|
|
2468
|
+
"206801",
|
|
2469
|
+
"200109"
|
|
2470
|
+
]
|
|
2471
|
+
}
|
|
2472
|
+
},
|
|
2473
|
+
"latest_message": {
|
|
2474
|
+
"type": "object",
|
|
2475
|
+
"required": [
|
|
2476
|
+
"subject",
|
|
2477
|
+
"from"
|
|
2478
|
+
],
|
|
2479
|
+
"properties": {
|
|
2480
|
+
"message_id": {
|
|
2481
|
+
"type": "string",
|
|
2482
|
+
"description": "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
|
|
2483
|
+
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
|
|
2484
|
+
},
|
|
2485
|
+
"sender": {
|
|
2486
|
+
"type": "string",
|
|
2487
|
+
"description": "Ivy User ID of user sends the message.",
|
|
2488
|
+
"example": "206801"
|
|
2489
|
+
},
|
|
2490
|
+
"subject": {
|
|
2491
|
+
"type": "string",
|
|
2492
|
+
"description": "Subject",
|
|
2493
|
+
"example": "Request for solar panel price"
|
|
2494
|
+
},
|
|
2495
|
+
"html": {
|
|
2496
|
+
"type": "string",
|
|
2497
|
+
"description": "HTML body",
|
|
2498
|
+
"example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
|
|
2499
|
+
},
|
|
2500
|
+
"text": {
|
|
2501
|
+
"type": "string",
|
|
2502
|
+
"description": "Text body",
|
|
2503
|
+
"example": "We at ABC GmbH would like to request a price quote for the solar panel."
|
|
2504
|
+
},
|
|
2505
|
+
"from": {
|
|
2506
|
+
"type": "object",
|
|
2507
|
+
"required": [
|
|
2508
|
+
"address"
|
|
2509
|
+
],
|
|
2510
|
+
"properties": {
|
|
2511
|
+
"name": {
|
|
2512
|
+
"type": "string",
|
|
2513
|
+
"description": "Email address alias",
|
|
2514
|
+
"example": "epilot"
|
|
2515
|
+
},
|
|
2516
|
+
"address": {
|
|
2517
|
+
"type": "string",
|
|
2518
|
+
"description": "Email address",
|
|
2519
|
+
"example": "messaging@epilot.cloud"
|
|
2520
|
+
},
|
|
2521
|
+
"send_status": {
|
|
2522
|
+
"type": "string",
|
|
2523
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2524
|
+
"enum": [
|
|
2525
|
+
"SEND",
|
|
2526
|
+
"DELIVERY",
|
|
2527
|
+
"REJECT",
|
|
2528
|
+
"COMPLAINT",
|
|
2529
|
+
"BOUNCE",
|
|
2530
|
+
"ERROR"
|
|
2531
|
+
]
|
|
2532
|
+
},
|
|
2533
|
+
"send_error": {
|
|
2534
|
+
"type": "object",
|
|
2535
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2536
|
+
}
|
|
2537
|
+
}
|
|
2538
|
+
},
|
|
2539
|
+
"reply_to": {
|
|
2540
|
+
"type": "object",
|
|
2541
|
+
"required": [
|
|
2542
|
+
"address"
|
|
2543
|
+
],
|
|
2544
|
+
"properties": {
|
|
2545
|
+
"name": {
|
|
2546
|
+
"type": "string",
|
|
2547
|
+
"description": "Email address alias",
|
|
2548
|
+
"example": "epilot"
|
|
2549
|
+
},
|
|
2550
|
+
"address": {
|
|
2551
|
+
"type": "string",
|
|
2552
|
+
"description": "Email address",
|
|
2553
|
+
"example": "messaging@epilot.cloud"
|
|
2554
|
+
},
|
|
2555
|
+
"send_status": {
|
|
2556
|
+
"type": "string",
|
|
2557
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2558
|
+
"enum": [
|
|
2559
|
+
"SEND",
|
|
2560
|
+
"DELIVERY",
|
|
2561
|
+
"REJECT",
|
|
2562
|
+
"COMPLAINT",
|
|
2563
|
+
"BOUNCE",
|
|
2564
|
+
"ERROR"
|
|
2565
|
+
]
|
|
2566
|
+
},
|
|
2567
|
+
"send_error": {
|
|
2568
|
+
"type": "object",
|
|
2569
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2570
|
+
}
|
|
2571
|
+
}
|
|
2572
|
+
},
|
|
2573
|
+
"to": {
|
|
2574
|
+
"type": "array",
|
|
2575
|
+
"description": "To email addresses",
|
|
2576
|
+
"items": {
|
|
2577
|
+
"type": "object",
|
|
2578
|
+
"required": [
|
|
2579
|
+
"address"
|
|
2580
|
+
],
|
|
2581
|
+
"properties": {
|
|
2582
|
+
"name": {
|
|
2583
|
+
"type": "string",
|
|
2584
|
+
"description": "Email address alias",
|
|
2585
|
+
"example": "epilot"
|
|
2586
|
+
},
|
|
2587
|
+
"address": {
|
|
1243
2588
|
"type": "string",
|
|
1244
|
-
"description": "
|
|
1245
|
-
"example": "
|
|
2589
|
+
"description": "Email address",
|
|
2590
|
+
"example": "messaging@epilot.cloud"
|
|
1246
2591
|
},
|
|
1247
|
-
"
|
|
2592
|
+
"send_status": {
|
|
1248
2593
|
"type": "string",
|
|
1249
|
-
"description": "
|
|
1250
|
-
"
|
|
2594
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2595
|
+
"enum": [
|
|
2596
|
+
"SEND",
|
|
2597
|
+
"DELIVERY",
|
|
2598
|
+
"REJECT",
|
|
2599
|
+
"COMPLAINT",
|
|
2600
|
+
"BOUNCE",
|
|
2601
|
+
"ERROR"
|
|
2602
|
+
]
|
|
1251
2603
|
},
|
|
1252
|
-
"
|
|
1253
|
-
"type": "
|
|
1254
|
-
"description": "
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
2604
|
+
"send_error": {
|
|
2605
|
+
"type": "object",
|
|
2606
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2607
|
+
}
|
|
2608
|
+
}
|
|
2609
|
+
}
|
|
2610
|
+
},
|
|
2611
|
+
"cc": {
|
|
2612
|
+
"type": "array",
|
|
2613
|
+
"description": "Cc email addresses",
|
|
2614
|
+
"items": {
|
|
2615
|
+
"type": "object",
|
|
2616
|
+
"required": [
|
|
2617
|
+
"address"
|
|
2618
|
+
],
|
|
2619
|
+
"properties": {
|
|
2620
|
+
"name": {
|
|
2621
|
+
"type": "string",
|
|
2622
|
+
"description": "Email address alias",
|
|
2623
|
+
"example": "epilot"
|
|
2624
|
+
},
|
|
2625
|
+
"address": {
|
|
2626
|
+
"type": "string",
|
|
2627
|
+
"description": "Email address",
|
|
2628
|
+
"example": "messaging@epilot.cloud"
|
|
1262
2629
|
},
|
|
1263
|
-
"
|
|
2630
|
+
"send_status": {
|
|
1264
2631
|
"type": "string",
|
|
1265
|
-
"description": "
|
|
2632
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1266
2633
|
"enum": [
|
|
1267
2634
|
"SEND",
|
|
2635
|
+
"DELIVERY",
|
|
1268
2636
|
"REJECT",
|
|
1269
|
-
"BOUNCE",
|
|
1270
2637
|
"COMPLAINT",
|
|
1271
|
-
"
|
|
1272
|
-
|
|
2638
|
+
"BOUNCE",
|
|
2639
|
+
"ERROR"
|
|
1273
2640
|
]
|
|
1274
2641
|
},
|
|
1275
|
-
"
|
|
2642
|
+
"send_error": {
|
|
2643
|
+
"type": "object",
|
|
2644
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2645
|
+
}
|
|
2646
|
+
}
|
|
2647
|
+
}
|
|
2648
|
+
},
|
|
2649
|
+
"bcc": {
|
|
2650
|
+
"type": "array",
|
|
2651
|
+
"description": "Bcc email addresses",
|
|
2652
|
+
"items": {
|
|
2653
|
+
"type": "object",
|
|
2654
|
+
"required": [
|
|
2655
|
+
"address"
|
|
2656
|
+
],
|
|
2657
|
+
"properties": {
|
|
2658
|
+
"name": {
|
|
1276
2659
|
"type": "string",
|
|
1277
|
-
"description": "
|
|
2660
|
+
"description": "Email address alias",
|
|
2661
|
+
"example": "epilot"
|
|
2662
|
+
},
|
|
2663
|
+
"address": {
|
|
2664
|
+
"type": "string",
|
|
2665
|
+
"description": "Email address",
|
|
2666
|
+
"example": "messaging@epilot.cloud"
|
|
2667
|
+
},
|
|
2668
|
+
"send_status": {
|
|
2669
|
+
"type": "string",
|
|
2670
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1278
2671
|
"enum": [
|
|
1279
|
-
"
|
|
1280
|
-
"
|
|
2672
|
+
"SEND",
|
|
2673
|
+
"DELIVERY",
|
|
2674
|
+
"REJECT",
|
|
2675
|
+
"COMPLAINT",
|
|
2676
|
+
"BOUNCE",
|
|
2677
|
+
"ERROR"
|
|
1281
2678
|
]
|
|
2679
|
+
},
|
|
2680
|
+
"send_error": {
|
|
2681
|
+
"type": "object",
|
|
2682
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
1282
2683
|
}
|
|
1283
|
-
}
|
|
1284
|
-
"description": "Latest trash message of thread"
|
|
2684
|
+
}
|
|
1285
2685
|
}
|
|
1286
|
-
}
|
|
1287
|
-
}
|
|
1288
|
-
]
|
|
1289
|
-
}
|
|
1290
|
-
}
|
|
1291
|
-
}
|
|
1292
|
-
}
|
|
1293
|
-
}
|
|
1294
|
-
}
|
|
1295
|
-
},
|
|
1296
|
-
"403": {
|
|
1297
|
-
"description": "Forbidden"
|
|
1298
|
-
}
|
|
1299
|
-
}
|
|
1300
|
-
}
|
|
1301
|
-
},
|
|
1302
|
-
"/threads": {
|
|
1303
|
-
"put": {
|
|
1304
|
-
"operationId": "updateThread",
|
|
1305
|
-
"summary": "updateThread",
|
|
1306
|
-
"description": "Modify the thread.",
|
|
1307
|
-
"tags": [
|
|
1308
|
-
"threads"
|
|
1309
|
-
],
|
|
1310
|
-
"requestBody": {
|
|
1311
|
-
"content": {
|
|
1312
|
-
"application/json": {
|
|
1313
|
-
"schema": {
|
|
1314
|
-
"description": "Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.",
|
|
1315
|
-
"required": [
|
|
1316
|
-
"topic"
|
|
1317
|
-
],
|
|
1318
|
-
"properties": {
|
|
1319
|
-
"topic": {
|
|
1320
|
-
"type": "string",
|
|
1321
|
-
"description": "Message topic (e.g. which service sends the message or message category)",
|
|
1322
|
-
"example": "CUSTOMER_MESSAGE"
|
|
1323
|
-
},
|
|
1324
|
-
"assigned_to": {
|
|
1325
|
-
"type": "array",
|
|
1326
|
-
"description": "Ivy User ID of who the message is assigned to. Default is the user who sends message.",
|
|
1327
|
-
"items": {
|
|
1328
|
-
"type": "string",
|
|
1329
|
-
"example": [
|
|
1330
|
-
"206801",
|
|
1331
|
-
"200109"
|
|
1332
|
-
]
|
|
1333
|
-
}
|
|
1334
|
-
},
|
|
1335
|
-
"latest_message": {
|
|
1336
|
-
"type": "object",
|
|
1337
|
-
"required": [
|
|
1338
|
-
"subject",
|
|
1339
|
-
"from"
|
|
1340
|
-
],
|
|
1341
|
-
"properties": {
|
|
1342
|
-
"message_id": {
|
|
1343
|
-
"type": "string",
|
|
1344
|
-
"description": "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
|
|
1345
|
-
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
|
|
1346
|
-
},
|
|
1347
|
-
"sender": {
|
|
1348
|
-
"type": "string",
|
|
1349
|
-
"description": "Ivy User ID of user sends the message.",
|
|
1350
|
-
"example": "206801"
|
|
1351
|
-
},
|
|
1352
|
-
"subject": {
|
|
1353
|
-
"type": "string",
|
|
1354
|
-
"description": "Subject",
|
|
1355
|
-
"example": "Request for solar panel price"
|
|
1356
|
-
},
|
|
1357
|
-
"html": {
|
|
1358
|
-
"type": "string",
|
|
1359
|
-
"description": "HTML body",
|
|
1360
|
-
"example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
|
|
1361
|
-
},
|
|
1362
|
-
"text": {
|
|
1363
|
-
"type": "string",
|
|
1364
|
-
"description": "Text body",
|
|
1365
|
-
"example": "We at ABC GmbH would like to request a price quote for the solar panel."
|
|
1366
|
-
},
|
|
1367
|
-
"from": {
|
|
1368
|
-
"type": "object",
|
|
1369
|
-
"required": [
|
|
1370
|
-
"address"
|
|
1371
|
-
],
|
|
1372
|
-
"properties": {
|
|
1373
|
-
"name": {
|
|
1374
|
-
"type": "string",
|
|
1375
|
-
"description": "Email address alias",
|
|
1376
|
-
"example": "epilot"
|
|
1377
|
-
},
|
|
1378
|
-
"address": {
|
|
1379
|
-
"type": "string",
|
|
1380
|
-
"description": "Email address",
|
|
1381
|
-
"example": "messaging@epilot.cloud"
|
|
1382
|
-
}
|
|
1383
|
-
}
|
|
1384
|
-
},
|
|
1385
|
-
"reply_to": {
|
|
1386
|
-
"type": "object",
|
|
1387
|
-
"required": [
|
|
1388
|
-
"address"
|
|
1389
|
-
],
|
|
1390
|
-
"properties": {
|
|
1391
|
-
"name": {
|
|
1392
|
-
"type": "string",
|
|
1393
|
-
"description": "Email address alias",
|
|
1394
|
-
"example": "epilot"
|
|
1395
|
-
},
|
|
1396
|
-
"address": {
|
|
1397
|
-
"type": "string",
|
|
1398
|
-
"description": "Email address",
|
|
1399
|
-
"example": "messaging@epilot.cloud"
|
|
1400
|
-
}
|
|
1401
|
-
}
|
|
1402
|
-
},
|
|
1403
|
-
"to": {
|
|
1404
|
-
"type": "array",
|
|
1405
|
-
"description": "To email addresses",
|
|
1406
|
-
"items": {
|
|
1407
|
-
"type": "object",
|
|
1408
|
-
"required": [
|
|
1409
|
-
"address"
|
|
1410
|
-
],
|
|
1411
|
-
"properties": {
|
|
1412
|
-
"name": {
|
|
1413
|
-
"type": "string",
|
|
1414
|
-
"description": "Email address alias",
|
|
1415
|
-
"example": "epilot"
|
|
1416
2686
|
},
|
|
1417
|
-
"
|
|
1418
|
-
"type": "
|
|
1419
|
-
"description": "
|
|
1420
|
-
"
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
"cid": {
|
|
1484
|
-
"type": "string",
|
|
1485
|
-
"description": "Attachment ID",
|
|
1486
|
-
"example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
|
|
2687
|
+
"attachments": {
|
|
2688
|
+
"type": "array",
|
|
2689
|
+
"description": "Message attachments",
|
|
2690
|
+
"items": {
|
|
2691
|
+
"type": "object",
|
|
2692
|
+
"required": [
|
|
2693
|
+
"filename",
|
|
2694
|
+
"size",
|
|
2695
|
+
"content_type",
|
|
2696
|
+
"url",
|
|
2697
|
+
"bucket",
|
|
2698
|
+
"object_key"
|
|
2699
|
+
],
|
|
2700
|
+
"properties": {
|
|
2701
|
+
"cid": {
|
|
2702
|
+
"type": "string",
|
|
2703
|
+
"description": "Attachment ID",
|
|
2704
|
+
"example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
|
|
2705
|
+
},
|
|
2706
|
+
"filename": {
|
|
2707
|
+
"type": "string",
|
|
2708
|
+
"description": "File name",
|
|
2709
|
+
"example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
2710
|
+
},
|
|
2711
|
+
"size": {
|
|
2712
|
+
"type": "number",
|
|
2713
|
+
"description": "File size in bytes",
|
|
2714
|
+
"example": 451349
|
|
2715
|
+
},
|
|
2716
|
+
"content_type": {
|
|
2717
|
+
"type": "string",
|
|
2718
|
+
"description": "Content type",
|
|
2719
|
+
"example": "application/pdf"
|
|
2720
|
+
},
|
|
2721
|
+
"url": {
|
|
2722
|
+
"type": "string",
|
|
2723
|
+
"description": "URL to download the attachment.",
|
|
2724
|
+
"example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
2725
|
+
},
|
|
2726
|
+
"bucket": {
|
|
2727
|
+
"type": "string",
|
|
2728
|
+
"description": "S3 bucket where file is stored",
|
|
2729
|
+
"example": "893487340562-message-attachment"
|
|
2730
|
+
},
|
|
2731
|
+
"object_key": {
|
|
2732
|
+
"type": "string",
|
|
2733
|
+
"description": "S3 object apiKey",
|
|
2734
|
+
"example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
2735
|
+
},
|
|
2736
|
+
"inline": {
|
|
2737
|
+
"type": "boolean",
|
|
2738
|
+
"description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
|
|
2739
|
+
"default": false
|
|
2740
|
+
},
|
|
2741
|
+
"send_as_link": {
|
|
2742
|
+
"type": "boolean",
|
|
2743
|
+
"description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
|
|
2744
|
+
"default": false
|
|
2745
|
+
},
|
|
2746
|
+
"copy_to_message": {
|
|
2747
|
+
"type": "boolean",
|
|
2748
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
2749
|
+
"default": false
|
|
2750
|
+
}
|
|
2751
|
+
}
|
|
2752
|
+
}
|
|
1487
2753
|
},
|
|
1488
|
-
"
|
|
2754
|
+
"references": {
|
|
1489
2755
|
"type": "string",
|
|
1490
|
-
"description": "
|
|
1491
|
-
"example": "
|
|
1492
|
-
},
|
|
1493
|
-
"size": {
|
|
1494
|
-
"type": "number",
|
|
1495
|
-
"description": "File size in bytes",
|
|
1496
|
-
"example": 451349
|
|
2756
|
+
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
|
|
2757
|
+
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1497
2758
|
},
|
|
1498
|
-
"
|
|
2759
|
+
"in_reply_to": {
|
|
1499
2760
|
"type": "string",
|
|
1500
|
-
"description": "
|
|
1501
|
-
"example": "
|
|
2761
|
+
"description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
|
|
2762
|
+
"example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1502
2763
|
},
|
|
1503
|
-
"
|
|
1504
|
-
"type": "
|
|
1505
|
-
"description": "
|
|
1506
|
-
"
|
|
2764
|
+
"user_read_message": {
|
|
2765
|
+
"type": "array",
|
|
2766
|
+
"description": "Ivy User ID of user read the message.",
|
|
2767
|
+
"items": {
|
|
2768
|
+
"type": "string",
|
|
2769
|
+
"example": [
|
|
2770
|
+
"206801",
|
|
2771
|
+
"200109"
|
|
2772
|
+
]
|
|
2773
|
+
}
|
|
1507
2774
|
},
|
|
1508
|
-
"
|
|
1509
|
-
"type": "
|
|
1510
|
-
"description": "
|
|
1511
|
-
"
|
|
2775
|
+
"send_status": {
|
|
2776
|
+
"type": "array",
|
|
2777
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2778
|
+
"items": {
|
|
2779
|
+
"type": "string",
|
|
2780
|
+
"enum": [
|
|
2781
|
+
"SEND",
|
|
2782
|
+
"DELIVERY",
|
|
2783
|
+
"REJECT",
|
|
2784
|
+
"COMPLAINT",
|
|
2785
|
+
"BOUNCE",
|
|
2786
|
+
"ERROR"
|
|
2787
|
+
]
|
|
2788
|
+
}
|
|
1512
2789
|
},
|
|
1513
|
-
"
|
|
2790
|
+
"type": {
|
|
1514
2791
|
"type": "string",
|
|
1515
|
-
"description": "
|
|
1516
|
-
"
|
|
1517
|
-
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
"description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
|
|
1521
|
-
"default": false
|
|
1522
|
-
},
|
|
1523
|
-
"send_as_link": {
|
|
1524
|
-
"type": "boolean",
|
|
1525
|
-
"description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
|
|
1526
|
-
"default": false
|
|
1527
|
-
},
|
|
1528
|
-
"copy_to_message": {
|
|
1529
|
-
"type": "boolean",
|
|
1530
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `cid`, `url`, `object_key`. This property supports for forwarding message.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
1531
|
-
"default": false
|
|
2792
|
+
"description": "Message type",
|
|
2793
|
+
"enum": [
|
|
2794
|
+
"SENT",
|
|
2795
|
+
"RECEIVED"
|
|
2796
|
+
]
|
|
1532
2797
|
}
|
|
1533
|
-
}
|
|
1534
|
-
}
|
|
1535
|
-
},
|
|
1536
|
-
"references": {
|
|
1537
|
-
"type": "string",
|
|
1538
|
-
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
|
|
1539
|
-
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1540
|
-
},
|
|
1541
|
-
"in_reply_to": {
|
|
1542
|
-
"type": "string",
|
|
1543
|
-
"description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
|
|
1544
|
-
"example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1545
|
-
},
|
|
1546
|
-
"user_read_message": {
|
|
1547
|
-
"type": "array",
|
|
1548
|
-
"description": "Ivy User ID of user read the message.",
|
|
1549
|
-
"items": {
|
|
1550
|
-
"type": "string",
|
|
1551
|
-
"example": [
|
|
1552
|
-
"206801",
|
|
1553
|
-
"200109"
|
|
1554
|
-
]
|
|
1555
|
-
}
|
|
1556
|
-
},
|
|
1557
|
-
"status": {
|
|
1558
|
-
"type": "string",
|
|
1559
|
-
"description": "Message status. Only apply for sent message.\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1560
|
-
"enum": [
|
|
1561
|
-
"SEND",
|
|
1562
|
-
"REJECT",
|
|
1563
|
-
"BOUNCE",
|
|
1564
|
-
"COMPLAINT",
|
|
1565
|
-
"DELIVERY",
|
|
1566
|
-
null
|
|
1567
|
-
]
|
|
1568
|
-
},
|
|
1569
|
-
"type": {
|
|
1570
|
-
"type": "string",
|
|
1571
|
-
"description": "Message type",
|
|
1572
|
-
"enum": [
|
|
1573
|
-
"SENT",
|
|
1574
|
-
"RECEIVED"
|
|
1575
|
-
]
|
|
1576
|
-
}
|
|
1577
|
-
},
|
|
1578
|
-
"description": "Latest message of thread"
|
|
1579
|
-
},
|
|
1580
|
-
"latest_trash_message": {
|
|
1581
|
-
"type": "object",
|
|
1582
|
-
"required": [
|
|
1583
|
-
"subject",
|
|
1584
|
-
"from"
|
|
1585
|
-
],
|
|
1586
|
-
"properties": {
|
|
1587
|
-
"message_id": {
|
|
1588
|
-
"type": "string",
|
|
1589
|
-
"description": "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
|
|
1590
|
-
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
|
|
1591
|
-
},
|
|
1592
|
-
"sender": {
|
|
1593
|
-
"type": "string",
|
|
1594
|
-
"description": "Ivy User ID of user sends the message.",
|
|
1595
|
-
"example": "206801"
|
|
1596
|
-
},
|
|
1597
|
-
"subject": {
|
|
1598
|
-
"type": "string",
|
|
1599
|
-
"description": "Subject",
|
|
1600
|
-
"example": "Request for solar panel price"
|
|
1601
|
-
},
|
|
1602
|
-
"html": {
|
|
1603
|
-
"type": "string",
|
|
1604
|
-
"description": "HTML body",
|
|
1605
|
-
"example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
|
|
1606
|
-
},
|
|
1607
|
-
"text": {
|
|
1608
|
-
"type": "string",
|
|
1609
|
-
"description": "Text body",
|
|
1610
|
-
"example": "We at ABC GmbH would like to request a price quote for the solar panel."
|
|
1611
|
-
},
|
|
1612
|
-
"from": {
|
|
1613
|
-
"type": "object",
|
|
1614
|
-
"required": [
|
|
1615
|
-
"address"
|
|
1616
|
-
],
|
|
1617
|
-
"properties": {
|
|
1618
|
-
"name": {
|
|
1619
|
-
"type": "string",
|
|
1620
|
-
"description": "Email address alias",
|
|
1621
|
-
"example": "epilot"
|
|
1622
|
-
},
|
|
1623
|
-
"address": {
|
|
1624
|
-
"type": "string",
|
|
1625
|
-
"description": "Email address",
|
|
1626
|
-
"example": "messaging@epilot.cloud"
|
|
1627
|
-
}
|
|
1628
|
-
}
|
|
1629
|
-
},
|
|
1630
|
-
"reply_to": {
|
|
1631
|
-
"type": "object",
|
|
1632
|
-
"required": [
|
|
1633
|
-
"address"
|
|
1634
|
-
],
|
|
1635
|
-
"properties": {
|
|
1636
|
-
"name": {
|
|
1637
|
-
"type": "string",
|
|
1638
|
-
"description": "Email address alias",
|
|
1639
|
-
"example": "epilot"
|
|
1640
2798
|
},
|
|
1641
|
-
"
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
"example": "messaging@epilot.cloud"
|
|
1645
|
-
}
|
|
1646
|
-
}
|
|
1647
|
-
},
|
|
1648
|
-
"to": {
|
|
1649
|
-
"type": "array",
|
|
1650
|
-
"description": "To email addresses",
|
|
1651
|
-
"items": {
|
|
2799
|
+
"description": "Latest message of thread"
|
|
2800
|
+
},
|
|
2801
|
+
"latest_trash_message": {
|
|
1652
2802
|
"type": "object",
|
|
1653
2803
|
"required": [
|
|
1654
|
-
"
|
|
2804
|
+
"subject",
|
|
2805
|
+
"from"
|
|
1655
2806
|
],
|
|
1656
2807
|
"properties": {
|
|
1657
|
-
"
|
|
2808
|
+
"message_id": {
|
|
1658
2809
|
"type": "string",
|
|
1659
|
-
"description": "
|
|
1660
|
-
"example": "
|
|
2810
|
+
"description": "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
|
|
2811
|
+
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
|
|
1661
2812
|
},
|
|
1662
|
-
"
|
|
1663
|
-
"type": "string",
|
|
1664
|
-
"description": "Email address",
|
|
1665
|
-
"example": "messaging@epilot.cloud"
|
|
1666
|
-
}
|
|
1667
|
-
}
|
|
1668
|
-
}
|
|
1669
|
-
},
|
|
1670
|
-
"cc": {
|
|
1671
|
-
"type": "array",
|
|
1672
|
-
"description": "Cc email addresses",
|
|
1673
|
-
"items": {
|
|
1674
|
-
"type": "object",
|
|
1675
|
-
"required": [
|
|
1676
|
-
"address"
|
|
1677
|
-
],
|
|
1678
|
-
"properties": {
|
|
1679
|
-
"name": {
|
|
2813
|
+
"sender": {
|
|
1680
2814
|
"type": "string",
|
|
1681
|
-
"description": "
|
|
1682
|
-
"example": "
|
|
2815
|
+
"description": "Ivy User ID of user sends the message.",
|
|
2816
|
+
"example": "206801"
|
|
1683
2817
|
},
|
|
1684
|
-
"
|
|
1685
|
-
"type": "string",
|
|
1686
|
-
"description": "Email address",
|
|
1687
|
-
"example": "messaging@epilot.cloud"
|
|
1688
|
-
}
|
|
1689
|
-
}
|
|
1690
|
-
}
|
|
1691
|
-
},
|
|
1692
|
-
"bcc": {
|
|
1693
|
-
"type": "array",
|
|
1694
|
-
"description": "Bcc email addresses",
|
|
1695
|
-
"items": {
|
|
1696
|
-
"type": "object",
|
|
1697
|
-
"required": [
|
|
1698
|
-
"address"
|
|
1699
|
-
],
|
|
1700
|
-
"properties": {
|
|
1701
|
-
"name": {
|
|
2818
|
+
"subject": {
|
|
1702
2819
|
"type": "string",
|
|
1703
|
-
"description": "
|
|
1704
|
-
"example": "
|
|
2820
|
+
"description": "Subject",
|
|
2821
|
+
"example": "Request for solar panel price"
|
|
1705
2822
|
},
|
|
1706
|
-
"
|
|
1707
|
-
"type": "string",
|
|
1708
|
-
"description": "Email address",
|
|
1709
|
-
"example": "messaging@epilot.cloud"
|
|
1710
|
-
}
|
|
1711
|
-
}
|
|
1712
|
-
}
|
|
1713
|
-
},
|
|
1714
|
-
"attachments": {
|
|
1715
|
-
"type": "array",
|
|
1716
|
-
"description": "Message attachments",
|
|
1717
|
-
"items": {
|
|
1718
|
-
"type": "object",
|
|
1719
|
-
"required": [
|
|
1720
|
-
"filename",
|
|
1721
|
-
"size",
|
|
1722
|
-
"content_type",
|
|
1723
|
-
"url",
|
|
1724
|
-
"bucket",
|
|
1725
|
-
"object_key"
|
|
1726
|
-
],
|
|
1727
|
-
"properties": {
|
|
1728
|
-
"cid": {
|
|
2823
|
+
"html": {
|
|
1729
2824
|
"type": "string",
|
|
1730
|
-
"description": "
|
|
1731
|
-
"example": "
|
|
2825
|
+
"description": "HTML body",
|
|
2826
|
+
"example": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
|
|
1732
2827
|
},
|
|
1733
|
-
"
|
|
2828
|
+
"text": {
|
|
1734
2829
|
"type": "string",
|
|
1735
|
-
"description": "
|
|
1736
|
-
"example": "
|
|
2830
|
+
"description": "Text body",
|
|
2831
|
+
"example": "We at ABC GmbH would like to request a price quote for the solar panel."
|
|
2832
|
+
},
|
|
2833
|
+
"from": {
|
|
2834
|
+
"type": "object",
|
|
2835
|
+
"required": [
|
|
2836
|
+
"address"
|
|
2837
|
+
],
|
|
2838
|
+
"properties": {
|
|
2839
|
+
"name": {
|
|
2840
|
+
"type": "string",
|
|
2841
|
+
"description": "Email address alias",
|
|
2842
|
+
"example": "epilot"
|
|
2843
|
+
},
|
|
2844
|
+
"address": {
|
|
2845
|
+
"type": "string",
|
|
2846
|
+
"description": "Email address",
|
|
2847
|
+
"example": "messaging@epilot.cloud"
|
|
2848
|
+
},
|
|
2849
|
+
"send_status": {
|
|
2850
|
+
"type": "string",
|
|
2851
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2852
|
+
"enum": [
|
|
2853
|
+
"SEND",
|
|
2854
|
+
"DELIVERY",
|
|
2855
|
+
"REJECT",
|
|
2856
|
+
"COMPLAINT",
|
|
2857
|
+
"BOUNCE",
|
|
2858
|
+
"ERROR"
|
|
2859
|
+
]
|
|
2860
|
+
},
|
|
2861
|
+
"send_error": {
|
|
2862
|
+
"type": "object",
|
|
2863
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2864
|
+
}
|
|
2865
|
+
}
|
|
1737
2866
|
},
|
|
1738
|
-
"
|
|
1739
|
-
"type": "
|
|
1740
|
-
"
|
|
1741
|
-
|
|
2867
|
+
"reply_to": {
|
|
2868
|
+
"type": "object",
|
|
2869
|
+
"required": [
|
|
2870
|
+
"address"
|
|
2871
|
+
],
|
|
2872
|
+
"properties": {
|
|
2873
|
+
"name": {
|
|
2874
|
+
"type": "string",
|
|
2875
|
+
"description": "Email address alias",
|
|
2876
|
+
"example": "epilot"
|
|
2877
|
+
},
|
|
2878
|
+
"address": {
|
|
2879
|
+
"type": "string",
|
|
2880
|
+
"description": "Email address",
|
|
2881
|
+
"example": "messaging@epilot.cloud"
|
|
2882
|
+
},
|
|
2883
|
+
"send_status": {
|
|
2884
|
+
"type": "string",
|
|
2885
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2886
|
+
"enum": [
|
|
2887
|
+
"SEND",
|
|
2888
|
+
"DELIVERY",
|
|
2889
|
+
"REJECT",
|
|
2890
|
+
"COMPLAINT",
|
|
2891
|
+
"BOUNCE",
|
|
2892
|
+
"ERROR"
|
|
2893
|
+
]
|
|
2894
|
+
},
|
|
2895
|
+
"send_error": {
|
|
2896
|
+
"type": "object",
|
|
2897
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2898
|
+
}
|
|
2899
|
+
}
|
|
1742
2900
|
},
|
|
1743
|
-
"
|
|
1744
|
-
"type": "
|
|
1745
|
-
"description": "
|
|
1746
|
-
"
|
|
2901
|
+
"to": {
|
|
2902
|
+
"type": "array",
|
|
2903
|
+
"description": "To email addresses",
|
|
2904
|
+
"items": {
|
|
2905
|
+
"type": "object",
|
|
2906
|
+
"required": [
|
|
2907
|
+
"address"
|
|
2908
|
+
],
|
|
2909
|
+
"properties": {
|
|
2910
|
+
"name": {
|
|
2911
|
+
"type": "string",
|
|
2912
|
+
"description": "Email address alias",
|
|
2913
|
+
"example": "epilot"
|
|
2914
|
+
},
|
|
2915
|
+
"address": {
|
|
2916
|
+
"type": "string",
|
|
2917
|
+
"description": "Email address",
|
|
2918
|
+
"example": "messaging@epilot.cloud"
|
|
2919
|
+
},
|
|
2920
|
+
"send_status": {
|
|
2921
|
+
"type": "string",
|
|
2922
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2923
|
+
"enum": [
|
|
2924
|
+
"SEND",
|
|
2925
|
+
"DELIVERY",
|
|
2926
|
+
"REJECT",
|
|
2927
|
+
"COMPLAINT",
|
|
2928
|
+
"BOUNCE",
|
|
2929
|
+
"ERROR"
|
|
2930
|
+
]
|
|
2931
|
+
},
|
|
2932
|
+
"send_error": {
|
|
2933
|
+
"type": "object",
|
|
2934
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2935
|
+
}
|
|
2936
|
+
}
|
|
2937
|
+
}
|
|
2938
|
+
},
|
|
2939
|
+
"cc": {
|
|
2940
|
+
"type": "array",
|
|
2941
|
+
"description": "Cc email addresses",
|
|
2942
|
+
"items": {
|
|
2943
|
+
"type": "object",
|
|
2944
|
+
"required": [
|
|
2945
|
+
"address"
|
|
2946
|
+
],
|
|
2947
|
+
"properties": {
|
|
2948
|
+
"name": {
|
|
2949
|
+
"type": "string",
|
|
2950
|
+
"description": "Email address alias",
|
|
2951
|
+
"example": "epilot"
|
|
2952
|
+
},
|
|
2953
|
+
"address": {
|
|
2954
|
+
"type": "string",
|
|
2955
|
+
"description": "Email address",
|
|
2956
|
+
"example": "messaging@epilot.cloud"
|
|
2957
|
+
},
|
|
2958
|
+
"send_status": {
|
|
2959
|
+
"type": "string",
|
|
2960
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2961
|
+
"enum": [
|
|
2962
|
+
"SEND",
|
|
2963
|
+
"DELIVERY",
|
|
2964
|
+
"REJECT",
|
|
2965
|
+
"COMPLAINT",
|
|
2966
|
+
"BOUNCE",
|
|
2967
|
+
"ERROR"
|
|
2968
|
+
]
|
|
2969
|
+
},
|
|
2970
|
+
"send_error": {
|
|
2971
|
+
"type": "object",
|
|
2972
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2973
|
+
}
|
|
2974
|
+
}
|
|
2975
|
+
}
|
|
2976
|
+
},
|
|
2977
|
+
"bcc": {
|
|
2978
|
+
"type": "array",
|
|
2979
|
+
"description": "Bcc email addresses",
|
|
2980
|
+
"items": {
|
|
2981
|
+
"type": "object",
|
|
2982
|
+
"required": [
|
|
2983
|
+
"address"
|
|
2984
|
+
],
|
|
2985
|
+
"properties": {
|
|
2986
|
+
"name": {
|
|
2987
|
+
"type": "string",
|
|
2988
|
+
"description": "Email address alias",
|
|
2989
|
+
"example": "epilot"
|
|
2990
|
+
},
|
|
2991
|
+
"address": {
|
|
2992
|
+
"type": "string",
|
|
2993
|
+
"description": "Email address",
|
|
2994
|
+
"example": "messaging@epilot.cloud"
|
|
2995
|
+
},
|
|
2996
|
+
"send_status": {
|
|
2997
|
+
"type": "string",
|
|
2998
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
2999
|
+
"enum": [
|
|
3000
|
+
"SEND",
|
|
3001
|
+
"DELIVERY",
|
|
3002
|
+
"REJECT",
|
|
3003
|
+
"COMPLAINT",
|
|
3004
|
+
"BOUNCE",
|
|
3005
|
+
"ERROR"
|
|
3006
|
+
]
|
|
3007
|
+
},
|
|
3008
|
+
"send_error": {
|
|
3009
|
+
"type": "object",
|
|
3010
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
3011
|
+
}
|
|
3012
|
+
}
|
|
3013
|
+
}
|
|
1747
3014
|
},
|
|
1748
|
-
"
|
|
3015
|
+
"attachments": {
|
|
3016
|
+
"type": "array",
|
|
3017
|
+
"description": "Message attachments",
|
|
3018
|
+
"items": {
|
|
3019
|
+
"type": "object",
|
|
3020
|
+
"required": [
|
|
3021
|
+
"filename",
|
|
3022
|
+
"size",
|
|
3023
|
+
"content_type",
|
|
3024
|
+
"url",
|
|
3025
|
+
"bucket",
|
|
3026
|
+
"object_key"
|
|
3027
|
+
],
|
|
3028
|
+
"properties": {
|
|
3029
|
+
"cid": {
|
|
3030
|
+
"type": "string",
|
|
3031
|
+
"description": "Attachment ID",
|
|
3032
|
+
"example": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
|
|
3033
|
+
},
|
|
3034
|
+
"filename": {
|
|
3035
|
+
"type": "string",
|
|
3036
|
+
"description": "File name",
|
|
3037
|
+
"example": "Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
3038
|
+
},
|
|
3039
|
+
"size": {
|
|
3040
|
+
"type": "number",
|
|
3041
|
+
"description": "File size in bytes",
|
|
3042
|
+
"example": 451349
|
|
3043
|
+
},
|
|
3044
|
+
"content_type": {
|
|
3045
|
+
"type": "string",
|
|
3046
|
+
"description": "Content type",
|
|
3047
|
+
"example": "application/pdf"
|
|
3048
|
+
},
|
|
3049
|
+
"url": {
|
|
3050
|
+
"type": "string",
|
|
3051
|
+
"description": "URL to download the attachment.",
|
|
3052
|
+
"example": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
3053
|
+
},
|
|
3054
|
+
"bucket": {
|
|
3055
|
+
"type": "string",
|
|
3056
|
+
"description": "S3 bucket where file is stored",
|
|
3057
|
+
"example": "893487340562-message-attachment"
|
|
3058
|
+
},
|
|
3059
|
+
"object_key": {
|
|
3060
|
+
"type": "string",
|
|
3061
|
+
"description": "S3 object apiKey",
|
|
3062
|
+
"example": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf"
|
|
3063
|
+
},
|
|
3064
|
+
"inline": {
|
|
3065
|
+
"type": "boolean",
|
|
3066
|
+
"description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
|
|
3067
|
+
"default": false
|
|
3068
|
+
},
|
|
3069
|
+
"send_as_link": {
|
|
3070
|
+
"type": "boolean",
|
|
3071
|
+
"description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
|
|
3072
|
+
"default": false
|
|
3073
|
+
},
|
|
3074
|
+
"copy_to_message": {
|
|
3075
|
+
"type": "boolean",
|
|
3076
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
3077
|
+
"default": false
|
|
3078
|
+
}
|
|
3079
|
+
}
|
|
3080
|
+
}
|
|
3081
|
+
},
|
|
3082
|
+
"references": {
|
|
1749
3083
|
"type": "string",
|
|
1750
|
-
"description": "
|
|
1751
|
-
"example": "
|
|
3084
|
+
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
|
|
3085
|
+
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1752
3086
|
},
|
|
1753
|
-
"
|
|
3087
|
+
"in_reply_to": {
|
|
1754
3088
|
"type": "string",
|
|
1755
|
-
"description": "
|
|
1756
|
-
"example": "
|
|
3089
|
+
"description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
|
|
3090
|
+
"example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
3091
|
+
},
|
|
3092
|
+
"user_read_message": {
|
|
3093
|
+
"type": "array",
|
|
3094
|
+
"description": "Ivy User ID of user read the message.",
|
|
3095
|
+
"items": {
|
|
3096
|
+
"type": "string",
|
|
3097
|
+
"example": [
|
|
3098
|
+
"206801",
|
|
3099
|
+
"200109"
|
|
3100
|
+
]
|
|
3101
|
+
}
|
|
3102
|
+
},
|
|
3103
|
+
"send_status": {
|
|
3104
|
+
"type": "array",
|
|
3105
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3106
|
+
"items": {
|
|
3107
|
+
"type": "string",
|
|
3108
|
+
"enum": [
|
|
3109
|
+
"SEND",
|
|
3110
|
+
"DELIVERY",
|
|
3111
|
+
"REJECT",
|
|
3112
|
+
"COMPLAINT",
|
|
3113
|
+
"BOUNCE",
|
|
3114
|
+
"ERROR"
|
|
3115
|
+
]
|
|
3116
|
+
}
|
|
1757
3117
|
},
|
|
1758
|
-
"
|
|
3118
|
+
"type": {
|
|
1759
3119
|
"type": "string",
|
|
1760
|
-
"description": "
|
|
1761
|
-
"
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
"description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n",
|
|
1766
|
-
"default": false
|
|
1767
|
-
},
|
|
1768
|
-
"send_as_link": {
|
|
1769
|
-
"type": "boolean",
|
|
1770
|
-
"description": "If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.",
|
|
1771
|
-
"default": false
|
|
1772
|
-
},
|
|
1773
|
-
"copy_to_message": {
|
|
1774
|
-
"type": "boolean",
|
|
1775
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `cid`, `url`, `object_key`. This property supports for forwarding message.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
1776
|
-
"default": false
|
|
3120
|
+
"description": "Message type",
|
|
3121
|
+
"enum": [
|
|
3122
|
+
"SENT",
|
|
3123
|
+
"RECEIVED"
|
|
3124
|
+
]
|
|
1777
3125
|
}
|
|
1778
|
-
}
|
|
1779
|
-
|
|
1780
|
-
},
|
|
1781
|
-
"references": {
|
|
1782
|
-
"type": "string",
|
|
1783
|
-
"description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
|
|
1784
|
-
"example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1785
|
-
},
|
|
1786
|
-
"in_reply_to": {
|
|
1787
|
-
"type": "string",
|
|
1788
|
-
"description": "In-Reply-To header. Value is the `message_id` of parent message.\n",
|
|
1789
|
-
"example": "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
|
|
1790
|
-
},
|
|
1791
|
-
"user_read_message": {
|
|
1792
|
-
"type": "array",
|
|
1793
|
-
"description": "Ivy User ID of user read the message.",
|
|
1794
|
-
"items": {
|
|
1795
|
-
"type": "string",
|
|
1796
|
-
"example": [
|
|
1797
|
-
"206801",
|
|
1798
|
-
"200109"
|
|
1799
|
-
]
|
|
3126
|
+
},
|
|
3127
|
+
"description": "Latest trash message of thread"
|
|
1800
3128
|
}
|
|
1801
|
-
},
|
|
1802
|
-
"status": {
|
|
1803
|
-
"type": "string",
|
|
1804
|
-
"description": "Message status. Only apply for sent message.\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
1805
|
-
"enum": [
|
|
1806
|
-
"SEND",
|
|
1807
|
-
"REJECT",
|
|
1808
|
-
"BOUNCE",
|
|
1809
|
-
"COMPLAINT",
|
|
1810
|
-
"DELIVERY",
|
|
1811
|
-
null
|
|
1812
|
-
]
|
|
1813
|
-
},
|
|
1814
|
-
"type": {
|
|
1815
|
-
"type": "string",
|
|
1816
|
-
"description": "Message type",
|
|
1817
|
-
"enum": [
|
|
1818
|
-
"SENT",
|
|
1819
|
-
"RECEIVED"
|
|
1820
|
-
]
|
|
1821
3129
|
}
|
|
1822
|
-
}
|
|
1823
|
-
|
|
1824
|
-
}
|
|
3130
|
+
}
|
|
3131
|
+
]
|
|
1825
3132
|
}
|
|
1826
3133
|
}
|
|
1827
3134
|
}
|
|
3135
|
+
},
|
|
3136
|
+
"403": {
|
|
3137
|
+
"description": "Forbidden"
|
|
1828
3138
|
}
|
|
1829
|
-
}
|
|
3139
|
+
}
|
|
3140
|
+
}
|
|
3141
|
+
},
|
|
3142
|
+
"/v1/message/threads/{id}": {
|
|
3143
|
+
"delete": {
|
|
3144
|
+
"operationId": "deleteThread",
|
|
3145
|
+
"summary": "deleteThread",
|
|
3146
|
+
"description": "Immediately and permanently delete a thread. This operation cannot be undone.",
|
|
3147
|
+
"tags": [
|
|
3148
|
+
"Threads"
|
|
3149
|
+
],
|
|
3150
|
+
"parameters": [
|
|
3151
|
+
{
|
|
3152
|
+
"name": "id",
|
|
3153
|
+
"description": "Thread ID",
|
|
3154
|
+
"in": "path",
|
|
3155
|
+
"required": true,
|
|
3156
|
+
"schema": {
|
|
3157
|
+
"type": "string"
|
|
3158
|
+
}
|
|
3159
|
+
}
|
|
3160
|
+
],
|
|
1830
3161
|
"responses": {
|
|
1831
3162
|
"204": {
|
|
1832
3163
|
"description": "Success"
|
|
@@ -1837,13 +3168,42 @@
|
|
|
1837
3168
|
}
|
|
1838
3169
|
}
|
|
1839
3170
|
},
|
|
1840
|
-
"/threads/{id}": {
|
|
1841
|
-
"
|
|
1842
|
-
"operationId": "
|
|
1843
|
-
"summary": "
|
|
1844
|
-
"description": "
|
|
3171
|
+
"/v1/message/threads/{id}/trash": {
|
|
3172
|
+
"post": {
|
|
3173
|
+
"operationId": "trashThread",
|
|
3174
|
+
"summary": "trashThread",
|
|
3175
|
+
"description": "Move a thread to trash",
|
|
3176
|
+
"tags": [
|
|
3177
|
+
"Threads"
|
|
3178
|
+
],
|
|
3179
|
+
"parameters": [
|
|
3180
|
+
{
|
|
3181
|
+
"name": "id",
|
|
3182
|
+
"description": "Thread ID",
|
|
3183
|
+
"in": "path",
|
|
3184
|
+
"required": true,
|
|
3185
|
+
"schema": {
|
|
3186
|
+
"type": "string"
|
|
3187
|
+
}
|
|
3188
|
+
}
|
|
3189
|
+
],
|
|
3190
|
+
"responses": {
|
|
3191
|
+
"204": {
|
|
3192
|
+
"description": "Success"
|
|
3193
|
+
},
|
|
3194
|
+
"403": {
|
|
3195
|
+
"description": "Forbidden"
|
|
3196
|
+
}
|
|
3197
|
+
}
|
|
3198
|
+
}
|
|
3199
|
+
},
|
|
3200
|
+
"/v1/message/threads/{id}/untrash": {
|
|
3201
|
+
"post": {
|
|
3202
|
+
"operationId": "untrashThread",
|
|
3203
|
+
"summary": "untrashThread",
|
|
3204
|
+
"description": "Restore a trashed thread",
|
|
1845
3205
|
"tags": [
|
|
1846
|
-
"
|
|
3206
|
+
"Threads"
|
|
1847
3207
|
],
|
|
1848
3208
|
"parameters": [
|
|
1849
3209
|
{
|
|
@@ -1866,13 +3226,13 @@
|
|
|
1866
3226
|
}
|
|
1867
3227
|
}
|
|
1868
3228
|
},
|
|
1869
|
-
"/attachments/upload-url": {
|
|
3229
|
+
"/v1/message/attachments/upload-url": {
|
|
1870
3230
|
"post": {
|
|
1871
3231
|
"operationId": "createAttachmentUploadUrl",
|
|
1872
3232
|
"summary": "createAttachmentUploadUrl",
|
|
1873
3233
|
"description": "Create S3 POST presigned URL to upload attachment. The URL is valid in 30 minutes. Maximum file size is 100MB.",
|
|
1874
3234
|
"tags": [
|
|
1875
|
-
"
|
|
3235
|
+
"Attachments"
|
|
1876
3236
|
],
|
|
1877
3237
|
"requestBody": {
|
|
1878
3238
|
"content": {
|
|
@@ -1952,13 +3312,8 @@
|
|
|
1952
3312
|
"EpilotAuth": {
|
|
1953
3313
|
"type": "http",
|
|
1954
3314
|
"scheme": "bearer",
|
|
1955
|
-
"description": "
|
|
1956
|
-
|
|
1957
|
-
"AsOrganization": {
|
|
1958
|
-
"type": "apiKey",
|
|
1959
|
-
"in": "header",
|
|
1960
|
-
"name": "x-ivy-org-id",
|
|
1961
|
-
"description": "Set organization id when using internal auth"
|
|
3315
|
+
"description": "Authorization header with epilot OAuth2 bearer token",
|
|
3316
|
+
"bearerFormat": "JWT"
|
|
1962
3317
|
}
|
|
1963
3318
|
},
|
|
1964
3319
|
"schemas": {
|
|
@@ -2086,6 +3441,22 @@
|
|
|
2086
3441
|
"type": "string",
|
|
2087
3442
|
"description": "Email address",
|
|
2088
3443
|
"example": "messaging@epilot.cloud"
|
|
3444
|
+
},
|
|
3445
|
+
"send_status": {
|
|
3446
|
+
"type": "string",
|
|
3447
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3448
|
+
"enum": [
|
|
3449
|
+
"SEND",
|
|
3450
|
+
"DELIVERY",
|
|
3451
|
+
"REJECT",
|
|
3452
|
+
"COMPLAINT",
|
|
3453
|
+
"BOUNCE",
|
|
3454
|
+
"ERROR"
|
|
3455
|
+
]
|
|
3456
|
+
},
|
|
3457
|
+
"send_error": {
|
|
3458
|
+
"type": "object",
|
|
3459
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2089
3460
|
}
|
|
2090
3461
|
}
|
|
2091
3462
|
},
|
|
@@ -2104,6 +3475,22 @@
|
|
|
2104
3475
|
"type": "string",
|
|
2105
3476
|
"description": "Email address",
|
|
2106
3477
|
"example": "messaging@epilot.cloud"
|
|
3478
|
+
},
|
|
3479
|
+
"send_status": {
|
|
3480
|
+
"type": "string",
|
|
3481
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3482
|
+
"enum": [
|
|
3483
|
+
"SEND",
|
|
3484
|
+
"DELIVERY",
|
|
3485
|
+
"REJECT",
|
|
3486
|
+
"COMPLAINT",
|
|
3487
|
+
"BOUNCE",
|
|
3488
|
+
"ERROR"
|
|
3489
|
+
]
|
|
3490
|
+
},
|
|
3491
|
+
"send_error": {
|
|
3492
|
+
"type": "object",
|
|
3493
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2107
3494
|
}
|
|
2108
3495
|
}
|
|
2109
3496
|
},
|
|
@@ -2125,6 +3512,22 @@
|
|
|
2125
3512
|
"type": "string",
|
|
2126
3513
|
"description": "Email address",
|
|
2127
3514
|
"example": "messaging@epilot.cloud"
|
|
3515
|
+
},
|
|
3516
|
+
"send_status": {
|
|
3517
|
+
"type": "string",
|
|
3518
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3519
|
+
"enum": [
|
|
3520
|
+
"SEND",
|
|
3521
|
+
"DELIVERY",
|
|
3522
|
+
"REJECT",
|
|
3523
|
+
"COMPLAINT",
|
|
3524
|
+
"BOUNCE",
|
|
3525
|
+
"ERROR"
|
|
3526
|
+
]
|
|
3527
|
+
},
|
|
3528
|
+
"send_error": {
|
|
3529
|
+
"type": "object",
|
|
3530
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2128
3531
|
}
|
|
2129
3532
|
}
|
|
2130
3533
|
}
|
|
@@ -2147,6 +3550,22 @@
|
|
|
2147
3550
|
"type": "string",
|
|
2148
3551
|
"description": "Email address",
|
|
2149
3552
|
"example": "messaging@epilot.cloud"
|
|
3553
|
+
},
|
|
3554
|
+
"send_status": {
|
|
3555
|
+
"type": "string",
|
|
3556
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3557
|
+
"enum": [
|
|
3558
|
+
"SEND",
|
|
3559
|
+
"DELIVERY",
|
|
3560
|
+
"REJECT",
|
|
3561
|
+
"COMPLAINT",
|
|
3562
|
+
"BOUNCE",
|
|
3563
|
+
"ERROR"
|
|
3564
|
+
]
|
|
3565
|
+
},
|
|
3566
|
+
"send_error": {
|
|
3567
|
+
"type": "object",
|
|
3568
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2150
3569
|
}
|
|
2151
3570
|
}
|
|
2152
3571
|
}
|
|
@@ -2169,6 +3588,22 @@
|
|
|
2169
3588
|
"type": "string",
|
|
2170
3589
|
"description": "Email address",
|
|
2171
3590
|
"example": "messaging@epilot.cloud"
|
|
3591
|
+
},
|
|
3592
|
+
"send_status": {
|
|
3593
|
+
"type": "string",
|
|
3594
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3595
|
+
"enum": [
|
|
3596
|
+
"SEND",
|
|
3597
|
+
"DELIVERY",
|
|
3598
|
+
"REJECT",
|
|
3599
|
+
"COMPLAINT",
|
|
3600
|
+
"BOUNCE",
|
|
3601
|
+
"ERROR"
|
|
3602
|
+
]
|
|
3603
|
+
},
|
|
3604
|
+
"send_error": {
|
|
3605
|
+
"type": "object",
|
|
3606
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2172
3607
|
}
|
|
2173
3608
|
}
|
|
2174
3609
|
}
|
|
@@ -2234,7 +3669,7 @@
|
|
|
2234
3669
|
},
|
|
2235
3670
|
"copy_to_message": {
|
|
2236
3671
|
"type": "boolean",
|
|
2237
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `
|
|
3672
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
2238
3673
|
"default": false
|
|
2239
3674
|
}
|
|
2240
3675
|
}
|
|
@@ -2261,17 +3696,20 @@
|
|
|
2261
3696
|
]
|
|
2262
3697
|
}
|
|
2263
3698
|
},
|
|
2264
|
-
"
|
|
2265
|
-
"type": "
|
|
2266
|
-
"description": "
|
|
2267
|
-
"
|
|
2268
|
-
"
|
|
2269
|
-
"
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
|
|
3699
|
+
"send_status": {
|
|
3700
|
+
"type": "array",
|
|
3701
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3702
|
+
"items": {
|
|
3703
|
+
"type": "string",
|
|
3704
|
+
"enum": [
|
|
3705
|
+
"SEND",
|
|
3706
|
+
"DELIVERY",
|
|
3707
|
+
"REJECT",
|
|
3708
|
+
"COMPLAINT",
|
|
3709
|
+
"BOUNCE",
|
|
3710
|
+
"ERROR"
|
|
3711
|
+
]
|
|
3712
|
+
}
|
|
2275
3713
|
},
|
|
2276
3714
|
"type": {
|
|
2277
3715
|
"type": "string",
|
|
@@ -2331,6 +3769,22 @@
|
|
|
2331
3769
|
"type": "string",
|
|
2332
3770
|
"description": "Email address",
|
|
2333
3771
|
"example": "messaging@epilot.cloud"
|
|
3772
|
+
},
|
|
3773
|
+
"send_status": {
|
|
3774
|
+
"type": "string",
|
|
3775
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3776
|
+
"enum": [
|
|
3777
|
+
"SEND",
|
|
3778
|
+
"DELIVERY",
|
|
3779
|
+
"REJECT",
|
|
3780
|
+
"COMPLAINT",
|
|
3781
|
+
"BOUNCE",
|
|
3782
|
+
"ERROR"
|
|
3783
|
+
]
|
|
3784
|
+
},
|
|
3785
|
+
"send_error": {
|
|
3786
|
+
"type": "object",
|
|
3787
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2334
3788
|
}
|
|
2335
3789
|
}
|
|
2336
3790
|
},
|
|
@@ -2349,6 +3803,22 @@
|
|
|
2349
3803
|
"type": "string",
|
|
2350
3804
|
"description": "Email address",
|
|
2351
3805
|
"example": "messaging@epilot.cloud"
|
|
3806
|
+
},
|
|
3807
|
+
"send_status": {
|
|
3808
|
+
"type": "string",
|
|
3809
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3810
|
+
"enum": [
|
|
3811
|
+
"SEND",
|
|
3812
|
+
"DELIVERY",
|
|
3813
|
+
"REJECT",
|
|
3814
|
+
"COMPLAINT",
|
|
3815
|
+
"BOUNCE",
|
|
3816
|
+
"ERROR"
|
|
3817
|
+
]
|
|
3818
|
+
},
|
|
3819
|
+
"send_error": {
|
|
3820
|
+
"type": "object",
|
|
3821
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2352
3822
|
}
|
|
2353
3823
|
}
|
|
2354
3824
|
},
|
|
@@ -2370,6 +3840,22 @@
|
|
|
2370
3840
|
"type": "string",
|
|
2371
3841
|
"description": "Email address",
|
|
2372
3842
|
"example": "messaging@epilot.cloud"
|
|
3843
|
+
},
|
|
3844
|
+
"send_status": {
|
|
3845
|
+
"type": "string",
|
|
3846
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3847
|
+
"enum": [
|
|
3848
|
+
"SEND",
|
|
3849
|
+
"DELIVERY",
|
|
3850
|
+
"REJECT",
|
|
3851
|
+
"COMPLAINT",
|
|
3852
|
+
"BOUNCE",
|
|
3853
|
+
"ERROR"
|
|
3854
|
+
]
|
|
3855
|
+
},
|
|
3856
|
+
"send_error": {
|
|
3857
|
+
"type": "object",
|
|
3858
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2373
3859
|
}
|
|
2374
3860
|
}
|
|
2375
3861
|
}
|
|
@@ -2392,6 +3878,22 @@
|
|
|
2392
3878
|
"type": "string",
|
|
2393
3879
|
"description": "Email address",
|
|
2394
3880
|
"example": "messaging@epilot.cloud"
|
|
3881
|
+
},
|
|
3882
|
+
"send_status": {
|
|
3883
|
+
"type": "string",
|
|
3884
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3885
|
+
"enum": [
|
|
3886
|
+
"SEND",
|
|
3887
|
+
"DELIVERY",
|
|
3888
|
+
"REJECT",
|
|
3889
|
+
"COMPLAINT",
|
|
3890
|
+
"BOUNCE",
|
|
3891
|
+
"ERROR"
|
|
3892
|
+
]
|
|
3893
|
+
},
|
|
3894
|
+
"send_error": {
|
|
3895
|
+
"type": "object",
|
|
3896
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2395
3897
|
}
|
|
2396
3898
|
}
|
|
2397
3899
|
}
|
|
@@ -2414,6 +3916,22 @@
|
|
|
2414
3916
|
"type": "string",
|
|
2415
3917
|
"description": "Email address",
|
|
2416
3918
|
"example": "messaging@epilot.cloud"
|
|
3919
|
+
},
|
|
3920
|
+
"send_status": {
|
|
3921
|
+
"type": "string",
|
|
3922
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
3923
|
+
"enum": [
|
|
3924
|
+
"SEND",
|
|
3925
|
+
"DELIVERY",
|
|
3926
|
+
"REJECT",
|
|
3927
|
+
"COMPLAINT",
|
|
3928
|
+
"BOUNCE",
|
|
3929
|
+
"ERROR"
|
|
3930
|
+
]
|
|
3931
|
+
},
|
|
3932
|
+
"send_error": {
|
|
3933
|
+
"type": "object",
|
|
3934
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2417
3935
|
}
|
|
2418
3936
|
}
|
|
2419
3937
|
}
|
|
@@ -2479,7 +3997,7 @@
|
|
|
2479
3997
|
},
|
|
2480
3998
|
"copy_to_message": {
|
|
2481
3999
|
"type": "boolean",
|
|
2482
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `
|
|
4000
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
2483
4001
|
"default": false
|
|
2484
4002
|
}
|
|
2485
4003
|
}
|
|
@@ -2506,17 +4024,20 @@
|
|
|
2506
4024
|
]
|
|
2507
4025
|
}
|
|
2508
4026
|
},
|
|
2509
|
-
"
|
|
2510
|
-
"type": "
|
|
2511
|
-
"description": "
|
|
2512
|
-
"
|
|
2513
|
-
"
|
|
2514
|
-
"
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
4027
|
+
"send_status": {
|
|
4028
|
+
"type": "array",
|
|
4029
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4030
|
+
"items": {
|
|
4031
|
+
"type": "string",
|
|
4032
|
+
"enum": [
|
|
4033
|
+
"SEND",
|
|
4034
|
+
"DELIVERY",
|
|
4035
|
+
"REJECT",
|
|
4036
|
+
"COMPLAINT",
|
|
4037
|
+
"BOUNCE",
|
|
4038
|
+
"ERROR"
|
|
4039
|
+
]
|
|
4040
|
+
}
|
|
2520
4041
|
},
|
|
2521
4042
|
"type": {
|
|
2522
4043
|
"type": "string",
|
|
@@ -2578,6 +4099,22 @@
|
|
|
2578
4099
|
"type": "string",
|
|
2579
4100
|
"description": "Email address",
|
|
2580
4101
|
"example": "messaging@epilot.cloud"
|
|
4102
|
+
},
|
|
4103
|
+
"send_status": {
|
|
4104
|
+
"type": "string",
|
|
4105
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4106
|
+
"enum": [
|
|
4107
|
+
"SEND",
|
|
4108
|
+
"DELIVERY",
|
|
4109
|
+
"REJECT",
|
|
4110
|
+
"COMPLAINT",
|
|
4111
|
+
"BOUNCE",
|
|
4112
|
+
"ERROR"
|
|
4113
|
+
]
|
|
4114
|
+
},
|
|
4115
|
+
"send_error": {
|
|
4116
|
+
"type": "object",
|
|
4117
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2581
4118
|
}
|
|
2582
4119
|
}
|
|
2583
4120
|
},
|
|
@@ -2596,6 +4133,22 @@
|
|
|
2596
4133
|
"type": "string",
|
|
2597
4134
|
"description": "Email address",
|
|
2598
4135
|
"example": "messaging@epilot.cloud"
|
|
4136
|
+
},
|
|
4137
|
+
"send_status": {
|
|
4138
|
+
"type": "string",
|
|
4139
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4140
|
+
"enum": [
|
|
4141
|
+
"SEND",
|
|
4142
|
+
"DELIVERY",
|
|
4143
|
+
"REJECT",
|
|
4144
|
+
"COMPLAINT",
|
|
4145
|
+
"BOUNCE",
|
|
4146
|
+
"ERROR"
|
|
4147
|
+
]
|
|
4148
|
+
},
|
|
4149
|
+
"send_error": {
|
|
4150
|
+
"type": "object",
|
|
4151
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2599
4152
|
}
|
|
2600
4153
|
}
|
|
2601
4154
|
},
|
|
@@ -2617,6 +4170,22 @@
|
|
|
2617
4170
|
"type": "string",
|
|
2618
4171
|
"description": "Email address",
|
|
2619
4172
|
"example": "messaging@epilot.cloud"
|
|
4173
|
+
},
|
|
4174
|
+
"send_status": {
|
|
4175
|
+
"type": "string",
|
|
4176
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4177
|
+
"enum": [
|
|
4178
|
+
"SEND",
|
|
4179
|
+
"DELIVERY",
|
|
4180
|
+
"REJECT",
|
|
4181
|
+
"COMPLAINT",
|
|
4182
|
+
"BOUNCE",
|
|
4183
|
+
"ERROR"
|
|
4184
|
+
]
|
|
4185
|
+
},
|
|
4186
|
+
"send_error": {
|
|
4187
|
+
"type": "object",
|
|
4188
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2620
4189
|
}
|
|
2621
4190
|
}
|
|
2622
4191
|
}
|
|
@@ -2639,6 +4208,22 @@
|
|
|
2639
4208
|
"type": "string",
|
|
2640
4209
|
"description": "Email address",
|
|
2641
4210
|
"example": "messaging@epilot.cloud"
|
|
4211
|
+
},
|
|
4212
|
+
"send_status": {
|
|
4213
|
+
"type": "string",
|
|
4214
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4215
|
+
"enum": [
|
|
4216
|
+
"SEND",
|
|
4217
|
+
"DELIVERY",
|
|
4218
|
+
"REJECT",
|
|
4219
|
+
"COMPLAINT",
|
|
4220
|
+
"BOUNCE",
|
|
4221
|
+
"ERROR"
|
|
4222
|
+
]
|
|
4223
|
+
},
|
|
4224
|
+
"send_error": {
|
|
4225
|
+
"type": "object",
|
|
4226
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2642
4227
|
}
|
|
2643
4228
|
}
|
|
2644
4229
|
}
|
|
@@ -2661,6 +4246,22 @@
|
|
|
2661
4246
|
"type": "string",
|
|
2662
4247
|
"description": "Email address",
|
|
2663
4248
|
"example": "messaging@epilot.cloud"
|
|
4249
|
+
},
|
|
4250
|
+
"send_status": {
|
|
4251
|
+
"type": "string",
|
|
4252
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4253
|
+
"enum": [
|
|
4254
|
+
"SEND",
|
|
4255
|
+
"DELIVERY",
|
|
4256
|
+
"REJECT",
|
|
4257
|
+
"COMPLAINT",
|
|
4258
|
+
"BOUNCE",
|
|
4259
|
+
"ERROR"
|
|
4260
|
+
]
|
|
4261
|
+
},
|
|
4262
|
+
"send_error": {
|
|
4263
|
+
"type": "object",
|
|
4264
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2664
4265
|
}
|
|
2665
4266
|
}
|
|
2666
4267
|
}
|
|
@@ -2726,7 +4327,7 @@
|
|
|
2726
4327
|
},
|
|
2727
4328
|
"copy_to_message": {
|
|
2728
4329
|
"type": "boolean",
|
|
2729
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `
|
|
4330
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
2730
4331
|
"default": false
|
|
2731
4332
|
}
|
|
2732
4333
|
}
|
|
@@ -2753,17 +4354,20 @@
|
|
|
2753
4354
|
]
|
|
2754
4355
|
}
|
|
2755
4356
|
},
|
|
2756
|
-
"
|
|
2757
|
-
"type": "
|
|
2758
|
-
"description": "
|
|
2759
|
-
"
|
|
2760
|
-
"
|
|
2761
|
-
"
|
|
2762
|
-
|
|
2763
|
-
|
|
2764
|
-
|
|
2765
|
-
|
|
2766
|
-
|
|
4357
|
+
"send_status": {
|
|
4358
|
+
"type": "array",
|
|
4359
|
+
"description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4360
|
+
"items": {
|
|
4361
|
+
"type": "string",
|
|
4362
|
+
"enum": [
|
|
4363
|
+
"SEND",
|
|
4364
|
+
"DELIVERY",
|
|
4365
|
+
"REJECT",
|
|
4366
|
+
"COMPLAINT",
|
|
4367
|
+
"BOUNCE",
|
|
4368
|
+
"ERROR"
|
|
4369
|
+
]
|
|
4370
|
+
}
|
|
2767
4371
|
},
|
|
2768
4372
|
"type": {
|
|
2769
4373
|
"type": "string",
|
|
@@ -2790,6 +4394,22 @@
|
|
|
2790
4394
|
"type": "string",
|
|
2791
4395
|
"description": "Email address",
|
|
2792
4396
|
"example": "messaging@epilot.cloud"
|
|
4397
|
+
},
|
|
4398
|
+
"send_status": {
|
|
4399
|
+
"type": "string",
|
|
4400
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4401
|
+
"enum": [
|
|
4402
|
+
"SEND",
|
|
4403
|
+
"DELIVERY",
|
|
4404
|
+
"REJECT",
|
|
4405
|
+
"COMPLAINT",
|
|
4406
|
+
"BOUNCE",
|
|
4407
|
+
"ERROR"
|
|
4408
|
+
]
|
|
4409
|
+
},
|
|
4410
|
+
"send_error": {
|
|
4411
|
+
"type": "object",
|
|
4412
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2793
4413
|
}
|
|
2794
4414
|
}
|
|
2795
4415
|
},
|
|
@@ -2851,7 +4471,7 @@
|
|
|
2851
4471
|
},
|
|
2852
4472
|
"copy_to_message": {
|
|
2853
4473
|
"type": "boolean",
|
|
2854
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `
|
|
4474
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
2855
4475
|
"default": false
|
|
2856
4476
|
}
|
|
2857
4477
|
}
|
|
@@ -2907,7 +4527,7 @@
|
|
|
2907
4527
|
},
|
|
2908
4528
|
"text": {
|
|
2909
4529
|
"type": "string",
|
|
2910
|
-
"description": "Text body",
|
|
4530
|
+
"description": "Text body. If not provided, text body is converted from HTML body using [html-to-text](https://www.npmjs.com/package/html-to-text)",
|
|
2911
4531
|
"example": "We at ABC GmbH would like to request a price quote for the solar panel."
|
|
2912
4532
|
},
|
|
2913
4533
|
"from": {
|
|
@@ -2925,6 +4545,22 @@
|
|
|
2925
4545
|
"type": "string",
|
|
2926
4546
|
"description": "Email address",
|
|
2927
4547
|
"example": "messaging@epilot.cloud"
|
|
4548
|
+
},
|
|
4549
|
+
"send_status": {
|
|
4550
|
+
"type": "string",
|
|
4551
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4552
|
+
"enum": [
|
|
4553
|
+
"SEND",
|
|
4554
|
+
"DELIVERY",
|
|
4555
|
+
"REJECT",
|
|
4556
|
+
"COMPLAINT",
|
|
4557
|
+
"BOUNCE",
|
|
4558
|
+
"ERROR"
|
|
4559
|
+
]
|
|
4560
|
+
},
|
|
4561
|
+
"send_error": {
|
|
4562
|
+
"type": "object",
|
|
4563
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2928
4564
|
}
|
|
2929
4565
|
}
|
|
2930
4566
|
},
|
|
@@ -2943,6 +4579,22 @@
|
|
|
2943
4579
|
"type": "string",
|
|
2944
4580
|
"description": "Email address",
|
|
2945
4581
|
"example": "messaging@epilot.cloud"
|
|
4582
|
+
},
|
|
4583
|
+
"send_status": {
|
|
4584
|
+
"type": "string",
|
|
4585
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4586
|
+
"enum": [
|
|
4587
|
+
"SEND",
|
|
4588
|
+
"DELIVERY",
|
|
4589
|
+
"REJECT",
|
|
4590
|
+
"COMPLAINT",
|
|
4591
|
+
"BOUNCE",
|
|
4592
|
+
"ERROR"
|
|
4593
|
+
]
|
|
4594
|
+
},
|
|
4595
|
+
"send_error": {
|
|
4596
|
+
"type": "object",
|
|
4597
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2946
4598
|
}
|
|
2947
4599
|
}
|
|
2948
4600
|
},
|
|
@@ -2964,6 +4616,22 @@
|
|
|
2964
4616
|
"type": "string",
|
|
2965
4617
|
"description": "Email address",
|
|
2966
4618
|
"example": "messaging@epilot.cloud"
|
|
4619
|
+
},
|
|
4620
|
+
"send_status": {
|
|
4621
|
+
"type": "string",
|
|
4622
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4623
|
+
"enum": [
|
|
4624
|
+
"SEND",
|
|
4625
|
+
"DELIVERY",
|
|
4626
|
+
"REJECT",
|
|
4627
|
+
"COMPLAINT",
|
|
4628
|
+
"BOUNCE",
|
|
4629
|
+
"ERROR"
|
|
4630
|
+
]
|
|
4631
|
+
},
|
|
4632
|
+
"send_error": {
|
|
4633
|
+
"type": "object",
|
|
4634
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2967
4635
|
}
|
|
2968
4636
|
}
|
|
2969
4637
|
}
|
|
@@ -2986,6 +4654,22 @@
|
|
|
2986
4654
|
"type": "string",
|
|
2987
4655
|
"description": "Email address",
|
|
2988
4656
|
"example": "messaging@epilot.cloud"
|
|
4657
|
+
},
|
|
4658
|
+
"send_status": {
|
|
4659
|
+
"type": "string",
|
|
4660
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4661
|
+
"enum": [
|
|
4662
|
+
"SEND",
|
|
4663
|
+
"DELIVERY",
|
|
4664
|
+
"REJECT",
|
|
4665
|
+
"COMPLAINT",
|
|
4666
|
+
"BOUNCE",
|
|
4667
|
+
"ERROR"
|
|
4668
|
+
]
|
|
4669
|
+
},
|
|
4670
|
+
"send_error": {
|
|
4671
|
+
"type": "object",
|
|
4672
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
2989
4673
|
}
|
|
2990
4674
|
}
|
|
2991
4675
|
}
|
|
@@ -3008,6 +4692,22 @@
|
|
|
3008
4692
|
"type": "string",
|
|
3009
4693
|
"description": "Email address",
|
|
3010
4694
|
"example": "messaging@epilot.cloud"
|
|
4695
|
+
},
|
|
4696
|
+
"send_status": {
|
|
4697
|
+
"type": "string",
|
|
4698
|
+
"description": "Sent message status regarding to this recipient.\\\nReference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
|
|
4699
|
+
"enum": [
|
|
4700
|
+
"SEND",
|
|
4701
|
+
"DELIVERY",
|
|
4702
|
+
"REJECT",
|
|
4703
|
+
"COMPLAINT",
|
|
4704
|
+
"BOUNCE",
|
|
4705
|
+
"ERROR"
|
|
4706
|
+
]
|
|
4707
|
+
},
|
|
4708
|
+
"send_error": {
|
|
4709
|
+
"type": "object",
|
|
4710
|
+
"description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
|
|
3011
4711
|
}
|
|
3012
4712
|
}
|
|
3013
4713
|
}
|
|
@@ -3073,7 +4773,7 @@
|
|
|
3073
4773
|
},
|
|
3074
4774
|
"copy_to_message": {
|
|
3075
4775
|
"type": "boolean",
|
|
3076
|
-
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `
|
|
4776
|
+
"description": "If true then this attachment is copied to the message and replaces corresponding one. The new attachment has different `url`, `object_key`. This property supports for forwarding message and copying attachments from email template.\\\nIf both `send_as_link` and `copy_to_message` are provided, `copy_to_message` is discarded.\n",
|
|
3077
4777
|
"default": false
|
|
3078
4778
|
}
|
|
3079
4779
|
}
|
|
@@ -3088,7 +4788,7 @@
|
|
|
3088
4788
|
],
|
|
3089
4789
|
"properties": {
|
|
3090
4790
|
"q": {
|
|
3091
|
-
"description": "Lucene
|
|
4791
|
+
"description": "Lucene query syntax supported with ElasticSearch",
|
|
3092
4792
|
"type": "string",
|
|
3093
4793
|
"example": "subject:\"Request for solar panel price\" AND _tags:INBOX"
|
|
3094
4794
|
},
|