@hostinger/mcp 1.52.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/.env.example +14 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +36 -0
- package/.github/workflows/build-release.yaml +163 -0
- package/CODEOWNERS +1 -0
- package/Dockerfile +15 -0
- package/LICENSE +21 -0
- package/README.md +4343 -0
- package/build.js +60 -0
- package/gemini-extension.json +25 -0
- package/glama.json +7 -0
- package/package.json +59 -0
- package/server.json +29 -0
- package/skills/headless/SKILL.md +55 -0
- package/skills/headless/entry/bootstrap.mjs +109 -0
- package/skills/headless/entry/skill.md +79 -0
- package/skills/headless/references/DEPLOYMENT.md +34 -0
- package/skills/headless/references/SETUP.md +34 -0
- package/skills/headless/references/STORE.md +52 -0
- package/skills/headless/references/WORDPRESS.md +51 -0
- package/src/core/oauth-error.html +90 -0
- package/src/core/oauth-success.html +77 -0
- package/src/core/oauth.js +406 -0
- package/src/core/oauth.ts +374 -0
- package/src/core/runtime.js +2673 -0
- package/src/core/runtime.ts +2724 -0
- package/src/core/tools/agency-hosting.js +1535 -0
- package/src/core/tools/agency-hosting.ts +1550 -0
- package/src/core/tools/all.js +15361 -0
- package/src/core/tools/all.ts +15376 -0
- package/src/core/tools/billing.js +310 -0
- package/src/core/tools/billing.ts +325 -0
- package/src/core/tools/dns.js +393 -0
- package/src/core/tools/dns.ts +408 -0
- package/src/core/tools/domains.js +1435 -0
- package/src/core/tools/domains.ts +1450 -0
- package/src/core/tools/ecommerce.js +1426 -0
- package/src/core/tools/ecommerce.ts +1441 -0
- package/src/core/tools/horizons.js +84 -0
- package/src/core/tools/horizons.ts +99 -0
- package/src/core/tools/hosting.js +2479 -0
- package/src/core/tools/hosting.ts +2494 -0
- package/src/core/tools/mail.js +1641 -0
- package/src/core/tools/mail.ts +1656 -0
- package/src/core/tools/reach.js +2270 -0
- package/src/core/tools/reach.ts +2285 -0
- package/src/core/tools/vps.js +2248 -0
- package/src/core/tools/vps.ts +2263 -0
- package/src/core/tools/wordpress.js +1570 -0
- package/src/core/tools/wordpress.ts +1585 -0
- package/src/servers/agency-hosting.js +6 -0
- package/src/servers/agency-hosting.ts +6 -0
- package/src/servers/all.js +6 -0
- package/src/servers/all.ts +6 -0
- package/src/servers/billing.js +6 -0
- package/src/servers/billing.ts +6 -0
- package/src/servers/dns.js +6 -0
- package/src/servers/dns.ts +6 -0
- package/src/servers/domains.js +6 -0
- package/src/servers/domains.ts +6 -0
- package/src/servers/ecommerce.js +6 -0
- package/src/servers/ecommerce.ts +6 -0
- package/src/servers/horizons.js +6 -0
- package/src/servers/horizons.ts +6 -0
- package/src/servers/hosting.js +6 -0
- package/src/servers/hosting.ts +6 -0
- package/src/servers/mail.js +6 -0
- package/src/servers/mail.ts +6 -0
- package/src/servers/reach.js +6 -0
- package/src/servers/reach.ts +6 -0
- package/src/servers/vps.js +6 -0
- package/src/servers/vps.ts +6 -0
- package/src/servers/wordpress.js +6 -0
- package/src/servers/wordpress.ts +6 -0
- package/tsconfig.json +15 -0
- package/types.d.ts +8836 -0
|
@@ -0,0 +1,1641 @@
|
|
|
1
|
+
// Auto-generated tool list for group: mail
|
|
2
|
+
export default [
|
|
3
|
+
{
|
|
4
|
+
"name": "mail_createAliasV1",
|
|
5
|
+
"title": "Create alias",
|
|
6
|
+
"annotations": {
|
|
7
|
+
"title": "Create alias",
|
|
8
|
+
"readOnlyHint": false,
|
|
9
|
+
"destructiveHint": false
|
|
10
|
+
},
|
|
11
|
+
"description": "Create an alias for the given mailbox. The alias address is formed\nfrom the given local part and the domain of the mailbox. Messages\nsent to the alias are delivered to the mailbox.",
|
|
12
|
+
"method": "POST",
|
|
13
|
+
"path": "/api/mail/v1/mailboxes/{mailboxId}/aliases",
|
|
14
|
+
"inputSchema": {
|
|
15
|
+
"type": "object",
|
|
16
|
+
"properties": {
|
|
17
|
+
"mailboxId": {
|
|
18
|
+
"type": "string",
|
|
19
|
+
"description": "Mailbox resource ID"
|
|
20
|
+
},
|
|
21
|
+
"local_part": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"description": "Local part of the alias address (the part before the @). The domain is taken from the mailbox. Case-insensitive and stored lowercase; must start and end with a letter or digit; single dots, underscores and hyphens are allowed in between."
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"required": [
|
|
27
|
+
"mailboxId",
|
|
28
|
+
"local_part"
|
|
29
|
+
]
|
|
30
|
+
},
|
|
31
|
+
"security": [
|
|
32
|
+
{
|
|
33
|
+
"apiToken": []
|
|
34
|
+
}
|
|
35
|
+
],
|
|
36
|
+
"group": "mail"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "mail_deleteAliasV1",
|
|
40
|
+
"title": "Delete alias",
|
|
41
|
+
"annotations": {
|
|
42
|
+
"title": "Delete alias",
|
|
43
|
+
"readOnlyHint": false,
|
|
44
|
+
"destructiveHint": true,
|
|
45
|
+
"idempotentHint": true
|
|
46
|
+
},
|
|
47
|
+
"description": "Delete an alias. Messages sent to the alias address are no longer\ndelivered to the mailbox.",
|
|
48
|
+
"method": "DELETE",
|
|
49
|
+
"path": "/api/mail/v1/aliases/{aliasId}",
|
|
50
|
+
"inputSchema": {
|
|
51
|
+
"type": "object",
|
|
52
|
+
"properties": {
|
|
53
|
+
"aliasId": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"description": "Alias resource ID"
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
"required": [
|
|
59
|
+
"aliasId"
|
|
60
|
+
]
|
|
61
|
+
},
|
|
62
|
+
"security": [
|
|
63
|
+
{
|
|
64
|
+
"apiToken": []
|
|
65
|
+
}
|
|
66
|
+
],
|
|
67
|
+
"group": "mail"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "mail_listAliasesV1",
|
|
71
|
+
"title": "List aliases",
|
|
72
|
+
"annotations": {
|
|
73
|
+
"title": "List aliases",
|
|
74
|
+
"readOnlyHint": true,
|
|
75
|
+
"destructiveHint": false
|
|
76
|
+
},
|
|
77
|
+
"description": "Retrieve a paginated list of aliases across all mailboxes of a mail\norder.",
|
|
78
|
+
"method": "GET",
|
|
79
|
+
"path": "/api/mail/v1/orders/{orderId}/aliases",
|
|
80
|
+
"inputSchema": {
|
|
81
|
+
"type": "object",
|
|
82
|
+
"properties": {
|
|
83
|
+
"orderId": {
|
|
84
|
+
"type": "string",
|
|
85
|
+
"description": "Order resource ID"
|
|
86
|
+
},
|
|
87
|
+
"page": {
|
|
88
|
+
"type": "integer",
|
|
89
|
+
"description": "Page number"
|
|
90
|
+
},
|
|
91
|
+
"per_page": {
|
|
92
|
+
"type": "integer",
|
|
93
|
+
"description": "Number of items per page"
|
|
94
|
+
}
|
|
95
|
+
},
|
|
96
|
+
"required": [
|
|
97
|
+
"orderId"
|
|
98
|
+
]
|
|
99
|
+
},
|
|
100
|
+
"security": [
|
|
101
|
+
{
|
|
102
|
+
"apiToken": []
|
|
103
|
+
}
|
|
104
|
+
],
|
|
105
|
+
"group": "mail"
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"name": "mail_createAPITokenV1",
|
|
109
|
+
"title": "Create API token",
|
|
110
|
+
"annotations": {
|
|
111
|
+
"title": "Create API token",
|
|
112
|
+
"readOnlyHint": false,
|
|
113
|
+
"destructiveHint": false
|
|
114
|
+
},
|
|
115
|
+
"description": "Create an API token for the given mail order. The token grants access\nto the [Hostinger Email API](https://api.mail.hostinger.com/), where\nyou can provision and manage the mailboxes it is scoped to.\n\nThe plaintext token is returned only in this response, never again.\nA maximum of 10 tokens can exist per order. Use\n`scope.has_all_mailboxes` to cover all current and future mailboxes,\nor list specific mailboxes in `scope.mailbox_ids`.",
|
|
116
|
+
"method": "POST",
|
|
117
|
+
"path": "/api/mail/v1/orders/{orderId}/api-tokens",
|
|
118
|
+
"inputSchema": {
|
|
119
|
+
"type": "object",
|
|
120
|
+
"properties": {
|
|
121
|
+
"orderId": {
|
|
122
|
+
"type": "string",
|
|
123
|
+
"description": "Order resource ID"
|
|
124
|
+
},
|
|
125
|
+
"name": {
|
|
126
|
+
"type": "string",
|
|
127
|
+
"description": "Human-readable label for this token"
|
|
128
|
+
},
|
|
129
|
+
"scope": {
|
|
130
|
+
"type": "object",
|
|
131
|
+
"description": "Mailbox scope this token can access",
|
|
132
|
+
"properties": {
|
|
133
|
+
"has_all_mailboxes": {
|
|
134
|
+
"type": "boolean",
|
|
135
|
+
"description": "Grant access to all current and future mailboxes of the order"
|
|
136
|
+
},
|
|
137
|
+
"mailbox_ids": {
|
|
138
|
+
"type": "array",
|
|
139
|
+
"description": "Required when `has_all_mailboxes` is false. Mailbox resource IDs of this order.",
|
|
140
|
+
"items": {
|
|
141
|
+
"type": "string",
|
|
142
|
+
"description": "mailbox_ids parameter"
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
},
|
|
146
|
+
"required": [
|
|
147
|
+
"has_all_mailboxes"
|
|
148
|
+
]
|
|
149
|
+
}
|
|
150
|
+
},
|
|
151
|
+
"required": [
|
|
152
|
+
"orderId",
|
|
153
|
+
"name",
|
|
154
|
+
"scope"
|
|
155
|
+
]
|
|
156
|
+
},
|
|
157
|
+
"security": [
|
|
158
|
+
{
|
|
159
|
+
"apiToken": []
|
|
160
|
+
}
|
|
161
|
+
],
|
|
162
|
+
"group": "mail"
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
"name": "mail_revokeAPITokenV1",
|
|
166
|
+
"title": "Revoke API token",
|
|
167
|
+
"annotations": {
|
|
168
|
+
"title": "Revoke API token",
|
|
169
|
+
"readOnlyHint": false,
|
|
170
|
+
"destructiveHint": true,
|
|
171
|
+
"idempotentHint": true
|
|
172
|
+
},
|
|
173
|
+
"description": "Revoke an API token. The token immediately loses access to the\n[Hostinger Email API](https://api.mail.hostinger.com/). This action\ncannot be undone.",
|
|
174
|
+
"method": "DELETE",
|
|
175
|
+
"path": "/api/mail/v1/api-tokens/{tokenId}",
|
|
176
|
+
"inputSchema": {
|
|
177
|
+
"type": "object",
|
|
178
|
+
"properties": {
|
|
179
|
+
"tokenId": {
|
|
180
|
+
"type": "string",
|
|
181
|
+
"description": "API token ID (returned when the token was created)"
|
|
182
|
+
}
|
|
183
|
+
},
|
|
184
|
+
"required": [
|
|
185
|
+
"tokenId"
|
|
186
|
+
]
|
|
187
|
+
},
|
|
188
|
+
"security": [
|
|
189
|
+
{
|
|
190
|
+
"apiToken": []
|
|
191
|
+
}
|
|
192
|
+
],
|
|
193
|
+
"group": "mail"
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"name": "mail_listAPITokensV1",
|
|
197
|
+
"title": "List API tokens",
|
|
198
|
+
"annotations": {
|
|
199
|
+
"title": "List API tokens",
|
|
200
|
+
"readOnlyHint": true,
|
|
201
|
+
"destructiveHint": false
|
|
202
|
+
},
|
|
203
|
+
"description": "Retrieve a paginated list of\n[Hostinger Email API](https://api.mail.hostinger.com/) tokens across\nall your mail orders, optionally filtered by order. Plaintext tokens\nare never included; they are returned only when a token is created.",
|
|
204
|
+
"method": "GET",
|
|
205
|
+
"path": "/api/mail/v1/api-tokens",
|
|
206
|
+
"inputSchema": {
|
|
207
|
+
"type": "object",
|
|
208
|
+
"properties": {
|
|
209
|
+
"order_id": {
|
|
210
|
+
"type": "string",
|
|
211
|
+
"description": "Filter tokens by order resource ID. Single value or comma-separated list."
|
|
212
|
+
},
|
|
213
|
+
"page": {
|
|
214
|
+
"type": "integer",
|
|
215
|
+
"description": "Page number"
|
|
216
|
+
},
|
|
217
|
+
"per_page": {
|
|
218
|
+
"type": "integer",
|
|
219
|
+
"description": "Number of items per page"
|
|
220
|
+
}
|
|
221
|
+
},
|
|
222
|
+
"required": []
|
|
223
|
+
},
|
|
224
|
+
"security": [
|
|
225
|
+
{
|
|
226
|
+
"apiToken": []
|
|
227
|
+
}
|
|
228
|
+
],
|
|
229
|
+
"group": "mail"
|
|
230
|
+
},
|
|
231
|
+
{
|
|
232
|
+
"name": "mail_createAutoreplyV1",
|
|
233
|
+
"title": "Create autoreply",
|
|
234
|
+
"annotations": {
|
|
235
|
+
"title": "Create autoreply",
|
|
236
|
+
"readOnlyHint": false,
|
|
237
|
+
"destructiveHint": false
|
|
238
|
+
},
|
|
239
|
+
"description": "Create an automatic reply for the given mailbox. A mailbox can have\nonly one autoreply. Omit `starts_at` to activate the autoreply\nimmediately and omit `ends_at` to keep it active indefinitely.",
|
|
240
|
+
"method": "POST",
|
|
241
|
+
"path": "/api/mail/v1/mailboxes/{mailboxId}/autoreplies",
|
|
242
|
+
"inputSchema": {
|
|
243
|
+
"type": "object",
|
|
244
|
+
"properties": {
|
|
245
|
+
"mailboxId": {
|
|
246
|
+
"type": "string",
|
|
247
|
+
"description": "Mailbox resource ID"
|
|
248
|
+
},
|
|
249
|
+
"subject": {
|
|
250
|
+
"type": "string",
|
|
251
|
+
"description": "Subject of the automatic reply"
|
|
252
|
+
},
|
|
253
|
+
"body": {
|
|
254
|
+
"type": "string",
|
|
255
|
+
"description": "Body of the automatic reply"
|
|
256
|
+
},
|
|
257
|
+
"display_name": {
|
|
258
|
+
"type": "string",
|
|
259
|
+
"description": "Sender display name used for the reply"
|
|
260
|
+
},
|
|
261
|
+
"starts_at": {
|
|
262
|
+
"type": "string",
|
|
263
|
+
"description": "When the autoreply becomes active. Defaults to now."
|
|
264
|
+
},
|
|
265
|
+
"ends_at": {
|
|
266
|
+
"type": "string",
|
|
267
|
+
"description": "When the autoreply stops. Omit for an indefinite autoreply."
|
|
268
|
+
}
|
|
269
|
+
},
|
|
270
|
+
"required": [
|
|
271
|
+
"mailboxId",
|
|
272
|
+
"subject",
|
|
273
|
+
"body"
|
|
274
|
+
]
|
|
275
|
+
},
|
|
276
|
+
"security": [
|
|
277
|
+
{
|
|
278
|
+
"apiToken": []
|
|
279
|
+
}
|
|
280
|
+
],
|
|
281
|
+
"group": "mail"
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"name": "mail_updateAutoreplyV1",
|
|
285
|
+
"title": "Update autoreply",
|
|
286
|
+
"annotations": {
|
|
287
|
+
"title": "Update autoreply",
|
|
288
|
+
"readOnlyHint": false,
|
|
289
|
+
"destructiveHint": true,
|
|
290
|
+
"idempotentHint": true
|
|
291
|
+
},
|
|
292
|
+
"description": "Replace the autoreply with the given content and schedule. Omitted\noptional fields are cleared: omit `starts_at` to activate the\nautoreply immediately and omit `ends_at` to keep it active\nindefinitely.",
|
|
293
|
+
"method": "PUT",
|
|
294
|
+
"path": "/api/mail/v1/autoreplies/{autoreplyId}",
|
|
295
|
+
"inputSchema": {
|
|
296
|
+
"type": "object",
|
|
297
|
+
"properties": {
|
|
298
|
+
"autoreplyId": {
|
|
299
|
+
"type": "string",
|
|
300
|
+
"description": "Autoreply resource ID"
|
|
301
|
+
},
|
|
302
|
+
"subject": {
|
|
303
|
+
"type": "string",
|
|
304
|
+
"description": "Subject of the automatic reply"
|
|
305
|
+
},
|
|
306
|
+
"body": {
|
|
307
|
+
"type": "string",
|
|
308
|
+
"description": "Body of the automatic reply"
|
|
309
|
+
},
|
|
310
|
+
"display_name": {
|
|
311
|
+
"type": "string",
|
|
312
|
+
"description": "Sender display name used for the reply"
|
|
313
|
+
},
|
|
314
|
+
"starts_at": {
|
|
315
|
+
"type": "string",
|
|
316
|
+
"description": "When the autoreply becomes active. Defaults to now."
|
|
317
|
+
},
|
|
318
|
+
"ends_at": {
|
|
319
|
+
"type": "string",
|
|
320
|
+
"description": "When the autoreply stops. Omit for an indefinite autoreply."
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
"required": [
|
|
324
|
+
"autoreplyId",
|
|
325
|
+
"subject",
|
|
326
|
+
"body"
|
|
327
|
+
]
|
|
328
|
+
},
|
|
329
|
+
"security": [
|
|
330
|
+
{
|
|
331
|
+
"apiToken": []
|
|
332
|
+
}
|
|
333
|
+
],
|
|
334
|
+
"group": "mail"
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"name": "mail_deleteAutoreplyV1",
|
|
338
|
+
"title": "Delete autoreply",
|
|
339
|
+
"annotations": {
|
|
340
|
+
"title": "Delete autoreply",
|
|
341
|
+
"readOnlyHint": false,
|
|
342
|
+
"destructiveHint": true,
|
|
343
|
+
"idempotentHint": true
|
|
344
|
+
},
|
|
345
|
+
"description": "Delete the autoreply of a mailbox. The mailbox stops sending\nautomatic replies immediately.",
|
|
346
|
+
"method": "DELETE",
|
|
347
|
+
"path": "/api/mail/v1/autoreplies/{autoreplyId}",
|
|
348
|
+
"inputSchema": {
|
|
349
|
+
"type": "object",
|
|
350
|
+
"properties": {
|
|
351
|
+
"autoreplyId": {
|
|
352
|
+
"type": "string",
|
|
353
|
+
"description": "Autoreply resource ID"
|
|
354
|
+
}
|
|
355
|
+
},
|
|
356
|
+
"required": [
|
|
357
|
+
"autoreplyId"
|
|
358
|
+
]
|
|
359
|
+
},
|
|
360
|
+
"security": [
|
|
361
|
+
{
|
|
362
|
+
"apiToken": []
|
|
363
|
+
}
|
|
364
|
+
],
|
|
365
|
+
"group": "mail"
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
"name": "mail_listAutorepliesV1",
|
|
369
|
+
"title": "List autoreplies",
|
|
370
|
+
"annotations": {
|
|
371
|
+
"title": "List autoreplies",
|
|
372
|
+
"readOnlyHint": true,
|
|
373
|
+
"destructiveHint": false
|
|
374
|
+
},
|
|
375
|
+
"description": "Retrieve a paginated list of autoreplies across all mailboxes of a\nmail order.",
|
|
376
|
+
"method": "GET",
|
|
377
|
+
"path": "/api/mail/v1/orders/{orderId}/autoreplies",
|
|
378
|
+
"inputSchema": {
|
|
379
|
+
"type": "object",
|
|
380
|
+
"properties": {
|
|
381
|
+
"orderId": {
|
|
382
|
+
"type": "string",
|
|
383
|
+
"description": "Order resource ID"
|
|
384
|
+
},
|
|
385
|
+
"page": {
|
|
386
|
+
"type": "integer",
|
|
387
|
+
"description": "Page number"
|
|
388
|
+
},
|
|
389
|
+
"per_page": {
|
|
390
|
+
"type": "integer",
|
|
391
|
+
"description": "Number of items per page"
|
|
392
|
+
}
|
|
393
|
+
},
|
|
394
|
+
"required": [
|
|
395
|
+
"orderId"
|
|
396
|
+
]
|
|
397
|
+
},
|
|
398
|
+
"security": [
|
|
399
|
+
{
|
|
400
|
+
"apiToken": []
|
|
401
|
+
}
|
|
402
|
+
],
|
|
403
|
+
"group": "mail"
|
|
404
|
+
},
|
|
405
|
+
{
|
|
406
|
+
"name": "mail_createCatchAllV1",
|
|
407
|
+
"title": "Create catch-all",
|
|
408
|
+
"annotations": {
|
|
409
|
+
"title": "Create catch-all",
|
|
410
|
+
"readOnlyHint": false,
|
|
411
|
+
"destructiveHint": false
|
|
412
|
+
},
|
|
413
|
+
"description": "Create a catch-all that routes all messages sent to unknown addresses\nof the domain to the given mailbox. The mailbox address receives a\nconfirmation email and the catch-all becomes active only after it is\nconfirmed. A domain can have only one catch-all.",
|
|
414
|
+
"method": "POST",
|
|
415
|
+
"path": "/api/mail/v1/mailboxes/{mailboxId}/catchalls",
|
|
416
|
+
"inputSchema": {
|
|
417
|
+
"type": "object",
|
|
418
|
+
"properties": {
|
|
419
|
+
"mailboxId": {
|
|
420
|
+
"type": "string",
|
|
421
|
+
"description": "Mailbox resource ID"
|
|
422
|
+
}
|
|
423
|
+
},
|
|
424
|
+
"required": [
|
|
425
|
+
"mailboxId"
|
|
426
|
+
]
|
|
427
|
+
},
|
|
428
|
+
"security": [
|
|
429
|
+
{
|
|
430
|
+
"apiToken": []
|
|
431
|
+
}
|
|
432
|
+
],
|
|
433
|
+
"group": "mail"
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
"name": "mail_deleteCatchAllV1",
|
|
437
|
+
"title": "Delete catch-all",
|
|
438
|
+
"annotations": {
|
|
439
|
+
"title": "Delete catch-all",
|
|
440
|
+
"readOnlyHint": false,
|
|
441
|
+
"destructiveHint": true,
|
|
442
|
+
"idempotentHint": true
|
|
443
|
+
},
|
|
444
|
+
"description": "Delete a catch-all. Messages sent to unknown addresses of the domain\nare no longer routed to the mailbox.",
|
|
445
|
+
"method": "DELETE",
|
|
446
|
+
"path": "/api/mail/v1/catchalls/{catchallId}",
|
|
447
|
+
"inputSchema": {
|
|
448
|
+
"type": "object",
|
|
449
|
+
"properties": {
|
|
450
|
+
"catchallId": {
|
|
451
|
+
"type": "string",
|
|
452
|
+
"description": "Catch-all resource ID"
|
|
453
|
+
}
|
|
454
|
+
},
|
|
455
|
+
"required": [
|
|
456
|
+
"catchallId"
|
|
457
|
+
]
|
|
458
|
+
},
|
|
459
|
+
"security": [
|
|
460
|
+
{
|
|
461
|
+
"apiToken": []
|
|
462
|
+
}
|
|
463
|
+
],
|
|
464
|
+
"group": "mail"
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
"name": "mail_listCatchAllsV1",
|
|
468
|
+
"title": "List catch-alls",
|
|
469
|
+
"annotations": {
|
|
470
|
+
"title": "List catch-alls",
|
|
471
|
+
"readOnlyHint": true,
|
|
472
|
+
"destructiveHint": false
|
|
473
|
+
},
|
|
474
|
+
"description": "Retrieve a paginated list of catch-alls across all mailboxes of a\nmail order.",
|
|
475
|
+
"method": "GET",
|
|
476
|
+
"path": "/api/mail/v1/orders/{orderId}/catchalls",
|
|
477
|
+
"inputSchema": {
|
|
478
|
+
"type": "object",
|
|
479
|
+
"properties": {
|
|
480
|
+
"orderId": {
|
|
481
|
+
"type": "string",
|
|
482
|
+
"description": "Order resource ID"
|
|
483
|
+
},
|
|
484
|
+
"page": {
|
|
485
|
+
"type": "integer",
|
|
486
|
+
"description": "Page number"
|
|
487
|
+
},
|
|
488
|
+
"per_page": {
|
|
489
|
+
"type": "integer",
|
|
490
|
+
"description": "Number of items per page"
|
|
491
|
+
}
|
|
492
|
+
},
|
|
493
|
+
"required": [
|
|
494
|
+
"orderId"
|
|
495
|
+
]
|
|
496
|
+
},
|
|
497
|
+
"security": [
|
|
498
|
+
{
|
|
499
|
+
"apiToken": []
|
|
500
|
+
}
|
|
501
|
+
],
|
|
502
|
+
"group": "mail"
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
"name": "mail_resendCatchAllConfirmationV1",
|
|
506
|
+
"title": "Resend catch-all confirmation",
|
|
507
|
+
"annotations": {
|
|
508
|
+
"title": "Resend catch-all confirmation",
|
|
509
|
+
"readOnlyHint": false,
|
|
510
|
+
"destructiveHint": false
|
|
511
|
+
},
|
|
512
|
+
"description": "Resend the confirmation email to the mailbox address of an\nunconfirmed catch-all.",
|
|
513
|
+
"method": "POST",
|
|
514
|
+
"path": "/api/mail/v1/catchalls/{catchallId}/confirmation/resend",
|
|
515
|
+
"inputSchema": {
|
|
516
|
+
"type": "object",
|
|
517
|
+
"properties": {
|
|
518
|
+
"catchallId": {
|
|
519
|
+
"type": "string",
|
|
520
|
+
"description": "Catch-all resource ID"
|
|
521
|
+
}
|
|
522
|
+
},
|
|
523
|
+
"required": [
|
|
524
|
+
"catchallId"
|
|
525
|
+
]
|
|
526
|
+
},
|
|
527
|
+
"security": [
|
|
528
|
+
{
|
|
529
|
+
"apiToken": []
|
|
530
|
+
}
|
|
531
|
+
],
|
|
532
|
+
"group": "mail"
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"name": "mail_createForwarderV1",
|
|
536
|
+
"title": "Create forwarder",
|
|
537
|
+
"annotations": {
|
|
538
|
+
"title": "Create forwarder",
|
|
539
|
+
"readOnlyHint": false,
|
|
540
|
+
"destructiveHint": false
|
|
541
|
+
},
|
|
542
|
+
"description": "Create a forwarder from the given mailbox to the destination address.\nThe destination receives a confirmation email and forwarding becomes\nactive only after it is confirmed.",
|
|
543
|
+
"method": "POST",
|
|
544
|
+
"path": "/api/mail/v1/mailboxes/{mailboxId}/forwarders",
|
|
545
|
+
"inputSchema": {
|
|
546
|
+
"type": "object",
|
|
547
|
+
"properties": {
|
|
548
|
+
"mailboxId": {
|
|
549
|
+
"type": "string",
|
|
550
|
+
"description": "Mailbox resource ID"
|
|
551
|
+
},
|
|
552
|
+
"destination": {
|
|
553
|
+
"type": "string",
|
|
554
|
+
"description": "Email address the messages will be forwarded to"
|
|
555
|
+
},
|
|
556
|
+
"is_keep_copy_enabled": {
|
|
557
|
+
"type": "boolean",
|
|
558
|
+
"description": "Whether to keep a copy of forwarded messages in the mailbox. Defaults to false."
|
|
559
|
+
}
|
|
560
|
+
},
|
|
561
|
+
"required": [
|
|
562
|
+
"mailboxId",
|
|
563
|
+
"destination"
|
|
564
|
+
]
|
|
565
|
+
},
|
|
566
|
+
"security": [
|
|
567
|
+
{
|
|
568
|
+
"apiToken": []
|
|
569
|
+
}
|
|
570
|
+
],
|
|
571
|
+
"group": "mail"
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
"name": "mail_deleteForwarderV1",
|
|
575
|
+
"title": "Delete forwarder",
|
|
576
|
+
"annotations": {
|
|
577
|
+
"title": "Delete forwarder",
|
|
578
|
+
"readOnlyHint": false,
|
|
579
|
+
"destructiveHint": true,
|
|
580
|
+
"idempotentHint": true
|
|
581
|
+
},
|
|
582
|
+
"description": "Delete a forwarder. The mailbox stops forwarding messages to the\ndestination address immediately.",
|
|
583
|
+
"method": "DELETE",
|
|
584
|
+
"path": "/api/mail/v1/forwarders/{forwarderId}",
|
|
585
|
+
"inputSchema": {
|
|
586
|
+
"type": "object",
|
|
587
|
+
"properties": {
|
|
588
|
+
"forwarderId": {
|
|
589
|
+
"type": "string",
|
|
590
|
+
"description": "Forwarder resource ID"
|
|
591
|
+
}
|
|
592
|
+
},
|
|
593
|
+
"required": [
|
|
594
|
+
"forwarderId"
|
|
595
|
+
]
|
|
596
|
+
},
|
|
597
|
+
"security": [
|
|
598
|
+
{
|
|
599
|
+
"apiToken": []
|
|
600
|
+
}
|
|
601
|
+
],
|
|
602
|
+
"group": "mail"
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
"name": "mail_listForwardersV1",
|
|
606
|
+
"title": "List forwarders",
|
|
607
|
+
"annotations": {
|
|
608
|
+
"title": "List forwarders",
|
|
609
|
+
"readOnlyHint": true,
|
|
610
|
+
"destructiveHint": false
|
|
611
|
+
},
|
|
612
|
+
"description": "Retrieve a paginated list of forwarders across all mailboxes of a\nmail order.",
|
|
613
|
+
"method": "GET",
|
|
614
|
+
"path": "/api/mail/v1/orders/{orderId}/forwarders",
|
|
615
|
+
"inputSchema": {
|
|
616
|
+
"type": "object",
|
|
617
|
+
"properties": {
|
|
618
|
+
"orderId": {
|
|
619
|
+
"type": "string",
|
|
620
|
+
"description": "Order resource ID"
|
|
621
|
+
},
|
|
622
|
+
"page": {
|
|
623
|
+
"type": "integer",
|
|
624
|
+
"description": "Page number"
|
|
625
|
+
},
|
|
626
|
+
"per_page": {
|
|
627
|
+
"type": "integer",
|
|
628
|
+
"description": "Number of items per page"
|
|
629
|
+
}
|
|
630
|
+
},
|
|
631
|
+
"required": [
|
|
632
|
+
"orderId"
|
|
633
|
+
]
|
|
634
|
+
},
|
|
635
|
+
"security": [
|
|
636
|
+
{
|
|
637
|
+
"apiToken": []
|
|
638
|
+
}
|
|
639
|
+
],
|
|
640
|
+
"group": "mail"
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
"name": "mail_resendForwarderConfirmationV1",
|
|
644
|
+
"title": "Resend forwarder confirmation",
|
|
645
|
+
"annotations": {
|
|
646
|
+
"title": "Resend forwarder confirmation",
|
|
647
|
+
"readOnlyHint": false,
|
|
648
|
+
"destructiveHint": false
|
|
649
|
+
},
|
|
650
|
+
"description": "Resend the confirmation email to the destination address of an\nunconfirmed forwarder.",
|
|
651
|
+
"method": "POST",
|
|
652
|
+
"path": "/api/mail/v1/forwarders/{forwarderId}/confirmation/resend",
|
|
653
|
+
"inputSchema": {
|
|
654
|
+
"type": "object",
|
|
655
|
+
"properties": {
|
|
656
|
+
"forwarderId": {
|
|
657
|
+
"type": "string",
|
|
658
|
+
"description": "Forwarder resource ID"
|
|
659
|
+
}
|
|
660
|
+
},
|
|
661
|
+
"required": [
|
|
662
|
+
"forwarderId"
|
|
663
|
+
]
|
|
664
|
+
},
|
|
665
|
+
"security": [
|
|
666
|
+
{
|
|
667
|
+
"apiToken": []
|
|
668
|
+
}
|
|
669
|
+
],
|
|
670
|
+
"group": "mail"
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"name": "mail_updateForwarderKeepCopySettingV1",
|
|
674
|
+
"title": "Update forwarder keep-copy setting",
|
|
675
|
+
"annotations": {
|
|
676
|
+
"title": "Update forwarder keep-copy setting",
|
|
677
|
+
"readOnlyHint": false,
|
|
678
|
+
"destructiveHint": true,
|
|
679
|
+
"idempotentHint": true
|
|
680
|
+
},
|
|
681
|
+
"description": "Enable or disable keeping a copy of forwarded messages in the\nmailbox.",
|
|
682
|
+
"method": "PATCH",
|
|
683
|
+
"path": "/api/mail/v1/forwarders/{forwarderId}/keep-copy",
|
|
684
|
+
"inputSchema": {
|
|
685
|
+
"type": "object",
|
|
686
|
+
"properties": {
|
|
687
|
+
"forwarderId": {
|
|
688
|
+
"type": "string",
|
|
689
|
+
"description": "Forwarder resource ID"
|
|
690
|
+
},
|
|
691
|
+
"is_keep_copy_enabled": {
|
|
692
|
+
"type": "boolean",
|
|
693
|
+
"description": "Whether to keep a copy of forwarded messages in the mailbox"
|
|
694
|
+
}
|
|
695
|
+
},
|
|
696
|
+
"required": [
|
|
697
|
+
"forwarderId",
|
|
698
|
+
"is_keep_copy_enabled"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
"security": [
|
|
702
|
+
{
|
|
703
|
+
"apiToken": []
|
|
704
|
+
}
|
|
705
|
+
],
|
|
706
|
+
"group": "mail"
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
"name": "mail_listAccessLogsV1",
|
|
710
|
+
"title": "List access logs",
|
|
711
|
+
"annotations": {
|
|
712
|
+
"title": "List access logs",
|
|
713
|
+
"readOnlyHint": true,
|
|
714
|
+
"destructiveHint": false
|
|
715
|
+
},
|
|
716
|
+
"description": "Retrieve paginated access logs for the domain attached to the given\nmail order. Supports filtering by account, date range, protocol,\nstatus, and deletion flag. Results are sorted by timestamp descending.",
|
|
717
|
+
"method": "GET",
|
|
718
|
+
"path": "/api/mail/v1/orders/{orderId}/logs/access",
|
|
719
|
+
"inputSchema": {
|
|
720
|
+
"type": "object",
|
|
721
|
+
"properties": {
|
|
722
|
+
"orderId": {
|
|
723
|
+
"type": "string",
|
|
724
|
+
"description": "Order resource ID"
|
|
725
|
+
},
|
|
726
|
+
"account": {
|
|
727
|
+
"type": "string",
|
|
728
|
+
"description": "Filter log entries by a specific email account"
|
|
729
|
+
},
|
|
730
|
+
"date": {
|
|
731
|
+
"type": "string",
|
|
732
|
+
"description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
|
|
733
|
+
},
|
|
734
|
+
"from_date": {
|
|
735
|
+
"type": "string",
|
|
736
|
+
"description": "Date range start (RFC 3339)"
|
|
737
|
+
},
|
|
738
|
+
"to_date": {
|
|
739
|
+
"type": "string",
|
|
740
|
+
"description": "Date range end (RFC 3339)"
|
|
741
|
+
},
|
|
742
|
+
"status": {
|
|
743
|
+
"type": "string",
|
|
744
|
+
"description": "Filter log entries by status",
|
|
745
|
+
"enum": [
|
|
746
|
+
"Successful",
|
|
747
|
+
"Failed"
|
|
748
|
+
]
|
|
749
|
+
},
|
|
750
|
+
"protocol": {
|
|
751
|
+
"type": "string",
|
|
752
|
+
"description": "Filter access log entries by protocol",
|
|
753
|
+
"enum": [
|
|
754
|
+
"imap",
|
|
755
|
+
"pop3",
|
|
756
|
+
"smtp"
|
|
757
|
+
]
|
|
758
|
+
},
|
|
759
|
+
"has_deletions": {
|
|
760
|
+
"type": "boolean",
|
|
761
|
+
"description": "Filter access log entries by whether the session had deletions"
|
|
762
|
+
},
|
|
763
|
+
"page": {
|
|
764
|
+
"type": "integer",
|
|
765
|
+
"description": "Page number"
|
|
766
|
+
},
|
|
767
|
+
"per_page": {
|
|
768
|
+
"type": "integer",
|
|
769
|
+
"description": "Number of items per page"
|
|
770
|
+
}
|
|
771
|
+
},
|
|
772
|
+
"required": [
|
|
773
|
+
"orderId"
|
|
774
|
+
]
|
|
775
|
+
},
|
|
776
|
+
"security": [
|
|
777
|
+
{
|
|
778
|
+
"apiToken": []
|
|
779
|
+
}
|
|
780
|
+
],
|
|
781
|
+
"group": "mail"
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"name": "mail_listActionLogsV1",
|
|
785
|
+
"title": "List action logs",
|
|
786
|
+
"annotations": {
|
|
787
|
+
"title": "List action logs",
|
|
788
|
+
"readOnlyHint": true,
|
|
789
|
+
"destructiveHint": false
|
|
790
|
+
},
|
|
791
|
+
"description": "Retrieve paginated account action logs (administrative and user\nactions) for the given mail order. Supports filtering by account,\ndate range, and status. Results are sorted by timestamp descending.",
|
|
792
|
+
"method": "GET",
|
|
793
|
+
"path": "/api/mail/v1/orders/{orderId}/logs/action",
|
|
794
|
+
"inputSchema": {
|
|
795
|
+
"type": "object",
|
|
796
|
+
"properties": {
|
|
797
|
+
"orderId": {
|
|
798
|
+
"type": "string",
|
|
799
|
+
"description": "Order resource ID"
|
|
800
|
+
},
|
|
801
|
+
"account": {
|
|
802
|
+
"type": "string",
|
|
803
|
+
"description": "Filter log entries by a specific email account"
|
|
804
|
+
},
|
|
805
|
+
"date": {
|
|
806
|
+
"type": "string",
|
|
807
|
+
"description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
|
|
808
|
+
},
|
|
809
|
+
"from_date": {
|
|
810
|
+
"type": "string",
|
|
811
|
+
"description": "Date range start (RFC 3339)"
|
|
812
|
+
},
|
|
813
|
+
"to_date": {
|
|
814
|
+
"type": "string",
|
|
815
|
+
"description": "Date range end (RFC 3339)"
|
|
816
|
+
},
|
|
817
|
+
"status": {
|
|
818
|
+
"type": "string",
|
|
819
|
+
"description": "Filter log entries by status",
|
|
820
|
+
"enum": [
|
|
821
|
+
"Successful",
|
|
822
|
+
"Failed"
|
|
823
|
+
]
|
|
824
|
+
},
|
|
825
|
+
"page": {
|
|
826
|
+
"type": "integer",
|
|
827
|
+
"description": "Page number"
|
|
828
|
+
},
|
|
829
|
+
"per_page": {
|
|
830
|
+
"type": "integer",
|
|
831
|
+
"description": "Number of items per page"
|
|
832
|
+
}
|
|
833
|
+
},
|
|
834
|
+
"required": [
|
|
835
|
+
"orderId"
|
|
836
|
+
]
|
|
837
|
+
},
|
|
838
|
+
"security": [
|
|
839
|
+
{
|
|
840
|
+
"apiToken": []
|
|
841
|
+
}
|
|
842
|
+
],
|
|
843
|
+
"group": "mail"
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
"name": "mail_listInboundLogsV1",
|
|
847
|
+
"title": "List inbound logs",
|
|
848
|
+
"annotations": {
|
|
849
|
+
"title": "List inbound logs",
|
|
850
|
+
"readOnlyHint": true,
|
|
851
|
+
"destructiveHint": false
|
|
852
|
+
},
|
|
853
|
+
"description": "Retrieve paginated inbound (received mail) delivery logs for the\ndomain attached to the given mail order. Supports filtering by\naccount, date range, status, sender, and recipient. Results are\nsorted by timestamp descending.",
|
|
854
|
+
"method": "GET",
|
|
855
|
+
"path": "/api/mail/v1/orders/{orderId}/logs/inbound",
|
|
856
|
+
"inputSchema": {
|
|
857
|
+
"type": "object",
|
|
858
|
+
"properties": {
|
|
859
|
+
"orderId": {
|
|
860
|
+
"type": "string",
|
|
861
|
+
"description": "Order resource ID"
|
|
862
|
+
},
|
|
863
|
+
"account": {
|
|
864
|
+
"type": "string",
|
|
865
|
+
"description": "Filter log entries by a specific email account"
|
|
866
|
+
},
|
|
867
|
+
"date": {
|
|
868
|
+
"type": "string",
|
|
869
|
+
"description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
|
|
870
|
+
},
|
|
871
|
+
"from_date": {
|
|
872
|
+
"type": "string",
|
|
873
|
+
"description": "Date range start (RFC 3339)"
|
|
874
|
+
},
|
|
875
|
+
"to_date": {
|
|
876
|
+
"type": "string",
|
|
877
|
+
"description": "Date range end (RFC 3339)"
|
|
878
|
+
},
|
|
879
|
+
"status": {
|
|
880
|
+
"type": "string",
|
|
881
|
+
"description": "Filter log entries by status",
|
|
882
|
+
"enum": [
|
|
883
|
+
"Successful",
|
|
884
|
+
"Failed"
|
|
885
|
+
]
|
|
886
|
+
},
|
|
887
|
+
"sender": {
|
|
888
|
+
"type": "string",
|
|
889
|
+
"description": "Filter log entries by sender. Accepts a full email address or a domain."
|
|
890
|
+
},
|
|
891
|
+
"recipient": {
|
|
892
|
+
"type": "string",
|
|
893
|
+
"description": "Filter log entries by recipient. Accepts a full email address or a domain."
|
|
894
|
+
},
|
|
895
|
+
"page": {
|
|
896
|
+
"type": "integer",
|
|
897
|
+
"description": "Page number"
|
|
898
|
+
},
|
|
899
|
+
"per_page": {
|
|
900
|
+
"type": "integer",
|
|
901
|
+
"description": "Number of items per page"
|
|
902
|
+
}
|
|
903
|
+
},
|
|
904
|
+
"required": [
|
|
905
|
+
"orderId"
|
|
906
|
+
]
|
|
907
|
+
},
|
|
908
|
+
"security": [
|
|
909
|
+
{
|
|
910
|
+
"apiToken": []
|
|
911
|
+
}
|
|
912
|
+
],
|
|
913
|
+
"group": "mail"
|
|
914
|
+
},
|
|
915
|
+
{
|
|
916
|
+
"name": "mail_listMailboxActionLogsV1",
|
|
917
|
+
"title": "List mailbox action logs",
|
|
918
|
+
"annotations": {
|
|
919
|
+
"title": "List mailbox action logs",
|
|
920
|
+
"readOnlyHint": true,
|
|
921
|
+
"destructiveHint": false
|
|
922
|
+
},
|
|
923
|
+
"description": "Retrieve paginated mailbox action logs (message and mailbox events)\nfor a mailbox in the given mail order. The mailbox email must belong\nto the order's domain. Supports date range and event type filters.\nResults are sorted by timestamp descending.",
|
|
924
|
+
"method": "GET",
|
|
925
|
+
"path": "/api/mail/v1/orders/{orderId}/logs/mailbox-actions",
|
|
926
|
+
"inputSchema": {
|
|
927
|
+
"type": "object",
|
|
928
|
+
"properties": {
|
|
929
|
+
"orderId": {
|
|
930
|
+
"type": "string",
|
|
931
|
+
"description": "Order resource ID"
|
|
932
|
+
},
|
|
933
|
+
"email": {
|
|
934
|
+
"type": "string",
|
|
935
|
+
"description": "Mailbox email address. Must belong to the order's domain."
|
|
936
|
+
},
|
|
937
|
+
"date": {
|
|
938
|
+
"type": "string",
|
|
939
|
+
"description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
|
|
940
|
+
},
|
|
941
|
+
"from_date": {
|
|
942
|
+
"type": "string",
|
|
943
|
+
"description": "Date range start (RFC 3339)"
|
|
944
|
+
},
|
|
945
|
+
"to_date": {
|
|
946
|
+
"type": "string",
|
|
947
|
+
"description": "Date range end (RFC 3339)"
|
|
948
|
+
},
|
|
949
|
+
"event": {
|
|
950
|
+
"type": "string",
|
|
951
|
+
"description": "Filter mailbox action log entries by event type",
|
|
952
|
+
"enum": [
|
|
953
|
+
"MessageNew",
|
|
954
|
+
"MessageRead",
|
|
955
|
+
"MessageAppend",
|
|
956
|
+
"MessageExpunge",
|
|
957
|
+
"MailboxCreate",
|
|
958
|
+
"MailboxDelete",
|
|
959
|
+
"MailboxRename"
|
|
960
|
+
]
|
|
961
|
+
},
|
|
962
|
+
"page": {
|
|
963
|
+
"type": "integer",
|
|
964
|
+
"description": "Page number"
|
|
965
|
+
},
|
|
966
|
+
"per_page": {
|
|
967
|
+
"type": "integer",
|
|
968
|
+
"description": "Number of items per page"
|
|
969
|
+
}
|
|
970
|
+
},
|
|
971
|
+
"required": [
|
|
972
|
+
"orderId",
|
|
973
|
+
"email"
|
|
974
|
+
]
|
|
975
|
+
},
|
|
976
|
+
"security": [
|
|
977
|
+
{
|
|
978
|
+
"apiToken": []
|
|
979
|
+
}
|
|
980
|
+
],
|
|
981
|
+
"group": "mail"
|
|
982
|
+
},
|
|
983
|
+
{
|
|
984
|
+
"name": "mail_listOutboundLogsV1",
|
|
985
|
+
"title": "List outbound logs",
|
|
986
|
+
"annotations": {
|
|
987
|
+
"title": "List outbound logs",
|
|
988
|
+
"readOnlyHint": true,
|
|
989
|
+
"destructiveHint": false
|
|
990
|
+
},
|
|
991
|
+
"description": "Retrieve paginated outbound (sent mail) delivery logs for the domain\nattached to the given mail order. Supports filtering by account, date\nrange, status, sender, and recipient. Results are sorted by timestamp\ndescending.",
|
|
992
|
+
"method": "GET",
|
|
993
|
+
"path": "/api/mail/v1/orders/{orderId}/logs/outbound",
|
|
994
|
+
"inputSchema": {
|
|
995
|
+
"type": "object",
|
|
996
|
+
"properties": {
|
|
997
|
+
"orderId": {
|
|
998
|
+
"type": "string",
|
|
999
|
+
"description": "Order resource ID"
|
|
1000
|
+
},
|
|
1001
|
+
"account": {
|
|
1002
|
+
"type": "string",
|
|
1003
|
+
"description": "Filter log entries by a specific email account"
|
|
1004
|
+
},
|
|
1005
|
+
"date": {
|
|
1006
|
+
"type": "string",
|
|
1007
|
+
"description": "Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given."
|
|
1008
|
+
},
|
|
1009
|
+
"from_date": {
|
|
1010
|
+
"type": "string",
|
|
1011
|
+
"description": "Date range start (RFC 3339)"
|
|
1012
|
+
},
|
|
1013
|
+
"to_date": {
|
|
1014
|
+
"type": "string",
|
|
1015
|
+
"description": "Date range end (RFC 3339)"
|
|
1016
|
+
},
|
|
1017
|
+
"status": {
|
|
1018
|
+
"type": "string",
|
|
1019
|
+
"description": "Filter log entries by status",
|
|
1020
|
+
"enum": [
|
|
1021
|
+
"Successful",
|
|
1022
|
+
"Failed"
|
|
1023
|
+
]
|
|
1024
|
+
},
|
|
1025
|
+
"sender": {
|
|
1026
|
+
"type": "string",
|
|
1027
|
+
"description": "Filter log entries by sender. Accepts a full email address or a domain."
|
|
1028
|
+
},
|
|
1029
|
+
"recipient": {
|
|
1030
|
+
"type": "string",
|
|
1031
|
+
"description": "Filter log entries by recipient. Accepts a full email address or a domain."
|
|
1032
|
+
},
|
|
1033
|
+
"page": {
|
|
1034
|
+
"type": "integer",
|
|
1035
|
+
"description": "Page number"
|
|
1036
|
+
},
|
|
1037
|
+
"per_page": {
|
|
1038
|
+
"type": "integer",
|
|
1039
|
+
"description": "Number of items per page"
|
|
1040
|
+
}
|
|
1041
|
+
},
|
|
1042
|
+
"required": [
|
|
1043
|
+
"orderId"
|
|
1044
|
+
]
|
|
1045
|
+
},
|
|
1046
|
+
"security": [
|
|
1047
|
+
{
|
|
1048
|
+
"apiToken": []
|
|
1049
|
+
}
|
|
1050
|
+
],
|
|
1051
|
+
"group": "mail"
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"name": "mail_listMailboxesV1",
|
|
1055
|
+
"title": "List mailboxes",
|
|
1056
|
+
"annotations": {
|
|
1057
|
+
"title": "List mailboxes",
|
|
1058
|
+
"readOnlyHint": true,
|
|
1059
|
+
"destructiveHint": false
|
|
1060
|
+
},
|
|
1061
|
+
"description": "Retrieve a paginated list of mailboxes belonging to a mail order.\n\nUse this endpoint to monitor mailboxes of your mail service, including\ntheir status, enabled protocols, attached resource counts, and\nperiodically synced usage numbers (usage may lag behind live values).",
|
|
1062
|
+
"method": "GET",
|
|
1063
|
+
"path": "/api/mail/v1/orders/{orderId}/mailboxes",
|
|
1064
|
+
"inputSchema": {
|
|
1065
|
+
"type": "object",
|
|
1066
|
+
"properties": {
|
|
1067
|
+
"orderId": {
|
|
1068
|
+
"type": "string",
|
|
1069
|
+
"description": "Order resource ID"
|
|
1070
|
+
},
|
|
1071
|
+
"search": {
|
|
1072
|
+
"type": "string",
|
|
1073
|
+
"description": "Filter mailboxes whose email address contains the given string"
|
|
1074
|
+
},
|
|
1075
|
+
"sort": {
|
|
1076
|
+
"type": "string",
|
|
1077
|
+
"description": "Sort mailboxes by field. Prefix with `-` for descending order.",
|
|
1078
|
+
"enum": [
|
|
1079
|
+
"address",
|
|
1080
|
+
"-address"
|
|
1081
|
+
]
|
|
1082
|
+
},
|
|
1083
|
+
"page": {
|
|
1084
|
+
"type": "integer",
|
|
1085
|
+
"description": "Page number"
|
|
1086
|
+
},
|
|
1087
|
+
"per_page": {
|
|
1088
|
+
"type": "integer",
|
|
1089
|
+
"description": "Number of items per page"
|
|
1090
|
+
}
|
|
1091
|
+
},
|
|
1092
|
+
"required": [
|
|
1093
|
+
"orderId"
|
|
1094
|
+
]
|
|
1095
|
+
},
|
|
1096
|
+
"security": [
|
|
1097
|
+
{
|
|
1098
|
+
"apiToken": []
|
|
1099
|
+
}
|
|
1100
|
+
],
|
|
1101
|
+
"group": "mail"
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
"name": "mail_createMailboxV1",
|
|
1105
|
+
"title": "Create mailbox",
|
|
1106
|
+
"annotations": {
|
|
1107
|
+
"title": "Create mailbox",
|
|
1108
|
+
"readOnlyHint": false,
|
|
1109
|
+
"destructiveHint": false
|
|
1110
|
+
},
|
|
1111
|
+
"description": "Create a mailbox under the given mail order. The full email address is\ncomposed from the given local part and the domain of the order.",
|
|
1112
|
+
"method": "POST",
|
|
1113
|
+
"path": "/api/mail/v1/orders/{orderId}/mailboxes",
|
|
1114
|
+
"inputSchema": {
|
|
1115
|
+
"type": "object",
|
|
1116
|
+
"properties": {
|
|
1117
|
+
"orderId": {
|
|
1118
|
+
"type": "string",
|
|
1119
|
+
"description": "Order resource ID"
|
|
1120
|
+
},
|
|
1121
|
+
"local_part": {
|
|
1122
|
+
"type": "string",
|
|
1123
|
+
"description": "Local part of the mailbox address (the part before the @). The domain is taken from the order. Must start and end with a letter or digit; single dots, underscores and hyphens are allowed in between."
|
|
1124
|
+
},
|
|
1125
|
+
"password": {
|
|
1126
|
+
"type": "string",
|
|
1127
|
+
"description": "Mailbox password. Minimum 8 characters with uppercase, lowercase, number and special character."
|
|
1128
|
+
}
|
|
1129
|
+
},
|
|
1130
|
+
"required": [
|
|
1131
|
+
"orderId",
|
|
1132
|
+
"local_part",
|
|
1133
|
+
"password"
|
|
1134
|
+
]
|
|
1135
|
+
},
|
|
1136
|
+
"security": [
|
|
1137
|
+
{
|
|
1138
|
+
"apiToken": []
|
|
1139
|
+
}
|
|
1140
|
+
],
|
|
1141
|
+
"group": "mail"
|
|
1142
|
+
},
|
|
1143
|
+
{
|
|
1144
|
+
"name": "mail_deleteMailboxV1",
|
|
1145
|
+
"title": "Delete mailbox",
|
|
1146
|
+
"annotations": {
|
|
1147
|
+
"title": "Delete mailbox",
|
|
1148
|
+
"readOnlyHint": false,
|
|
1149
|
+
"destructiveHint": true,
|
|
1150
|
+
"idempotentHint": true
|
|
1151
|
+
},
|
|
1152
|
+
"description": "Delete a mailbox. The mailbox is soft-deleted and stays restorable\nfor a limited period before it is permanently removed.",
|
|
1153
|
+
"method": "DELETE",
|
|
1154
|
+
"path": "/api/mail/v1/mailboxes/{mailboxId}",
|
|
1155
|
+
"inputSchema": {
|
|
1156
|
+
"type": "object",
|
|
1157
|
+
"properties": {
|
|
1158
|
+
"mailboxId": {
|
|
1159
|
+
"type": "string",
|
|
1160
|
+
"description": "Mailbox resource ID"
|
|
1161
|
+
}
|
|
1162
|
+
},
|
|
1163
|
+
"required": [
|
|
1164
|
+
"mailboxId"
|
|
1165
|
+
]
|
|
1166
|
+
},
|
|
1167
|
+
"security": [
|
|
1168
|
+
{
|
|
1169
|
+
"apiToken": []
|
|
1170
|
+
}
|
|
1171
|
+
],
|
|
1172
|
+
"group": "mail"
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"name": "mail_changeMailboxPasswordV1",
|
|
1176
|
+
"title": "Change mailbox password",
|
|
1177
|
+
"annotations": {
|
|
1178
|
+
"title": "Change mailbox password",
|
|
1179
|
+
"readOnlyHint": false,
|
|
1180
|
+
"destructiveHint": true,
|
|
1181
|
+
"idempotentHint": true
|
|
1182
|
+
},
|
|
1183
|
+
"description": "Change the password of a mailbox.",
|
|
1184
|
+
"method": "PATCH",
|
|
1185
|
+
"path": "/api/mail/v1/mailboxes/{mailboxId}/password",
|
|
1186
|
+
"inputSchema": {
|
|
1187
|
+
"type": "object",
|
|
1188
|
+
"properties": {
|
|
1189
|
+
"mailboxId": {
|
|
1190
|
+
"type": "string",
|
|
1191
|
+
"description": "Mailbox resource ID"
|
|
1192
|
+
},
|
|
1193
|
+
"password": {
|
|
1194
|
+
"type": "string",
|
|
1195
|
+
"description": "New mailbox password. Minimum 8 characters with uppercase, lowercase, number and special character; must not be a commonly used password."
|
|
1196
|
+
}
|
|
1197
|
+
},
|
|
1198
|
+
"required": [
|
|
1199
|
+
"mailboxId",
|
|
1200
|
+
"password"
|
|
1201
|
+
]
|
|
1202
|
+
},
|
|
1203
|
+
"security": [
|
|
1204
|
+
{
|
|
1205
|
+
"apiToken": []
|
|
1206
|
+
}
|
|
1207
|
+
],
|
|
1208
|
+
"group": "mail"
|
|
1209
|
+
},
|
|
1210
|
+
{
|
|
1211
|
+
"name": "mail_listOrdersV1",
|
|
1212
|
+
"title": "List orders",
|
|
1213
|
+
"annotations": {
|
|
1214
|
+
"title": "List orders",
|
|
1215
|
+
"readOnlyHint": true,
|
|
1216
|
+
"destructiveHint": false
|
|
1217
|
+
},
|
|
1218
|
+
"description": "Retrieve a paginated list of mail orders associated with your account.\n\nUse this endpoint to monitor your mail services, including their status,\nplan, attached domain, and expiration details.",
|
|
1219
|
+
"method": "GET",
|
|
1220
|
+
"path": "/api/mail/v1/orders",
|
|
1221
|
+
"inputSchema": {
|
|
1222
|
+
"type": "object",
|
|
1223
|
+
"properties": {
|
|
1224
|
+
"domain": {
|
|
1225
|
+
"type": "string",
|
|
1226
|
+
"description": "Filter orders by domain name (exact match)"
|
|
1227
|
+
},
|
|
1228
|
+
"status": {
|
|
1229
|
+
"type": "string",
|
|
1230
|
+
"description": "Filter orders by status",
|
|
1231
|
+
"enum": [
|
|
1232
|
+
"pending_setup",
|
|
1233
|
+
"active",
|
|
1234
|
+
"suspended"
|
|
1235
|
+
]
|
|
1236
|
+
},
|
|
1237
|
+
"is_trial": {
|
|
1238
|
+
"type": "boolean",
|
|
1239
|
+
"description": "Filter orders by trial state"
|
|
1240
|
+
},
|
|
1241
|
+
"sort": {
|
|
1242
|
+
"type": "string",
|
|
1243
|
+
"description": "Sort orders by field. Prefix with `-` for descending order.",
|
|
1244
|
+
"enum": [
|
|
1245
|
+
"created_at",
|
|
1246
|
+
"-created_at",
|
|
1247
|
+
"expires_at",
|
|
1248
|
+
"-expires_at"
|
|
1249
|
+
]
|
|
1250
|
+
},
|
|
1251
|
+
"page": {
|
|
1252
|
+
"type": "integer",
|
|
1253
|
+
"description": "Page number"
|
|
1254
|
+
},
|
|
1255
|
+
"per_page": {
|
|
1256
|
+
"type": "integer",
|
|
1257
|
+
"description": "Number of items per page"
|
|
1258
|
+
}
|
|
1259
|
+
},
|
|
1260
|
+
"required": []
|
|
1261
|
+
},
|
|
1262
|
+
"security": [
|
|
1263
|
+
{
|
|
1264
|
+
"apiToken": []
|
|
1265
|
+
}
|
|
1266
|
+
],
|
|
1267
|
+
"group": "mail"
|
|
1268
|
+
},
|
|
1269
|
+
{
|
|
1270
|
+
"name": "mail_getOrderPlanV1",
|
|
1271
|
+
"title": "Get order plan",
|
|
1272
|
+
"annotations": {
|
|
1273
|
+
"title": "Get order plan",
|
|
1274
|
+
"readOnlyHint": true,
|
|
1275
|
+
"destructiveHint": false
|
|
1276
|
+
},
|
|
1277
|
+
"description": "Retrieve the plan the given mail order was purchased with, including\ndomain-level and mailbox-level quotas, limits, and protocol\navailability.",
|
|
1278
|
+
"method": "GET",
|
|
1279
|
+
"path": "/api/mail/v1/orders/{orderId}/plan",
|
|
1280
|
+
"inputSchema": {
|
|
1281
|
+
"type": "object",
|
|
1282
|
+
"properties": {
|
|
1283
|
+
"orderId": {
|
|
1284
|
+
"type": "string",
|
|
1285
|
+
"description": "Order resource ID"
|
|
1286
|
+
}
|
|
1287
|
+
},
|
|
1288
|
+
"required": [
|
|
1289
|
+
"orderId"
|
|
1290
|
+
]
|
|
1291
|
+
},
|
|
1292
|
+
"security": [
|
|
1293
|
+
{
|
|
1294
|
+
"apiToken": []
|
|
1295
|
+
}
|
|
1296
|
+
],
|
|
1297
|
+
"group": "mail"
|
|
1298
|
+
},
|
|
1299
|
+
{
|
|
1300
|
+
"name": "mail_createWebhookV1",
|
|
1301
|
+
"title": "Create webhook",
|
|
1302
|
+
"annotations": {
|
|
1303
|
+
"title": "Create webhook",
|
|
1304
|
+
"readOnlyHint": false,
|
|
1305
|
+
"destructiveHint": false
|
|
1306
|
+
},
|
|
1307
|
+
"description": "Create a webhook for the given mailbox. The generated secret is\nreturned only in this response and is sent as a bearer token with\nevery delivery.",
|
|
1308
|
+
"method": "POST",
|
|
1309
|
+
"path": "/api/mail/v1/mailboxes/{mailboxId}/webhooks",
|
|
1310
|
+
"inputSchema": {
|
|
1311
|
+
"type": "object",
|
|
1312
|
+
"properties": {
|
|
1313
|
+
"mailboxId": {
|
|
1314
|
+
"type": "string",
|
|
1315
|
+
"description": "Mailbox resource ID"
|
|
1316
|
+
},
|
|
1317
|
+
"name": {
|
|
1318
|
+
"type": "string",
|
|
1319
|
+
"description": "Human-readable name for this webhook"
|
|
1320
|
+
},
|
|
1321
|
+
"description": {
|
|
1322
|
+
"type": "string",
|
|
1323
|
+
"description": "Optional description of the webhook's purpose"
|
|
1324
|
+
},
|
|
1325
|
+
"events": {
|
|
1326
|
+
"type": "array",
|
|
1327
|
+
"description": "Events that trigger this webhook",
|
|
1328
|
+
"items": {
|
|
1329
|
+
"type": "string",
|
|
1330
|
+
"description": "events parameter",
|
|
1331
|
+
"enum": [
|
|
1332
|
+
"message.received"
|
|
1333
|
+
]
|
|
1334
|
+
}
|
|
1335
|
+
},
|
|
1336
|
+
"status": {
|
|
1337
|
+
"type": "string",
|
|
1338
|
+
"description": "Initial status of the webhook",
|
|
1339
|
+
"enum": [
|
|
1340
|
+
"active",
|
|
1341
|
+
"disabled",
|
|
1342
|
+
"paused"
|
|
1343
|
+
]
|
|
1344
|
+
},
|
|
1345
|
+
"url": {
|
|
1346
|
+
"type": "string",
|
|
1347
|
+
"description": "Publicly reachable URL that receives the webhook POST requests"
|
|
1348
|
+
}
|
|
1349
|
+
},
|
|
1350
|
+
"required": [
|
|
1351
|
+
"mailboxId",
|
|
1352
|
+
"name",
|
|
1353
|
+
"events",
|
|
1354
|
+
"url"
|
|
1355
|
+
]
|
|
1356
|
+
},
|
|
1357
|
+
"security": [
|
|
1358
|
+
{
|
|
1359
|
+
"apiToken": []
|
|
1360
|
+
}
|
|
1361
|
+
],
|
|
1362
|
+
"group": "mail"
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
"name": "mail_listWebhookDeliveryLogsV1",
|
|
1366
|
+
"title": "List webhook delivery logs",
|
|
1367
|
+
"annotations": {
|
|
1368
|
+
"title": "List webhook delivery logs",
|
|
1369
|
+
"readOnlyHint": true,
|
|
1370
|
+
"destructiveHint": false
|
|
1371
|
+
},
|
|
1372
|
+
"description": "Retrieve a paginated list of webhook delivery logs for the given mail\norder, including delivery outcome, duration, and retry counts.\nSupports filtering by mailbox.",
|
|
1373
|
+
"method": "GET",
|
|
1374
|
+
"path": "/api/mail/v1/orders/{orderId}/webhooks/delivery-logs",
|
|
1375
|
+
"inputSchema": {
|
|
1376
|
+
"type": "object",
|
|
1377
|
+
"properties": {
|
|
1378
|
+
"orderId": {
|
|
1379
|
+
"type": "string",
|
|
1380
|
+
"description": "Order resource ID"
|
|
1381
|
+
},
|
|
1382
|
+
"mailbox_id": {
|
|
1383
|
+
"type": "string",
|
|
1384
|
+
"description": "Filter by the mailbox resource ID the webhooks are attached to"
|
|
1385
|
+
},
|
|
1386
|
+
"page": {
|
|
1387
|
+
"type": "integer",
|
|
1388
|
+
"description": "Page number"
|
|
1389
|
+
},
|
|
1390
|
+
"per_page": {
|
|
1391
|
+
"type": "integer",
|
|
1392
|
+
"description": "Number of items per page"
|
|
1393
|
+
}
|
|
1394
|
+
},
|
|
1395
|
+
"required": [
|
|
1396
|
+
"orderId"
|
|
1397
|
+
]
|
|
1398
|
+
},
|
|
1399
|
+
"security": [
|
|
1400
|
+
{
|
|
1401
|
+
"apiToken": []
|
|
1402
|
+
}
|
|
1403
|
+
],
|
|
1404
|
+
"group": "mail"
|
|
1405
|
+
},
|
|
1406
|
+
{
|
|
1407
|
+
"name": "mail_getWebhookV1",
|
|
1408
|
+
"title": "Get webhook",
|
|
1409
|
+
"annotations": {
|
|
1410
|
+
"title": "Get webhook",
|
|
1411
|
+
"readOnlyHint": true,
|
|
1412
|
+
"destructiveHint": false
|
|
1413
|
+
},
|
|
1414
|
+
"description": "Retrieve the details of a single webhook. The webhook secret is never\nincluded; it is returned only when a webhook is created or its secret\nis regenerated.",
|
|
1415
|
+
"method": "GET",
|
|
1416
|
+
"path": "/api/mail/v1/webhooks/{webhookId}",
|
|
1417
|
+
"inputSchema": {
|
|
1418
|
+
"type": "object",
|
|
1419
|
+
"properties": {
|
|
1420
|
+
"webhookId": {
|
|
1421
|
+
"type": "string",
|
|
1422
|
+
"description": "Webhook ID (returned when the webhook was created)"
|
|
1423
|
+
}
|
|
1424
|
+
},
|
|
1425
|
+
"required": [
|
|
1426
|
+
"webhookId"
|
|
1427
|
+
]
|
|
1428
|
+
},
|
|
1429
|
+
"security": [
|
|
1430
|
+
{
|
|
1431
|
+
"apiToken": []
|
|
1432
|
+
}
|
|
1433
|
+
],
|
|
1434
|
+
"group": "mail"
|
|
1435
|
+
},
|
|
1436
|
+
{
|
|
1437
|
+
"name": "mail_deleteWebhookV1",
|
|
1438
|
+
"title": "Delete webhook",
|
|
1439
|
+
"annotations": {
|
|
1440
|
+
"title": "Delete webhook",
|
|
1441
|
+
"readOnlyHint": false,
|
|
1442
|
+
"destructiveHint": true,
|
|
1443
|
+
"idempotentHint": true
|
|
1444
|
+
},
|
|
1445
|
+
"description": "Permanently delete a webhook. This action cannot be undone. After\ndeletion the URL no longer receives event notifications.",
|
|
1446
|
+
"method": "DELETE",
|
|
1447
|
+
"path": "/api/mail/v1/webhooks/{webhookId}",
|
|
1448
|
+
"inputSchema": {
|
|
1449
|
+
"type": "object",
|
|
1450
|
+
"properties": {
|
|
1451
|
+
"webhookId": {
|
|
1452
|
+
"type": "string",
|
|
1453
|
+
"description": "Webhook ID (returned when the webhook was created)"
|
|
1454
|
+
}
|
|
1455
|
+
},
|
|
1456
|
+
"required": [
|
|
1457
|
+
"webhookId"
|
|
1458
|
+
]
|
|
1459
|
+
},
|
|
1460
|
+
"security": [
|
|
1461
|
+
{
|
|
1462
|
+
"apiToken": []
|
|
1463
|
+
}
|
|
1464
|
+
],
|
|
1465
|
+
"group": "mail"
|
|
1466
|
+
},
|
|
1467
|
+
{
|
|
1468
|
+
"name": "mail_updateWebhookV1",
|
|
1469
|
+
"title": "Update webhook",
|
|
1470
|
+
"annotations": {
|
|
1471
|
+
"title": "Update webhook",
|
|
1472
|
+
"readOnlyHint": false,
|
|
1473
|
+
"destructiveHint": true,
|
|
1474
|
+
"idempotentHint": true
|
|
1475
|
+
},
|
|
1476
|
+
"description": "Partially update a webhook. Only the fields included in the request\nbody are changed; omitted fields retain their current values. Pass\n`\"description\": null` to clear the description.",
|
|
1477
|
+
"method": "PATCH",
|
|
1478
|
+
"path": "/api/mail/v1/webhooks/{webhookId}",
|
|
1479
|
+
"inputSchema": {
|
|
1480
|
+
"type": "object",
|
|
1481
|
+
"properties": {
|
|
1482
|
+
"webhookId": {
|
|
1483
|
+
"type": "string",
|
|
1484
|
+
"description": "Webhook ID (returned when the webhook was created)"
|
|
1485
|
+
},
|
|
1486
|
+
"name": {
|
|
1487
|
+
"type": "string",
|
|
1488
|
+
"description": "New human-readable name for the webhook"
|
|
1489
|
+
},
|
|
1490
|
+
"description": {
|
|
1491
|
+
"type": "string",
|
|
1492
|
+
"description": "New description, or null to clear it"
|
|
1493
|
+
},
|
|
1494
|
+
"events": {
|
|
1495
|
+
"type": "array",
|
|
1496
|
+
"description": "Replaces the full list of subscribed events",
|
|
1497
|
+
"items": {
|
|
1498
|
+
"type": "string",
|
|
1499
|
+
"description": "events parameter",
|
|
1500
|
+
"enum": [
|
|
1501
|
+
"message.received"
|
|
1502
|
+
]
|
|
1503
|
+
}
|
|
1504
|
+
},
|
|
1505
|
+
"status": {
|
|
1506
|
+
"type": "string",
|
|
1507
|
+
"description": "New status for the webhook",
|
|
1508
|
+
"enum": [
|
|
1509
|
+
"active",
|
|
1510
|
+
"disabled",
|
|
1511
|
+
"paused"
|
|
1512
|
+
]
|
|
1513
|
+
},
|
|
1514
|
+
"url": {
|
|
1515
|
+
"type": "string",
|
|
1516
|
+
"description": "New URL to deliver events to"
|
|
1517
|
+
}
|
|
1518
|
+
},
|
|
1519
|
+
"required": [
|
|
1520
|
+
"webhookId"
|
|
1521
|
+
]
|
|
1522
|
+
},
|
|
1523
|
+
"security": [
|
|
1524
|
+
{
|
|
1525
|
+
"apiToken": []
|
|
1526
|
+
}
|
|
1527
|
+
],
|
|
1528
|
+
"group": "mail"
|
|
1529
|
+
},
|
|
1530
|
+
{
|
|
1531
|
+
"name": "mail_listWebhooksV1",
|
|
1532
|
+
"title": "List webhooks",
|
|
1533
|
+
"annotations": {
|
|
1534
|
+
"title": "List webhooks",
|
|
1535
|
+
"readOnlyHint": true,
|
|
1536
|
+
"destructiveHint": false
|
|
1537
|
+
},
|
|
1538
|
+
"description": "Retrieve a paginated list of webhooks belonging to the given mail\norder. Supports filtering by mailbox and status. The webhook secret\nis never included; it is returned only when a webhook is created or\nits secret is regenerated.",
|
|
1539
|
+
"method": "GET",
|
|
1540
|
+
"path": "/api/mail/v1/orders/{orderId}/webhooks",
|
|
1541
|
+
"inputSchema": {
|
|
1542
|
+
"type": "object",
|
|
1543
|
+
"properties": {
|
|
1544
|
+
"orderId": {
|
|
1545
|
+
"type": "string",
|
|
1546
|
+
"description": "Order resource ID"
|
|
1547
|
+
},
|
|
1548
|
+
"mailbox_id": {
|
|
1549
|
+
"type": "string",
|
|
1550
|
+
"description": "Filter by the mailbox resource ID the webhooks are attached to"
|
|
1551
|
+
},
|
|
1552
|
+
"status": {
|
|
1553
|
+
"type": "string",
|
|
1554
|
+
"description": "Filter webhooks by status",
|
|
1555
|
+
"enum": [
|
|
1556
|
+
"active",
|
|
1557
|
+
"disabled",
|
|
1558
|
+
"paused"
|
|
1559
|
+
]
|
|
1560
|
+
},
|
|
1561
|
+
"page": {
|
|
1562
|
+
"type": "integer",
|
|
1563
|
+
"description": "Page number"
|
|
1564
|
+
},
|
|
1565
|
+
"per_page": {
|
|
1566
|
+
"type": "integer",
|
|
1567
|
+
"description": "Number of items per page"
|
|
1568
|
+
}
|
|
1569
|
+
},
|
|
1570
|
+
"required": [
|
|
1571
|
+
"orderId"
|
|
1572
|
+
]
|
|
1573
|
+
},
|
|
1574
|
+
"security": [
|
|
1575
|
+
{
|
|
1576
|
+
"apiToken": []
|
|
1577
|
+
}
|
|
1578
|
+
],
|
|
1579
|
+
"group": "mail"
|
|
1580
|
+
},
|
|
1581
|
+
{
|
|
1582
|
+
"name": "mail_regenerateWebhookSecretV1",
|
|
1583
|
+
"title": "Regenerate webhook secret",
|
|
1584
|
+
"annotations": {
|
|
1585
|
+
"title": "Regenerate webhook secret",
|
|
1586
|
+
"readOnlyHint": false,
|
|
1587
|
+
"destructiveHint": false
|
|
1588
|
+
},
|
|
1589
|
+
"description": "Regenerate the secret of a webhook. The previous secret is\nimmediately invalidated. The new secret is returned only in this\nresponse and is sent as a bearer token with every delivery.",
|
|
1590
|
+
"method": "POST",
|
|
1591
|
+
"path": "/api/mail/v1/webhooks/{webhookId}/regenerate-secret",
|
|
1592
|
+
"inputSchema": {
|
|
1593
|
+
"type": "object",
|
|
1594
|
+
"properties": {
|
|
1595
|
+
"webhookId": {
|
|
1596
|
+
"type": "string",
|
|
1597
|
+
"description": "Webhook ID (returned when the webhook was created)"
|
|
1598
|
+
}
|
|
1599
|
+
},
|
|
1600
|
+
"required": [
|
|
1601
|
+
"webhookId"
|
|
1602
|
+
]
|
|
1603
|
+
},
|
|
1604
|
+
"security": [
|
|
1605
|
+
{
|
|
1606
|
+
"apiToken": []
|
|
1607
|
+
}
|
|
1608
|
+
],
|
|
1609
|
+
"group": "mail"
|
|
1610
|
+
},
|
|
1611
|
+
{
|
|
1612
|
+
"name": "mail_testWebhookV1",
|
|
1613
|
+
"title": "Test webhook",
|
|
1614
|
+
"annotations": {
|
|
1615
|
+
"title": "Test webhook",
|
|
1616
|
+
"readOnlyHint": false,
|
|
1617
|
+
"destructiveHint": false
|
|
1618
|
+
},
|
|
1619
|
+
"description": "Send a test delivery to the webhook URL and return the result. Test\nrequests are rate limited upstream.",
|
|
1620
|
+
"method": "POST",
|
|
1621
|
+
"path": "/api/mail/v1/webhooks/{webhookId}/test",
|
|
1622
|
+
"inputSchema": {
|
|
1623
|
+
"type": "object",
|
|
1624
|
+
"properties": {
|
|
1625
|
+
"webhookId": {
|
|
1626
|
+
"type": "string",
|
|
1627
|
+
"description": "Webhook ID (returned when the webhook was created)"
|
|
1628
|
+
}
|
|
1629
|
+
},
|
|
1630
|
+
"required": [
|
|
1631
|
+
"webhookId"
|
|
1632
|
+
]
|
|
1633
|
+
},
|
|
1634
|
+
"security": [
|
|
1635
|
+
{
|
|
1636
|
+
"apiToken": []
|
|
1637
|
+
}
|
|
1638
|
+
],
|
|
1639
|
+
"group": "mail"
|
|
1640
|
+
}
|
|
1641
|
+
];
|