README
¶
go-ses
Table of Contents
- Installation
- Documentation
- Examples & Tests
- Benchmarks
- Code Standards
- Usage
- Maintainers
- Contributing
- License
Installation
go-ses requires a supported release of Go.
go get -u github.com/mrz1836/go-ses
Documentation
View the generated documentation
Features
- Send
raworhtmlemails - Multiple
to,cc, andbccrecipients - AWS4 signature compliance
Library Deployment
goreleaser for easy binary or library deployment to GitHub and can be installed via: brew install goreleaser.
The .goreleaser.yml file is used to configure goreleaser.
Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.
Makefile Commands
View all makefile commands
make help
List of all current commands:
all Runs multiple commands
clean Remove previous builds and any test cache data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
diff Show the git diff
generate Runs the go generate command in the base of the repo
godocs Sync the latest tag with GoDocs
help Show this help message
install Install the application
install-go Install the application (Using Native Go)
lint Run the golangci-lint application (install if not found)
release Full production release (creates release in Github)
release Runs common.release then runs godocs
release-snap Test the full release (build binaries)
release-test Full production test release (everything except deploy)
replace-version Replaces the version in HTML/JS (pre-deploy)
run-examples Runs all the examples
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
test Runs lint and ALL tests
test-ci Runs all tests via CI (exports coverage)
test-ci-no-race Runs all tests via CI (no race) (exports coverage)
test-ci-short Runs unit tests via CI (exports coverage)
test-no-lint Runs just tests
test-short Runs vet, lint and tests (excludes integration tests)
test-unit Runs tests and outputs coverage
uninstall Uninstall the application (and remove files)
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
Examples & Tests
All unit tests and examples run via GitHub Actions and uses Go version 1.19.x. View the configuration file.
Run all tests (including integration tests)
make test
Run tests (excluding integration tests)
make test-short
Run the examples:
make run-examples
Running Integration Tests
- Set the environment variables
$AWS_ACCESS_KEY_ID,$AWS_SECRET_KEY,$AWS_REGIONand$AWS_SES_ENDPOINT. - Run
go test -from=user@example.com, whereuser@example.comis a sender address that is verified in your Amazon SES account.
Benchmarks
Run the Go benchmarks:
make bench
Code Standards
Read more about this Go project's code standards.
Usage
View the examples
Maintainers
 |
|---|
| MrZ |
Contributing
Previous Contributors:
- Forked from publica-project
- Quinn Slack sqs@sourcegraph.com
- Patrick Crosby (author of original stathat/amzses)
View the contributing guidelines and follow the code of conduct.
How can I help?
All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀
License
Documentation
¶
Overview ¶
Package ses sends emails using the Amazon AWS Simple Email Service (SES).
Index ¶
Constants ¶
This section is empty.
Variables ¶
var EnvConfig = Config{ AccessKeyID: os.Getenv("AWS_ACCESS_KEY_ID"), Endpoint: os.Getenv("AWS_SES_ENDPOINT"), HTTPClient: http.DefaultClient, Region: os.Getenv("AWS_REGION"), SecretAccessKey: os.Getenv("AWS_SECRET_KEY"), }
EnvConfig takes the access key ID and secret access key values from the environment variables $AWS_ACCESS_KEY_ID and $AWS_SECRET_KEY, respectively.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Endpoint is the AWS endpoint to use for requests.
Endpoint string
// The region
Region string
// AccessKeyID is your Amazon AWS access key ID.
AccessKeyID string
// SecretAccessKey is your Amazon AWS secret key.
SecretAccessKey string
// HTTPClient is a http client to use
HTTPClient httpInterface
}
Config specifies configuration options and credentials for accessing Amazon SES.
func (*Config) SendEmail ¶
SendEmail sends a plain text email. Note that from must be a verified address in the AWS control panel.
Source Files
Directories