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
1276 commits 3 branches 39 tags 9.8 MiB
Commit graph

35 commits

Author SHA1 Message Date
Winni Neessen
9412f31874
Lock mutex when setting the logger 
Add mutex locking to ensure thread-safety when setting the logger in the `smtp` package. This prevents potential race conditions and ensures that the logger is updated consistently in concurrent operations.
 2024-11-11 17:47:59 +01:00
Winni Neessen
c3252626e3
Reverted change made in 3fffcd15f6 2024-11-11 13:31:02 +01:00
Winni Neessen
3fffcd15f6
Remove deprecated test hook for STARTTLS 
The testHookStartTLS variable and its related conditional code have been removed from the smtp.go file. This cleanup streamlines the TLS initiation process and removes unnecessary test-specific hooks no longer in use.
 2024-11-11 12:54:39 +01:00
Winni Neessen
8353b4b255
Follow upstream for HELO during Quit bug 
I reported the bug I fixed in 74fa3f6f62 to Go upstream. They fixed simpler by just ignoring the error (See: https://go.dev/cl/622476). We follow this patch accordingly. The upstream test has been adopted as well.
 2024-10-25 09:33:45 +02:00
Winni Neessen
563ccbab4a
Fix typo in comment within Quit function 
Corrected grammar in a comment to enhance code readability and maintain consistency. This change does not affect the functionality of the `Quit` method.
 2024-10-23 22:26:08 +02:00
Winni Neessen
74fa3f6f62
Fix Quit handling when initial HELO fails 
Ensure QUIT command can be sent even if initial HELO fails. Added a check to skip retrying HELO if it already failed, allowing for proper closing of the connection. This prevents potential hangs or errors during connection termination.
 2024-10-23 21:54:06 +02:00
Winni Neessen
55a5d02fe0
Add support for configurable SMTP auth data logging 
Added the `logAuthData` flag to enable conditional logging of SMTP authentication data. Introduced the `SetLogAuthData` method for clients to toggle this flag. Adjusted existing logging logic to respect this new configuration.
 2024-10-15 19:52:31 +02:00
Winni Neessen
7acfe8015d
Redact authentication logs 
Add a boolean flag `authIsActive` to manage redaction of sensitive authentication information in debug logs. When this flag is true, authentication details are replaced with `<auth redacted>`.
 2024-10-12 20:53:58 +02:00
Winni Neessen
476130d6e3
Fumpt files to make golangci-lint happy 2024-10-05 11:43:50 +02:00
Winni Neessen
159c1bf850
Add tests for new tls and connection handling methods 
This commit introduces tests for various TLS-related methods such as GetTLSConnectionState, HasConnection, SetDSNMailReturnOption, SetDSNRcptNotifyOption, and UpdateDeadline. It also modifies the error handling logic in smtp.go to include new error types and improves the mutex handling in UpdateDeadline.
 2024-10-05 10:55:25 +02:00
Winni Neessen
9163943684
Add isConnected flag to track active connection state 
Introduced the isConnected boolean flag in the Client struct to clearly indicate whether there is an active connection. Updated relevant methods to set this flag accordingly, ensuring consistent state management across the Client's lifecycle.
 2024-10-05 10:15:43 +02:00
Winni Neessen
adcb8ac41d
Fix connection handling and improve thread-safety in SMTP client 
Reset connections to nil after Close, add RLock in HasConnection, and refine Close logic to handle already closed connections gracefully. Enhanced DialWithContext documentation and added tests for double-close scenarios to ensure robustness.
 2024-10-04 23:15:01 +02:00
Winni Neessen
f823112a4d
Refactor: consolidate ErrNonTLSConnection variable 
The variable ErrNonTLSConnection has been simplified from a multi-line declaration to a single-line declaration. This increases code readability and maintains consistency with Go conventions.
 2024-10-01 20:32:41 +02:00
Winni Neessen
15b9ddf067
Refactor error handling for non-TLS SMTP connections 
Introduce a global error variable for non-TLS connections and update corresponding error handling across the codebase. This enhances readability and maintainability of the error management logic.
 2024-10-01 17:23:29 +02:00
Winni Neessen
738f43e289
Add GetTLSConnectionState method to SMTP client 
Introduce a method to retrieve the TLS connection state of the client's current connection. This method checks if the connection uses TLS and is established, returning appropriate errors otherwise.
 2024-10-01 11:05:42 +02:00
Winni Neessen
8791ce5a33
Fix deferred mutex unlock in TLSConnectionState 
Correct the sequence of mutex unlocking in TLSConnectionState to ensure the mutex is always released properly. This prevents potential deadlocks and ensures the function behaves as expected in a concurrent context.
 2024-09-27 17:00:07 +02:00
Winni Neessen
6bd9a9c735
Refactor mutex usage for connection safety 
This commit revises locking mechanism usage around connection operations to avoid potential deadlocks and improve code clarity. Specifically, defer statements were removed and explicit unlocks were added to ensure that mutexes are properly released after critical sections. This change affects several methods, including `Close`, `cmd`, `TLSConnectionState`, `UpdateDeadline`, and newly introduced locking for concurrent data writes and reads in `dataCloser`.
 2024-09-27 14:03:26 +02:00
Winni Neessen
fdb80ad9dd
Add mutex to Client for thread-safe operations 
This commit introduces a RWMutex to the Client struct in the smtp package to ensure thread-safe access to shared resources. Critical sections in methods like Close, StartTLS, and cmd are now protected with appropriate locking mechanisms. This change helps prevent potential race conditions, ensuring consistent and reliable behavior in concurrent environments.
 2024-09-27 11:10:23 +02:00
Winni Neessen
371b950bc7
Refactor Client struct for better readability and organization 
Reordered and grouped fields in the Client struct for clarity. The reorganization separates logical groups of fields, making it easier to understand and maintain the code. This includes proper grouping of TLS parameters, DSN options, and debug settings.
 2024-09-27 10:33:19 +02:00
Winni Neessen
3871b2be44
Lock client connections and update deadline handling 
Add mutex locking for client connections to ensure thread safety. Introduce `HasConnection` method to check active connections and `UpdateDeadline` method to handle timeout updates. Refactor connection handling in `checkConn` and `tls` methods accordingly.
 2024-09-26 11:51:30 +02:00
Winni Neessen
071ad66035
Sync with upstream 
This PR syncs our smtp package with the upstream `net/smtp` changes introduced via bf91eb3a8b
 2024-05-24 18:50:27 +02:00
Winni Neessen
5dbb1e6dde
Refine function comments to include return type details 
This is a sync with the net/smtp upstream as committed here: 1d45a7ef56 (diff-4f6f6bdb9891d4dd271f9f31430420a2e44018fe4ee539576faf458bebb3cee4).
 2024-01-10 11:05:34 +01:00
Winni Neessen
1c5c1e318c
#136: Refactor logging for clearer messaging direction 
The logging system in the smtp.go and log package has been refactored. A new custom log type `Log` was introduced, that includes the message direction, format and arguments. The `Logger` interface and the `Stdlog` implementation were modified to accept this new type. This change provides a clearer understanding of message direction inside logs, allowing for easier debugging and reduced complexity. This change does not affect features or disrupt user functionality. Additionally, it allows for custom implementations of the log.Logger interface to without being forced to use the C --> S/C <-- S direction logging.
 2023-08-02 11:43:45 +02:00
Nicola Murino
2a67b397c7 OAuth2: don't send the "*" command to cancel authentication 
XOAUTH2 does not follow the SMTP AUTH RFC
 2023-05-29 18:21:24 +02:00
Winni Neessen
44dce70c46
#119 make golangci-lint happy again 
Since we are Go <1.20 compatible, we can't easily combine errors here. The suggested golangci-lint fix will not work neither, since the %w verb can't be used twice. Therefore, for now we will ignore the linting error

Closes #119
 2023-03-11 10:48:14 +01:00
Winni Neessen
6633591b51
Implement Logger interface 
As stated in https://github.com/wneessen/go-mail/pull/102#issuecomment-1411956040 it would be beneficial if, instead of forcing the Go stdlib logger on the user to provide a simple interface and use that for logging purposes.

This PR implements this simple log.Logger interface as well as a standard logger that satisfies this interface. If no custom logger is provided, the Stdlog will be used (which makes use of the Go stdlib again).

Accordingly, a `Client.WithLogger` and `Client.SetLogger` have been implemented. Same applies for the smtp counterparts.
 2023-02-03 10:19:26 +01:00
Winni Neessen
63d8cef8ca
Refactor DSN handling from client.go to smtp.go 
This PR refactors the the DSN (RFC 1891) SMTP client handling, that was introduced in f4cdc61dd0.

While most of the Client options stay the same, the whole workaround logic for the SMTP client has been removed and added as part of the SMTP client instead.

This was we got rid of the Client's own `mail()`, `rcpt()`, `dsnRcpt()`, `dsnMail()` methods as well as the copies of the `cmd()` and `validateLine()` methods. The Client is now using the proper `Mail()` and `Rcpt()` methods of the SMTP client instead.
 2023-01-18 10:30:06 +01:00
Winni Neessen
3922d3f195
Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
Winni Neessen
ccbab59207
Fix log direction string 2023-01-14 13:07:42 +01:00
Winni Neessen
e36511e90e
Fix tests to not log authentication data 
We don't want to expose SMTP authentication details in tests, therefore the tests have been adjusted a bit
 2023-01-14 13:05:04 +01:00
Winni Neessen
34b432a985
Implement debug logging in SMTP client 
Resolves #101.

Since we now have full control over the SMTP client we can also access the message input and output.

This PR introduces a new debug logging feature. Via the `Client.WithDebugLog` the user can enable this feature. It will then make use of the new `smtp/Client.SetDebugLog` method. Once the flag is set to true, the SMTP client will start logging incoming and outgoing messages to os.Stderr.

Log directions will be output accordingly
 2023-01-14 12:47:51 +01:00
Winni Neessen
8559e8c301
Re-introduce backwards compatibility with Go 1.17 and Go 1.18 
The following changes make use of methods that are not available in Go 1.17/Go 1.18. To guarantee at least 4 versions of backwards compatibility, versioned copies of those changes have been back-ported:
- 4d8db00641 (diff-4f6f6bdb9891d4dd271f9f31430420a2e44018fe4ee539576faf458bebb3cee4)
- 58158e990f (diff-772fc9f5d0c86f26e35158fb3e7a71a4967d18b4ec23a5dbb60781ab0babf426)
 2023-01-13 17:34:41 +01:00
Winni Neessen
7cb34856a3
Adjusting license headers and including original LICENSE file from the Go project into the smtp/ directory as suggested in https://github.com/wneessen/go-mail/issues/97#issuecomment-1381046444 2023-01-13 16:54:55 +01:00
Winni Neessen
a804e4a101
Fix license SPDX headers for forked net/smtp code 
- Also import the original BSD-3-Clause.txt license from the Go team into the LICENSES directory
- Further on, license headers should hold "The go-mail Authors" instead of my name. Did this already for the MIT license.
 2023-01-10 10:09:45 +01:00
Winni Neessen
0d6777ab39
Fork net/smpt into go-mail 
As part of #97 we are going to fork the official `net/smtp` package into go-mail to provide us with more flexibility.

This commit fulfills the first big step of importing the package into smtp/. Also go-mail's own LoginAuth has been moved from auth/ into smtp/ to be consistent with the stdlib.

There are still a couple of open issues (i. e. license adjustments and making golangci-lint happy) but so far all tests already work, which is a good start.
 2023-01-10 00:38:42 +01:00