Skip to main content

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​

MethodPathAuthDeclared in
GET/.well-known/jmapAuthorization: Bearer — сессия, или пароль приложения (HTTP Basic)mail/internal/jmap/jmap.go

control​

MethodPathAuthDeclared 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​

MethodPathAuthDeclared in
POST/v1/devicesAuthorization: Bearer — сессия, бот или служебный токен, см. api/overviewmail/internal/jmap/jmap.go
DELETE/v1/devices/{id}Authorization: Bearer — сессия, бот или служебный токен, см. api/overviewmail/internal/jmap/jmap.go

healthz​

MethodPathAuthDeclared in
GET/healthzбез аутентификацииmail/cmd/mail/main.go

internal​

MethodPathAuthDeclared in
GET/internal/v1/recipients—mail/internal/edgeapi/edgeapi.go

jmap​

MethodPathAuthDeclared in
POST/jmap/apiAuthorization: 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/eventsourceAuthorization: Bearer — сессия, или пароль приложения (HTTP Basic)mail/internal/jmap/jmap.go
POST/jmap/upload/{account}/Authorization: Bearer — сессия, или пароль приложения (HTTP Basic)mail/internal/jmap/jmap.go
GET/jmap/wsAuthorization: Bearer — сессия, или пароль приложения (HTTP Basic)mail/internal/jmap/jmap.go

recall​

MethodPathAuthDeclared in
POST/v1/recallAuthorization: Bearer — сессия, бот или служебный токен, см. api/overviewmail/internal/jmap/jmap.go

settings​

MethodPathAuthDeclared in
GET/v1/settingsAuthorization: Bearer — сессия, бот или служебный токен, см. api/overviewmail/internal/jmap/jmap.go
PATCH/v1/settingsAuthorization: Bearer — сессия, бот или служебный токен, см. api/overviewmail/internal/jmap/jmap.go