Customers Mail Cloudではプログラム側からデータを取得したり、メールを送信するWeb APIの他に、Customers Mail Cloudでメールを受信した時にイベントを伝えてくれるWebhook APIが用意されています。
Webhook APIを使うことで、自前でメールサーバを立てずにメール受信のタイミングでシステムを起動させられるようになります。メールサーバを安定して動作させ続けるのはメンテナンスコストが大きいですが、Customers Mail Cloudを使うことで簡単にメールと連携したシステムが作れるようになるでしょう。
今回はGoogle Cloud Functionsで、Go言語を使ってメールを処理する流れを紹介します。
フォーマットはJSONとマルチパートフォームデータ
Webhookの形式として、JSONとマルチパートフォームデータ(multipart/form-data)が選択できます。この二つの違いは、添付ファイルがあるかどうかです。JSONの場合、添付ファイルは送られてきません。メールに添付ファイルがついてくる可能性がある場合は、後者を選択してください。
今回はJSONフォーマットにおけるWebhook処理について紹介します。
Google Cloud Functionsの準備
今回はローカルで開発する流れを紹介します。まず、適当なフォルダを作成します。今回はcmcとします。
mkdir cmc cd cmc
次に hello_http.go
というファイルを作成し、以下のように記述します。
package helloworld import ( "encoding/json" "fmt" "html" "net/http" "github.com/GoogleCloudPlatform/functions-framework-go/functions" ) func init() { functions.HTTP("HelloHTTP", HelloHTTP) } func HelloHTTP(w http.ResponseWriter, r *http.Request) { // ここに処理を記述 }
次に依存関係を追跡します。
go mod init example.com/hello go mod tidy
ローカルで実行できるようにする準備
cmc
フォルダ内に cmd
フォルダを作成します。
mkdir cmd
cmd/main.go
ファイルを作成し、内容を以下のようにします。
package main import ( "log" "os" // Blank-import the function package so the init() runs _ "example.com/hello" "github.com/GoogleCloudPlatform/functions-framework-go/funcframework" ) func main() { // Use PORT environment variable, or default to 8080. port := "8080" if envPort := os.Getenv("PORT"); envPort != "" { port = envPort } if err := funcframework.Start(port); err != nil { log.Fatalf("funcframework.Start: %v\n", err) } }
残りの依存関係を解決します。
go mod tidy
後は以下のコマンドで http://localhost:8080
でサーバーが立ち上がります。
export FUNCTION_TARGET=HelloHTTP go run cmd/main.go
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" }
Go言語のコード
処理は hello_http.go
の HelloHTTP
関数内に記述します。
func HelloHTTP(w http.ResponseWriter, r *http.Request) { // ここに処理を記述 }
送られてくるデータは r.Body
で受け取れます。この内容はJSON文字列なので、 json.NewDecoder
を使って構造体に変換します。
var Webhook struct { Filter string `json:"filter"` Headers []struct { Name string `json:"name"` Value string `json:"value"` } `json:"headers"` Subject string `json:"subject"` EnvelopeTo string `json:"envelope-to"` ServerComposition string `json:"server_composition"` HTML string `json:"html"` Text string `json:"text"` EnvelopeFrom string `json:"envelope-from"` } if err := json.NewDecoder(r.Body).Decode(&Webhook); err != nil { fmt.Fprint(w, "Hello, World!") return }
この Webhook
は構造体なので、プロパティを指定して値を取り出せます。
fmt.Fprintf(w, Webhook.Filter) // info@smtps.jp fmt.Fprintf(w, Webhook.Subject) // Webhookのテスト
Webhookの結果は管理画面で確認
Webhookでデータが送信されたログは管理画面で確認できます。送信時のAPIキー設定など、HTTPヘッダーを編集するといった機能も用意されていますので、運用に応じて細かなカスタマイズが可能です。
まとめ
メールと連携したシステムはよくあります。通常、メールサーバを立てて、その中で処理することが多いのですが、メールサーバが落ちてしまうとシステムが稼働しなくなったり、メール文面の解析が煩雑でした。Customers Mail Cloudを使えばそうした手間なくJSONで処理できて便利です。