Customers Mail CloudのWebhookは2種類あります。
- メール受信時
- メール送信時
メール受信時のWebhookはその名の通り、メールを受け取った際に任意のURLをコールするものです。この記事では添付ファイル付きメールを受け取った際のWebhook処理について解説します。
<!—more—>
フォーマットはマルチパートフォームデータ
Webhookの形式として、JSONとマルチパートフォームデータ(multipart/form-data)が選択できます。この二つの違いは、添付ファイルがあるかどうかです。JSONの場合、添付ファイルは送られてきません。今回のようにメールに添付ファイルがついてくる場合は、後者を選択してください。
送信されてくるデータについて
メールを受信すると、以下のようなWebhookが送られてきます(データは一部マスキングしています)。JSONにしていますが、実際にはmultipart/form-data
です。
{ "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", "attachments": 1, "attachment1": "...." }
Google Cloud Functionsの準備
今回はローカルで開発する流れを紹介します。まずFunction.csというファイルを作成し、内容を以下のように記述します。
using Google.Cloud.Functions.Framework; using Microsoft.AspNetCore.Http; using System.Threading.Tasks; using System; namespace HelloWorld; public class Function : IHttpFunction { public async Task HandleAsync(HttpContext context) { // この中に処理を記述します await context.Response.WriteAsync("ok"); } }
次に、 HelloWorld.csproj
というファイルを作成し、以下のように記述します。
<Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <OutputType>Exe</OutputType> <TargetFramework>net6.0</TargetFramework> </PropertyGroup> <ItemGroup> <PackageReference Include="Google.Cloud.Functions.Hosting" Version="2.1.0" /> </ItemGroup> </Project>
これで準備は完了です。関数は以下のように実行します。
dotnet run
実行すると、 http://127.0.0.1:8080
でサーバーが立ち上がります。
.NETのコード
以下のコードは、上記関数 HandleAsync
の内容です。
マルチパートフォームデータを取得する
multipart/form-data
で送られてくるデータは context.Request.ReadFormAsync()
にて取得できます。これは Dict になっており、キーを指定してデータを取得できます。
var form = await context.Request.ReadFormAsync(); Console.WriteLine(form["filter"]);
添付ファイルの処理
添付ファイルの有無は form["attachments"]
が0以上かどうかで判別できます。
添付ファイルは form.Files
にてアクセスできます。1つ目の添付ファイルはインデックス0、2つ目はインデックス1になります。
var attachments = Int32.Parse(form["attachments"]); if (attachments > 0) { Console.WriteLine(form.Files[0].FileName); Console.WriteLine(form.Files[0].Length.ToString()); }
全体のコード
全体は以下のようなコードになります。
using Google.Cloud.Functions.Framework; using Microsoft.AspNetCore.Http; using System.Threading.Tasks; using System; using System.IO; namespace HelloWorld; public class Function : IHttpFunction { public async Task HandleAsync(HttpContext context) { var form = await context.Request.ReadFormAsync(); Console.WriteLine(form["filter"]); var attachments = Int32.Parse(form["attachments"]); if (attachments > 0) { Console.WriteLine(form.Files[0].FileName); Console.WriteLine(form.Files[0].Length.ToString()); } await context.Response.WriteAsync("ok"); } }
Webhookの結果は管理画面で確認
Webhookでデータが送信されたログは管理画面で確認できます。送信時のAPIキー設定など、HTTPヘッダーを編集するといった機能も用意されていますので、運用に応じて細かなカスタマイズが可能です。
まとめ
メールと連携したシステムはよくあります。通常、メールサーバを立てて、その中で処理することが多いのですが、メールサーバが落ちてしまうとシステムが稼働しなくなったり、メール文面の解析が煩雑でした。Customers Mail Cloudを使えばそうした手間なくJSONで処理できて便利です。
添付ファイルまで処理対象にしたい時には、この方法を利用してください。