mirror of
https://github.com/wneessen/go-mail.git
synced 2024-11-09 23:42:55 +01:00
Reformatted README.md
This commit is contained in:
parent
25153c6b6b
commit
600ca8522e
1 changed files with 22 additions and 21 deletions
15
README.md
15
README.md
|
@ -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)
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue