wneessen/go-mail
1
1
Fork 0
mirror of https://github.com/wneessen/go-mail.git synced 2024-11-25 07:00:49 +01:00
Code Issues Projects Releases Packages Wiki Activity

Refactor comments for clarity in client.go

Browse source 
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.
This commit is contained in:
Winni Neessen 2024-10-04 23:25:43 +02:00
parent 48b469faf7
commit fbbf17acd0
Signed by: wneessen
GPG key ID: 385AC9889632126E
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
client.go
View file

@ -767,7 +767,9 @@ func (c *Client) DialAndSendWithContext(ctx context.Context, messages ...*Msg) e
return nil return nil
} }
// auth will try to perform SMTP AUTH if requested // auth attempts to authenticate the client using SMTP AUTH mechanisms. It checks the connection, determines
// the supported authentication methods, and applies the appropriate authentication type. Returns an error if
// authentication fails.
func (c *Client) auth() error { func (c *Client) auth() error {
if err := c.checkConn(); err != nil { if err := c.checkConn(); err != nil {
return fmt.Errorf("failed to authenticate: %w", err) return fmt.Errorf("failed to authenticate: %w", err)
@ -940,8 +942,7 @@ func (c *Client) sendSingleMsg(message *Msg) error {
return nil return nil
} }
// checkConn makes sure that a required server connection is available and extends the // checkConn makes sure that a required server connection is available and extends the connection deadline
// connection deadline
func (c *Client) checkConn() error { func (c *Client) checkConn() error {
if !c.smtpClient.HasConnection() { if !c.smtpClient.HasConnection() {
return ErrNoActiveConnection return ErrNoActiveConnection
@ -959,13 +960,12 @@ func (c *Client) checkConn() error {
return nil return nil
} }
// serverFallbackAddr returns the currently set combination of hostname // serverFallbackAddr returns the currently set combination of hostname and fallback port.
// and fallback port.
func (c *Client) serverFallbackAddr() string { func (c *Client) serverFallbackAddr() string {
return fmt.Sprintf("%s:%d", c.host, c.fallbackPort) return fmt.Sprintf("%s:%d", c.host, c.fallbackPort)
} }
// setDefaultHelo retrieves the current hostname and sets it as HELO/EHLO hostname // setDefaultHelo sets the HELO/EHLO hostname to the local machine's hostname.
func (c *Client) setDefaultHelo() error { func (c *Client) setDefaultHelo() error {
hostname, err := os.Hostname() hostname, err := os.Hostname()
if err != nil { if err != nil {
@ -975,7 +975,8 @@ func (c *Client) setDefaultHelo() error {
return nil return nil
} }
// tls tries to make sure that the STARTTLS requirements are satisfied // tls establishes a TLS connection based on the client's TLS policy and configuration.
// Returns an error if no active connection exists or if a TLS error occurs.
func (c *Client) tls() error { func (c *Client) tls() error {
if !c.smtpClient.HasConnection() { if !c.smtpClient.HasConnection() {
return ErrNoActiveConnection return ErrNoActiveConnection