Document NetDialTimeout

go-mail · Dec 6, 2017 · 8340910 · 8340910
1 parent f10eb0a
commit 8340910
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/smtp.go b/smtp.go
@@ -55,6 +55,9 @@ func NewPlainDialer(host string, port int, username, password string) *Dialer {
 	return NewDialer(host, port, username, password)
 }
 
+// NetDialTimeout specifies the DialTimeout function to establish a connection
+// to the SMTP server. This can be used to override dialing in the case that a
+// proxy or other special behavior is needed.
 var NetDialTimeout = net.DialTimeout
 
 // Dial dials and authenticates to an SMTP server. The returned SendCloser