From fa3c6f956edcfd974f64b157d50f2e9426ce4175 Mon Sep 17 00:00:00 2001 From: Winni Neessen Date: Sat, 5 Oct 2024 11:02:26 +0200 Subject: [PATCH] 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. --- client_119.go | 5 ++++- client_120.go | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/client_119.go b/client_119.go index 7de5d59..24a0118 100644 --- a/client_119.go +++ b/client_119.go @@ -9,7 +9,10 @@ package mail import "errors" -// Send sends out the mail message +// Send attempts to send one or more Msg using the Client connection to the SMTP server. +// If the Client has no active connection to the server, Send will fail with an error. For each of the +// provided Msg it will associate a SendError to the Msg in case there of a transmission or delivery +// error. func (c *Client) Send(messages ...*Msg) error { if err := c.checkConn(); err != nil { return &SendError{Reason: ErrConnCheck, errlist: []error{err}, isTemp: isTempError(err)} diff --git a/client_120.go b/client_120.go index 4f82aa7..c6049eb 100644 --- a/client_120.go +++ b/client_120.go @@ -11,7 +11,10 @@ import ( "errors" ) -// Send sends out the mail message +// Send attempts to send one or more Msg using the Client connection to the SMTP server. +// If the Client has no active connection to the server, Send will fail with an error. For each of the +// provided Msg it will associate a SendError to the Msg in case there of a transmission or delivery +// error. func (c *Client) Send(messages ...*Msg) (returnErr error) { if err := c.checkConn(); err != nil { returnErr = &SendError{Reason: ErrConnCheck, errlist: []error{err}, isTemp: isTempError(err)}