Почта — справочник эндпоинтов

Актуально для: SimpleTwo 0.9.x · Сгенерировано из кода службы mail/

Роли mail и mx: JMAP и его push для клиентов, настройки и отзыв письма, служебные двери для координатора.

Это карта, а не описание

Файл собран автоматически из объявлений маршрутов, поэтому он не отстаёт от кода, но и не рассказывает, что делает каждый эндпоинт. Описания, примеры запросов и коды ошибок — в статьях раздела API; карта нужна, чтобы увидеть поверхность целиком и найти, где она объявлена.

Пересобрать: python3 site/docs-gen/api-reference.py. Столбец «Аутентификация» выведен из префикса пути — соглашение продукта, а не разбор middleware.

Всего эндпоинтов: 30.

.well-known

Метод	Путь	Аутентификация	Объявлен в
GET	/.well-known/jmap	Authorization: Bearer — сессия, или пароль приложения (HTTP Basic)	mail/internal/jmap/jmap.go

control

Метод	Путь	Аутентификация	Объявлен в
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

Метод	Путь	Аутентификация	Объявлен в
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

Метод	Путь	Аутентификация	Объявлен в
GET	/healthz	без аутентификации	mail/cmd/mail/main.go

internal

Метод	Путь	Аутентификация	Объявлен в
GET	/internal/v1/recipients	—	mail/internal/edgeapi/edgeapi.go

jmap

Метод	Путь	Аутентификация	Объявлен в
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

Метод	Путь	Аутентификация	Объявлен в
POST	/v1/recall	Authorization: Bearer — сессия, бот или служебный токен, см. api/overview	mail/internal/jmap/jmap.go

settings

Метод	Путь	Аутентификация	Объявлен в
GET	/v1/settings	Authorization: Bearer — сессия, бот или служебный токен, см. api/overview	mail/internal/jmap/jmap.go
PATCH	/v1/settings	Authorization: Bearer — сессия, бот или служебный токен, см. api/overview	mail/internal/jmap/jmap.go