Sign inGet Started

Go · Gin

通过三个步骤从 Gin 应用发送第一封邮件:安装 SDK、添加发送路由,然后运行。

1. 安装

代码示例
go mod init example.com/bird-gin-quickstart
go get github.com/gin-gonic/gin github.com/messagebird/bird-sdk-go
SDK 需要 Go 1.24+。在控制面板的 Developers > API keys 中获取一个 API 密钥并导出;SDK 会根据密钥的 bk_us1_ / bk_eu1_ 前缀推断区域,无需其他配置:
代码示例
export BIRD_API_KEY="bk_us1_..."

2. 发送

创建 main.go,添加一条通过 Bird 共享入门域名发送邮件的路由,无需域名验证:
代码示例
package main

import (
	"errors"
	"log"
	"net/http"
	"os"

	"github.com/gin-gonic/gin"
	bird "github.com/messagebird/bird-sdk-go"
	"github.com/messagebird/bird-sdk-go/option"
)

func main() {
	client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
	if err != nil {
		log.Fatal(err)
	}

	r := gin.Default()
	r.POST("/send", func(c *gin.Context) {
		msg, err := client.Email.Send(c.Request.Context(), bird.EmailSendParams{
			From:    "onboarding@messagebird.dev",
			To:      []string{"delivered@messagebird.dev"},
			Subject: "Hello from Bird",
			HTML:    "<p>My first Bird email.</p>",
		})
		if err != nil {
			var apiErr *bird.APIError
			if errors.As(err, &apiErr) {
				c.JSON(apiErr.StatusCode, gin.H{"error": apiErr.Error()})
				return
			}
			c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
			return
		}
		c.JSON(http.StatusAccepted, msg)
	})

	log.Fatal(r.Run(":3000"))
}
SDK 为每次 Send 调用生成一个幂等键,并在重试超时、429 响应和 5xx 响应时复用该键。因此,重试不会产生第二次发送。

3. 试一试

代码示例
go run . &
curl -X POST localhost:3000/send
Bird 以 202 响应,表示邮件已被接受并将异步投递,路由返回消息。*_count 字段跟踪收件人的投递状态。在初始响应中,一个收件人已被接受,尚无投递完成:
代码示例
{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted",
  "category": "marketing",
  "from": { "email": "onboarding@messagebird.dev" },
  "to": [{ "email": "delivered@messagebird.dev" }],
  "subject": "Hello from Bird",
  "accepted_count": 1,
  "processed_count": 0,
  "delivered_count": 0,
  "deferred_count": 0,
  "bounced_count": 0,
  "complained_count": 0,
  "rejected_count": 0,
  "open_count": 0,
  "click_count": 0,
  "track_opens": true,
  "track_clicks": true,
  "created_at": "2026-07-23T13:58:20.866Z"
}
由于收件人是 delivered@messagebird.dev 沙箱地址,投递一定成功。通过 em_ ID 使用 client.Email.Get 获取消息,查看状态变为 delivered。

后续步骤