Directories
¶
| Path | Synopsis |
|---|---|
|
Package email sends reminders by email over SMTP (ADR 0007).
|
Package email sends reminders by email over SMTP (ADR 0007). |
|
smtptest
Package smtptest is an in-process SMTP server for tests.
|
Package smtptest is an in-process SMTP server for tests. |
|
Package fake is a text channel for tests: it renders messages as plain text so conversation scripts can be compared with golden files.
|
Package fake is a text channel for tests: it renders messages as plain text so conversation scripts can be compared with golden files. |
|
Package notifiers runs the notify-only channels (email, ntfy, webhooks, Web Push): it owns their instance settings and hands the channels to the action layer.
|
Package notifiers runs the notify-only channels (email, ntfy, webhooks, Web Push): it owns their instance settings and hands the channels to the action layer. |
|
Package notify is what the notify-only channels (email, ntfy, webhooks) share: turning a channel-agnostic actions.Message into plain text and HTML, and the link back to the web.
|
Package notify is what the notify-only channels (email, ntfy, webhooks) share: turning a channel-agnostic actions.Message into plain text and HTML, and the link back to the web. |
|
Package ntfy sends reminders as push notifications through ntfy (https://ntfy.sh or a self-hosted server).
|
Package ntfy sends reminders as push notifications through ntfy (https://ntfy.sh or a self-hosted server). |
|
Package slack (piece ③) connects Exhale to a Slack workspace over Socket Mode: a WebSocket the app opens outward, so no public URL or open port is needed (ADR 0001, 0007).
|
Package slack (piece ③) connects Exhale to a Slack workspace over Socket Mode: a WebSocket the app opens outward, so no public URL or open port is needed (ADR 0001, 0007). |
|
Package telegram (piece ②) connects Exhale to a Telegram bot over long polling: an outbound connection, so no public URL or open port is needed (ADR 0001, 0007).
|
Package telegram (piece ②) connects Exhale to a Telegram bot over long polling: an outbound connection, so no public URL or open port is needed (ADR 0001, 0007). |
|
Package webhook sends each reminder as one HTTP POST with a JSON body to an address the member chooses.
|
Package webhook sends each reminder as one HTTP POST with a JSON body to an address the member chooses. |
|
Package webpush sends reminders as Web Push notifications to the browsers and installed apps (PWA) where a member turned them on (ADR 0026).
|
Package webpush sends reminders as Web Push notifications to the browsers and installed apps (PWA) where a member turned them on (ADR 0026). |
|
pushtest
Package pushtest is a fake Web Push service and a fake browser for tests.
|
Package pushtest is a fake Web Push service and a fake browser for tests. |
Click to show internal directories.
Click to hide internal directories.