Documentation
¶
Overview ¶
Package notification is the module manifest: telling somebody something, in the application and optionally by mail.
It is the shape every module follows, with one deliberate omission: there is no rest.Spec. A Spec's list route is the whole tenant, and these rows are addressed to a person — every caller's list is a different list — so the two routes are written by hand and scoped by the principal rather than by a permission. See internal/handler.go.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var SMTP = internal.NewSMTP
SMTP is the production Mailer for a configured server. main wires it, or the in-memory Mailbox when there is none, so the choice is visible in the file that composes the application.
Functions ¶
Types ¶
type Deps ¶
type Deps struct {
// Recipients turns a user id into an email address. The interface is
// declared in this module's contracts/ and satisfied by an adapter over the
// user module in apps/platformkit: the app adapts, so notification never
// names user. A nil lookup writes every row and sends no mail.
Recipients contracts.RecipientLookup
// Mailer sends the rendered message, in the worker.
Mailer contracts.Mailer
// Hosts turns the tenant an event belongs to into the host its people reach
// the application at, which is what a notice's link has to become for a mail
// client. It is declared in this module's contracts/ and satisfied by an
// adapter over the tenant module in apps/platformkit, the same way
// Recipients is satisfied over the user module.
Hosts contracts.HostLookup
// Secure says the application is reached over https, which is the scheme a
// mailed link is built with. It is one bool rather than a host because it is
// the same decision the session cookie's Secure flag is: a laptop reached at
// a local name gets http, and everything else gets https.
Secure bool
}
Deps is what this module cannot make for itself.
type Mail ¶
Mail is one outgoing mail server. It has the same shape as config.Mail, so main converts one to the other in a line.
type Mailbox ¶
type Mailbox struct {
// contains filtered or unexported fields
}
Mailbox is contracts.Mailer over a slice. It keeps every message and logs each one, so a development machine can read what would have been sent and a test can assert on it.
It lives in the module and not in notificationtest, and the reason is a link rather than a taste. A deployment with no mail server wires this, so it is production code by use; notificationtest also holds a conformance suite, which imports "testing", and a package is linked whole — so the reference binary used to carry the testing package, its flag registrations and its init, because of where one struct sat. The test suite still uses this one: what a test wants and what an unconfigured deployment wants is the same thing, which is somewhere for a message to go that is not a mail server.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package contracts is everything another module, an app or a test may know about notifications: the entity, the notice, the events, the two interfaces this module needs somebody else to satisfy, and the Service.
|
Package contracts is everything another module, an app or a test may know about notifications: the entity, the notice, the events, the two interfaces this module needs somebody else to satisfy, and the Service. |
|
Package internal is every implementation of the notification module.
|
Package internal is every implementation of the notification module. |