A webmail client. Forked from https://git.sr.ht/~migadu/alps

Simon Ser 6bccdd62ce Document that plugins don't have access to passwords		pirms 4 gadiem
cmd/koushin	Introduce base plugin	pirms 4 gadiem
plugins/base	Make Go plugin handlers take a *Context	pirms 4 gadiem
themes	themes/sourcehut: use formatdate template func	pirms 4 gadiem
.gitignore	Introduce base plugin	pirms 4 gadiem
LICENSE	Correct license ownership	pirms 4 gadiem
README.md	Allow Lua plugins to inject all templates	pirms 4 gadiem
go.mod	Add a form to set message flags	pirms 4 gadiem
go.sum	Add a form to set message flags	pirms 4 gadiem
imap.go	Introduce base plugin	pirms 4 gadiem
plugin.go	Add Context to Plugin.Inject	pirms 4 gadiem
plugin_go.go	Make Go plugin handlers take a *Context	pirms 4 gadiem
plugin_lua.go	Add Context to Plugin.Inject	pirms 4 gadiem
server.go	Remove the public/ directory	pirms 4 gadiem
session.go	Document that plugins don't have access to passwords	pirms 4 gadiem
smtp.go	Introduce base plugin	pirms 4 gadiem
template.go	Add Context to Plugin.Inject	pirms 4 gadiem

README.md

koushin

Usage

go run ./cmd/koushin imaps://mail.example.org:993 smtps://mail.example.org:465

See -h for more information.

Themes

They should be put in themes/<name>/.

Templates in themes/<name>/*.html override default templates in plugins. Assets in themes/<name>/assets/* are served by the HTTP server at /themes/<name>/assets/*.

Plugins

Plugins can be written in Go or in Lua and live in plugins/<name>/.

Plugins can provide their own templates in plugins/<name>/public/*.html. Assets in plugins/<name>/public/assets/* are served by the HTTP server at /plugins/<name>/assets/*.

Go plugins

They can use the Go plugin helpers and need to be included at compile-time in cmd/koushin/main.go.

Lua plugins

The entry point is at plugins/<name>/main.lua.

API:

koushin.on_render(name, f): prior to rendering the template name, call f with the template data (the special name * matches all templates)
koushin.set_filter(name, f): set a template function
koushin.set_route(method, path, f): register a new HTTP route, f will be called with the HTTP context

Contributing

Send patches on the mailing list, report bugs on the issue tracker.

License

MIT