mirror of https://github.com/mailscope/kumomta.git synced 2026-08-19 19:08:17 +00:00

Files

T

Wez Furlong 42bf5c5e61 docs: adjust reference to improve search terms

We've been hoping that mkdocs-material will ship the much anticipated
search enhancements for some time, but it's time to recognize that
we need to do something to improve the search results with how
things work right now.

This is a big commit that changes the titles of the various pages
from the code-annotated synopsis to just the name of the function.

This makes it much easier now to match things like `kumo.reject`
directly, but `reject` remains awkward to find.

I think this is the best that we can do at this time.

A few functions have been annotated with the `status: deprecated` to
show as deprecated in the toc/nav (shows with a little trash can next
to the name).

2025-05-16 14:02:19 -07:00

643 B

Raw Blame History

HTTP API

HTTP service is configured via kumo.start_http_listener.

Authentication

All HTTP endpoints require that the client satisfy one of the follow conditions:

Trusted IP - Connecting from a host covered by the trusted_hosts defined for the HTTP listener
Authenticated - Provide HTTP Basic authentication credentials that are validated successfully by the http_server_validate_auth_basic event handler

Endpoints { data-search-exclude }

The following endpoints are available:

643 B Raw Blame History

HTTP API

Authentication

Endpoints { data-search-exclude }

643 B

Raw Blame History