Golang轻量级可配置多线程模拟SMTP服务器插件smtpmock的使用

smtpmock是一个用Go编写的轻量级可配置多线程模拟SMTP服务器，它符合RFC 2821和RFC 5321规范的最小要求，可以模拟任何SMTP服务器行为用于测试环境。

主要特性

• 可配置的多线程RFC兼容SMTP服务器
• 实现最小命令集，根据RFC规范响应命令并为消息添加有效的接收头
• 能够为每个SMTP命令配置行为
• 开箱即用的默认设置，只需配置你需要的部分
• 能够覆盖之前的SMTP命令
• 快速失败场景（当命令不一致或失败时关闭客户端会话）
• 多接收者支持（在一个会话中配置多个RCPT TO命令接收）
• 多消息接收支持
• 服务器活动日志记录
• 支持优雅/强制关闭SMTP模拟服务器
• 零运行时依赖

安装

安装smtpmock：

go get github.com/mocktools/go-smtp-mock/v2
go install github.com/mocktools/go-smtp-mock/v2

在代码中导入smtpmock依赖：

package main

import smtpmock "github.com/mocktools/go-smtp-mock/v2"

使用示例

在Golang生态系统中使用

配置服务器

server := smtpmock.New(smtpmock.ConfigurationAttr{
    // 服务器行为配置
    HostAddress:       "[::]",  // 服务器运行的主机地址，默认为"127.0.0.1"
    PortNumber:        2525,    // 服务器绑定的端口号，未指定时会动态分配
    LogToStdout:       true,    // 启用/禁用标准输出日志，默认为false
    LogServerActivity: true,    // 启用/禁用服务器活动日志，默认为false
    SessionTimeout:    42,      // 会话超时时间，默认为30秒
    ShutdownTimeout:   5,       // 优雅关闭超时时间，默认为1秒

    // SMTP命令处理行为配置
    IsCmdFailFast:            true,  // 启用快速失败场景，默认为false
    MultipleRcptto:           true,  // 启用多RCPT TO接收，默认为false
    MultipleMessageReceiving: true,  // 启用多消息接收，默认为false
    
    // 黑名单和响应延迟配置
    BlacklistedHeloDomains:    []string{"example1.com", "example2.com"},
    BlacklistedMailfromEmails: []string{"bot@olo.com", "robot@molo.com"},
    ResponseDelayHelo:         2,    // HELO响应延迟秒数
    ResponseDelayMailfrom:     2,    // MAIL FROM响应延迟秒数
    
    // 自定义消息
    MsgGreeting:      "msgGreeting",      // 自定义服务器欢迎消息
    MsgInvalidCmd:    "msgInvalidCmd",    // 自定义无效命令消息
    MsgHeloReceived:  "msgHeloReceived",  // 自定义HELO接收消息
})

服务器操作示例

package main

import (
    "fmt"
    "net"
    "net/smtp"
    "time"

    smtpmock "github.com/mocktools/go-smtp-mock/v2"
)

func main() {
    // 创建服务器实例
    server := smtpmock.New(smtpmock.ConfigurationAttr{
        LogToStdout:       true,
        LogServerActivity: true,
    })

    // 启动服务器
    if err := server.Start(); err != nil {
        fmt.Println(err)
    }

    // 获取服务器地址和端口
    hostAddress, portNumber := "127.0.0.1", server.PortNumber()

    // 创建SMTP客户端连接
    address := fmt.Sprintf("%s:%d", hostAddress, portNumber)
    timeout := time.Duration(2) * time.Second

    connection, _ := net.DialTimeout("tcp", address, timeout)
    client, _ := smtp.NewClient(connection, hostAddress)
    client.Hello("example.com")
    client.Quit()
    client.Close()

    // 获取服务器消息
    messages := server.Messages()
    fmt.Printf("Received messages: %+v\n", messages)

    // 停止服务器
    if err := server.Stop(); err != nil {
        fmt.Println(err)
    }
}

使用自定义日志器

package main

import (
    "bytes"
    "fmt"

    smtpmock "github.com/mocktools/go-smtp-mock/v2"
)

// 自定义日志器实现
type customLogger struct {
    out *bytes.Buffer
    err *bytes.Buffer
}

func (logger *customLogger) InfoActivity(message string) {
    logger.out.WriteString(message)
}

func (logger *customLogger) Info(message string) {
    logger.out.WriteString(message)
}

func (logger *customLogger) Warning(message string) {
    logger.out.WriteString(message)
}

func (logger *customLogger) Error(message string) {
    logger.err.WriteString(message)
}

func main() {
    server := smtpmock.New(smtpmock.ConfigurationAttr{
        LogToStdout:       true,
        LogServerActivity: true,
    })

    // 设置自定义日志器
    outBuf := &bytes.Buffer{}
    errBuf := &bytes.Buffer{}
    server.WithLogger(&customLogger{
        out: outBuf,
        err: errBuf,
    })

    // 启动和停止服务器
    if err := server.Start(); err != nil {
        fmt.Println(err)
    }
    
    if err := server.Stop(); err != nil {
        fmt.Println(err)
    }
}

在Ruby生态系统中使用

在Ruby生态系统中，smtpmock可以作为smtp_mock gem使用，它是smtpmock二进制文件的灵活Ruby包装器。

安装和使用示例：

gem install smtp_mock
bundle exec smtp_mock -i ~

Ruby代码示例：

require 'smtp_mock'

# 启动服务器并配置
smtp_mock_server = SmtpMock.start_server(not_registered_emails: %w[user@olo.com user@molo.com])

# 获取服务器端口
smtp_mock_server.port # => 55640

# 停止服务器
smtp_mock_server.stop! # => true

在任何生态系统中使用

你可以将smtpmock作为二进制文件使用。下载预编译的二进制文件后，使用以下命令启动服务器：

curl -sL https://raw.githubusercontent.com/mocktools/go-smtp-mock/master/script/download.sh | bash
./smtpmock -port=2525 -log

已实现的SMTP命令

贡献

欢迎在GitHub上提交错误报告和拉取请求。请遵循贡献者行为准则和我们的贡献指南。

许可证

此Go包是根据MIT许可证条款提供的开源软件。