README
¶
go-ses - send email using Amazon AWS Simple Email Service
go-ses is an API client library for Amazon AWS Simple Email Service (SES). It is a fork of Patrick Crosby's stathat/amzses.
Note: the public API is experimental and subject to change until further notice.
Usage
Documentation: go-ses on Sourcegraph.
Example: example_test.go (Sourcegraph):
package ses_test
import (
"fmt"
"github.com/sourcegraph/go-ses"
)
func Example() {
// Change the From address to a sender address that is verified in your Amazon SES account.
from := "notify@sourcegraph.com"
to := "success@simulator.amazonses.com"
// EnvConfig uses the AWS credentials in the environment variables $AWS_ACCESS_KEY_ID and
// $AWS_SECRET_KEY.
res, err := ses.EnvConfig.SendEmail(from, to, "Hello, world!", "Here is the message body.")
if err == nil {
fmt.Printf("Sent email: %s...\n", res[:32])
} else {
fmt.Printf("Error sending email: %s\n", err)
}
// output:
// Sent email: <SendEmailResponse xmlns="http:/...
}
Running tests
- Set the environment variables
$AWS_ACCESS_KEY_IDand$AWS_SECRET_KEYand$AWS_SES_ENDPOINT. - Example SES Endpoint
https://email.us-west-2.amazonaws.com - Run
go test -from=user@example.com, whereuser@example.comis a sender address that is verified in your Amazon SES account.
Contributors
- Quinn Slack sqs@sourcegraph.com
- Patrick Crosby (author of original stathat/amzses)
Changelog
2013-06-11 (forked from stathat/amzses)
- renamed API functions to be consistent with AWS SES API endpoints
- reads AWS credentials from a Config struct, not from a config file
- added runnable example_test.go
Documentation
¶
Overview ¶
Package ses sends emails using the Amazon AWS Simple Email Service (SES).
Example ¶
package main
import (
"fmt"
"github.com/sourcegraph/go-ses"
)
func main() {
// Change the From address to a sender address that is verified in your Amazon SES account.
from := "notify@sourcegraph.com"
to := "success@simulator.amazonses.com"
// EnvConfig uses the AWS credentials in the environment variables $AWS_ACCESS_KEY_ID and
// $AWS_SECRET_KEY.
res, err := ses.EnvConfig.SendEmail(from, to, "Hello, world!", "Here is the message body.")
if err == nil {
fmt.Printf("Sent email: %s...\n", res[:32])
} else {
fmt.Printf("Error sending email: %s\n", err)
}
}
Output: Sent email: <SendEmailResponse xmlns="http:/...
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var EnvConfig = Config{ Endpoint: os.Getenv("AWS_SES_ENDPOINT"), AccessKeyID: os.Getenv("AWS_ACCESS_KEY_ID"), 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
// AccessKeyID is your Amazon AWS access key ID.
AccessKeyID string
// SecretAccessKey is your Amazon AWS secret key.
SecretAccessKey string
}
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.
func (*Config) SendEmailHTML ¶
SendEmailHTML sends a HTML email. Note that from must be a verified address in the AWS control panel.
Source Files