golazy.dev
–
golazy.dev
/
lazymailer
Index
|
Files
package lazymailer ¶
import "golazy.dev/lazymailer"Functions ¶
func MustParseAddress ¶
func MustParseAddress(value string) mail.Addressfunc ParseAddress ¶
func ParseAddress(value string) (mail.Address, error)func Recipients ¶
func Recipients(addresses []mail.Address) []stringfunc WithContext ¶
func WithContext(ctx context.Context, mailer *Mailer) context.ContextTypes ¶
type Address ¶
type Address = mail.Addresstype Base ¶
type Base struct {
// contains filtered or unexported fields
}func NewBase ¶
func NewBase(ctx context.Context, controller string, defaults Defaults) (Base, error)func (b *Base) Build ¶
func (b *Base) Build(options Options) (Message, error)func (b *Base) Mail ¶
func (b *Base) Mail(options Options) errorfunc (b *Base) Set ¶
func (b *Base) Set(name string, value any)type Defaults ¶
type Defaults struct {
From mail.Address
Delivery string
Layout string
Headers textproto.MIMEHeader
}type Delivery ¶
type Delivery interface {
Deliver(context.Context, Message) error
}type DeliveryFunc ¶
type DeliveryFunc func(context.Context, Message) errorfunc (f DeliveryFunc) Deliver ¶
func (f DeliveryFunc) Deliver(ctx context.Context, message Message) errortype Mailer ¶
type Mailer struct {
// contains filtered or unexported fields
}func FromContext ¶
func FromContext(ctx context.Context) (*Mailer, bool)func New ¶
func New(ctx context.Context, deliveries *Registry) (*Mailer, error)type MemoryDelivery ¶
type MemoryDelivery struct {
// contains filtered or unexported fields
}func (d *MemoryDelivery) Deliver ¶
func (d *MemoryDelivery) Deliver(_ context.Context, message Message) errorfunc (d *MemoryDelivery) Messages ¶
func (d *MemoryDelivery) Messages() []Messagetype Message ¶
type Message struct {
From mail.Address
To []mail.Address
Subject string
Headers textproto.MIMEHeader
Text string
HTML string
}func (m Message) Bytes ¶
func (m Message) Bytes() ([]byte, error)type Options ¶
type Options struct {
Action string
To []mail.Address
From mail.Address
Subject string
Delivery string
Layout string
Headers textproto.MIMEHeader
}type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}func NewRegistry ¶
func NewRegistry(defaultName string, deliveries map[string]Delivery) *Registryfunc (r *Registry) Deliver ¶
func (r *Registry) Deliver(ctx context.Context, name string, message Message) errortype SMTPDelivery ¶
type SMTPDelivery struct {
Addr string
Auth smtp.Auth
}func (d SMTPDelivery) Deliver ¶
func (d SMTPDelivery) Deliver(_ context.Context, message Message) error
Package lazymailer renders mailer views into standard-library MIME messages and sends them through pluggable delivery implementations.
The package has a deliberate boundary between rendering and delivery. Base holds template variables with Set, Build renders a Message, and Mail calls Build and then passes the message to a named Delivery in a Registry. Build is useful when tests need to inspect the rendered text, HTML, headers, or recipients before anything is sent. Mail is the normal application path when a message should cross the delivery boundary.
Mailer templates are rendered by lazyview through the renderer stored in context by lazycontroller. The controller name passed to NewBase selects the view directory, and Options.Action selects the template basename. For example, NewBase(ctx, "notice_mailer", defaults) with Action "welcome" looks for notice_mailer/welcome.text.* and notice_mailer/welcome.html.* templates. Text and HTML are rendered independently; one format may be missing, but Build returns an error when neither format exists. Layout defaults to "mailer", so mailer layouts usually live next to application layouts as layouts/mailer.text.* and layouts/mailer.html.*.
In a conventional GoLazy application, lazyapp creates the shared lazyview renderer and stores it in the application context through lazycontroller. Application setup then creates a Mailer with New, stores it with WithContext, and constructs app-specific mailer types that embed or hold Base. The same embedded view filesystem, template engine registration, and helpers used by lazycontroller views are therefore available to mailer views. lazyapp does not choose an SMTP server or test delivery by itself; applications keep that configuration at their dependency or context boundary and pass a Registry to New.
The package is also usable without lazyapp. Create a lazycontroller renderer from an fs.FS, put it in context with lazycontroller.WithRenderer, import a lazyview engine such as golazy.dev/lazyview/gotmpl, and then use New, WithContext, and NewBase exactly as an application would.
Delivery is intentionally small. SMTPDelivery sends the bytes returned by Message.Bytes with net/smtp. MemoryDelivery records Message values for tests and development. DeliveryFunc adapts a function when an application already has another mail transport, queue, or provider client.