-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathindex.js
More file actions
422 lines (399 loc) · 11.7 KB
/
index.js
File metadata and controls
422 lines (399 loc) · 11.7 KB
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
const express = require('express');
const cors = require('cors');
const dotenv = require('dotenv');
const swaggerUi = require('swagger-ui-express');
const swaggerJsdoc = require('swagger-jsdoc');
const dockerMailserver = require('./dockerMailserver');
dotenv.config();
const app = express();
const PORT = process.env.PORT || 3001;
const options = {
definition: {
openapi: '3.0.0',
info: {
title: 'Docker Mailserver GUI API',
version: '1.0.0',
description: 'API for Docker Mailserver GUI',
},
},
apis: ['./*.js'], // files containing annotations as above
};
const specs = swaggerJsdoc(options);
// Middleware
app.use(cors());
app.use(express.json());
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
// Routes
/**
* @swagger
* /api/status:
* get:
* summary: Get server status
* description: Retrieve the status of the docker-mailserver
* responses:
* 200:
* description: Server status
* 500:
* description: Unable to connect to docker-mailserver
*/
app.get('/api/status', async (req, res) => {
try {
const status = await dockerMailserver.getServerStatus();
res.json(status);
} catch (error) {
res.status(500).json({ error: 'Unable to connect to docker-mailserver' });
}
});
// Endpoint for retrieving email accounts
/**
* @swagger
* /api/accounts:
* get:
* summary: Get email accounts
* description: Retrieve all email accounts
* responses:
* 200:
* description: List of email accounts
* 500:
* description: Unable to retrieve accounts
*/
app.get('/api/accounts', async (req, res) => {
try {
const accounts = await dockerMailserver.getAccounts();
res.json(accounts);
} catch (error) {
res.status(500).json({ error: 'Unable to retrieve accounts' });
}
});
// Endpoint for adding a new email account
/**
* @swagger
* /api/accounts:
* post:
* summary: Add a new email account
* description: Add a new email account to the docker-mailserver
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* email:
* type: string
* description: Email address of the new account
* password:
* type: string
* description: Password for the new account
* responses:
* 201:
* description: Account created successfully
* 400:
* description: Email and password are required
* 500:
* description: Unable to create account
*/
app.post('/api/accounts', async (req, res) => {
try {
const { email, password } = req.body;
if (!email || !password) {
return res.status(400).json({ error: 'Email and password are required' });
}
const result = await dockerMailserver.addAccount(email, password);
res.status(201).json({ message: 'Account created successfully', email });
} catch (error) {
res.status(500).json({ error: 'Unable to create account' });
}
});
// Endpoint for deleting an email account
/**
* @swagger
* /api/accounts/{email}:
* delete:
* summary: Delete an email account
* description: Delete an email account from the docker-mailserver
* parameters:
* - in: path
* name: email
* required: true
* schema:
* type: string
* description: Email address of the account to delete
* responses:
* 200:
* description: Account deleted successfully
* 400:
* description: Email is required
* 500:
* description: Unable to delete account
*/
app.delete('/api/accounts/:email', async (req, res) => {
try {
const { email } = req.params;
if (!email) {
return res.status(400).json({ error: 'Email is required' });
}
await dockerMailserver.deleteAccount(email);
res.json({ message: 'Account deleted successfully', email });
} catch (error) {
res.status(500).json({ error: 'Unable to delete account' });
}
});
// Endpoint for updating an email account password
/**
* @swagger
* /api/accounts/{email}/password:
* put:
* summary: Update an email account password
* description: Update the password for an existing email account
* parameters:
* - in: path
* name: email
* required: true
* schema:
* type: string
* description: Email address of the account to update
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* password:
* type: string
* description: New password for the account
* responses:
* 200:
* description: Password updated successfully
* 400:
* description: Email and password are required
* 500:
* description: Unable to update password
*/
app.put('/api/accounts/:email/password', async (req, res) => {
try {
const { email } = req.params;
const { password } = req.body;
if (!email) {
return res.status(400).json({ error: 'Email is required' });
}
if (!password) {
return res.status(400).json({ error: 'Password is required' });
}
await dockerMailserver.updateAccountPassword(email, password);
res.json({ message: 'Password updated successfully', email });
} catch (error) {
res.status(500).json({ error: 'Unable to update password' });
}
});
// Endpoint for updating an email account quota
/**
* @swagger
* /api/accounts/{email}/quota:
* put:
* summary: Update an email account quota
* description: Update the storage quota for an existing email account
* parameters:
* - in: path
* name: email
* required: true
* schema:
* type: string
* description: Email address of the account to update
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* quota:
* type: string
* description: New quota value, for example 1024M or 2G
* responses:
* 200:
* description: Quota updated successfully
* 400:
* description: Email and quota are required
* 500:
* description: Unable to update quota
*/
app.put('/api/accounts/:email/quota', async (req, res) => {
try {
const { email } = req.params;
const { quota } = req.body;
if (!email) {
return res.status(400).json({ error: 'Email is required' });
}
if (!quota) {
return res.status(400).json({ error: 'Quota is required' });
}
if (!/^\d+\s*[mMgG]$/.test(String(quota).trim())) {
return res
.status(400)
.json({ error: 'Quota must use MB or GB units, for example 500M or 2G' });
}
await dockerMailserver.updateAccountQuota(email, quota);
res.json({ message: 'Quota updated successfully', email, quota });
} catch (error) {
res.status(500).json({ error: 'Unable to update quota' });
}
});
// Endpoint for retrieving aliases
/**
* @swagger
* /api/aliases:
* get:
* summary: Get aliases
* description: Retrieve all email aliases
* responses:
* 200:
* description: List of email aliases
* 500:
* description: Unable to retrieve aliases
*/
app.get('/api/aliases', async (req, res) => {
try {
const aliases = await dockerMailserver.getAliases();
res.json(aliases);
} catch (error) {
res.status(500).json({ error: 'Unable to retrieve aliases' });
}
});
// Endpoint for adding an alias
/**
* @swagger
* /api/aliases:
* post:
* summary: Add a new alias
* description: Add a new email alias to the docker-mailserver
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* source:
* type: string
* description: Source email address for the alias
* destination:
* type: string
* description: Destination email address for the alias
* responses:
* 201:
* description: Alias created successfully
* 400:
* description: Source and destination are required
* 500:
* description: Unable to create alias
*/
app.post('/api/aliases', async (req, res) => {
try {
const { source, destination } = req.body;
if (!source || !destination) {
return res
.status(400)
.json({ error: 'Source and destination are required' });
}
await dockerMailserver.addAlias(source, destination);
res
.status(201)
.json({ message: 'Alias created successfully', source, destination });
} catch (error) {
res.status(500).json({ error: 'Unable to create alias' });
}
});
// Endpoint for deleting an alias
/**
* @swagger
* /api/aliases/{source}/{destination}:
* delete:
* summary: Delete an alias
* description: Delete an email alias from the docker-mailserver
* parameters:
* - in: path
* name: source
* required: true
* schema:
* type: string
* description: Source email address of the alias to delete
* - in: path
* name: destination
* required: true
* schema:
* type: string
* description: Destination email address of the alias to delete
* responses:
* 200:
* description: Alias deleted successfully
* 400:
* description: Source and destination are required
* 500:
* description: Unable to delete alias
*/
app.delete('/api/aliases/:source/:destination', async (req, res) => {
try {
const { source, destination } = req.params;
if (!source) {
return res.status(400).json({ error: 'Source is required' });
}
if (!destination) {
return res.status(400).json({ error: 'Destination is required' });
}
await dockerMailserver.deleteAlias(source, destination);
res.json({ message: 'Alias deleted successfully', source, destination });
} catch (error) {
res.status(500).json({ error: 'Unable to delete alias' });
}
});
// Endpoint for retrieving domains overview
/**
* @swagger
* /api/domains:
* get:
* summary: Get domains overview
* description: Retrieve all domains with DKIM/SPF/DMARC DNS guidance
* responses:
* 200:
* description: List of domains and DNS records
* 500:
* description: Unable to retrieve domains overview
*/
app.get('/api/domains', async (req, res) => {
try {
const domains = await dockerMailserver.getDomainsOverview();
res.json(domains);
} catch (error) {
res.status(500).json({ error: 'Unable to retrieve domains overview' });
}
});
// Endpoint for generating DKIM keys
/**
* @swagger
* /api/domains/dkim:
* post:
* summary: Configure DKIM
* description: Run `setup config dkim` inside docker-mailserver container
* responses:
* 200:
* description: DKIM configuration command executed
* 500:
* description: Unable to configure DKIM
*/
app.post('/api/domains/dkim', async (req, res) => {
try {
await dockerMailserver.configureDkim();
res.json({ message: 'DKIM configuration command executed successfully' });
} catch (error) {
res.status(500).json({ error: 'Unable to configure DKIM' });
}
});
app.listen(PORT, () => {
console.log(`Server running on port ${PORT}`);
// Log debug status
if (process.env.DEBUG_DOCKER === 'true') {
console.log('🐞 Docker debug mode is ENABLED');
}
});