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

Rename method and improve context handling

Browse source 
Renamed `SMTPClientFromDialWithContext` to `DialToSMTPClientWithContext` for clarity and consistency. Updated method parameters and documentation to standardize context usage across the codebase.
This commit is contained in:
Winni Neessen 2024-11-22 16:06:28 +01:00
parent 4c107f4645
commit 7aba5212c4
Signed by: wneessen
GPG key ID: 385AC9889632126E
1 changed files with 21 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
client.go
View file

@ -955,12 +955,12 @@ func (c *Client) SetLogAuthData(logAuth bool) {
// SMTP server. // SMTP server.
// //
// Parameters: // Parameters:
// - dialCtx: The context.Context used to control the connection timeout and cancellation. // - ctxDial: The context.Context used to control the connection timeout and cancellation.
// //
// Returns: // Returns:
// - An error if the connection to the SMTP server fails or any subsequent command fails. // - An error if the connection to the SMTP server fails or any subsequent command fails.
func (c *Client) DialWithContext(dialCtx context.Context) error { func (c *Client) DialWithContext(ctxDial context.Context) error {
client, err := c.SMTPClientFromDialWithContext(dialCtx) client, err := c.DialToSMTPClientWithContext(ctxDial)
if err != nil { if err != nil {
return err return err
} }
@ -970,9 +970,23 @@ func (c *Client) DialWithContext(dialCtx context.Context) error {
return nil return nil
} }
// SMTPClientFromDialWithContext is similar to DialWithContext but instead of storing the smtp.Client // DialToSMTPClientWithContext establishes and configures a smtp.Client connection using
// on the Client it will return the smtp.Client instead. // the provided context.
func (c *Client) SMTPClientFromDialWithContext(ctxDial context.Context) (*smtp.Client, error) { //
// This function uses the provided context to manage the connection deadline and cancellation.
// It dials the SMTP server using the Client's configured DialContextFunc or a default dialer.
// If SSL is enabled, it uses a TLS connection. After successfully connecting, it initializes
// an smtp.Client, sends the HELO/EHLO command, and optionally performs STARTTLS and SMTP AUTH
// based on the Client's configuration. Debug and authentication logging are enabled if
// configured.
//
// Parameters:
// - ctxDial: The context used to control the connection timeout and cancellation.
//
// Returns:
// - A pointer to the initialized smtp.Client.
// - An error if the connection fails, the smtp.Client cannot be created, or any subsequent commands fail.
func (c *Client) DialToSMTPClientWithContext(ctxDial context.Context) (*smtp.Client, error) {
c.mutex.RLock() c.mutex.RLock()
defer c.mutex.RUnlock() defer c.mutex.RUnlock()
@ -1137,7 +1151,7 @@ func (c *Client) DialAndSend(messages ...*Msg) error {
// - An error if the connection fails, if sending the messages fails, or if closing the // - An error if the connection fails, if sending the messages fails, or if closing the
// connection fails; otherwise, returns nil. // connection fails; otherwise, returns nil.
func (c *Client) DialAndSendWithContext(ctx context.Context, messages ...*Msg) error { func (c *Client) DialAndSendWithContext(ctx context.Context, messages ...*Msg) error {
client, err := c.SMTPClientFromDialWithContext(ctx) client, err := c.DialToSMTPClientWithContext(ctx)
if err != nil { if err != nil {
return fmt.Errorf("dial failed: %w", err) return fmt.Errorf("dial failed: %w", err)
} }