Webhook APIを使ってメールを処理する（Go言語 + gin編）

Customers Mail Cloudではプログラム側からデータを取得したり、メールを送信するWeb APIの他に、Customers Mail Cloudでメールを受信した時にイベントを伝えてくれるWebhook APIが用意されています。

Webhook APIを使うことで、自前でメールサーバを立てずにメール受信のタイミングでシステムを起動させられるようになります。メールサーバを安定して動作させ続けるのはメンテナンスコストが大きいですが、Customers Mail Cloudを使うことで簡単にメールと連携したシステムが作れるようになるでしょう。

今回はGo言語 + ginを使ってメールを処理する流れを紹介します。

フォーマットはJSONとマルチパートフォームデータ

Webhookの形式として、JSONとマルチパートフォームデータ（multipart/form-data）が選択できます。この二つの違いは、添付ファイルがあるかどうかです。JSONの場合、添付ファイルは送られてきません。メールに添付ファイルがついてくる可能性がある場合は、後者を選択してください。

今回はJSONフォーマットにおけるWebhook処理について紹介します。

Goのコード

Go言語では以下のように作成します。今回はWebフレームワークとしてginを利用しています。まず、プロジェクトを作ります。

go mod init smtps/webhook

また、ginをインストールします。

go get -u github.com/gin-gonic/gin

ginを使った場合のコードは、外観として以下のようになります。今回は POST /mails にてWebhookを受け取る前提になります。

package main

import (
    "fmt
  "github.com/gin-gonic/gin"
)

func main() {
  r := gin.Default()
  r.POST("/mails", func(c *gin.Context) {
    // この中で処理します
  })
  r.Run() // 0.0.0.0:8080 でサーバーを立てます。
}

Webhookで受け取るデータについて

Webhookを使ってPOSTされるJSONデータは、次のようになっています。

{
    "filter": "info@smtps.jp",
    "headers": [
      {name: 'Return-Path', value: '<user@example.com>'},
        :
      {name: 'Date', value: 'Thu, 27 Apr 2023 15:56:26 +0900'}
    ],
    "subject": "Webhookのテスト",
    "envelope-to": "user@smtps.jp",
    "server_composition": "sandbox",
    "html": "<div dir=\\\\\\\\\\\\\\\\"ltr\\\\\\\\\\\\\\\\">Webhookのテスト用メールです。<div>...</div></div>",
    "text": "Webhookのテスト用メールです。\\\\\\\\\\\\\\\\r\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\r\\\\\\\\\\\\\\\\n--\\\\\\\\\\\\\\\\r\\\\\\\\\\\\\\\\n...",
    "envelope-from": "info@smtps.jp"
}

構造体の作成

上記JSONデータに基づいて構造体を用意します。

type Mail struct {
    Filter            string   `json:"filter"`
    Headers           []Header `json:"headers"`
    Subject           string   `json:"subject"`
    EnvelopeTo        string   `json:"envelope-to"`
    ServerComposition string   `json:"server_composition"`
    Html              string   `json:"html"`
    EnvelopeFrom      string   `json:"envelope-from"`
    Text              string   `json:"text"`
}

type Header struct {
    Name  string `json:"name"`
    Value string `json:"value"`
}

POST時の処理について

今回はごく簡単に以下のように処理します。レスポンスは必ず200で返してください。 ShouldBindJSON を使ってJSONデータを構造体に変換できます。

   r.POST("/mails", func(c *gin.Context) {
        var mail Mail
        if err := c.ShouldBindJSON(&mail); err != nil {
            c.JSON(400, gin.H{"error": err.Error()})
            return
        }
        fmt.Println(mail.Subject)
        fmt.Println(mail.EnvelopeFrom)
        c.JSON(200, gin.H{})
    })