krzysbaranski/smsapi2email

SMS-API 2 EMAIL

镜像概述和主要用途

该镜像为测试环境提供SMSAPI的替代解决方案，通过与Smsapi.pl兼容的REST API，将原本应发送的短信转换为邮件发送，便于在测试环境中模拟和验证短信发送功能，尤其适合与MailHog等邮件测试工具集成。

核心功能和特性

• 通过简单API将短信转为邮件发送，替代实际SMS发送
• 提供简洁的REST API，易于集成
• 与流行的Smsapi.pl服务REST API兼容
• 可轻松与MailHog等邮件测试工具集成

工作原理

应用将消息发送至***地址to@domain而非实际短信，其中：

• to为REST请求中的查询参数（通常是电话号码）
• domain由环境变量DOMAIN指定（使用MailHog时可设为任意值）

API详情

端点

http://HOST:PORT/sms.do

支持的查询参数

• from: 发送者名称或发送类型（如2way）
• to: 目标电话号码
• message: 消息内容

使用示例

使用cURL发送消息

bash
curl 'http://localhost:8080/sms.do?from=MyCompany&to=666777888&message=some_message'

Docker部署

基础运行命令

Docker镜像地址：https://store.docker.com/community/images/krzysbaranski/smsapi2email

bash
docker run --rm -d --env DOMAIN=example.com --env SMTP_HOST=smtp.example.com --env SMTP_PORT=25 -p 8080:8080 docker.xuanyuan.run/krzysbaranski/smsapi2email

Docker Compose配置

同时启动smsapi2email和MailHog的docker-compose配置：

• MailHog访问地址：http://localhost:8025
• API端点：http://localhost:8080/sms.do

启动命令：

bash
docker-compose up -d

环境变量说明

其他运行方式（非Docker）

直接通过Go运行

1. 配置环境变量（可选）：

bash
export DOMAIN="mydomain"
export PORT="8090"
export HOSTNAME="localhost"

2. 运行：

bash
go run main.go

通过二进制运行

bash
SMTP_HOST=mysmtpserver SMTP_PORT=25 ./smsapi2email