Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 2.02 KB

README.md

File metadata and controls

42 lines (32 loc) · 2.02 KB
Raw

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.

Static Badge Commitizen friendly Go Reference

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

  1. Setup environment variables by copying .env.example -> .env and filling out the missing environment variables.

    cp .env.example .env

  2. There is a standalone HTTP server you can run with:

    go run cmd/standalone/standalone.go

    This standalone server uses the NoopSender so it does not actually send emails which is nice for testing. You can send CloudEvents via HTTP by using the public postman collection.

Run in Postman

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.