81 commits

Author	SHA1	Message	Date
Winni Neessen	b0f514ea8a	Merge c2d9104b45 into bb2fd0f970	2024-10-16 05:39:05 +11:00
Winni Neessen	0944296cff	Enable logging of SMTP authentication data ... Added a new option and methods to enable logging of SMTP authentication data. Updated documentation to indicate caution when using this feature due to potential data protection risks.	2024-10-15 19:52:59 +02:00
Winni Neessen	021666d6ad	#332: Add default SMTP authentication type to NewClient ... This commit fixes a regression introduced in v0.5.0. We now set the default SMTPAuthType to NOAUTH in NewClient. Enhanced documentation and added test cases for different SMTP authentication scenarios.	2024-10-11 11:21:56 +02:00
Winni Neessen	756269644e	Update SMTP client documentation with detailed descriptions ... Enhance the SMTP client method documentation by adding detailed explanations of the methods' purposes, parameters, return values, and operational flow. This improves clarity, making it easier for developers to understand the functionality and usage of each method.	2024-10-06 13:39:40 +02:00
Winni Neessen	d6426063ba	Refactor comments and docstrings for clarity and detail ... Enhanced comments and docstrings for better readability and detail in client.go and b64linebreaker.go. Updated descriptions, added parameter and return details, and included RFC references where applicable for improved documentation quality.	2024-10-06 12:39:02 +02:00
Winni Neessen	78e2857782	Update method comments to include additional context and RFC references ... Enhanced the comments for various methods in `msg.go`, `client.go`, `auth.go`, and `encoding.go` to provide more detailed explanations, context, and relevant RFC references. This improves the clarity and maintainability of the code by providing developers with a deeper understanding of each method's purpose and usage.	2024-10-05 13:39:21 +02:00
Winni Neessen	fbbf17acd0	Refactor comments for clarity in client.go ... Simplify comments in `client.go` to improve code documentation. Ensure comments are more descriptive and provide context for the functions they describe, enhancing code readability and maintainability.	2024-10-04 23:25:43 +02:00
Winni Neessen	48b469faf7	Refactor SMTP client comment and function documentation ... Updated function comments across client.go to improve clarity and consistency. Added missing details on error handling and context usage for `DialAndSendWithContext` and ensured all functions contain relevant, detailed descriptions.	2024-10-04 23:23:16 +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	dfdadc5da2	Refactor client.go: Move functions to new locations ... Reordered several functions within client.go for better code organization and readability. This change involves moving `setDefaultHelo`, `checkConn`, `serverFallbackAddr`, and `tls` functions to new locations without altering their implementations.	2024-10-04 22:38:18 +02:00
Winni Neessen	972a3c51c7	Add custom SMTP authentication type support ... Introduce the SMTPAuthCustom type to represent user-defined SMTP authentication mechanisms. Updated relevant functions in client.go to handle the new type appropriately and made sure the client distinguishes between built-in and custom authentication methods.	2024-10-04 22:33:42 +02:00
Winni Neessen	d900f5403e	Refine method documentation in client.go ... Correct typos and enhance clarity in method descriptions. Provide additional context for default values and behavior, and specify consequences for security settings in client configurations.	2024-10-04 22:23:18 +02:00
Winni Neessen	eeaee3f60a	Update and expand documentation for client configuration options ... Revised comments provide clearer guidance on the usage of various client configuration functions. Additional details and external references are included for better understanding and error handling.	2024-10-04 21:57:38 +02:00
Winni Neessen	bae0ac6cde	Refactor TLS policy comments for clarity ... Updated comments for WithTLSPolicy and WithTLSPortPolicy to provide clearer explanations. Improved readability and emphasized recommended best practices for SMTP TLS connections.	2024-10-04 21:45:12 +02:00
Winni Neessen	3e5c93a418	Refine and clarify SSL and debug logging comments ... Revised the comments for `WithSSLPort`, `WithDebugLog`, `WithLogger`, and `WithHELO` options to improve readability and provide clearer explanations. Added caution about potential data protection issues when using debug logging and specified defaults where applicable.	2024-10-04 21:38:39 +02:00
Winni Neessen	a34f400a05	Improve client option documentation for clarity and validation ... Enhanced the documentation for NewClient and related option functions to provide clearer descriptions. Added validation details for WithPort and WithTimeout, and improved explanations for SSL/TLS settings.	2024-10-04 21:26:29 +02:00
Winni Neessen	779a3f3942	Refactor error comments for clarity ... Updated error comments to provide clearer and more descriptive explanations. Enhanced readability by elaborating on the conditions that result in each error, giving developers better context. No functional changes to the code were made.	2024-10-04 21:12:05 +02:00
Winni Neessen	6cd3cfd2f7	Refactor comments for clarity and consistency ... Rephrase comments to enhance clarity and maintain consistent style. Improved explanations for fields such as `smtpAuth`, `helo`, and `noNoop`, and standardize grammar and format across all comments. This helps in better understanding the code and its functionality.	2024-10-04 20:57:51 +02:00
Winni Neessen	aab04672f8	Rename DSN type variable for clarity ... Renamed the variable from `dsnrntype` to `dsnRcptNotifyType` to improve code readability and ensure clarity regarding its purpose. Also updated corresponding comments and test cases to reflect this change.	2024-10-04 20:39:14 +02:00
Winni Neessen	f7c12d412b	Rename dsnmrtype to dsnReturnType in client.go ... Refactor variable names for consistency. The `dsnmrtype` variable has been renamed to `dsnReturnType` across the client and test files to improve code readability and maintain uniformity.	2024-10-04 20:30:43 +02:00
Winni Neessen	ef3da39840	Refactor DSN field in Client structure ... Renamed `dsn` field to `requestDSN` in Client structure for clarity and consistency. Adjusted associated methods and tests to reflect this change, improving code readability and maintainability.	2024-10-04 20:29:14 +02:00
Winni Neessen	92c411454b	Enhance comments with detailed explanations and links ... Improved comments for better clarity by detailing the purpose of each constant and type, and included relevant RFC links for deeper context. These changes aim to help developers quickly understand the code without needing to cross-reference external documents.	2024-10-04 20:13:13 +02:00
Winni Neessen	986a988c5d	Reset SMTP auth when setting SMTP auth type ... This change ensures that the smtpAuth field is reset to nil whenever the SMTP auth type is updated. This prevents potential issues with mismatched authentication settings.	2024-10-01 20:44:50 +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	8838414c38	Fix incorrect error types for unsupported SMTP authentication ... Corrects the error messages returned for unsupported SMTP authentication types from ErrXOauth2AuthNotSupported to specific errors like ErrSCRAMSHA1AuthNotSupported, ErrSCRAMSHA256AuthNotSupported, and so on. This change improves the accuracy of error reporting for various SMTP authentication mechanisms.	2024-10-01 17:00:57 +02:00
Winni Neessen	27838f5b1f	Improve TLS state handling and add SCRAM-SHA-256 auth support ... Replaced direct TLSConnectionState call with error handling for TLS state retrieval. Introduced SCRAM-SHA-256 support in the SMTP authentication process.	2024-10-01 15:28:10 +02:00
Winni Neessen	4f1a60760d	Add support for SCRAM-SHA authentication methods ... Extended SMTP authentication to include SCRAM-SHA-1, SCRAM-SHA-1-PLUS, SCRAM-SHA-256, and SCRAM-SHA-256-PLUS methods. This enhancement provides more secure and flexible authentication options for SMTP clients.	2024-10-01 11:04:16 +02:00
Winni Neessen	253d065c83	Move mutex lock to sendSingleMsg method ... Mutex locking was relocated from the Send method in client_120.go and client_119.go to sendSingleMsg in client.go. This ensures thread-safety specifically during the message transmission process.	2024-09-27 14:03:50 +02:00
Winni Neessen	f59aa23ed8	Add mutex locking to SetTLSConfig ... This change ensures that the SetTLSConfig method is thread-safe by adding a mutex lock. The lock is acquired before any changes to the TLS configuration and released afterward to prevent concurrent access issues.	2024-09-27 11:58:08 +02:00
Winni Neessen	2234f0c5bc	Remove connection field from Client struct ... This commit removes the 'connection' field from the 'Client' struct and updates the related test logic accordingly. By using 'smtpClient.HasConnection()' to check for connections, code readability and maintainability are improved. All necessary test cases have been adjusted to reflect this change.	2024-09-27 11:43:22 +02:00
Winni Neessen	2084526c77	Refactor Client struct to improve organization and clarity ... Rearranged and grouped struct fields more logically within Client. Introduced the dialContextFunc and fallbackPort fields to enhance connection flexibility. Minor code style adjustments were also made for better readability.	2024-09-27 10:36:09 +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	d400379e2f	Refactor error handling for SendError struct ... Reformat the construction of SendError objects for better readability. This improves the clarity and maintainability of the error handling code within the client.go file.	2024-09-20 10:31:19 +02:00
Winni Neessen	0239318d94	Add affectedMsg field to SendError struct ... Included the affected message in the SendError struct for better error tracking and debugging. This enhancement ensures that any errors encountered during the sending process can be directly associated with the specific message that caused them.	2024-09-19 12:09:23 +02:00
Winni Neessen	277ae9be19	Refactor message sending logic ... Consolidated the message sending logic into a single `sendSingleMsg` function to reduce duplication and improve code maintainability. This change simplifies the `Send` method in multiple Go version files by removing redundant code and calling the new helper function instead.	2024-09-19 10:56:01 +02:00
Norbert Hauriel	c811ee689f	fix(typo): client.go error message	2024-07-24 13:12:06 +02:00
Winni Neessen	94138b6d23	Refine SMTP port selection and fallback logic ... The update modifies the client's handling of port selection when configuring SSL/TLS connections. The clients' functions `WithSSLPort`, `WithTLSPortPolicy`, `SetTLSPortPolicy`, and `SetSSLPort` are revised to avoid overriding previously set ports. Additionally, the deprecation notes have been removed and replaced with notes on best-practice recommendations, referring the new *Port*() methods. This change revises #105 and takes the comments made in #181 into account.	2024-04-06 16:49:34 +02:00
Winni Neessen	f18335fa1d	Refactor variable names in SMTP client code ... Improved variable names in the SMTP client code to make them more expressive and descriptive. Also corrected several code comments to enhance clarity. These changes are intended to increase code readability and maintainability and have been implemented throughout the client_119.go and client.go files for consistency in naming conventions.	2024-02-25 17:48:53 +01:00
Winni Neessen	e1098091c3	Refactor variable names in SMTP client code ... The commit introduces improved variable names in the SMTP client code that are more expressive and better describe the function they perform. This is combined with corrections to some code comments. It's aimed to increase code readability and maintainability. Updates are made across the client_119.go and client.go files to ensure consistent naming conventions.	2024-02-24 22:06:18 +01:00
Winni Neessen	1efac7fb67	Add new test cases for client functionalities and clean client code ... Test cases have been added for numerous client functionalities including WithTLSPortPolicy option for the NewClient method, Client.SetSSLPort method, and the Client.DialWithContext method with the fallback port functionality. Minor code simplification has also been performed in the 'SetSSLPort' function in client.go file.	2024-01-31 11:22:01 +01:00
Winni Neessen	7a2d9ff938	#105: Add default ports and fallback behavior for SSL and TLS ... Introduced default ports for SSL/TLS and STARTTLS connections in SMTP client. Also added fallback behavior, allowing the client to attempt connections on port 25 using plaintext if secured connections fail. Deprecated old methods and implemented new ones to enforce these changes effectively. This is a copy of the PR muhlemmer:enhance-default-tls-port by @muhlemmer. Since they unfortunately didn't reply in the PR anymore I cloned the PR. They will be fully attributed in the PR, though.	2024-01-25 13:39:02 +01:00
Winni Neessen	bb18ef9e93	"Improve error checking in SMTP client creation" ... A change was made in the SMTP client creation process to add more robust error handling. The new logic checks if the client is null after being created and, if true, returns an error. This update can help prevent potential null pointer exceptions in runtime, ultimately leading to more stable application.	2023-11-29 16:25:35 +01:00
Nicola Murino	8673addaf0	OAuth2: remove variants ... Microsoft also accept the same protocol used for Google servers	2023-05-29 18:19:01 +02:00
Nicola Murino	6e4b348ccf	add Oauth2 support ... fixes #129	2023-05-28 14:31:04 +02:00
sters	e757327e1d	Adding WithDialContextFunc client option	2023-04-19 23:20:33 +09: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	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