diff --git a/README.md b/README.md
index ff05b81..ead383e 100644
--- a/README.md
+++ b/README.md
@@ -3,19 +3,19 @@
[](https://goreportcard.com/report/github.com/wneessen/go-mail) [](https://cirrus-ci.com/github/wneessen/go-mail) 
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.
+my [JS-Mailer](https://github.com/wneessen/js-mailer) project. It quickly evolved into a full-fledged mail library.
-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.
+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.
-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)
+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)
which both seems to not be maintained anymore.
## Features
+
Some of the features of this library:
+
* [X] Only Standard Library dependant
* [X] Modern, idiomatic Go
* [X] Sane and secure defaults
@@ -29,12 +29,13 @@ Some of the features of this library:
* [X] Support for attachments and inline embeds
* [ ] 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
-consider standard in a MUA.
+go-mail works like a programatic email client and provides lots of methods and functionalities you would consider
+standard in a MUA.
## Examples
+
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)
For ease of use, here is a full usage example:
@@ -62,24 +63,24 @@ func main() {
if err := m.To(`"Max Mastermind "`); err != nil {
fmt.Printf("failed to set TO address: %s\n", err)
os.Exit(1)
- }
+ }
m.CcIgnoreInvalid("cc@example.com")
-
+
// Set a subject line
m.Subject("This is a great email")
-
+
// And some other common headers
m.SetDate() // Sets a valid "Date" header field with the current time
m.SetMessageID() // Generates a valid and unique "Message-ID"
m.SetBulk() // Sets the "Precedence"-Header to "bulk" to indicate a "bulk mail"
-
+
// Add your mail message to body
m.SetBodyString(mail.TypeTextPlain, "This is a great message body text.")
-
+
// Attach a file from your local FS
// We override the attachment name using the WithFileName() Option
m.AttachFile("/home/ttester/test.txt", mail.WithFileName("attachment.txt"))
-
+
// Next let's create a Client
// We have lots of With* options at our disposal to stear the Client. It will set sane
// options by default, though
@@ -87,22 +88,22 @@ func main() {
// Let's assume we need to perform SMTP AUTH with the sending server, though. Since we
// use SMTP PLAIN AUTH, let's also make sure to enforce strong TLS
host := "relay.example.com"
- c, err := mail.NewClient(host,
+ c, err := mail.NewClient(host,
mail.WithSMTPAuth(mail.SMTPAuthPlain), mail.WithUsername("ttester"),
mail.WithPassword("V3rySecUr3!Pw."), mail.WithTLSPolicy(mail.TLSMandatory))
if err != nil {
fmt.Printf("failed to create new mail client: %s\n", err)
os.Exit(1)
- }
-
+ }
+
// 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()
// seperately as well
if err := c.DialAndSend(m); err != nil {
fmt.Printf("failed to send mail: %s\n", err)
os.Exit(1)
- }
-
+ }
+
fmt.Println("Mail successfully sent.")
}
```
\ No newline at end of file