wneessen/go-mail
1
1
Fork 0
mirror of https://github.com/wneessen/go-mail.git synced 2024-09-19 18:52:47 +02:00
Code Issues Projects Releases Packages Wiki Activity

Reformatted README.md

Browse source
This commit is contained in:
Winni Neessen 2022-03-14 10:57:55 +01:00
parent 25153c6b6b
commit 600ca8522e
Signed by: wneessen
GPG key ID: 385AC9889632126E
1 changed files with 22 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -3,19 +3,19 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/wneessen/go-mail)](https://goreportcard.com/report/github.com/wneessen/go-mail) [![Build Status](https://api.cirrus-ci.com/github/wneessen/go-mail.svg)](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> [![Go Report Card](https://goreportcard.com/badge/github.com/wneessen/go-mail)](https://goreportcard.com/report/github.com/wneessen/go-mail) [![Build Status](https://api.cirrus-ci.com/github/wneessen/go-mail.svg)](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 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 my [JS-Mailer](https://github.com/wneessen/js-mailer) project. It quickly evolved into a full-fledged mail library.
full-fledged mail library.
go-mail follows idiomatic Go style and best practice. It's only dependency is the Go Standard Library. go-mail follows idiomatic Go style and best practice. It's only dependency is the Go Standard Library. It combines a lot
It combines a lot of functionality from the standard library to give easy and convenient access to of functionality from the standard library to give easy and convenient access to mail and SMTP related tasks.
mail and SMTP related tasks.
Parts of this library (especially some parts of [msgwriter.go](msgwriter.go)) have been forked/ported from the Parts of this library (especially some parts of [msgwriter.go](msgwriter.go)) have been forked/ported from the
[go-mail/mail](https://github.com/go-mail/mail) respectively [go-gomail/gomail](https://github.com/go-gomail/gomail) [go-mail/mail](https://github.com/go-mail/mail) respectively [go-gomail/gomail](https://github.com/go-gomail/gomail)
which both seems to not be maintained anymore. which both seems to not be maintained anymore.
## Features ## Features
Some of the features of this library: Some of the features of this library:
* [X] Only Standard Library dependant * [X] Only Standard Library dependant
* [X] Modern, idiomatic Go * [X] Modern, idiomatic Go
* [X] Sane and secure defaults * [X] Sane and secure defaults
@ -29,10 +29,11 @@ Some of the features of this library:
* [X] Support for attachments and inline embeds * [X] Support for attachments and inline embeds
* [ ] Support for different encodings (existing but not fully tested) * [ ] Support for different encodings (existing but not fully tested)
go-mail works like a programatic email client and provides lots of methods and functionalities you would go-mail works like a programatic email client and provides lots of methods and functionalities you would consider
consider standard in a MUA. standard in a MUA.
## Examples ## Examples
The package is shipped with GoDoc example code for difference scenarios. Check them out on its The package is shipped with GoDoc example code for difference scenarios. Check them out on its
[GoDoc page](https://pkg.go.dev/github.com/wneessen/go-mail#pkg-examples) [GoDoc page](https://pkg.go.dev/github.com/wneessen/go-mail#pkg-examples)
@ -62,7 +63,7 @@ func main() {
if err := m.To(`"Max Mastermind <rcpt@example.com>"`); err != nil { if err := m.To(`"Max Mastermind <rcpt@example.com>"`); err != nil {
fmt.Printf("failed to set TO address: %s\n", err) fmt.Printf("failed to set TO address: %s\n", err)
os.Exit(1) os.Exit(1)
} }
m.CcIgnoreInvalid("cc@example.com") m.CcIgnoreInvalid("cc@example.com")
// Set a subject line // Set a subject line
@ -93,7 +94,7 @@ func main() {
if err != nil { if err != nil {
fmt.Printf("failed to create new mail client: %s\n", err) fmt.Printf("failed to create new mail client: %s\n", err)
os.Exit(1) os.Exit(1)
} }
// Now that we have our client, we can connect to the server and send our mail message // Now that we have our client, we can connect to the server and send our mail message
// via the convenient DialAndSend() method. You have the option to Dial() and Send() // via the convenient DialAndSend() method. You have the option to Dial() and Send()
@ -101,7 +102,7 @@ func main() {
if err := c.DialAndSend(m); err != nil { if err := c.DialAndSend(m); err != nil {
fmt.Printf("failed to send mail: %s\n", err) fmt.Printf("failed to send mail: %s\n", err)
os.Exit(1) os.Exit(1)
} }
fmt.Println("Mail successfully sent.") fmt.Println("Mail successfully sent.")
} }