{{ message }}
Repository navigation
Expand file tree
/
Copy pathswagger.yaml
More file actions
2648 lines (2640 loc) · 99.4 KB
/
Copy pathswagger.yaml
File metadata and controls
2648 lines (2640 loc) · 99.4 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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
title: uMailServer API
description: |-
REST API of uMailServer (source of truth: `internal/api/server.go`, `internal/api/admin.go`).
**Base path.** Everything JSON lives under `/api/v1` on the main HTTP listener (`http.port`, default 443; the process itself speaks plain HTTP on that listener and TLS is expected to be provided in front of it, cookies are marked `Secure` when the request arrived over TLS). A second, admin-only listener (default `127.0.0.1:8443`, `admin.*`) serves the admin SPA plus a subset of the admin routes (domains, accounts, queue, rate limits, metrics, stats, vacations list, push stats) and `/health`.
**Authentication.** `POST /api/v1/auth/login` returns a JWT (HS256) in the body (non-browser clients) and sets an HttpOnly `jwt` cookie. Send it as `Authorization: Bearer <token>` or let the browser send the cookie (cookie wins when both are present). Public endpoints are marked `security: []`. Admin-only operations are labelled and answer 403 `{"error":"admin access required"}` to ordinary users. The admin listener accepts Bearer tokens only (no cookie) and reports auth failures as `{"error","message","code"}`.
**Request rules (all unsafe methods under `/api/v1/` except login, logout and `/api/v1/account/*`).** `Content-Type: application/json` is mandatory even for body-less DELETE/POST (400 `Content-Type must be application/json`). Cookie-authenticated requests with an Origin/Referer from another host are 403. JSON bodies reject unknown fields (400). Default body cap 4 MB (26 MB for mail send/draft); oversize bodies surface as 400, not 413.
**Errors.** `{"error": "<message>"}` with the HTTP status. Methods other than those documented answer 405 with an `Allow` header; HEAD is answered for GET routes.
**Rate limiting.** Per client IP, 1-minute window, `security.rate_limit.http_requests_per_minute` (default 120, 0 disables), applied to the protected `/api/v1/` routes and logout; exceeded -> 429 with `Retry-After: 60`. Login has its own failure lockouts (see the operation). `/health`, `/health/ready`, `/api/v1/events`, `/mcp`, `/metrics`, `/api/v1/account/*` and login are outside this limiter.
**Lists** (`/domains`, `/accounts`, `/aliases`) return plain JSON arrays with the unpaginated size in the `X-Total-Count` header; `limit` 1-1000 (default 100) and `offset` are validated (400).
**Message ids.** The REST message id is the blob content hash. When byte-identical copies exist (same mail in two folders or twice in one), list results report each copy as `<hash>_<uid>_<base64url(mailbox)>`, which addresses exactly one (folder, uid) entry for delete/flags/move/get; a hash held once keeps its plain id.
Generated from `openapi.yaml` (OpenAPI 3.0.3, the primary spec); the admin-only listener (`http://127.0.0.1:8443`) serves the admin routes with the same paths. Cookie auth (`jwt`) cannot be expressed in Swagger 2.0 and is described in prose only; use `openapi.yaml` for the full model.
version: 1.0.0
contact: {name: uMailServer, url: 'https://github.com/umailserver/umailserver/issues'}
license: {name: MIT, url: 'https://opensource.org/licenses/MIT'}
host: mail.example.com
basePath: /
schemes: [https]
consumes: [application/json]
produces: [application/json]
tags:
- {name: Auth, description: 'Login, logout, token refresh'}
- {name: Account, description: Self-service for the authenticated account}
- {name: Admin, description: 'Administrator operations (domains, accounts, aliases, queue, limits, keys)'}
- {name: Cluster, description: HA cluster operations (admin)}
- {name: Mail, description: Webmail endpoints operating on the caller's own mailboxes}
- {name: Threads, description: Conversation threads}
- {name: Settings, description: 'Vacation, filters, push'}
- {name: Realtime, description: SSE and MCP}
- {name: Operations, description: Health and metrics}
- {name: Client configuration, description: Mail client autoconfiguration}
securityDefinitions:
bearerAuth: {type: apiKey, in: header, name: Authorization, description: '`Bearer <JWT>` from POST /api/v1/auth/login.
An HttpOnly `jwt` cookie is accepted as an alternative (not expressible in Swagger 2.0).'}
security:
- bearerAuth: []
definitions:
Error:
type: object
properties:
error: {type: string, description: Human-readable message}
required: [error]
description: Error body used by every JSON handler of the main API. Some cluster/health/SSE paths answer with
plain text instead (noted per operation).
AdminListenerError:
type: object
properties:
error: {type: string}
message: {type: string}
code: {type: integer}
required: [error, message, code]
description: Error body of the authentication / admin-guard layer of the admin-only listener (port 8443).
LoginRequest:
type: object
properties:
email: {type: string, format: email}
password: {type: string}
totp_code: {type: string, description: Required when the account has TOTP enabled.}
required: [email, password]
TokenResponse:
type: object
properties:
token: {type: string, description: JWT (HS256). Returned in the body only for non-browser clients (User-Agent
without Mozilla/Chrome/Firefox/Safari/Edge) or when an Authorization header was sent; browsers receive
it solely via the HttpOnly `jwt` cookie.}
expiresIn: {type: integer, description: Token lifetime in seconds.}
required: [expiresIn]
Message:
type: object
properties:
message: {type: string}
required: [message]
Status:
type: object
properties:
status: {type: string}
required: [status]
Domain:
type: object
properties:
name: {type: string}
max_accounts: {type: integer}
is_active: {type: boolean}
created_at: {type: string, format: date-time}
updated_at: {type: string, format: date-time}
dkim_selector: {type: string, description: Present once a DKIM key exists (always "default" for API-created
domains).}
dkim_public_key: {type: string, description: DNS TXT public key value.}
required: [name, max_accounts, is_active, created_at, updated_at]
DomainCreate:
type: object
properties:
name: {type: string, description: Lower-cased; validated as a domain name.}
max_accounts: {type: integer, minimum: 0, maximum: 1000000, description: 0 = unlimited.}
required: [name]
DomainUpdate:
type: object
properties:
max_accounts: {type: integer, minimum: 0, maximum: 1000000}
is_active: {type: boolean}
description: Omitted fields keep their stored value.
Account:
type: object
properties:
email: {type: string}
is_admin: {type: boolean}
is_active: {type: boolean}
quota_used: {type: integer, format: int64}
quota_limit: {type: integer, format: int64, description: 0 = unlimited.}
forward_to: {type: string}
forward_keep_copy: {type: boolean}
created_at: {type: string, format: date-time}
updated_at: {type: string, format: date-time}
last_login: {type: string, format: date-time}
vacation_settings: {type: string}
required: [email, is_admin, is_active]
AccountCreate:
type: object
properties:
email: {type: string, format: email, description: Domain must already exist.}
password: {type: string, description: Must satisfy the password policy (max 128 characters).}
is_admin: {type: boolean}
required: [email, password]
AccountUpdate:
type: object
properties:
password: {type: string, description: 'Admin reset of ANOTHER account''s password (403 for your own: use /api/v1/account/password).
Revokes that account''s sessions.'}
is_admin: {type: boolean, description: Changing it requires current_admin_password; an admin cannot change
their own admin flag.}
is_active: {type: boolean}
forward_to: {type: string}
forward_keep_copy: {type: boolean}
quota_limit: {type: integer, format: int64, minimum: 0}
vacation_settings: {type: string}
current_admin_password: {type: string, description: Acting admin's password; required when is_admin changes.}
description: Omitted fields keep their stored value; unknown fields are rejected (400).
PasswordDelete:
type: object
properties:
password: {type: string}
required: [password]
Alias:
type: object
properties:
alias: {type: string, description: Full alias address.}
target: {type: string}
domain: {type: string}
is_active: {type: boolean}
created_at: {type: string, format: date-time}
required: [alias, target, domain, is_active]
AliasCreate:
type: object
properties:
alias: {type: string, format: email}
target: {type: string, format: email, description: Must be an existing account.}
is_active: {type: boolean, default: true}
required: [alias, target]
AliasUpdate:
type: object
properties:
target: {type: string, format: email}
is_active: {type: boolean}
QueueEntry:
type: object
properties:
id: {type: string}
from: {type: string}
to:
type: array
items: {type: string}
status: {type: string, description: 'pending, sending, failed (delivered/bounced entries are never listed;
they can still be fetched by id).'}
retry_count: {type: integer}
last_error: {type: string}
created_at: {type: string, format: date-time}
next_retry: {type: string, format: date-time}
Stats:
type: object
properties:
domains: {type: integer}
accounts: {type: integer}
messages: {type: integer, description: Currently always 0.}
queue_size: {type: integer, description: pending + sending + failed}
RateLimitConfig:
type: object
properties:
ip_per_minute: {type: integer, minimum: 1, maximum: 10000000}
ip_per_hour: {type: integer, minimum: 1, maximum: 10000000}
ip_per_day: {type: integer, minimum: 1, maximum: 10000000}
ip_connections: {type: integer, minimum: 1, maximum: 10000000}
user_per_minute: {type: integer, minimum: 1, maximum: 10000000}
user_per_hour: {type: integer, minimum: 1, maximum: 10000000}
user_per_day: {type: integer, minimum: 1, maximum: 10000000}
user_max_recipients: {type: integer, minimum: 1, maximum: 10000000}
global_per_minute: {type: integer, minimum: 1, maximum: 10000000}
global_per_hour: {type: integer, minimum: 1, maximum: 10000000}
required: [ip_per_minute, ip_per_hour, ip_per_day, ip_connections, user_per_minute, user_per_hour, user_per_day,
user_max_recipients, global_per_minute, global_per_hour]
description: Mail-protocol (SMTP/IMAP) rate limits managed at runtime; unrelated to the HTTP API limiter. All
fields are required on PUT.
Mail:
type: object
properties:
id: {type: string, description: 'Message id. Plain content hash, or `<hash>_<uid>_<base64url(mailbox)>` when
identical bytes exist more than once for the account (see tag description).'}
from: {type: string}
fromName: {type: string}
to:
type: array
items: {type: string}
subject: {type: string}
body: {type: string}
preview: {type: string}
date: {type: string}
read: {type: boolean}
starred: {type: boolean}
folder: {type: string}
hasAttachments: {type: boolean}
messageId: {type: string, description: 'RFC 5322 Message-ID header, when present.'}
size: {type: integer, format: int64}
cc:
type: array
items: {type: string}
bcc:
type: array
items: {type: string}
description: '`cc`/`bcc` are only present on single-message reads of the Drafts folder.'
MailList:
type: object
properties:
emails:
type: array
items: {$ref: '#/definitions/Mail'}
total: {type: integer, description: Messages matching the filter.}
limit: {type: integer}
offset: {type: integer}
folder: {type: string}
unreadTotal: {type: integer, description: 'Folder-wide, ignores filters.'}
starredTotal: {type: integer, description: 'Folder-wide, ignores filters.'}
SendMailRequest:
type: object
properties:
to:
type: array
items: {type: string}
cc:
type: array
items: {type: string}
bcc:
type: array
items: {type: string}
subject: {type: string, maxLength: 998}
body: {type: string, description: 'Plain text, max 25 MB.'}
inReplyTo: {type: string, description: Message-ID in angle brackets.}
references:
type: array
items: {type: string}
required: [to]
description: to+cc+bcc <= 100 addresses, each a bare addr-spec. Unknown fields are rejected (400). No attachment
support.
FlagsRequest:
type: object
properties:
id: {type: string}
ids:
type: array
items: {type: string}
folder: {type: string, description: Optional; all mailboxes searched when omitted.}
add:
type: array
items:
type: string
enum: [\Seen, \Flagged, \Answered, \Draft]
remove:
type: array
items:
type: string
enum: [\Seen, \Flagged, \Answered, \Draft]
description: id + ids up to 1000 distinct ids; add + remove between 1 and 16 entries (flag names case-insensitive,
leading backslash optional).
DraftRequest:
type: object
properties:
id: {type: string, description: Existing draft to replace (required for PUT).}
to:
type: array
items: {type: string}
cc:
type: array
items: {type: string}
bcc:
type: array
items: {type: string}
subject: {type: string, maxLength: 998}
body: {type: string}
description: to+cc+bcc <= 100 addresses, body <= 25 MB.
MoveRequest:
type: object
properties:
id: {type: string}
ids:
type: array
items: {type: string}
from: {type: string, description: 'Source folder (inbox, sent, drafts, trash, spam or a mailbox name).'}
to: {type: string}
required: [from, to]
description: id + ids up to 1000 distinct ids. Unknown fields are ignored.
Thread:
type: object
properties:
thread_id: {type: string}
subject: {type: string}
participants:
type: array
items: {type: string}
message_count: {type: integer}
unread_count: {type: integer}
last_activity: {type: string, format: date-time}
created_at: {type: string, format: date-time}
ThreadMessage:
type: object
properties:
message_id: {type: string}
uid: {type: integer}
mailbox: {type: string}
from: {type: string}
to: {type: string}
subject: {type: string}
date: {type: string, format: date-time}
is_read: {type: boolean}
flags:
type: array
items: {type: string}
Vacation:
type: object
properties:
enabled: {type: boolean}
start_date: {type: string, format: date-time, description: RFC 3339. An unparsable value is silently ignored.}
end_date: {type: string, format: date-time, description: RFC 3339; must not be before start_date.}
subject: {type: string, description: Required when enabled.}
message: {type: string, description: Required when enabled.}
html_message: {type: string}
send_interval: {type: integer, minimum: 1, maximum: 8760, description: Hours between replies to the same sender.
Required on PUT (0/omitted is rejected).}
exclude_addresses:
type: array
items: {type: string}
ignore_lists: {type: boolean}
ignore_bulk: {type: boolean}
required: [enabled, subject, message]
FilterCondition:
type: object
properties:
field: {type: string, description: 'from, to, subject, body or header'}
operator: {type: string, description: 'contains, equals, startsWith, endsWith, matches'}
value: {type: string, minLength: 1, maxLength: 1000}
headerName: {type: string, description: Required when field is header.}
required: [field, operator, value]
FilterAction:
type: object
properties:
type: {type: string, description: 'move, copy, delete, markRead, markSpam, forward, flag'}
target: {type: string, description: Folder for move/copy.}
forwardTo: {type: string, description: Address for forward.}
required: [type]
Filter:
type: object
properties:
id: {type: string, format: uuid}
user_id: {type: string}
name: {type: string}
enabled: {type: boolean}
matchAll: {type: boolean}
conditions:
type: array
items: {$ref: '#/definitions/FilterCondition'}
actions:
type: array
items: {$ref: '#/definitions/FilterAction'}
priority: {type: integer}
createdAt: {type: string, format: date-time}
updatedAt: {type: string, format: date-time}
FilterCreate:
type: object
properties:
name: {type: string, maxLength: 255}
matchAll: {type: boolean}
conditions:
type: array
items: {$ref: '#/definitions/FilterCondition'}
minItems: 1
maxItems: 50
actions:
type: array
items: {$ref: '#/definitions/FilterAction'}
minItems: 1
maxItems: 20
required: [name, conditions, actions]
FilterUpdate:
type: object
properties:
name: {type: string, maxLength: 255}
enabled: {type: boolean}
matchAll: {type: boolean}
conditions:
type: array
items: {$ref: '#/definitions/FilterCondition'}
maxItems: 50
actions:
type: array
items: {$ref: '#/definitions/FilterAction'}
maxItems: 20
description: Omitted/empty fields keep their stored value.
PushSubscribe:
type: object
properties:
endpoint: {type: string, description: Must be an https URL.}
p256dh: {type: string}
auth: {type: string}
deviceType: {type: string}
os: {type: string}
browser: {type: string}
name: {type: string}
required: [endpoint, p256dh, auth]
Health:
type: object
properties:
status:
type: string
enum: [healthy, degraded, unhealthy, draining]
timestamp: {type: string, format: date-time}
version: {type: string}
checks:
type: array
items:
type: object
properties:
name: {type: string}
status: {type: string}
message: {type: string}
response_time_ms: {type: number}
details: {type: object, additionalProperties: true}
system:
type: object
properties:
go_version: {type: string}
goroutines: {type: integer}
memory_mb: {type: integer}
memory_used_mb: {type: integer}
uptime: {type: string}
database: {type: string}
queue: {type: string}
storage: {type: string}
draining: {type: boolean}
description: 'Shape depends on wiring. With the health monitor (normal server start): status/timestamp/version/checks/system.
Without it: status plus database/queue/storage strings. 503 when unhealthy.'
responses:
BadRequest:
description: Invalid input
schema: {$ref: '#/definitions/Error'}
Unauthorized:
description: Missing/invalid/expired/revoked token, or account disabled
schema: {$ref: '#/definitions/Error'}
Forbidden:
description: Not permitted (e.g. `admin access required`)
schema: {$ref: '#/definitions/Error'}
NotFound:
description: Resource not found
schema: {$ref: '#/definitions/Error'}
Conflict:
description: Conflicts with current state
schema: {$ref: '#/definitions/Error'}
TooManyRequests:
description: Rate limit or lockout
schema: {$ref: '#/definitions/Error'}
headers:
Retry-After: {type: string, description: 'Always `60` (seconds), also for longer lockouts.'}
MethodNotAllowed:
description: Method not supported on this path; `Allow` lists the supported ones
schema: {$ref: '#/definitions/Error'}
headers:
Allow: {type: string}
Unavailable:
description: Service or backing store unavailable
schema: {$ref: '#/definitions/Error'}
ServerError:
description: Internal error
schema: {$ref: '#/definitions/Error'}
QuotaExceeded:
description: Mailbox quota exceeded (`Quota exceeded`)
schema: {$ref: '#/definitions/Error'}
paths:
/api/v1/auth/login:
post:
tags: [Auth]
summary: Log in
description: Rate limited per IP (failure lockout, default 5 failures, 5 min doubling to 60 min; `security.max_login_attempts`)
and per (IP, account) (5 failures / 5 min). Failed TOTP attempts per account lock after 5 failures for 5
minutes. Sets the `jwt` cookie.
operationId: login
parameters:
- name: body
in: body
required: true
description: ''
schema: {$ref: '#/definitions/LoginRequest'}
produces: [application/json]
consumes: [application/json]
responses:
'200':
description: Logged in
schema: {$ref: '#/definitions/TokenResponse'}
headers:
Set-Cookie: {type: string, description: 'jwt cookie (HttpOnly, SameSite=Strict)'}
'400': {$ref: '#/responses/BadRequest'}
'401':
description: '`invalid credentials` (bad password, unknown or disabled account), `TOTP code required`,
`invalid TOTP code` or `TOTP code already used`'
schema: {$ref: '#/definitions/Error'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'429': {$ref: '#/responses/TooManyRequests'}
security: []
/api/v1/auth/logout:
post:
tags: [Auth]
summary: Log out
description: Revokes the presented token(s) and clears the cookie. `DELETE` is accepted as an alias of POST.
operationId: logout
produces: [application/json]
responses:
'200':
description: Logged out
schema: {$ref: '#/definitions/Message'}
'401': {$ref: '#/responses/Unauthorized'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'429': {$ref: '#/responses/TooManyRequests'}
delete:
tags: [Auth]
summary: Log out (DELETE alias)
produces: [application/json]
responses:
'200':
description: Logged out
schema: {$ref: '#/definitions/Message'}
'401': {$ref: '#/responses/Unauthorized'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'429': {$ref: '#/responses/TooManyRequests'}
/api/v1/auth/refresh:
post:
tags: [Auth]
summary: Refresh token
description: 'Revokes the presented token(s) and issues a new one (also replaces the cookie for cookie sessions).
The request must still carry `Content-Type: application/json` (CSRF layer), body is ignored.'
operationId: refresh
produces: [application/json]
responses:
'200':
description: New token
schema: {$ref: '#/definitions/TokenResponse'}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'429': {$ref: '#/responses/TooManyRequests'}
/api/v1/account/password:
post:
tags: [Account]
summary: Change own password
description: Shares the per-(IP, account) failed-password budget with login (5 failures / 5 min). Revokes
all existing sessions of the account and returns a replacement (cookie, plus `token`/`expiresIn` for non-browser
clients).
operationId: changeOwnPassword
parameters:
- name: body
in: body
required: true
description: ''
schema:
type: object
properties:
current_password: {type: string}
new_password: {type: string, minLength: 8, maxLength: 128}
required: [current_password, new_password]
produces: [application/json]
consumes: [application/json]
responses:
'200':
description: Changed
schema:
type: object
properties:
message: {type: string}
token: {type: string}
expiresIn: {type: integer}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'403':
description: '`current password is incorrect`'
schema: {$ref: '#/definitions/Error'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'429': {$ref: '#/responses/TooManyRequests'}
/api/v1/account/totp:
get:
tags: [Account]
summary: Own TOTP state
produces: [application/json]
responses:
'200':
description: OK
schema:
type: object
properties:
enabled: {type: boolean}
pending_setup: {type: boolean}
'401': {$ref: '#/responses/Unauthorized'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
/api/v1/account/totp/setup:
post:
tags: [Account]
summary: Start TOTP enrolment
description: Generates and stores (encrypted) a new secret; not active until verified.
produces: [application/json]
responses:
'200':
description: OK
schema:
type: object
properties:
uri: {type: string, description: 'otpauth:// URI'}
'401': {$ref: '#/responses/Unauthorized'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'409': {$ref: '#/responses/Conflict'}
/api/v1/account/totp/verify:
post:
tags: [Account]
summary: Confirm TOTP enrolment
description: Enables TOTP; each time step can be used once. Revokes sessions and returns a replacement session
like a password change.
parameters:
- name: body
in: body
required: true
description: ''
schema:
type: object
properties:
code: {type: string}
required: [code]
produces: [application/json]
consumes: [application/json]
responses:
'200':
description: OK
schema:
type: object
properties:
enabled: {type: boolean}
token: {type: string}
expiresIn: {type: integer}
'400': {$ref: '#/responses/BadRequest'}
'401':
description: '`invalid TOTP code` or `TOTP code already used`'
schema: {$ref: '#/definitions/Error'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'429': {$ref: '#/responses/TooManyRequests'}
/api/v1/account/totp/disable:
post:
tags: [Account]
summary: Disable TOTP
description: When TOTP is enabled the body must carry a current valid `code` (400 `current TOTP code required
to disable 2FA`, 401 invalid/used, 429 after 5 failures).
parameters:
- name: body
in: body
required: false
description: ''
schema:
type: object
properties:
code: {type: string}
produces: [application/json]
consumes: [application/json]
responses:
'200':
description: OK
schema:
type: object
properties:
enabled: {type: boolean}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'429': {$ref: '#/responses/TooManyRequests'}
/api/v1/account/forwarding:
get:
tags: [Account]
summary: Get own forwarding
produces: [application/json]
responses:
'200':
description: OK
schema:
type: object
properties:
forward_to: {type: string}
keep_copy: {type: boolean}
forwarding_on: {type: boolean}
'401': {$ref: '#/responses/Unauthorized'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
put:
tags: [Account]
summary: Set own forwarding
description: Empty `forward_to` disables forwarding and clears keep_copy. `forward_copy` is accepted as a
legacy alias of `keep_copy`.
parameters:
- name: body
in: body
required: true
description: ''
schema:
type: object
properties:
forward_to: {type: string}
keep_copy: {type: boolean}
produces: [application/json]
consumes: [application/json]
responses:
'200':
description: Stored configuration
schema:
type: object
properties:
forward_to: {type: string}
keep_copy: {type: boolean}
forwarding_on: {type: boolean}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
/api/v1/domains:
get:
tags: [Admin]
summary: List domains
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). Sorted by name.'
parameters:
- {name: limit, in: query, required: false, type: integer, minimum: 1, maximum: 1000, default: 100}
- {name: offset, in: query, required: false, type: integer, minimum: 0, default: 0}
produces: [application/json]
responses:
'200':
description: Plain array
schema:
type: array
items: {$ref: '#/definitions/Domain'}
headers:
X-Total-Count: {type: integer, description: Unpaginated number of items}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'405': {$ref: '#/responses/MethodNotAllowed'}
post:
tags: [Admin]
summary: Create domain
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). Generates a 2048-bit DKIM
key (selector `default`).'
parameters:
- name: body
in: body
required: true
description: ''
schema: {$ref: '#/definitions/DomainCreate'}
produces: [application/json]
consumes: [application/json]
responses:
'201':
description: Created
schema: {$ref: '#/definitions/Domain'}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'409': {$ref: '#/responses/Conflict'}
'500': {$ref: '#/responses/ServerError'}
/api/v1/domains/{domain}:
parameters:
- {name: domain, in: path, required: true, type: string}
get:
tags: [Admin]
summary: Get domain
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise).'
produces: [application/json]
responses:
'200':
description: OK
schema: {$ref: '#/definitions/Domain'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
put:
tags: [Admin]
summary: Update domain
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). Deactivating a domain that
still has accounts is a 409.'
parameters:
- name: body
in: body
required: true
description: ''
schema: {$ref: '#/definitions/DomainUpdate'}
produces: [application/json]
consumes: [application/json]
responses:
'200':
description: Updated
schema: {$ref: '#/definitions/Domain'}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'409': {$ref: '#/responses/Conflict'}
delete:
tags: [Admin]
summary: Delete domain
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). Cascades to the domain''s
accounts and mailbox data. 409 when it holds the last active administrator; 500 if mailbox purge partly
failed (retry DELETE per account).'
responses:
'204': {description: Deleted}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'409': {$ref: '#/responses/Conflict'}
'500': {$ref: '#/responses/ServerError'}
/api/v1/accounts:
get:
tags: [Admin]
summary: List accounts
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). Sorted by address.'
parameters:
- {name: domain, in: query, required: false, description: Restrict to a domain, type: string}
- {name: limit, in: query, required: false, type: integer, minimum: 1, maximum: 1000, default: 100}
- {name: offset, in: query, required: false, type: integer, minimum: 0, default: 0}
produces: [application/json]
responses:
'200':
description: Plain array
schema:
type: array
items: {$ref: '#/definitions/Account'}
headers:
X-Total-Count: {type: integer, description: Unpaginated number of items}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'500': {$ref: '#/responses/ServerError'}
post:
tags: [Admin]
summary: Create account
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). 400 for a bad address, weak
password or unknown domain; 409 for a duplicate account or when the domain''s `max_accounts` is reached.'
parameters:
- name: body
in: body
required: true
description: ''
schema: {$ref: '#/definitions/AccountCreate'}
produces: [application/json]
consumes: [application/json]
responses:
'201':
description: Created
schema: {$ref: '#/definitions/Account'}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'409': {$ref: '#/responses/Conflict'}
'500': {$ref: '#/responses/ServerError'}
/api/v1/accounts/{email}:
parameters:
- {name: email, in: path, required: true, description: Account address (case-insensitive), type: string}
get:
tags: [Admin]
summary: Get account
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise).'
produces: [application/json]
responses:
'200':
description: OK
schema: {$ref: '#/definitions/Account'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
put:
tags: [Admin]
summary: Update account
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). Partial update. 409 `cannot
demote or deactivate the last active administrator`. A password reset, disable or demotion revokes the account''s
sessions.'
parameters:
- name: body
in: body
required: true
description: ''
schema: {$ref: '#/definitions/AccountUpdate'}
produces: [application/json]
consumes: [application/json]
responses:
'200':
description: Updated
schema: {$ref: '#/definitions/Account'}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'409': {$ref: '#/responses/Conflict'}
delete:
tags: [Admin]
summary: Delete account
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). Removes the account and
purges its mailbox data. 409 `cannot delete the last active administrator` (also when an admin deletes their
own account). Admin callers need no password. The handler also contains a branch for a non-admin deleting
their own account with `{"password": ...}` in the body (400 `password is required...`, 403 `password is
incorrect`, 429 shared password budget), but the route is wrapped in the admin guard, so non-admins always
receive 403 before reaching it.'
parameters:
- name: body
in: body
required: false
description: Only consulted for non-admin callers (unreachable through the router).
schema: {$ref: '#/definitions/PasswordDelete'}
consumes: [application/json]
responses:
'204': {description: Deleted}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'409': {$ref: '#/responses/Conflict'}
'429': {$ref: '#/responses/TooManyRequests'}
'500': {$ref: '#/responses/ServerError'}
/api/v1/accounts/{email}/totp/setup:
parameters:
- {name: email, in: path, required: true, description: Account address (case-insensitive), type: string}
post:
tags: [Admin]
summary: Start TOTP enrolment for an account
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). An admin may act on non-admin
accounts only; acting on an admin account (other than your own) is 403.'
produces: [application/json]
responses:
'200':
description: OK
schema:
type: object
properties:
uri: {type: string}
enabled: {type: boolean}
'400': {$ref: '#/responses/BadRequest'}
'401': {$ref: '#/responses/Unauthorized'}
'403': {$ref: '#/responses/Forbidden'}
'404': {$ref: '#/responses/NotFound'}
'405': {$ref: '#/responses/MethodNotAllowed'}
'409': {$ref: '#/responses/Conflict'}
'429': {$ref: '#/responses/TooManyRequests'}
/api/v1/accounts/{email}/totp/verify:
parameters:
- {name: email, in: path, required: true, description: Account address (case-insensitive), type: string}
post:
tags: [Admin]
summary: Confirm TOTP enrolment for an account
description: '**Admin only** (403 `{"error":"admin access required"}` otherwise). An admin may act on non-admin
accounts only; acting on an admin account (other than your own) is 403.'
parameters:
- name: body
in: body
required: true
description: ''
You can’t perform that action at this time.