notifiers

type ChannelsStatus struct {
	PublicURL          string     `json:"publicUrl,omitempty" doc:"address used for links in messages; empty when the server was started without --public-url"`
	AllowPrivate       bool       `json:"allowPrivate" doc:"webhooks and ntfy may reach private-network addresses"`
	AllowPrivateSource string     `json:"allowPrivateSource,omitempty" enum:"env,settings"`
	SMTP               SMTPStatus `json:"smtp"`
	Ntfy               NtfyStatus `json:"ntfy"`
}

type Manager struct {
	// contains filtered or unexported fields
}

type NtfyInput struct {
	Server      string `json:"server,omitempty" doc:"base address of the ntfy server; default https://ntfy.sh"`
	Token       string `json:"token,omitempty" doc:"access token (tk_…), for servers that need one to publish; leave empty to keep the saved one"`
	RemoveToken bool   `json:"removeToken,omitempty" doc:"forget the saved access token"`
}

type NtfyStatus struct {
	Source   string `json:"source,omitempty" enum:"env,settings" doc:"empty: the default public server"`
	Server   string `json:"server" doc:"where members subscribe to their topic"`
	HasToken bool   `json:"hasToken" doc:"an access token is saved; it is never returned"`
}

type Options struct {
	// PublicURL is the address people open Exhale at (--public-url). Links
	// in messages need it; without it they are left out.
	PublicURL string
	// SMTP comes from EXHALE_SMTP_*; it applies when Host is set.
	SMTP email.Config
	// NtfyServer and NtfyToken come from EXHALE_NTFY_URL and _TOKEN.
	NtfyServer, NtfyToken string
	// AllowPrivate comes from EXHALE_ALLOW_PRIVATE_DESTINATIONS; nil when
	// it is not set.
	AllowPrivate *bool
	// Version goes in the User-Agent of webhooks.
	Version string

	// Guard replaces the network rules' resolver and dialer (tests).
	Guard *netguard.Guard
	// SMTPRoots replaces the system certificates for SMTP (tests).
	SMTPRoots *x509.CertPool
	// PushRoots replaces the system certificates for push services (tests).
	PushRoots *x509.CertPool
}

type PushActions interface {
	HandlePush(ctx context.Context, memberID, device, verb, chargeID string) (actions.PushResult, error)
}

type PushDevice struct {
	Endpoint string `json:"endpoint" doc:"the push service address from PushSubscription.endpoint"`
	P256dh   string `json:"p256dh" doc:"keys.p256dh, base64url"`
	Auth     string `json:"auth" doc:"keys.auth, base64url"`
	Device   string `json:"device,omitempty" doc:"how to show it, e.g. Chrome on Android"`
}

type PushStatus struct {
	PublicKey string `json:"publicKey" doc:"VAPID public key, base64url: the applicationServerKey to subscribe with"`
}

type SMTPInput struct {
	Host     string `json:"host" doc:"SMTP server, e.g. smtp.example.com"`
	Port     int    `json:"port,omitempty" doc:"default: 587 with starttls, 465 with tls, 25 with none"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty" doc:"leave empty to keep the saved password"`
	From     string `json:"from" doc:"sender address, e.g. reminders@example.com"`
	TLS      string `json:"tls,omitempty" enum:"starttls,tls,none" doc:"starttls (default), tls (implicit, port 465) or none (local relays)"`
}

type SMTPStatus struct {
	Configured  bool   `json:"configured"`
	Source      string `json:"source,omitempty" enum:"env,settings" doc:"env: set by EXHALE_SMTP_* on the server and not editable in the web"`
	Host        string `json:"host,omitempty"`
	Port        int    `json:"port,omitempty"`
	Username    string `json:"username,omitempty"`
	From        string `json:"from,omitempty"`
	TLS         string `json:"tls,omitempty" enum:"starttls,tls,none"`
	HasPassword bool   `json:"hasPassword" doc:"a password is saved; it is never returned"`
}