Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jordan-wright/email
Robust and flexible email library for Go
https://github.com/jordan-wright/email
Last synced: 4 days ago
JSON representation
Robust and flexible email library for Go
- Host: GitHub
- URL: https://github.com/jordan-wright/email
- Owner: jordan-wright
- License: mit
- Created: 2013-12-12T20:11:59.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T15:25:08.000Z (11 months ago)
- Last Synced: 2025-01-14T11:12:17.704Z (12 days ago)
- Language: Go
- Homepage:
- Size: 195 KB
- Stars: 2,684
- Watchers: 59
- Forks: 321
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - email - A robust and flexible email library for Go. (Email / Search and Analytic Databases)
- awesome-go - jordan-wright/email
- awesome-ccamel - jordan-wright/email - Robust and flexible email library for Go (Go)
- go-awesome - jordan-wright/email
- awesome-go - email - A robust and flexible email library for Go. Stars:`2.7K`. (Email / Search and Analytic Databases)
- awesome-cobol - email - A robust and flexible email library for Cobol. (Email / Middlewares)
- awesome-go - email - Robust and flexible email library for Go - ★ 951 (Email)
- awesome-go-extra - email - 12-12T20:11:59Z|2021-12-17T03:22:10Z| (Email / Advanced Console UIs)
- awesome-go - email
- awesome-go - email
README
email
=====
[](https://travis-ci.org/jordan-wright/email) [](https://godoc.org/github.com/jordan-wright/email)
Robust and flexible email library for Go
### Email for humans
The ```email``` package is designed to be simple to use, but flexible enough so as not to be restrictive. The goal is to provide an *email interface for humans*.
The ```email``` package currently supports the following:
* From, To, Bcc, and Cc fields
* Email addresses in both "[email protected]" and "First Last <[email protected]>" format
* Text and HTML Message Body
* Attachments
* Read Receipts
* Custom headers
* More to come!
### Installation
```go get github.com/jordan-wright/email```
*Note: Version > 1 of this library requires Go v1.5 or above.*
*If you need compatibility with previous Go versions, you can use the previous package at gopkg.in/jordan-wright/email.v1*
### Examples
#### Sending email using Gmail
```go
e := email.NewEmail()
e.From = "Jordan Wright "
e.To = []string{"[email protected]"}
e.Bcc = []string{"[email protected]"}
e.Cc = []string{"[email protected]"}
e.Subject = "Awesome Subject"
e.Text = []byte("Text Body is, of course, supported!")
e.HTML = []byte("
Fancy HTML is supported, too!
")
e.Send("smtp.gmail.com:587", smtp.PlainAuth("", "[email protected]", "password123", "smtp.gmail.com"))
```
#### Another Method for Creating an Email
You can also create an email directly by creating a struct as follows:
```go
e := &email.Email {
To: []string{"[email protected]"},
From: "Jordan Wright ",
Subject: "Awesome Subject",
Text: []byte("Text Body is, of course, supported!"),
HTML: []byte("
Fancy HTML is supported, too!
"),
Headers: textproto.MIMEHeader{},
}
```
#### Creating an Email From an io.Reader
You can also create an email from any type that implements the ```io.Reader``` interface by using ```email.NewEmailFromReader```.
#### Attaching a File
```go
e := NewEmail()
e.AttachFile("test.txt")
```
#### A Pool of Reusable Connections
```go
(var ch <-chan *email.Email)
p := email.NewPool(
"smtp.gmail.com:587",
4,
smtp.PlainAuth("", "[email protected]", "password123", "smtp.gmail.com"),
)
for i := 0; i < 4; i++ {
go func() {
for e := range ch {
p.Send(e, 10 * time.Second)
}
}()
}
```
### Documentation
[http://godoc.org/github.com/jordan-wright/email](http://godoc.org/github.com/jordan-wright/email)
### Other Sources
Sections inspired by the handy [gophermail](https://github.com/jpoehls/gophermail) project.
### Contributors
I'd like to thank all the [contributors and maintainers](https://github.com/jordan-wright/email/graphs/contributors) of this package.
A special thanks goes out to Jed Denlea [jeddenlea](https://github.com/jeddenlea) for his numerous contributions and optimizations.