email

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 16, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package email is the platform's one email-sending capability: a narrow Sender interface plus SMTP, SES, and Resend implementations, shared by internal/alerting and internal/api so neither imports the other.

Index

Constants

This section is empty.

Variables

View Source 
var ErrNotConfigured = errors.New("email: not configured")

ErrNotConfigured is returned by NewSender when a Config names no backend: no settings row and no env-var fallback.

Functions

func ValidateAddress added in v0.2.0 

func ValidateAddress(s string) error

ValidateAddress reports an error unless s is a single bare email address ("a@b.com", not "Name <a@b.com>" or a list).

Types

type Backend 

type Backend string

Backend names which transport a Config uses to actually send. 

const (
	BackendSMTP   Backend = "smtp"
	BackendSES    Backend = "ses"
	BackendResend Backend = "resend"
)

The backends NewSender supports.

type Config 

type Config struct {
	Backend Backend
	SMTP    *SMTPConfig
	SES     *SESConfig
	Resend  *ResendConfig
}

Config names which backend to use plus that backend's own settings.

type ConfigLoader 

type ConfigLoader func(ctx context.Context) (Config, error)

ConfigLoader resolves the current Config on every call, never cached: settings can change at runtime.

type DynamicSender 

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

DynamicSender adapts a ConfigLoader into a Sender, so a settings change takes effect on the very next send with no restart required.

func NewDynamicSender 

func NewDynamicSender(load ConfigLoader) *DynamicSender

NewDynamicSender builds a DynamicSender. load must not be nil.

func (*DynamicSender) Configured 

func (d *DynamicSender) Configured(ctx context.Context) bool

Configured reports whether the current settings name a backend that can send, so callers can tell "no mail server set up" from a failed send.

func (*DynamicSender) Send 

func (d *DynamicSender) Send(ctx context.Context, to, subject, body string) error

Send implements Sender. It rejects a CR or LF in to or subject before any backend runs, since either could start an injected header.

type ResendConfig added in v0.2.0 

type ResendConfig struct {
	APIKey string
	From   string
}

ResendConfig is a Resend sender's connection details.

type SESConfig 

type SESConfig struct {
	Region          string
	AccessKeyID     string
	SecretAccessKey string
	From            string
}

SESConfig is an AWS SES v2 sender's connection details.

type SMTPConfig 

type SMTPConfig struct {
	// Addr is host:port, e.g. "smtp.example.com:587".
	Addr     string
	Host     string // just the host part of Addr, for PlainAuth's identity check
	Username string
	Password string
	From     string
}

SMTPConfig is an SMTP server's connection details.

type Sender 

type Sender interface {
	Send(ctx context.Context, to, subject, body string) error
}

Sender sends one plain-text email.

func NewSender 

func NewSender(cfg Config) (Sender, error)

NewSender builds the Sender cfg.Backend names, or ErrNotConfigured for an empty or unrecognized Backend.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.