logsender

package

v0.1.0 Latest Latest Go to latest Published: Oct 8, 2026 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/plexusone/omnimail

Links

Open Source Insights

Documentation ¶

Overview ¶

Package logsender provides an omnimail.Sender that writes messages to a slog.Logger instead of delivering them. It is intended for local development. Bodies are redacted by default because transactional mail carries secrets such as verification links; enable them with WithBodies only where logs are private.

Index ¶

Constants
type Option
- func WithBodies() Option
- func WithLevel(l slog.Level) Option
type Sender
- func New(logger *slog.Logger, opts ...Option) *Sender
- func (s *Sender) Send(ctx context.Context, msg *omnimail.Message) (*omnimail.SendResult, error)

Constants ¶

View Source

const ProviderName = "log"

ProviderName is reported in SendResult.Provider.

View Source

const Redacted = "[redacted]"

Redacted replaces body content in log records unless WithBodies is set.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Option ¶

type Option func(*Sender)

Option configures a Sender.

func WithBodies ¶

func WithBodies() Option

WithBodies logs the text and HTML bodies instead of redacting them.

func WithLevel ¶

func WithLevel(l slog.Level) Option

WithLevel sets the log level (default slog.LevelInfo).

type Sender ¶

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

Sender logs messages. It is safe for concurrent use.

func New ¶

func New(logger *slog.Logger, opts ...Option) *Sender

New returns a Sender writing to logger, or slog.Default() when nil.

func (*Sender) Send ¶

func (s *Sender) Send(ctx context.Context, msg *omnimail.Message) (*omnimail.SendResult, error)

Send validates msg and logs it as one record.

Source Files ¶

View all Source files

logsender.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL