Merge pull request #103 from wneessen/update_docs_headers

Update documentation and copyright headers

CONTRIBUTING.md

@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 
 SPDX-License-Identifier: CC0-1.0
 -->

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Winni Neessen
+Copyright (c) 2022-2023 The go-mail Authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 
 SPDX-License-Identifier: CC0-1.0
 -->
@@ -25,6 +25,9 @@ Parts of this library (especially some parts of [msgwriter.go](msgwriter.go)) ha
 [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.
 
+The smtp package of go-mail is forked from the original Go stdlib's `net/smtp` and then extended by the go-mail
+team.
+
 ## Features
 
 Some of the features of this library:
@@ -48,6 +51,8 @@ Some of the features of this library:
 * [X] Message object satisfies `io.WriteTo` and `io.Reader` interfaces
 * [X] Support for Go's `html/template` and `text/template` (as message body, alternative part or attachment/emebed)
 * [X] Output to file support which allows storing mail messages as e. g. `.eml` files to disk to open them in a MUA
+* [X] Debug logging of SMTP traffic
+* [X] Custom error types for delivery errors
 
 go-mail works like a programatic email client and provides lots of methods and functionalities you would consider
 standard in a MUA.
@@ -72,8 +77,13 @@ found in a seperate repository: [go-mail-middlware](https://github.com/wneessen/
 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.
 
-## Contributors
-Thanks to the following people for contributing to the go-mail project:
+## Authors/Contributors
+go-mail was initially authored and developed by [Winni Neessen](https://github.com/wneessen/).
+
+Big thanks to the following people, for contributing to the go-mail project (either in form of code or by 
+reviewing code, writing documenation or helping to translate the website):
 * [Dhia Gharsallaoui](https://github.com/dhia-gharsallaoui)
 * [inliquid](https://github.com/inliquid) 
+* [iwittkau](https://github.com/iwittkau)
+* [James Elliott](https://github.com/james-d-elliott)
 * [Maria Letta](https://github.com/MariaLetta) (designed the go-mail logo)

SECURITY.md

@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 
 SPDX-License-Identifier: CC0-1.0
 -->
@@ -8,5 +8,11 @@ SPDX-License-Identifier: CC0-1.0
 
 ## Reporting a Vulnerability
 
-Please send a mail to wn+gomail@neessen.net when you found a security issue in go-mail, even when you are not 100% certain 
-that it is actually a security issue. Typically, you will receive an answer within a day or even within a few hours.
+To report (possible) security issues in go-mail, please either send a mail to 
+[security@go-mail.dev](mailto:security@go-mail.dev) or use Github's 
+[private reporting feature](https://github.com/wneessen/go-mail/security/advisories/new).
+Reports are always welcome. Even if you are not 100% certain that a specific issue you found
+counts as a security issue, we'd love to hear the details, so we can figure out together if
+the issue in question needds to be addressed.
+
+Typically, you will receive an answer within a day or even within a few hours.

auth.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

b64linebreaker.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

b64linebreaker_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

client.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

client_119.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

client_120.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

client_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

codecov.yml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+# SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 #
 # SPDX-License-Identifier: CC0-1.0
 

doc.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 
@@ -6,4 +6,4 @@
 package mail
 
 // VERSION is used in the default user agent string
-const VERSION = "0.3.8"
+const VERSION = "0.3.9"

doc_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

encoding.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

encoding_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

file.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

file_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

go.mod

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

header.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

header_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

msg.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

msg_nowin_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

msg_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

msg_totmpfile.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

msg_totmpfile_116.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

msgwriter.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

msgwriter_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

part.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

part_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

random.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

random_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

reader.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

reader_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

senderror.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

senderror_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

smtp/auth_login.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
+// SPDX-FileCopyrightText: Copyright (c) 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

smtp/smtp.go

@@ -17,13 +17,6 @@
 //	8BITMIME  RFC 1652
 //	AUTH      RFC 2554
 //	STARTTLS  RFC 3207
-//
-// Additional extensions may be handled by clients.
-//
-// The smtp package is frozen and is not accepting new features.
-// Some external packages provide more functionality. See:
-//
-//	https://godoc.org/?q=smtp
 package smtp
 
 import (

sonar-project.properties

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+# SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 #
 # SPDX-License-Identifier: CC0-1.0
 

tls.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT
 

tls_test.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2022 Winni Neessen <winni@neessen.dev>
+// SPDX-FileCopyrightText: 2022-2023 The go-mail Authors
 //
 // SPDX-License-Identifier: MIT