postmark

package
v2.0.2 Latest Latest
Warning

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

Go to latest
Published: Mar 23, 2026 License: AGPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (

	// ErrNilConfig indicates a nil config was provided.
	ErrNilConfig = platformerrors.New("postmark config is nil")
	// ErrEmptyServerToken indicates an empty server token was provided.
	ErrEmptyServerToken = platformerrors.New("empty Postmark server token")
	// ErrNilHTTPClient indicates a nil HTTP client was provided.
	ErrNilHTTPClient = platformerrors.New("nil HTTP client")
)

Functions

This section is empty.

Types

type Config

type Config struct {
	ServerToken string `env:"SERVER_TOKEN" json:"serverToken"`
	// BaseURL overrides the API base URL (e.g. for testing with httptest).
	BaseURL string `env:"BASE_URL" json:"baseURL"`
}

Config configures Postmark to send email.

func (*Config) ValidateWithContext

func (s *Config) ValidateWithContext(ctx context.Context) error

ValidateWithContext validates a Config struct.

type Emailer

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

Emailer uses Postmark to send email.

func NewPostmarkEmailer

func NewPostmarkEmailer(cfg *Config, logger logging.Logger, tracerProvider tracing.TracerProvider, client *http.Client, circuitBreaker circuitbreaking.CircuitBreaker) (*Emailer, error)

NewPostmarkEmailer returns a new Postmark-backed Emailer.

func (*Emailer) SendEmail

func (e *Emailer) SendEmail(ctx context.Context, details *email.OutboundEmailMessage) error

SendEmail sends an email.

Jump to

Keyboard shortcuts

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