mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-29 02:44:08 -05:00
93 lines
2.2 KiB
Markdown
93 lines
2.2 KiB
Markdown
|
# Gomail
|
||
|
|
[](https://travis-ci.org/go-gomail/gomail) [](http://gocover.io/gopkg.in/gomail.v2) [](https://godoc.org/gopkg.in/gomail.v2)
|
||
|
|
|
||
|
|
## Introduction
|
||
|
|
|
||
|
|
Gomail is a simple and efficient package to send emails. It is well tested and
|
||
|
|
documented.
|
||
|
|
|
||
|
|
Gomail can only send emails using an SMTP server. But the API is flexible and it
|
||
|
|
is easy to implement other methods for sending emails using a local Postfix, an
|
||
|
|
API, etc.
|
||
|
|
|
||
|
|
It is versioned using [gopkg.in](https://gopkg.in) so I promise
|
||
|
|
there will never be backward incompatible changes within each version.
|
||
|
|
|
||
|
|
It requires Go 1.2 or newer. With Go 1.5, no external dependencies are used.
|
||
|
|
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
Gomail supports:
|
||
|
|
- Attachments
|
||
|
|
- Embedded images
|
||
|
|
- HTML and text templates
|
||
|
|
- Automatic encoding of special characters
|
||
|
|
- SSL and TLS
|
||
|
|
- Sending multiple emails with the same SMTP connection
|
||
|
|
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
https://godoc.org/gopkg.in/gomail.v2
|
||
|
|
|
||
|
|
|
||
|
|
## Download
|
||
|
|
|
||
|
|
go get gopkg.in/gomail.v2
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
See the [examples in the documentation](https://godoc.org/gopkg.in/gomail.v2#example-package).
|
||
|
|
|
||
|
|
|
||
|
|
## FAQ
|
||
|
|
|
||
|
|
### x509: certificate signed by unknown authority
|
||
|
|
|
||
|
|
If you get this error it means the certificate used by the SMTP server is not
|
||
|
|
considered valid by the client running Gomail. As a quick workaround you can
|
||
|
|
bypass the verification of the server's certificate chain and host name by using
|
||
|
|
`SetTLSConfig`:
|
||
|
|
|
||
|
|
package main
|
||
|
|
|
||
|
|
import (
|
||
|
|
"crypto/tls"
|
||
|
|
|
||
|
|
"gopkg.in/gomail.v2"
|
||
|
|
)
|
||
|
|
|
||
|
|
func main() {
|
||
|
|
d := gomail.NewDialer("smtp.example.com", 587, "user", "123456")
|
||
|
|
d.TLSConfig = &tls.Config{InsecureSkipVerify: true}
|
||
|
|
|
||
|
|
// Send emails using d.
|
||
|
|
}
|
||
|
|
|
||
|
|
Note, however, that this is insecure and should not be used in production.
|
||
|
|
|
||
|
|
|
||
|
|
## Contribute
|
||
|
|
|
||
|
|
Contributions are more than welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for
|
||
|
|
more info.
|
||
|
|
|
||
|
|
|
||
|
|
## Change log
|
||
|
|
|
||
|
|
See [CHANGELOG.md](CHANGELOG.md).
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[MIT](LICENSE)
|
||
|
|
|
||
|
|
|
||
|
|
## Contact
|
||
|
|
|
||
|
|
You can ask questions on the [Gomail
|
||
|
|
thread](https://groups.google.com/d/topic/golang-nuts/jMxZHzvvEVg/discussion)
|
||
|
|
in the Go mailing-list.
|