chore: comments

2024-11-25 21:22:20 +08:00
parent 124af0b76d
commit 2b93552d1d
17 changed files with 61 additions and 19 deletions
--- a/internal/pkg/core/notifier/providers/email/email.go
+++ b/internal/pkg/core/notifier/providers/email/email.go
@@ -13,12 +13,20 @@ import (
 )

 type EmailNotifierConfig struct {
-	SmtpHost        string `json:"smtpHost"`
-	SmtpPort        int32  `json:"smtpPort"`
-	SmtpTLS         bool   `json:"smtpTLS"`
-	Username        string `json:"username"`
-	Password        string `json:"password"`
-	SenderAddress   string `json:"senderAddress"`
+	// SMTP 服务器地址。
+	SmtpHost string `json:"smtpHost"`
+	// SMTP 服务器端口。
+	// 零值时根据是否启用 TLS 决定。
+	SmtpPort int32 `json:"smtpPort"`
+	// 是否启用 TLS。
+	SmtpTLS bool `json:"smtpTLS"`
+	// 用户名。
+	Username string `json:"username"`
+	// 密码。
+	Password string `json:"password"`
+	// 发件人邮箱。
+	SenderAddress string `json:"senderAddress"`
+	// 收件人邮箱。
 	ReceiverAddress string `json:"receiverAddress"`
 }