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

Update and expand documentation for client configuration options

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

39
client.go
View file

@ -376,7 +376,8 @@ func WithTLSPortPolicy(policy TLSPolicy) Option {
} }
} }
// WithTLSConfig tells the client to use the provided *tls.Config // WithTLSConfig sets the tls.Config for the Client and overrides the default. An error is returned
// if the provided tls.Config is invalid.
func WithTLSConfig(tlsconfig *tls.Config) Option { func WithTLSConfig(tlsconfig *tls.Config) Option {
return func(c *Client) error { return func(c *Client) error {
if tlsconfig == nil { if tlsconfig == nil {
@ -387,7 +388,7 @@ func WithTLSConfig(tlsconfig *tls.Config) Option {
} }
} }
// WithSMTPAuth tells the client to use the provided SMTPAuthType for authentication // WithSMTPAuth configures the Client to use the specified SMTPAuthType for the SMTP authentication.
func WithSMTPAuth(authtype SMTPAuthType) Option { func WithSMTPAuth(authtype SMTPAuthType) Option {
return func(c *Client) error { return func(c *Client) error {
c.smtpAuthType = authtype c.smtpAuthType = authtype
@ -395,7 +396,8 @@ func WithSMTPAuth(authtype SMTPAuthType) Option {
} }
} }
// WithSMTPAuthCustom tells the client to use the provided smtp.Auth for SMTP authentication // WithSMTPAuthCustom sets a custom SMTP authentication mechanism for the client instance. The provided
// authentication mechanism has to satisfy the smtp.Auth interface.
func WithSMTPAuthCustom(smtpAuth smtp.Auth) Option { func WithSMTPAuthCustom(smtpAuth smtp.Auth) Option {
return func(c *Client) error { return func(c *Client) error {
c.smtpAuth = smtpAuth c.smtpAuth = smtpAuth
@ -403,7 +405,7 @@ func WithSMTPAuthCustom(smtpAuth smtp.Auth) Option {
} }
} }
// WithUsername tells the client to use the provided string as username for authentication // WithUsername sets the username, the Client will use for the SMTP authentication.
func WithUsername(username string) Option { func WithUsername(username string) Option {
return func(c *Client) error { return func(c *Client) error {
c.user = username c.user = username
@ -411,7 +413,7 @@ func WithUsername(username string) Option {
} }
} }
// WithPassword tells the client to use the provided string as password/secret for authentication // WithPassword sets the password, the Client will use for the SMTP authentication.
func WithPassword(password string) Option { func WithPassword(password string) Option {
return func(c *Client) error { return func(c *Client) error {
c.pass = password c.pass = password
@ -419,10 +421,12 @@ func WithPassword(password string) Option {
} }
} }
// WithDSN enables the Client to request DSNs (if the server supports it) // WithDSN enables DSN (Delivery Status Notifications) for the Client as described in the RFC 1891. DSN
// as described in the RFC 1891 and set defaults for DSNMailReturnOption // only work if the server supports them.
// to DSNMailReturnFull and DSNRcptNotifyOption to DSNRcptNotifySuccess // https://datatracker.ietf.org/doc/html/rfc1891
// and DSNRcptNotifyFailure //
// By default we set DSNMailReturnOption to DSNMailReturnFull and DSNRcptNotifyOption to DSNRcptNotifySuccess
// and DSNRcptNotifyFailure.
func WithDSN() Option { func WithDSN() Option {
return func(c *Client) error { return func(c *Client) error {
c.requestDSN = true c.requestDSN = true
@ -432,10 +436,11 @@ func WithDSN() Option {
} }
} }
// WithDSNMailReturnType enables the Client to request DSNs (if the server supports it) // WithDSNMailReturnType enables DSN (Delivery Status Notifications) for the Client as described in the
// as described in the RFC 1891 and set the MAIL FROM Return option type to the // RFC 1891. DSN only work if the server supports them.
// given DSNMailReturnOption // https://datatracker.ietf.org/doc/html/rfc1891
// See: https://www.rfc-editor.org/rfc/rfc1891 //
// It will set the DSNMailReturnOption to the provided value.
func WithDSNMailReturnType(option DSNMailReturnOption) Option { func WithDSNMailReturnType(option DSNMailReturnOption) Option {
return func(c *Client) error { return func(c *Client) error {
switch option { switch option {
@ -451,9 +456,11 @@ func WithDSNMailReturnType(option DSNMailReturnOption) Option {
} }
} }
// WithDSNRcptNotifyType enables the Client to request DSNs as described in the RFC 1891 // WithDSNRcptNotifyType enables DSN (Delivery Status Notifications) for the Client as described in the
// and sets the RCPT TO notify options to the given list of DSNRcptNotifyOption // RFC 1891. DSN only work if the server supports them.
// See: https://www.rfc-editor.org/rfc/rfc1891 // https://datatracker.ietf.org/doc/html/rfc1891
//
// It will set the DSNRcptNotifyOption to the provided values.
func WithDSNRcptNotifyType(opts ...DSNRcptNotifyOption) Option { func WithDSNRcptNotifyType(opts ...DSNRcptNotifyOption) Option {
return func(c *Client) error { return func(c *Client) error {
var rcptOpts []string var rcptOpts []string