-
Notifications
You must be signed in to change notification settings - Fork 89
/
apiary.apib
315 lines (247 loc) · 10.1 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
FORMAT: 1A
HOST: https://www.ahem.email
# AHEM - Ad Hoc Email
[AHEM](https://www.ahem.email) is an ad hoc disposable and temporary email service. It allows receiving email at an ad-hoc created email, created on the fly when an email is received by our server.
Using the AHEM service allows you to prevent spam to your real email, and to test products that send email as part of their lifecycle.
An access token is needed for most API calls. Get an access token by calling /api/auth/token.
Use the token in the Authorization header as a Bearer token.
## alive [/api/alive]
### Get system check results [GET]
+ Response 200 (application/json)
{
"success": true,
"api": true,
"smtp": true,
"db": true
}
## properties [/api/properties]
### Get server properties [GET]
+ Response 200 (application/json)
{
"serverBaseUri":"https://www.ahem.email",
"emailDeleteInterval":86400,
"emailDeleteAge":7200,
"allowedDomains":[
"ahem.email",
"mail.ahem.email",
"ahem-email.com"
],
"allowAutocomplete":false,
"customText": null
}
## authentication [/api/auth/token]
### Get access token [POST]
+ Request (application/json)
+ Body
{}
+ Response 200 (application/json)
{
"success":true,
"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpcCI6Ijo6MSIsImlhdCI6MTUzOTU1NTI5NCwiZXhwIjoxNTM5NTU4ODk0fQ.Y8FhYY5OGbHNn6EOcrF81swX3xeLF4t7Q6F5L7z6Xdg",
}
## Mailbox [/api/mailbox/{mailboxName}/email]
### get a mailbox's emails list [GET]
+ Parameters
+ mailboxName: mailboxName (string, required) - mailbox name.
+ Request
+ Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpcCI6Ijo6MSIsImlhdCI6MTUzOTU1NTI5NCwiZXhwIjoxNTM5NTU4ODk0fQ.Y8FhYY5OGbHNn6EOcrF81swX3xeLF4t7Q6F5L7z6Xdg
+ Response 200 (application/json)
[
{
"emailId":"5bc3c17cb76d8f4e1099725c",
"sender":
{
"address":"test@my.domain.com",
"name":"AHEM Test!"
},
"subject":"AHEM mail test!",
"timestamp":1539555708477,
"isRead":true
}
]
+ Response 404 (application/json)
{
error: "MAILBOX IS EMPTY!"
}
+ Response 401 (application/json)
{
"success": false,
"message": "No token provided."
}
## Email [/api/mailbox/{mailboxName}/email/{emailId}]
### Get an email's content [GET]
+ Parameters
+ mailboxName: mailboxName (string, required) - mailbox name.
+ emailId: emailId (string, required) - mailbox name.
+ Request
+ Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpcCI6Ijo6MSIsImlhdCI6MTUzOTU1NTI5NCwiZXhwIjoxNTM5NTU4ODk0fQ.Y8FhYY5OGbHNn6EOcrF81swX3xeLF4t7Q6F5L7z6Xdg
+ Response 200 (application/json)
{
"_id": "5bc64017002e254f65eb37ef",
"attachments": [
{
"type": "attachment",
"content": "iVBORw0KGgoAAAANSUhEUgAAAfoAAAFkCAYAAADIefl6AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAACAASURBVHic7J13eFRV2sB/585MekIggQAJyaRAgACWIGAHFQXE3pB1RSyfvXfctaDr2ru7rq6ia9dV1w4qigKWVXQt2AqJCmyPszLl/0c8IQ3mc14/tXXMdCsQ6rBX1c+w8Qhx8xjeCyPbDOPNKP/ODxOQzrk/F5xqAJLlywJtCnwdF5entjUxq0UFBcTkSuQmCC",
"contentType": "image/png",
"release": null,
"contentDisposition": "attachment",
"filename": "ahem-happy.png",
"contentId": "<ahem-tester@mydomain.com>",
"cid": "ahem-tester@mydomain.com",
"related": true,
"headers": {
"content-type": {
"value": "image/png",
"params": {
"name": "ahem-happy.png"
}
},
"content-id": "<ahem-tester@mydomain.com>",
"content-transfer-encoding": "base64",
"content-disposition": {
"value": "attachment",
"params": {
"filename": "ahem-happy.png"
}
}
},
"checksum": "4ac3f7fa98c8c86bb1677f32279db7ad",
"size": 57654
}
],
"headers": {
"content-type": {
"value": "multipart/alternative",
"params": {
"boundary": "--_NmP-56cbf8151211f597-Part_1"
}
},
"from": {
"value": [
{
"address": "alive-test@my.domain.com",
"name": "AHEM Test!"
}
],
"html": "<span class=\"mp_address_group\"><span class=\"mp_address_name\">AHEM Test!</span> <<a href=\"mailto:alive-test@my.domain.com\" class=\"mp_address_email\">alive-test@my.domain.com</a>></span>",
"text": "AHEM Test! <alive-test@my.domain.com>"
},
"to": {
"value": [
{
"address": "alive-test@my.domain.com",
"name": ""
}
],
"html": "<span class=\"mp_address_group\"><a href=\"mailto:alive-test@my.domain.com\" class=\"mp_address_email\">alive-test@my.domain.com</a></span>",
"text": "alive-test@my.domain.com"
},
"subject": "AHEM mail test! ✔",
"message-id": "<c70341d4-2acc-ce06-d8ae-e2246e9e867e@my.domain.com>",
"date": "2018-10-16T19:46:31.000Z",
"mime-version": "1.0"
},
"headerLines": [
{
"key": "content-type",
"line": "Content-Type: multipart/alternative;\r\n boundary=\"--_NmP-56cbf8151211f597-Part_1\""
},
{
"key": "from",
"line": "From: \"AHEM Test!\" <alive-test@my.domain.com>"
},
{
"key": "to",
"line": "To: alive-test@my.domain.com"
},
{
"key": "subject",
"line": "Subject: =?UTF-8?Q?AHEM_mail_test!_=E2=9C=94?="
},
{
"key": "message-id",
"line": "Message-ID: <c70341d4-2acc-ce06-d8ae-e2246e9e867e@my.domain.com>"
},
{
"key": "date",
"line": "Date: Tue, 16 Oct 2018 19:46:31 +0000"
},
{
"key": "mime-version",
"line": "MIME-Version: 1.0"
}
],
"html": "<p><b>API Test:</b> <span style=\"color: darkgreen\">✔</span></p><p><b>SMTP Test:</b> <span style=\"color: darkgreen\">✔</span></p><p><b>DB Test:</b> <span style=\"color: darkgreen\">✔</span></p><p><br/></p>",
"text": "API: ✔ SMTP: ✔ DB: ✔",
"textAsHtml": "<p>API: ✔ SMTP: ✔ DB: ✔</p>",
"subject": "AHEM mail test! ✔",
"date": "2018-10-16T19:46:31.000Z",
"to": {
"value": [
{
"address": "alive-test@my.domain.com",
"name": ""
}
],
"html": "<span class=\"mp_address_group\"><a href=\"mailto:alive-test@my.domain.com\" class=\"mp_address_email\">alive-test@my.domain.com</a></span>",
"text": "alive-test@my.domain.com"
},
"from": {
"value": [
{
"address": "alive-test@my.domain.com",
"name": "AHEM Test!"
}
],
"html": "<span class=\"mp_address_group\"><span class=\"mp_address_name\">AHEM Test!</span> <<a href=\"mailto:alive-test@my.domain.com\" class=\"mp_address_email\">alive-test@my.domain.com</a>></span>",
"text": "AHEM Test! <alive-test@my.domain.com>"
},
"messageId": "<c70341d4-2acc-ce06-d8ae-e2246e9e867e@my.domain.com>",
"timestamp": 1539719191853
}
+ Response 404 (application/json)
{
error: "MAILBOX IS EMPTY!"
}
+ Response 500 (application/json)
{
"error": "error details"
}
### Delete an Email [DELETE]
+ Parameters
+ mailboxName: mailboxName (string, required) - mailbox name.
+ emailId: emailId (string, required) - mailbox name.
+ Request
+ Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpcCI6Ijo6MSIsImlhdCI6MTUzOTU1NTI5NCwiZXhwIjoxNTM5NTU4ODk0fQ.Y8FhYY5OGbHNn6EOcrF81swX3xeLF4t7Q6F5L7z6Xdg
+ Response 200 (application/json)
{
"success": true
}
+ Response 500 (application/json)
{
"error": "error details"
}
### Update an Email's metadata [PATCH]
+ Parameters
+ mailboxName: mailboxName (string, required) - mailbox name.
+ emailId: emailId (string, required) - mailbox name.
+ Request
+ Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpcCI6Ijo6MSIsImlhdCI6MTUzOTU1NTI5NCwiZXhwIjoxNTM5NTU4ODk0fQ.Y8FhYY5OGbHNn6EOcrF81swX3xeLF4t7Q6F5L7z6Xdg
+ Body
{
"isRead": true
}
+ Response 200 (application/json)
{
"n":1,
"nModified":0,
"ok":1
}
+ Response 500 (application/json)
{
"error": "error details"
}