Mail — endpoint reference
Applies to: SimpleTwo 0.9.x · Generated from the code of mail/
The mail and mx roles: JMAP and its push for the clients, settings and recall, the coordinator's service doors.
This is a map, not a description
The file is assembled from the route declarations, so it does not lag behind the code — and it does not say what each endpoint does either. Descriptions, request examples and error codes are in the API section; this map exists to show the whole surface and where it is declared.
Regenerate with python3 site/docs-gen/api-reference.py. The "Auth" column is derived from the path
prefix — a product convention rather than a reading of the middleware.
Endpoints in total: 30.
.well-known
| Method | Path | Auth | Declared in |
|---|---|---|---|
GET | /.well-known/jmap | Authorization: Bearer — сессия, или пароль приложения (HTTP Basic) | mail/internal/jmap/jmap.go |
control
| Method | Path | Auth | Declared in |
|---|---|---|---|
GET | /v1/control/audit | служебный токен координатора (svc:coordinator) | mail/internal/jmap/jmap.go |
GET | /v1/control/audit/export | служебный токен координатора (svc:coordinator) | mail/internal/jmap/jmap.go |
DELETE | /v1/control/domains/{domain}/disclaimer | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_domains.go |
GET | /v1/control/domains/{domain}/disclaimer | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_domains.go |
PUT | /v1/control/domains/{domain}/disclaimer | слу жебный токен координатора (svc:coordinator) | mail/internal/jmap/control_domains.go |
GET | /v1/control/groups/{id} | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_mailboxes.go |
DELETE | /v1/control/groups/{id}/senders | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_mailboxes.go |
PUT | /v1/control/groups/{id}/senders | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_mailboxes.go |
POST | /v1/control/mailboxes | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_mailboxes.go |
GET | /v1/control/mailboxes/{id} | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_mailboxes.go |
PATCH | /v1/control/mailboxes/{id} | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_mailboxes.go |
DELETE | /v1/control/mailboxes/{id}/grants | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_mailboxes.go |
PUT | /v1/control/mailboxes/{id}/grants | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_mailboxes.go |
DELETE | /v1/control/retention | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_domains.go |
GET | /v1/control/retention | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_domains.go |
PUT | /v1/control/retention | служебный токен координатора (svc:coordinator) | mail/internal/jmap/control_domains.go |
GET | /v1/control/tracking | служебный токен координатора (svc:coordinator) | mail/internal/jmap/jmap.go |
devices
| Method | Path | Auth | Declared in |
|---|---|---|---|
POST | /v1/devices | Authorization: Bearer — сессия, бот или служебный токен, см. api/overview | mail/internal/jmap/jmap.go |
DELETE | /v1/devices/{id} | Authorization: Bearer — сессия, бот или служебный токен, см. api/overview | mail/internal/jmap/jmap.go |
healthz
| Method | Path | Auth | Declared in |
|---|---|---|---|
GET | /healthz | без аутентификации | mail/cmd/mail/main.go |
internal
| Method | Path | Auth | Declared in |
|---|---|---|---|
GET | /internal/v1/recipients | — | mail/internal/edgeapi/edgeapi.go |
jmap
| Method | Path | Auth | Declared in |
|---|---|---|---|
POST | /jmap/api | Authorization: Bearer — сессия, или пароль приложения (HTTP Basic) | mail/internal/jmap/jmap.go |
GET | /jmap/download/{account}/{blob}/{name} | Authorization: Bearer — сессия, или пароль приложения (HTTP Basic) | mail/internal/jmap/jmap.go |
GET | /jmap/eventsource | Authorization: Bearer — сессия, или пароль приложения (HTTP Basic) | mail/internal/jmap/jmap.go |
POST | /jmap/upload/{account}/ | Authorization: Bearer — сессия, или пароль приложения (HTTP Basic) | mail/internal/jmap/jmap.go |
GET | /jmap/ws | Authorization: Bearer — сессия, или пароль приложения (HTTP Basic) | mail/internal/jmap/jmap.go |
recall
| Method | Path | Auth | Declared in |
|---|---|---|---|
POST | /v1/recall | Authorization: Bearer — сессия, бот или служебный токен, см. api/overview | mail/internal/jmap/jmap.go |
settings
| Method | Path | Auth | Declared in |
|---|---|---|---|
GET | /v1/settings | Authorization: Bearer — сессия, бот или служебный токен, см. api/overview | mail/internal/jmap/jmap.go |
PATCH | /v1/settings | Authorization: Bearer — сессия, бот или служебный токен, см. api/overview | mail/internal/jmap/jmap.go |