wneessen/go-mail
1
1
Fork 0
mirror of https://github.com/wneessen/go-mail.git synced 2024-11-15 02:12:55 +01:00
Code Issues Projects Releases Packages Wiki Activity
go-mail/README.md

118 lines
7.3 KiB
Markdown
Raw Normal View History

#24: Add SPDX license IDs for REUSE compliance # SUMMARY * Bad licenses: * Deprecated licenses: * Licenses without file extension: * Missing licenses: * Unused licenses: * Used licenses: CC0-1.0, MIT * Read errors: 0 * Files with copyright information: 45 / 45 * Files with license information: 45 / 45 Congratulations! Your project is compliant with version 3.0 of the REUSE Specification :-)
2022-06-17 15:05:54 +02:00
<!--
Added note about forked smtp package Additionally added new feature references and updated contributors section
2023-01-15 16:12:33 +01:00
SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
#24: Add SPDX license IDs for REUSE compliance # SUMMARY * Bad licenses: * Deprecated licenses: * Licenses without file extension: * Missing licenses: * Unused licenses: * Used licenses: CC0-1.0, MIT * Read errors: 0 * Files with copyright information: 45 / 45 * Files with license information: 45 / 45 Congratulations! Your project is compliant with version 3.0 of the REUSE Specification :-)
2022-06-17 15:05:54 +02:00
SPDX-License-Identifier: CC0-1.0
-->
Update README.md Removed obsolete parts from the README and referred to GoDoc and our documenation website.
2022-10-27 14:31:14 +02:00
# go-mail - Easy to use, yet comprehensive library for sending mails with Go
Initial checkin
2022-03-05 12:10:20 +01:00
Added codecov badge
2022-03-15 21:48:08 +01:00
[![GoDoc](https://godoc.org/github.com/wneessen/go-mail?status.svg)](https://pkg.go.dev/github.com/wneessen/go-mail)
[![codecov](https://codecov.io/gh/wneessen/go-mail/branch/main/graph/badge.svg?token=37KWJV03MR)](https://codecov.io/gh/wneessen/go-mail)
Added gocov.io link to README.md
2022-03-15 14:54:11 +01:00
[![Go Report Card](https://goreportcard.com/badge/github.com/wneessen/go-mail)](https://goreportcard.com/report/github.com/wneessen/go-mail)
Preparation for the v0.4.0 release: - Updated discord link
2023-05-31 09:40:51 +02:00
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/avelino/awesome-go)
[![#go-mail on Discord](https://img.shields.io/badge/Discord-%23go%E2%80%93mail-blue.svg)](https://discord.gg/ysQXkaccXk)
Add OpenSSF Best Practices badge to README.md An OpenSSF Best Practices badge was added to the README file. This badge reflects adherence to critical open source software security practices.
2024-03-23 17:28:04 +01:00
[![REUSE status](https://api.reuse.software/badge/github.com/wneessen/go-mail)](https://api.reuse.software/info/github.com/wneessen/go-mail)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8701/badge)](https://www.bestpractices.dev/projects/8701)
Add OpenSSF Scorecard badge to README This commit introduces the OpenSSF Scorecard badge to the README file. The badge will provide immediate access to the security scorecards of the go-mail project for users.
2024-03-24 16:34:38 +01:00
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/wneessen/go-mail/badge)](https://securityscorecards.dev/viewer/?uri=github.com/wneessen/go-mail)
Added gocov.io link to README.md
2022-03-15 14:54:11 +01:00
<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>
Initial checkin
2022-03-05 12:10:20 +01:00
Update README.md Center logo
2022-07-11 10:21:09 +02:00
<p align="center"><img src="./assets/gopher2.svg" width="250" alt="go-mail logo"/></p>
Added new go-mail logo
2022-07-08 16:04:04 +02:00
Update README to clarify library features and dependencies Revised the README to provide clearer explanations of the library's origins, dependencies, and features. Added details on the small dependency footprint and enhanced SMTP Auth methods, and emphasized the concurrency-safe reuse of SMTP connections.
2024-10-01 15:41:26 +02:00
The main idea of this library was to provide a simple interface for sending mails to
Reformatted README.md
2022-03-14 10:57:55 +01:00
my [JS-Mailer](https://github.com/wneessen/js-mailer) project. It quickly evolved into a full-fledged mail library.
Initial checkin
2022-03-05 12:10:20 +01:00
Update README to clarify library features and dependencies Revised the README to provide clearer explanations of the library's origins, dependencies, and features. Added details on the small dependency footprint and enhanced SMTP Auth methods, and emphasized the concurrency-safe reuse of SMTP connections.
2024-10-01 15:41:26 +02:00
go-mail follows idiomatic Go style and best practice. It has a small dependency footprint by mainly relying on the
Go Standard Library and the Go extended packages. It combines a lot of functionality from the standard library to
give easy and convenient access to mail and SMTP related tasks.
Lots of cleanups and refactoring
2022-03-10 16:19:51 +01:00
Update README.md wordings for clarity Refined the wording in the README.md to enhance readability and clarity. Changed some sentences to past perfect tense and added backticks around `smtp` for consistency with code references.
2024-10-01 15:47:07 +02:00
In the early days, parts of this library (especially some parts of [msgwriter.go](msgwriter.go)) had been
forked/ported from [go-mail/mail](https://github.com/go-mail/mail) and respectively [go-gomail/gomail](https://github.com/go-gomail/gomail). Today
most of the ported code has been refactored.
Updated README.md
2022-03-14 10:33:15 +01:00
Update README.md wordings for clarity Refined the wording in the README.md to enhance readability and clarity. Changed some sentences to past perfect tense and added backticks around `smtp` for consistency with code references.
2024-10-01 15:47:07 +02:00
The `smtp` package of go-mail has been forked from the original Go stdlib's `net/smtp` package and has then been extended
Update README to clarify library features and dependencies Revised the README to provide clearer explanations of the library's origins, dependencies, and features. Added details on the small dependency footprint and enhanced SMTP Auth methods, and emphasized the concurrency-safe reuse of SMTP connections.
2024-10-01 15:41:26 +02:00
by the go-mail team to fit the packages needs (more SMTP Auth methods, logging, concurrency-safety, etc.).
Added note about forked smtp package Additionally added new feature references and updated contributors section
2023-01-15 16:12:33 +01:00
Lots of cleanups and refactoring
2022-03-10 16:19:51 +01:00
## Features
Reformatted README.md
2022-03-14 10:57:55 +01:00
Update README to clarify library features and dependencies Revised the README to provide clearer explanations of the library's origins, dependencies, and features. Added details on the small dependency footprint and enhanced SMTP Auth methods, and emphasized the concurrency-safe reuse of SMTP connections.
2024-10-01 15:41:26 +02:00
Here are some highlights of go-mail's featureset:
Reformatted README.md
2022-03-14 10:57:55 +01:00
Update README to clarify library features and dependencies Revised the README to provide clearer explanations of the library's origins, dependencies, and features. Added details on the small dependency footprint and enhanced SMTP Auth methods, and emphasized the concurrency-safe reuse of SMTP connections.
2024-10-01 15:41:26 +02:00
* [X] Very small dependency footprint (mainly Go Stdlib and Go extended packages)
Update README.md and removed example code in favor for doc_test.go example
2022-03-12 15:19:32 +01:00
* [X] Modern, idiomatic Go
Calling it a day...
2022-03-10 16:56:41 +01:00
* [X] Sane and secure defaults
Updated README.md (added full example)
2022-03-14 10:57:01 +01:00
* [X] Explicit SSL/TLS support
* [X] Implicit StartTLS support with different policies
Lots of cleanups and refactoring
2022-03-10 16:19:51 +01:00
* [X] Makes use of contexts for a better control flow and timeout/cancelation handling
Update README to clarify library features and dependencies Revised the README to provide clearer explanations of the library's origins, dependencies, and features. Added details on the small dependency footprint and enhanced SMTP Auth methods, and emphasized the concurrency-safe reuse of SMTP connections.
2024-10-01 15:41:26 +02:00
* [X] SMTP Auth support (LOGIN, PLAIN, CRAM-MD, XOAUTH2, SCRAM-SHA-1(-PLUS), SCRAM-SHA-256(-PLUS))
Lots of cleanups and refactoring
2022-03-10 16:19:51 +01:00
* [X] RFC5322 compliant mail address validation
Updated README.md (added full example)
2022-03-14 10:57:01 +01:00
* [X] Support for common mail header field generation (Message-ID, Date, Bulk-Precedence, Priority, etc.)
Update README to clarify library features and dependencies Revised the README to provide clearer explanations of the library's origins, dependencies, and features. Added details on the small dependency footprint and enhanced SMTP Auth methods, and emphasized the concurrency-safe reuse of SMTP connections.
2024-10-01 15:41:26 +02:00
* [X] Concurrency-safe reusing the same SMTP connection to send multiple mails
Update README.md #29: Mention the different the embed/attach methods we support.
2022-07-07 10:58:52 +02:00
* [X] Support for attachments and inline embeds (from file system, `io.Reader` or `embed.FS`)
Closes #11 This PR adds a `Msg.Read()` method which satisfies the `io.Reader` interface
2022-05-28 10:58:19 +02:00
* [X] Support for different encodings
Updated README.md to introduce middlewares
2022-10-02 13:03:51 +02:00
* [X] Middleware support for 3rd-party libraries to alter mail messages
Updating the README.md to explain the sendmail feature
2022-05-24 16:33:41 +02:00
* [X] Support sending mails via a local sendmail command
Implemented DSNs as described in RFC 1891 - Added test coverage for the WithDSN* methods - Updated README.md accordingly
2022-09-11 21:07:15 +02:00
* [X] Support for requestng MDNs (RFC 8098) and DSNs (RFC 1891)
Update README.md Added DKIM Support to README.md
2022-10-26 20:06:17 +02:00
* [X] DKIM signature support via [go-mail-middlware](https://github.com/wneessen/go-mail-middleware)
Closes #11 This PR adds a `Msg.Read()` method which satisfies the `io.Reader` interface
2022-05-28 10:58:19 +02:00
* [X] Message object satisfies `io.WriteTo` and `io.Reader` interfaces
#13: Update README.md
2022-06-03 10:42:56 +02:00
* [X] Support for Go's `html/template` and `text/template` (as message body, alternative part or attachment/emebed)
Update README.md Added a support note for #18
2022-06-09 10:24:57 +02:00
* [X] Output to file support which allows storing mail messages as e. g. `.eml` files to disk to open them in a MUA
Added note about forked smtp package Additionally added new feature references and updated contributors section
2023-01-15 16:12:33 +01:00
* [X] Debug logging of SMTP traffic
* [X] Custom error types for delivery errors
Preparation for the v0.4.0 release: - Bump version in doc.go - Add sonarlint to .gitignore - Update README to reflect the changes and contributors - Fixed typos in auth_cram_md5_118.go, msg.go, msg_test.go, reader.go and smtp_ehlo_117.go
2023-05-31 09:34:45 +02:00
* [X] Custom dial-context functions for more control over the connection (proxing, DNS hooking, etc.)
Add EML file support to go-mail in README The README has been updated to show that go-mail now supports outputting a message as an EML file and parsing an EML file into a go-mail message. This addition enhances the flexibility and control over the email content and format.
2024-06-28 13:51:49 +02:00
* [X] Output a go-mail message as EML file and parse EML file into a go-mail message
Implemented SMTP AUTH
2022-03-10 10:53:38 +01:00
Reformatted README.md
2022-03-14 10:57:55 +01:00
go-mail works like a programatic email client and provides lots of methods and functionalities you would consider
standard in a MUA.
Updated README.md (added full example)
2022-03-14 10:57:01 +01:00
Update README.md Removed obsolete parts from the README and referred to GoDoc and our documenation website.
2022-10-27 14:31:14 +02:00
## Documentation
Preparation for the v0.4.0 release: - Bump version in doc.go - Add sonarlint to .gitignore - Update README to reflect the changes and contributors - Fixed typos in auth_cram_md5_118.go, msg.go, msg_test.go, reader.go and smtp_ehlo_117.go
2023-05-31 09:34:45 +02:00
We aim for good GoDoc documenation in our library which gives you a full API reference. We also provide a more in-depth
documentation website at [go-mail.dev](https://go-mail.dev)
Update README.md Removed obsolete parts from the README and referred to GoDoc and our documenation website.
2022-10-27 14:31:14 +02:00
Added version compatibility statement
2023-02-02 10:18:59 +01:00
## Compatibility
Go is growing fast and providing great features with every new release. While we'd love to adopt the latest Go features
into our code, we realize that not everybody using this package can run the latest Go versions. Therefore we try to
implement alternative solutions for Go versions that do not support these features. Yet, the work needed to maintain
the separate versions is not to be underestimated. For that reason, we might retire that code at some point.
We guarantee that go-mail will always support the last four releases of Go. With two Go releases per year, this gives
the user a timeframe of two years to update to the next or even the latest version of Go.
Update README.md Added Discord badge.
2022-09-22 16:54:38 +02:00
## Support
Update README.md Replaced discord channel
2023-01-29 14:52:43 +01:00
We have a support and general discussion channel on Discord. Find us at: [#go-mail](https://discord.gg/dbfQyC4s)
Updated README.md to introduce middlewares
2022-10-02 13:03:51 +02:00
## Middleware
The goal of go-mail is to keep it free from 3rd party dependencies and only focus on things a mail library should
fulfill. Yet, since version v0.2.8 we've added support for middleware on the `Msg` object, allowing 3rd parties to
alter a given mail message to their needs without relying on `go-mail` to support their specific need.
To get our users started with message middleware, we've created a collection of useful middlewares. It can be
found in a seperate repository: [go-mail-middlware](https://github.com/wneessen/go-mail-middleware).
Update README.md Added Merch information to README
2024-05-06 19:22:12 +02:00
## Merch
Thanks to our wonderful friends at [HelloTux](https://www.hellotux.com) we can offer great go-mail merchandising. All merch articles are embroidery
to provide the best and most long-lasting quality possible.
If you want to support the open source community and represent your favourite Go mail library with some cool drip, check out our merch shop at:
[https://www.hellotux.com/go-mail](https://www.hellotux.com/go-mail).
Update README.md and removed example code in favor for doc_test.go example
2022-03-12 15:19:32 +01:00
## Examples
Reformatted README.md
2022-03-14 10:57:55 +01:00
Update README.md Removed obsolete parts from the README and referred to GoDoc and our documenation website.
2022-10-27 14:31:14 +02:00
We provide example code in both our GoDocs as well as on our official Website (see [Documentation](#documentation)). For a quick start into go-mail
check out our [Getting started](https://go-mail.dev/getting-started/introduction/) guide.
Update README.md Added contributions section
2022-05-28 11:14:26 +02:00
Added note about forked smtp package Additionally added new feature references and updated contributors section
2023-01-15 16:12:33 +01:00
## Authors/Contributors
Enhance contributors section and add sponsors acknowledgment Updated the Authors/Contributors section to include a graphical representation of contributors and added special thanks to Maria Letta for the logo design. Introduced a new Sponsors section to acknowledge the support from sponsors.
2024-10-01 15:57:01 +02:00
go-mail was initially created and developed by [Winni Neessen](https://github.com/wneessen/), but over time a lot of amazing people
contributed ot the project. Big thanks to all of them for improving the go-mail project (be it writing code, testing
code, reviewing code, writing documenation or helping to translate the website):
<a href="https://github.com/wneessen/go-mail/graphs/contributors">
<img src="https://contrib.rocks/image?repo=wneessen/go-mail" />
</a>
A huge thank you also goes to [Maria Letta](https://github.com/MariaLetta) for designing our super cool go-mail logo!
## Sponsors
Simplify sponsor appreciation message Revise the sponsors section in README.md to convey gratitude more concisely. Removed redundant phrasing and made the message more direct while ensuring the intent remains clear.
2024-10-01 16:01:58 +02:00
We sincerely thank our amazing sponsors for their generous support! Your contributions do not go unnoticed and helps
keeping up the project!
Enhance contributors section and add sponsors acknowledgment Updated the Authors/Contributors section to include a graphical representation of contributors and added special thanks to Maria Letta for the logo design. Introduced a new Sponsors section to acknowledge the support from sponsors.
2024-10-01 15:57:01 +02:00
* [kolaente](https://github.com/kolaente)
Reference in a new issue Copy permalink