使用Go語言封裝實現郵件發(fā)送功能

更新時間：2025年03月26日 09:43:02 作者：熬了夜的程序員

在現代 Web 開發(fā)中,郵件發(fā)送功能是一個常見的需求,本文將介紹如何在 Go 語言中封裝一個通用的郵件發(fā)送包,支持驗證碼發(fā)送和通用郵件發(fā)送,需要的可以參考下

在現代 Web 開發(fā)中，郵件發(fā)送功能是一個常見的需求，特別是在用戶注冊、密碼重置、通知等場景中，往往需要通過郵件發(fā)送驗證碼或其他信息。本文將介紹如何在 Go 語言中封裝一個通用的郵件發(fā)送包，支持驗證碼發(fā)送和通用郵件發(fā)送。

目標

封裝一個郵件發(fā)送的包

支持 SMTP 協議發(fā)送郵件

提供發(fā)送驗證碼和普通郵件的功能

通過結構體和方法實現面向對象的設計

完善的單元測試，確保代碼健壯性

依賴包

在開始之前，需要引入以下依賴包：

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

github.com/jordan-wright/email：一個常用的 Go 語言郵件發(fā)送庫，簡化 SMTP 發(fā)送流程。
go.uber.org/zap：Uber 開發(fā)的高效日志庫，用于記錄日志。
github.com/stretchr/testify：Go 的單元測試庫。

項目結構

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

代碼實現

email/email.go

創(chuàng)建 email/email.go 文件，封裝郵件發(fā)送功能。

package email

import (
	"fmt"
	"gin-mall/model"
	"gin-mall/pkg/logger"
	"net/smtp"
	"time"

	"github.com/jordan-wright/email"
	"go.uber.org/zap"
)

// Email 郵件
type Email struct {
	config  Config   // 郵件配置
	From    string   // 發(fā)件人
	To      []string // 收件人
	Subject string   // 主題
	Body    string   // 內容
}

// Config 郵件配置
type Config struct {
	SMTPServer string // SMTP服務器
	SMTPPort   int    // SMTP端口
	Username   string // 用戶名
	Password   string // 密碼
}

// NewEmail 創(chuàng)建Email實例
func NewEmail(config Config) *Email {
	e := &Email{config: config}
	e.From = config.Username
	return e
}

// SetFrom 設置發(fā)件人
func (e *Email) SetFrom(from string) {
	e.From = from
}

// SetTo 設置收件人
func (e *Email) SetTo(to []string) {
	e.To = to
}

// AppendTo 添加收件人
func (e *Email) AppendTo(to string) {
	e.To = append(e.To, to)
}

// SetSubject 設置郵件主題
func (e *Email) SetSubject(subject string) {
	e.Subject = subject
}

// SetBody 設置郵件內容
func (e *Email) SetBody(body string) {
	e.Body = body
}

// Send 發(fā)送郵件
func (e *Email) Send() error {
	auth := smtp.PlainAuth("", e.config.Username, e.config.Password, e.config.SMTPServer)

	host := fmt.Sprintf("%s:%d", e.config.SMTPServer, e.config.SMTPPort)

	eClient := email.NewEmail()
	eClient.From = e.From
	eClient.To = e.To
	eClient.Subject = e.Subject
	eClient.Text = []byte(e.Body)

	err := eClient.Send(host, auth)
	if err != nil {
		return err
	}

	return nil
}

// SendVerifyCode 發(fā)送驗證碼
func (e *Email) SendVerifyCode(receiver, code, key string) error {
	// 保存驗證碼到緩存
	err := model.CacheDb.Set(key, code, 5*time.Minute)
	if err != nil {
		logger.Error("設置緩存失敗", zap.Error(err))
		return err
	}

	// 發(fā)送郵件
	msg := fmt.Sprintf("【XXX】您的驗證碼是: %s, 請在5分鐘內完成驗證.", code)
	e.AppendTo(receiver)
	e.SetSubject("GinMall 驗證碼")
	e.SetBody(msg)

	return e.Send()
}

主要方法說明

方法名	功能	說明
NewEmail	創(chuàng)建新的郵件實例	通過傳入 SMTP 配置，創(chuàng)建 Email 結構體
SetFrom	設置發(fā)件人	可自定義發(fā)件人
SetTo	設置收件人	直接設置收件人數組
AppendTo	添加收件人	動態(tài)添加收件人
SetSubject	設置主題	設置郵件的標題
SetBody	設置內容	設置郵件的內容
Send	發(fā)送郵件	通過 SMTP 協議發(fā)送郵件
SendVerifyCode	發(fā)送驗證碼	生成并發(fā)送驗證碼

單元測試

email/email_test.go

創(chuàng)建 email/email_test.go，對郵件發(fā)送功能進行測試。

package email

import (
	"testing"

	"github.com/stretchr/testify/assert"
)

func TestSendEmail(t *testing.T) {
	config := Config{
		SMTPServer: "smtp.163.com",
		SMTPPort:   25,
		Username:   "your-email@163.com",
		Password:   "your-password",
	}

	email := NewEmail(config)
	assert.NotNil(t, email)

	email.SetFrom(config.Username)
	email.AppendTo("receiver@example.com")
	email.SetSubject("Test Email")
	email.SetBody("This is a test email.")

	err := email.Send()
	assert.Nil(t, err)

	t.Logf("Email sent successfully")
}

使用示例

在 main.go 文件中直接調用封裝好的方法來發(fā)送郵件：

package main

import (
	"log"
	"gin-mall/email"
)

func main() {
	config := email.Config{
		SMTPServer: "smtp.163.com",
		SMTPPort:   25,
		Username:   "your-email@163.com",
		Password:   "your-password",
	}

	email := email.NewEmail(config)
	email.SetFrom(config.Username)
	email.AppendTo("receiver@example.com")
	email.SetSubject("Welcome to GinMall")
	email.SetBody("Thank you for signing up to GinMall!")

	err := email.Send()
	if err != nil {
		log.Fatalf("Failed to send email: %v", err)
	} else {
		log.Println("Email sent successfully")
	}
}