使用MailHog进行Golang电子邮件和SMTP测试

MailHog是一个开源的电子邮件测试工具，专门为开发人员设计，它可以捕获发送到它的所有邮件，而无需实际发送出去。这对于开发和测试环境中的电子邮件功能验证非常有用。

MailHog简介

MailHog的主要特点：

• 轻量级的SMTP服务器
• 提供Web界面查看捕获的邮件
• 支持API访问
• 易于安装和使用

安装MailHog

1. 直接下载二进制文件

从官方GitHub仓库下载适合您系统的二进制文件。

2. 使用Docker运行

docker run -d -p 1025:1025 -p 8025:8025 mailhog/mailhog

3. 使用Homebrew (macOS)

brew install mailhog
brew services start mailhog

在Golang中使用MailHog测试邮件发送

以下是一个完整的示例，展示如何在Golang中发送邮件并通过MailHog进行测试：

package main

import (
	"fmt"
	"net/smtp"
	"strings"
)

// Mail 邮件结构体
type Mail struct {
	Sender  string
	To      []string
	Subject string
	Body    string
}

// SendMail 发送邮件
func SendMail(host string, port int, username, password string, mail Mail) error {
	addr := fmt.Sprintf("%s:%d", host, port)
	auth := smtp.PlainAuth("", username, password, host)

	msg := buildMessage(mail)
	return smtp.SendMail(addr, auth, mail.Sender, mail.To, []byte(msg))
}

func buildMessage(mail Mail) string {
	msg := "MIME-version: 1.0;\nContent-Type: text/html; charset=\"UTF-8\";\r\n"
	msg += fmt.Sprintf("From: %s\r\n", mail.Sender)
	msg += fmt.Sprintf("To: %s\r\n", strings.Join(mail.To, ";"))
	msg += fmt.Sprintf("Subject: %s\r\n", mail.Subject)
	msg += fmt.Sprintf("\r\n%s\r\n", mail.Body)

	return msg
}

func main() {
	// MailHog配置
	host := "localhost"
	port := 1025 // MailHog默认SMTP端口
	username := "" // MailHog不需要认证
	password := "" // MailHog不需要认证

	// 创建邮件
	mail := Mail{
		Sender:  "sender@example.com",
		To:      []string{"recipient@example.com"},
		Subject: "Test Email from Go",
		Body:    "<h1>Hello from Go!</h1><p>This is a test email sent using MailHog.</p>",
	}

	// 发送邮件
	err := SendMail(host, port, username, password, mail)
	if err != nil {
		fmt.Println("Error sending email:", err)
		return
	}

	fmt.Println("Email sent successfully!")
}

查看捕获的邮件

发送邮件后，您可以通过以下方式查看捕获的邮件：

1. 打开浏览器访问 http://localhost:8025
2. 您将看到MailHog的Web界面，显示所有捕获的邮件
3. 点击邮件可以查看详细内容，包括头部信息和正文

高级用法

1. 使用API获取邮件

MailHog提供了REST API，您可以通过编程方式访问捕获的邮件：

package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

type MailHogMessage struct {
	ID      string `json:"ID"`
	From    string `json:"From"`
	To      []string `json:"To"`
	Content struct {
		Headers map[string][]string `json:"Headers"`
		Body    string              `json:"Body"`
	} `json:"Content"`
}

func main() {
	resp, err := http.Get("http://localhost:8025/api/v2/messages")
	if err != nil {
		fmt.Println("Error fetching messages:", err)
		return
	}
	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		fmt.Println("Error reading response:", err)
		return
	}

	var messages struct {
		Total int               `json:"total"`
		Items []MailHogMessage `json:"items"`
	}

	err = json.Unmarshal(body, &messages)
	if err != nil {
		fmt.Println("Error unmarshaling JSON:", err)
		return
	}

	fmt.Printf("Found %d messages\n", messages.Total)
	for i, msg := range messages.Items {
		fmt.Printf("\nMessage %d:\n", i+1)
		fmt.Printf("From: %s\n", msg.From)
		fmt.Printf("To: %v\n", msg.To)
		fmt.Printf("Subject: %s\n", msg.Content.Headers["Subject"][0])
		fmt.Println("Body preview:", msg.Content.Body[:50], "...")
	}
}

2. 集成测试示例

package main

import (
	"net/smtp"
	"testing"
)

func TestEmailSending(t *testing.T) {
	host := "localhost"
	port := 1025

	mail := Mail{
		Sender:  "test@example.com",
		To:      []string{"test-recipient@example.com"},
		Subject: "Test Email",
		Body:    "This is a test email body",
	}

	err := SendMail(host, port, "", "", mail)
	if err != nil {
		t.Errorf("Failed to send email: %v", err)
	}

	// 这里可以添加API检查，确认邮件确实被MailHog捕获
}

注意事项

1. MailHog仅适用于开发和测试环境，不要在生产环境中使用
2. 默认情况下，MailHog不需要任何认证
3. MailHog不会持久化存储邮件，重启服务后所有邮件会丢失
4. 对于更复杂的测试场景，可以考虑使用MailHog的API进行自动化验证

通过使用MailHog，您可以轻松测试Golang应用程序中的电子邮件功能，而无需担心实际发送邮件或配置复杂的SMTP服务器。