README
¶
email Package
email package responds to CloudEvents to send emails.
Check out the official documentation for end user documentation. This README is dedicated to information about package development.
Roadmap
- Add support for some sort of database to keep track of emails already sent to ensure exactly once delivery.
- Provide ready to go adapters for other SaaS providers besides Mailgun.
- Sendgrid
- Mandrill
Contributing
Local Setup
-
Setup environment variables by copying
.env.example->.envand filling out the missing environment variables.cp .env.example .env -
There is a standalone HTTP server you can run with:
go run cmd/standalone/standalone.goThis standalone server uses the
NoopSenderso it does not actually send emails which is nice for testing. You can send CloudEvents via HTTP by using the public postman collection.
Releasing
This package uses release-please which will open a "release" pull request anytime something
releasable is merged into the main branch. Once the release pull request is merged there is a manual CI step the
package author will need to kick off to create a GitHub release.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
standalone
Package main is meant for local testing purposes only, it sets up a minimalistic standalone server to send CloudEvents to.
|
Package main is meant for local testing purposes only, it sets up a minimalistic standalone server to send CloudEvents to. |
|
version
Package main prints the current version of the package.
|
Package main prints the current version of the package. |
|
Package send exposes primitives to send emails by responding to [CloudEvents].
|
Package send exposes primitives to send emails by responding to [CloudEvents]. |