wneessen/go-mail
1
1
Fork 0
mirror of https://github.com/wneessen/go-mail.git synced 2024-12-23 02:50:39 +01:00
Code Issues Projects Releases Packages Wiki Activity
987 commits 2 branches 39 tags 11 MiB
Commit graph

987 commits

This branch
This branch
All branches
Author SHA1 Message Date
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
8faac3d101
Merge pull request #329 from wneessen/feature/327_simplify-message-id-generation-and-get-rid-of-randnum 
Simplify message id generation and get rid of randnum
 2024-10-07 15:12:46 +02:00
Winni Neessen
5874911c91
Simplify Message-ID generation 
Updated the SetMessageID method to generate a "Message-ID" using a
single randomly generated string combined with the hostname, replacing
the prior complex format that included process ID and multiple random
numbers. This change simplifies the code of the generated IDs.
 2024-10-07 15:04:04 +02:00
Winni Neessen
5c8b2fc371
Update character set and bit size for secure string generation 
Revised the character set to include a larger variety of symbols and adjusted the bit size calculations to correspond with the new set size. This ensures more efficient and secure random string generation by effectively utilizing the bitmask.
 2024-10-07 15:03:07 +02:00
Winni Neessen
cdb9463ec8
Delete redundant random number generation methods 
Removed `randNum` functions and associated tests from `random_119.go`, `random_121.go`, and `random_122.go`. These functions are no longer necessary. Additionally, replaced `TestRandomNum` and `TestRandomNumZero` with benchmarking for `randomStringSecure`.
 2024-10-07 15:02:49 +02:00
Winni Neessen
a94e721161
Update doc.go 
Bump version for v0.5.0 release
 2024-10-06 17:29:26 +02:00
Winni Neessen
46ca42e1b7
Merge pull request #324 from wneessen/better-godoc 
Revision of the GoDoc documentation
 2024-10-06 17:28:39 +02:00
Winni Neessen
f0388ec600
Refactor TLSPolicy documentation and String method 
Updated the TLSPolicy type documentation to improve clarity and consistency. Enhanced the String method with detailed commentary and return value explanation, ensuring it better adheres to the fmt.Stringer interface.
 2024-10-06 17:15:39 +02:00
Winni Neessen
6ce5c2a860
Enhance documentation for SendError methods and fields 
Improved comments for better clarity and detail in SendError-related methods and fields. Updated comments provide more in-depth explanations of functionality, parameters, return values, and usage.
 2024-10-06 17:12:52 +02:00
Winni Neessen
5d79ff69c3
Enhance and clarify Reader struct documentation 
Improved documentation for the Reader struct, its methods, and error handling. Added detailed explanations for `Read`, `Error`, `Reset`, and `empty` functions to better describe their parameters, return values, and behavior.
 2024-10-06 17:05:04 +02:00
Winni Neessen
cd90c3ddf3
Update randNum function and documentation for multiple versions 
Expanded randNum function comments to provide detailed behavior and usage across different Go versions. Enhanced the randomStringSecure function doc to explain its cryptographic secure implementation and error handling.
 2024-10-06 17:00:49 +02:00
Winni Neessen
e640f2df46
Add detailed comments and return descriptions to Part methods 
Enhanced the documentation of `Part` struct and its methods to provide clearer explanations, including parameter and return descriptions. This improves code readability and helps developers understand the functionality and usage of each method.
 2024-10-06 16:54:18 +02:00
Winni Neessen
295155ba67
Refactor and document msgWriter methods 
Streamline msgWriter by adding detailed documentation for each method and constant. This includes parameter descriptions, return values, and references to relevant RFCs, improving code readability and maintainability.
 2024-10-06 16:42:50 +02:00
Winni Neessen
0b105048e6
Refine WriteToTempFile docstring 
Clarify the documentation for WriteToTempFile to better explain its functionality, ensure consistency, and detail its return values.
 2024-10-06 16:21:37 +02:00
Winni Neessen
3333c784a6
Refactor documentation for Importance methods 
Updated the documentation for NumString, XPrioString, and String methods in the Importance type to provide clearer descriptions of their behavior and return values. Enhanced comments for better readability and maintainability of the code.
 2024-10-06 16:19:53 +02:00
Winni Neessen
ac7fa5771a
Refactor documentation and enhance comments 
Updated documentation for the `File` struct and its methods, providing clearer explanations and detailed parameter and return descriptions. Improved readability and consistency of comments across the codebase.
 2024-10-06 16:16:49 +02:00
Winni Neessen
dab9cc947a
Improve documentation for String methods 
Enhanced comments for String methods on Charset, ContentType, and Encoding types. Detailed the purpose and usage of each method, emphasizing their role in formatted output and logging.
 2024-10-06 13:53:20 +02:00
Winni Neessen
2c1082fe42
Enhance EML parsing function documentation 
Added detailed doc comments to EML parsing functions, specifying parameters, return values, and providing thorough explanations of functionalities to improve code understandability and maintainability. This helps future developers and users comprehend the usage and behavior of these functions more effectively.
 2024-10-06 13:51:36 +02:00
Winni Neessen
3e8706d52e
Refactor Send method documentation in client files 
Updated the documentation for the Send method in client_119.go and client_120.go to provide clearer explanations, include detailed descriptions of parameters, and specify return values. Ensured consistency across files by elaborating on error handling and connection checks.
 2024-10-06 13:41:45 +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
b4197a136e
Enhance documentation for message methods 
Expanded docstrings for methods in msg.go to provide detailed explanations, parameters, and return values. This improves clarity and helps developers understand usage and behavior more effectively.
 2024-10-06 12:04:27 +02:00
Winni Neessen
01278ccb30
Document message methods 
Added detailed comments to various methods in `msg.go` for clarity. Each method now includes a declaration, a detailed description, returned values, parameters, and relevant RFC references. This enhances code readability and maintainability.
 2024-10-06 00:49:09 +02:00
Winni Neessen
eafb9cb17e
Add detailed parameter and return descriptions to msg.go 
Enhanced function documentation by adding detailed descriptions of parameters and return values for various methods. This clarifies expected inputs and outputs, improving code readability and maintainability.
 2024-10-06 00:25:15 +02:00
Winni Neessen
864c593208
Add parameters and references to method comments in msg.go 
Enhanced method documentation by adding parameter descriptions and reference links. This improves the clarity and usability of the code, ensuring that users understand the purpose and usage of each method.
 2024-10-05 20:29:33 +02:00
Winni Neessen
4890d9130b
Expand docstrings for MsgOption functions and methods. 
This commit enhances the docstrings for the MsgOption functions and related methods in msg.go, providing extensive explanations, parameters, and references. It helps users understand the functionality, usage, and context of each function, improving code readability and usability.
 2024-10-05 20:06:51 +02:00
Winni Neessen
b37f8995da
Update Msg documentation for clarity and RFC compliance 
Enhanced the documentation for several Msg methods to provide clearer explanations and include relevant RFC references. This includes improved descriptions of functionality, parameter details, return values, and links to pertinent RFC sections.
 2024-10-05 19:34:37 +02:00
Winni Neessen
c520925457
Enhance documentation for email address methods 
Detailed doc comments have been added to various methods handling "From", "To", "CC", "BCC", and "Reply-To" email addresses within the Msg class. The new comments follow RFC 5322 standards and provide explicit descriptions of the functionality and validation rules for each method. This improves code readability and maintainability. Additionally, moved the `addAddr` function to a more appropriate position within the file.
 2024-10-05 19:11:16 +02:00
Winni Neessen
3d5435c138
Update EnvelopeFromFormat documentation in msg.go 
Expanded the documentation for the EnvelopeFromFormat method to clarify its purpose, usage, and compliance with RFC 5322. Added details on how the envelope from address is used in SMTP communication and validation requirements.
 2024-10-05 13:59:24 +02:00
Winni Neessen
1dcdad9da1
Enhance address header methods with detailed documentation 
Updated comments in `header.go` and `msg.go` to provide more detailed explanations and references to RFC 5322. This improves clarity on how headers are set and utilized, and the conditions under which they operate.
 2024-10-05 13:56:47 +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
c186cba2c2
Refactor MsgOption comments for clarity 
Revised the comments for MsgOption functions to provide clearer explanations of their purpose and usage. Added detailed descriptions for options such as WithMIMEVersion and WithBoundary to clarify their contexts and constraints.
 2024-10-05 12:48:09 +02:00
Winni Neessen
682f7a6ca5
Clarify Msg struct field comments 
Updated comments for all fields in the Msg struct to provide clearer and more detailed explanations. This includes specifying the data type for each field and the role they play within the Msg struct, making the code easier to understand and maintain.
 2024-10-05 12:35:15 +02:00
Winni Neessen
cd4c0194dc
Refactor comments for clarity and detail 
Enhanced the descriptive comments for error variables, constants, and types to provide clearer and more detailed explanations. This improves code readability and ensures that the purpose and usage of different elements are better understood by developers.
 2024-10-05 12:15:01 +02:00
Winni Neessen
a820ba3cee
Correct typo in README.md 
Fixed a typo in the README where `io.WriteTo` was incorrectly spelled instead of `io.WriterTo`. This ensures the documentation correctly reflects the interfaces implemented by the Message object.
 2024-10-05 12:14:00 +02:00
Winni Neessen
96466facdd
Refactor and document header types and importance levels. 
Updated type declarations for headers and importance to clarify their roles in the Msg package. Added detailed inline comments and RFC links for better documentation and understanding. Enhanced string representation methods to explicitly handle importance levels and header types.
 2024-10-05 12:00:10 +02:00
Winni Neessen
493f8fc657
Add periods to charset comments 
Updated the comment lines for various charset constants to include ending periods for consistency and better readability. This change enhances code documentation quality without altering any functional behavior.
 2024-10-05 11:54:37 +02:00
Winni Neessen
94f47d4369
Update crypto and text libraries 
Upgraded golang.org/x/crypto to v0.28.0 and golang.org/x/text to v0.19.0. These updates improve security and compatibility with recent changes in Go modules. Ensure to run `go mod tidy` to clean up any unused dependencies.
 2024-10-05 11:47:15 +02:00
Winni Neessen
476130d6e3
Fumpt files to make golangci-lint happy 2024-10-05 11:43:50 +02:00
Winni Neessen
a0a7f74121
Refactor file.go comments for clarity and detail 
Improved comments for better readability and understanding. Enhanced descriptions for File, FileOption, and various methods, providing more context and precision. Added notes on default behaviors and specific use cases for methods where applicable.
 2024-10-05 11:42:21 +02:00
Winni Neessen
ecd0bff5ad
Update comments for better clarity and add RFC references 
Revised the comments to provide more detailed descriptions and context for each type and constant. Additionally, included relevant RFC document references where applicable to improve understanding of encoding and MIME types.
 2024-10-05 11:23:44 +02:00
Winni Neessen
5653df373b
Add periods to end of go doc comments 
Ensure all go doc comments in eml.go have consistent punctuation by adding periods to the end of each comment. This improves code readability and maintains uniformity in the documentation style.
 2024-10-05 11:11:17 +02:00
Winni Neessen
869e8db6c5
Improve package documentation and description 
Expand the package mail description to highlight ease of use, reliance on the Go Standard Library, and added functionalities. Clarify the role of VERSION in the user agent string.
 2024-10-05 11:06:46 +02:00
Winni Neessen
fa3c6f956e
Update Send function documentation for better clarity 
Enhanced the documentation of the `Send` function to explicitly describe the behavior when the Client has no active connection and the handling of multiple message transmissions. This ensures developers understand the error handling mechanism and the association of `SendError` with each message.
 2024-10-05 11:02:26 +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
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