notification

Aug 18, 2026

Changes in this version

+ const CategoryScriptReview

+ const CategoryScriptRun

+ const KindScriptReview

+ const KindScriptRun

+ func Deliverable(addr string) bool

Aug 1, 2026

Changes in this version

+ const CategoryReviewQueue

+ const DefaultHistoryLimit

+ const KindReviewQueue

+ const MaxHistoryLimit

+ type HistoryFilter struct

+ Category string

+ Limit int

+ Offset int

+ Recipient string

+ Status string

+ func (f HistoryFilter) EffectiveLimit() int

+ type HistoryStore interface

+ Count func(ctx context.Context, filter HistoryFilter) (int, error)

+ CountsByStatus func(ctx context.Context, filter HistoryFilter) (map[string]int, error)

+ List func(ctx context.Context, filter HistoryFilter) ([]Notification, error)

type Payload

+ Review *ReviewQueue

type PrefsUpdate

+ func (u PrefsUpdate) Apply(p *Prefs)

+ type ReviewQueue struct

+ OldestAgeDays int

+ Pending int

+ StaleAfterDays int

+ StaleCount int

Jul 29, 2026

Changes in this version

+ const PlaintextAuthWarning

+ func NormalizeAddress(s string) string

type PrefsAPI

+ Settings SettingsStore

type PrefsResponse

+ DeliveryAvailable bool

type SMTPSettingsView

+ Warnings []string

Jul 25, 2026

Changes in this version

+ const CategoryMention

+ const KindMention

type Enqueuer

+ func (e *Enqueuer) NotifyFanout(ctx context.Context, recipients []string, category string, p Payload) []string

type Prefs

+ MentionsEnabled bool

type PrefsRequest

+ MentionsEnabled *bool

type PrefsResponse

+ MentionsEnabled bool

type PrefsUpdate

+ MentionsEnabled *bool

Jul 22, 2026

Changes in this version

type Branding

+ AboutText string

+ ReplyTo string

+ SupportContact string

type Email

+ ReplyTo string

Jul 22, 2026

Changes in this version

type Branding

+ PrivacyURL string

+ TermsURL string

type Email

+ UnsubURL string

Jul 21, 2026

Changes in this version

+ func UnsubToken(key []byte, email string) string

+ func VerifyUnsubToken(key []byte, tok string) (email string, ok bool)

type Renderer

+ func (r *Renderer) RenderGuestLink(to, link string) (*Email, error)

+ func (r *Renderer) SetUnsubscribeURLFn(fn func(email string) string)

+ type UnsubscribeHandler struct

+ BrandName string

+ Key []byte

+ Prefs PrefsStore

+ func (h *UnsubscribeHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Jul 20, 2026

Changes in this version

type Branding

+ LogoPNG []byte

type Email

+ LogoPNG []byte

Jul 20, 2026

Changes in this version

+ const CategoryComment

+ const CategoryShare

+ const DefaultLease

+ const DefaultMaxAttempts

+ const DefaultPendingTTL

+ const DefaultPollEvery

+ const DefaultResolvedRetention

+ const KindAsset

+ const KindCollection

+ const KindComment

+ const KindFeedback

+ const KindPrompt

+ const ModeDaily

+ const ModeImmediate

+ const ModeOff

+ const NotifyChannel

+ const SettingsSectionSMTP

+ const StatusFailed

+ const StatusPending

+ const StatusSending

+ const StatusSent

+ const TLSModeImplicit

+ const TLSModeNone

+ const TLSModeStartTLS

+ var ErrNoWork = errors.New("notification: no work available")

+ var ErrNotFound = errors.New("notification: not found")

+ var ErrSMTPNotConfigured = errors.New("notification: smtp is disabled or not configured")

+ func NextDigestTime(now time.Time, hourUTC int) time.Time

+ func PortalLink(baseURL, route string) string

+ func RecipientsExcluding(actor string, candidates ...string) []string

+ func Snippet(s string) string

+ func ValidMode(m string) bool

+ type Branding struct

+ BaseURL string

+ ImplementorName string

+ ImplementorURL string

+ Name string

+ type Email struct

+ HTML string

+ Subject string

+ Text string

+ To string

+ type Enqueuer struct

+ func NewEnqueuer(prefs PrefsStore, queue QueueStore, digestHourUTC int) *Enqueuer

+ func (e *Enqueuer) Close()

+ func (e *Enqueuer) Notify(ctx context.Context, recipient, category string, p Payload) error

+ type Listener struct

+ func NewListener(dsn string, notifiers ...notifier) *Listener

+ func (l *Listener) Start(_ context.Context) error

+ func (l *Listener) Stop()

+ type Notification struct

+ Attempts int

+ Category string

+ CreatedAt time.Time

+ Digest bool

+ ID int64

+ LastError string

+ Payload Payload

+ Recipient string

+ ScheduledFor time.Time

+ SentAt *time.Time

+ Status string

+ type Payload struct

+ Actor string

+ ItemID string

+ ItemTitle string

+ Kind string

+ Link string

+ Message string

+ type PostgresPrefsStore struct

+ func NewPostgresPrefsStore(db *sql.DB) *PostgresPrefsStore

+ func (s *PostgresPrefsStore) Get(ctx context.Context, email string) (Prefs, error)

+ func (s *PostgresPrefsStore) Set(ctx context.Context, email string, u PrefsUpdate) (Prefs, error)

+ type PostgresQueueStore struct

+ func NewPostgresQueueStore(db *sql.DB) *PostgresQueueStore

+ func (s *PostgresQueueStore) ClaimDigest(ctx context.Context, lease time.Duration) ([]Notification, error)

+ func (s *PostgresQueueStore) ClaimImmediate(ctx context.Context, lease time.Duration) (*Notification, error)

+ func (s *PostgresQueueStore) Enqueue(ctx context.Context, n Notification) error

+ func (s *PostgresQueueStore) Fail(ctx context.Context, ids []int64, sendErr string) error

+ func (s *PostgresQueueStore) MarkSent(ctx context.Context, ids []int64) error

+ func (s *PostgresQueueStore) PurgeOld(ctx context.Context, resolvedRetention, pendingTTL time.Duration) (int64, error)

+ func (s *PostgresQueueStore) Retry(ctx context.Context, ids []int64, sendErr string, backoff time.Duration) error

+ type PostgresSettingsStore struct

+ func NewPostgresSettingsStore(db *sql.DB, enc StringEncryptor) *PostgresSettingsStore

+ func (s *PostgresSettingsStore) GetSMTP(ctx context.Context) (*SMTPSettings, error)

+ func (s *PostgresSettingsStore) SetSMTP(ctx context.Context, in SMTPSettings, author string) error

+ type Prefs struct

+ CommentsEnabled bool

+ Email string

+ Mode string

+ SharesEnabled bool

+ UpdatedAt time.Time

+ func DefaultPrefs(email string) Prefs

+ type PrefsAPI struct

+ Store PrefsStore

+ UserEmail func(*http.Request) string

+ func (a *PrefsAPI) Register(mux *http.ServeMux)

+ type PrefsRequest struct

+ CommentsEnabled *bool

+ Mode *string

+ SharesEnabled *bool

+ type PrefsResponse struct

+ CommentsEnabled bool

+ Mode string

+ SharesEnabled bool

+ type PrefsStore interface

+ Get func(ctx context.Context, email string) (Prefs, error)

+ Set func(ctx context.Context, email string, u PrefsUpdate) (Prefs, error)

+ type PrefsUpdate struct

+ CommentsEnabled *bool

+ Mode *string

+ SharesEnabled *bool

+ type QueueStore interface

+ ClaimDigest func(ctx context.Context, lease time.Duration) ([]Notification, error)

+ ClaimImmediate func(ctx context.Context, lease time.Duration) (*Notification, error)

+ Enqueue func(ctx context.Context, n Notification) error

+ Fail func(ctx context.Context, ids []int64, sendErr string) error

+ MarkSent func(ctx context.Context, ids []int64) error

+ PurgeOld func(ctx context.Context, resolvedRetention, pendingTTL time.Duration) (int64, error)

+ Retry func(ctx context.Context, ids []int64, sendErr string, backoff time.Duration) error

+ type Renderer struct

+ func NewRenderer(b Branding) (*Renderer, error)

+ func (r *Renderer) Render(ns []Notification) (*Email, error)

+ func (r *Renderer) RenderTest(to string) (*Email, error)

+ type SMTPSender struct

+ func NewSMTPSender() *SMTPSender

+ func (*SMTPSender) Send(ctx context.Context, settings SMTPSettings, email Email) error

+ type SMTPSettings struct

+ Enabled bool

+ From string

+ FromName string

+ Host string

+ Password string

+ Port int

+ TLSMode string

+ UpdatedAt time.Time

+ UpdatedBy string

+ Username string

+ func (s *SMTPSettings) View() SMTPSettingsView

+ type SMTPSettingsInput struct

+ Enabled bool

+ From string

+ FromName string

+ Host string

+ Password string

+ Port int

+ TLSMode string

+ Username string

+ func (in *SMTPSettingsInput) Settings() SMTPSettings

+ func (in *SMTPSettingsInput) Validate() string

+ type SMTPSettingsView struct

+ Enabled bool

+ From string

+ FromName string

+ Host string

+ PasswordSet bool

+ Port int

+ TLSMode string

+ UpdatedAt time.Time

+ UpdatedBy string

+ Username string

+ func UnconfiguredSMTPView() SMTPSettingsView

+ type Sender interface

+ Send func(ctx context.Context, settings SMTPSettings, email Email) error

+ type SettingsStore interface

+ GetSMTP func(ctx context.Context) (*SMTPSettings, error)

+ SetSMTP func(ctx context.Context, s SMTPSettings, author string) error

+ type StringEncryptor interface

+ Decrypt func(ciphertext string) (string, error)

+ Encrypt func(plaintext string) (string, error)

+ type TestEmailRequest struct

+ To string

+ func (r *TestEmailRequest) Validate() string

+ type Worker struct

+ func NewWorker(cfg WorkerConfig) *Worker

+ func (w *Worker) Notify()

+ func (w *Worker) Start(_ context.Context)

+ func (w *Worker) Stop()

+ type WorkerConfig struct

+ Lease time.Duration

+ MaxAttempts int

+ PollEvery time.Duration

+ Queue QueueStore

+ Renderer *Renderer

+ Sender Sender

+ Settings SettingsStore