README
¶
gas/email
Part of the Gas monorepo · Documentation · All modules
Transactional email for the Gas framework, over AWS SES, with optional
template rendering through gas.TemplateProvider.
Implements gas.EmailProvider.
go get github.com/gasmod/gas/email
gas.WithSingletonService[gas.EmailProvider](ses.New()),
ses.New() needs gas.TemplateProvider, gas.ConfigProvider and gas.Logger, even if you
only ever call Send.
| Package | Provides |
|---|---|
email/ses |
AWS SES, and LocalStack via a custom endpoint |
email/emailtest |
Recording mock of gas.EmailProvider |
Documentation
The full guide, with configuration, testing, and worked examples, is on the docs site. This README is deliberately a signpost: keeping a second copy here is how the docs drifted before.
- Guide: Send email
- API reference: pkg.go.dev/github.com/gasmod/gas/email
- Contributing: CONTRIBUTING.md
License
Documentation
¶
Overview ¶
Package email provides email sending via AWS SES with template integration. Concrete implementations live in the ses sub-package.
See the module README for usage examples and design rationale.
SPDX-License-Identifier: MIT
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrClosed is returned when an operation is attempted on a closed // email service. ErrClosed = errors.New("email: service is closed") )
Sentinel errors returned by EmailProvider implementations.
Functions ¶
func IsErrClosed ¶
IsErrClosed checks if the provided error corresponds to the ErrClosed sentinel error.
Types ¶
This section is empty.
Source Files
Directories