mirror of
https://github.com/wneessen/go-mail.git
synced 2024-11-14 09:52:54 +01:00
36 lines
No EOL
2 KiB
Markdown
36 lines
No EOL
2 KiB
Markdown
# go-mail - Simple and easy way to send mails in Go
|
|
|
|
[](https://goreportcard.com/report/github.com/wneessen/go-mail) [](https://cirrus-ci.com/github/wneessen/go-mail) <a href="https://ko-fi.com/D1D24V9IX"><img src="https://uploads-ssl.webflow.com/5c14e387dab576fe667689cf/5cbed8a4ae2b88347c06c923_BuyMeACoffee_blue.png" height="20" alt="buy ma a coffee"></a>
|
|
|
|
The main idea of this library was to provide a simple interface to sending mails for
|
|
my [JS-Mailer](https://github.com/wneessen/js-mailer) project. It quickly evolved into a
|
|
full-fledged mail library.
|
|
|
|
Parts (especially the msgWriter) of this library have been ported from the [GoMail](https://github.com/go-mail/mail)
|
|
which seems to not be maintained anymore.
|
|
|
|
**This library is "WIP" an should not be considered "production ready", yet.**
|
|
|
|
go-mail follows idiomatic Go style and best practice. It's only dependency is the Go Standard Library.
|
|
It combines a lot of functionality from the standard library to give easy and convenient access to
|
|
mail and SMTP related tasks.
|
|
|
|
## Features
|
|
Some of the features of this library:
|
|
* [X] Only Standard Library dependant
|
|
* [X] Modern, idiomatic Go
|
|
* [X] Sane and secure defaults
|
|
* [X] SSL/TLS support
|
|
* [X] StartTLS support with different policies
|
|
* [X] Makes use of contexts for a better control flow and timeout/cancelation handling
|
|
* [X] SMTP Auth support (LOGIN, PLAIN, CRAM-MD5, DIGEST-MD5)
|
|
* [X] RFC5322 compliant mail address validation
|
|
* [X] Support for common mail header field generation (Message-ID, Date, Bulk-Precedence, etc.)
|
|
* [X] Reusing the same SMTP connection to send multiple mails
|
|
* [ ] Support for different encodings
|
|
* [ ] Support for attachments
|
|
* [ ] Go template support
|
|
|
|
## Examples
|
|
The packageis shipped with example code. Check it out on the packages
|
|
[GoDoc page](https://pkg.go.dev/github.com/wneessen/go-mail#pkg-examples) |