在现代 Web 开发中，邮件发送功能是一个常见的需求，特别是在用户注册、密码重置、通知等场景中，往往需要通过邮件发送验证码或其他信息。本文将介绍如何在 Go 语言中封装一个通用的邮件发送包，支持验证码发送和通用邮件发送。

目标

封装一个邮件发送的包
支持 SMTP 协议发送邮件
提供发送验证码和普通邮件的功能
通过结构体和方法实现面向对象的设计
完善的单元测试，确保代码健壮性

依赖包

在开始之前，需要引入以下依赖包：

1. go get github.com/jordan-wright/email
   
2. go get go.uber.org/zap
   
3. go get github.com/stretchr/testify

复制代码

• github.com/jordan-wright/email：一个常用的 Go 语言邮件发送库，简化 SMTP 发送流程。
  
• go.uber.org/zap：Uber 开发的高效日志库，用于记录日志。
  
• github.com/stretchr/testify：Go 的单元测试库。
  

项目结构

1. ├── email│   ├── email.go│   └── email_test.go├── model│   └── cache.go├── pkg│   └── logger.go├── go.mod├── go.sum└── main.go

复制代码

代码实现

email/email.go
创建 email/email.go 文件，封装邮件发送功能。

1. package email
   
2. 
   
3. import (
   
4.         "fmt"
   
5.         "gin-mall/model"
   
6.         "gin-mall/pkg/logger"
   
7.         "net/smtp"
   
8.         "time"
   
9. 
   
10.         "github.com/jordan-wright/email"
    
11.         "go.uber.org/zap"
    
12. )
    
13. 
    
14. // Email 邮件
    
15. type Email struct {
    
16.         config  Config   // 邮件配置
    
17.         From    string   // 发件人
    
18.         To      []string // 收件人
    
19.         Subject string   // 主题
    
20.         Body    string   // 内容
    
21. }
    
22. 
    
23. // Config 邮件配置
    
24. type Config struct {
    
25.         SMTPServer string // SMTP服务器
    
26.         SMTPPort   int    // SMTP端口
    
27.         Username   string // 用户名
    
28.         Password   string // 密码
    
29. }
    
30. 
    
31. // NewEmail 创建Email实例
    
32. func NewEmail(config Config) *Email {
    
33.         e := &Email{config: config}
    
34.         e.From = config.Username
    
35.         return e
    
36. }
    
37. 
    
38. // SetFrom 设置发件人
    
39. func (e *Email) SetFrom(from string) {
    
40.         e.From = from
    
41. }
    
42. 
    
43. // SetTo 设置收件人
    
44. func (e *Email) SetTo(to []string) {
    
45.         e.To = to
    
46. }
    
47. 
    
48. // AppendTo 添加收件人
    
49. func (e *Email) AppendTo(to string) {
    
50.         e.To = append(e.To, to)
    
51. }
    
52. 
    
53. // SetSubject 设置邮件主题
    
54. func (e *Email) SetSubject(subject string) {
    
55.         e.Subject = subject
    
56. }
    
57. 
    
58. // SetBody 设置邮件内容
    
59. func (e *Email) SetBody(body string) {
    
60.         e.Body = body
    
61. }
    
62. 
    
63. // Send 发送邮件
    
64. func (e *Email) Send() error {
    
65.         auth := smtp.PlainAuth("", e.config.Username, e.config.Password, e.config.SMTPServer)
    
66. 
    
67.         host := fmt.Sprintf("%s:%d", e.config.SMTPServer, e.config.SMTPPort)
    
68. 
    
69.         eClient := email.NewEmail()
    
70.         eClient.From = e.From
    
71.         eClient.To = e.To
    
72.         eClient.Subject = e.Subject
    
73.         eClient.Text = []byte(e.Body)
    
74. 
    
75.         err := eClient.Send(host, auth)
    
76.         if err != nil {
    
77.                 return err
    
78.         }
    
79. 
    
80.         return nil
    
81. }
    
82. 
    
83. // SendVerifyCode 发送验证码
    
84. func (e *Email) SendVerifyCode(receiver, code, key string) error {
    
85.         // 保存验证码到缓存
    
86.         err := model.CacheDb.Set(key, code, 5*time.Minute)
    
87.         if err != nil {
    
88.                 logger.Error("设置缓存失败", zap.Error(err))
    
89.                 return err
    
90.         }
    
91. 
    
92.         // 发送邮件
    
93.         msg := fmt.Sprintf("【XXX】您的验证码是: %s, 请在5分钟内完成验证.", code)
    
94.         e.AppendTo(receiver)
    
95.         e.SetSubject("GinMall 验证码")
    
96.         e.SetBody(msg)
    
97. 
    
98.         return e.Send()
    
99. }

复制代码

主要方法说明

方法名功能说明NewEmail创建新的邮件实例通过传入 SMTP 配置，创建 Email 结构体SetFrom设置发件人可自定义发件人SetTo设置收件人直接设置收件人数组AppendTo添加收件人动态添加收件人SetSubject设置主题设置邮件的标题SetBody设置内容设置邮件的内容Send发送邮件通过 SMTP 协议发送邮件SendVerifyCode发送验证码生成并发送验证码
单元测试

email/email_test.go
创建 email/email_test.go，对邮件发送功能进行测试。

1. package email
   
2. 
   
3. import (
   
4.         "testing"
   
5. 
   
6.         "github.com/stretchr/testify/assert"
   
7. )
   
8. 
   
9. func TestSendEmail(t *testing.T) {
   
10.         config := Config{
    
11.                 SMTPServer: "smtp.163.com",
    
12.                 SMTPPort:   25,
    
13.                 Username:   "your-email@163.com",
    
14.                 Password:   "your-password",
    
15.         }
    
16. 
    
17.         email := NewEmail(config)
    
18.         assert.NotNil(t, email)
    
19. 
    
20.         email.SetFrom(config.Username)
    
21.         email.AppendTo("receiver@example.com")
    
22.         email.SetSubject("Test Email")
    
23.         email.SetBody("This is a test email.")
    
24. 
    
25.         err := email.Send()
    
26.         assert.Nil(t, err)
    
27. 
    
28.         t.Logf("Email sent successfully")
    
29. }

复制代码

使用示例

在 main.go 文件中直接调用封装好的方法来发送邮件：

1. package main
   
2. 
   
3. import (
   
4.         "log"
   
5.         "gin-mall/email"
   
6. )
   
7. 
   
8. func main() {
   
9.         config := email.Config{
   
10.                 SMTPServer: "smtp.163.com",
    
11.                 SMTPPort:   25,
    
12.                 Username:   "your-email@163.com",
    
13.                 Password:   "your-password",
    
14.         }
    
15. 
    
16.         email := email.NewEmail(config)
    
17.         email.SetFrom(config.Username)
    
18.         email.AppendTo("receiver@example.com")
    
19.         email.SetSubject("Welcome to GinMall")
    
20.         email.SetBody("Thank you for signing up to GinMall!")
    
21. 
    
22.         err := email.Send()
    
23.         if err != nil {
    
24.                 log.Fatalf("Failed to send email: %v", err)
    
25.         } else {
    
26.                 log.Println("Email sent successfully")
    
27.         }
    
28. }

复制代码

代码亮点

✅ 面向对象设计，封装良好
✅ 使用 go.uber.org/zap 记录日志
✅ 使用 github.com/jordan-wright/email 简化 SMTP 发送
✅ 使用 github.com/stretchr/testify 进行单元测试

改进方向

支持 HTML 格式的邮件内容
支持添加附件
通过配置文件设置邮件参数
添加邮件发送失败的重试机制

总结

通过封装 github.com/jordan-wright/email，我们可以快速实现邮件发送功能。封装良好的结构体和方法，使代码更易于扩展和复用。希
到此这篇关于使用Go语言封装实现邮件发送功能的文章就介绍到这了,更多相关Go邮件发送内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

来源：互联网
免责声明：如果侵犯了您的权益，请联系站长（1277306191@qq.com），我们会及时删除侵权内容，谢谢合作！