some security notes

google · Oct 12, 2020 · 72cc99b · 72cc99b
1 parent 349dcc5
commit 72cc99b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/pkg/email/config.go b/pkg/email/config.go
@@ -39,6 +39,12 @@ const (
 )
 
 // Config represents the env var based configuration for email SMTP server connection.
+//
+// Note: This may not work with email providers that do not accept external connections.
+//       The provider must accept TLS and users should consider the security of the
+//       email provder / account.
+//   Gmail or Google Workspace accounts can be used with an app-password, but will
+//   not work with security features such as Advanced Protection enabled.
 type Config struct {
 	ProviderType ProviderType