Customers Mail Cloudではプログラム側からデータを取得したり、メールを送信するWeb APIの他に、Customers Mail Cloudでメールを受信した時にイベントを伝えてくれるWebhook APIが用意されています。
Webhook APIを使うことで、自前でメールサーバを立てずにメール受信のタイミングでシステムを起動させられるようになります。メールサーバを安定して動作させ続けるのはメンテナンスコストが大きいですが、Customers Mail Cloudを使うことで簡単にメールと連携したシステムが作れるようになるでしょう。
今回はRuby on Railsを使ってメールを処理する流れを紹介します。今回は添付ファイル付きメールを処理します。
フォーマットはJSONとマルチパートフォームデータ
Webhookの形式として、JSONとマルチパートフォームデータ（multipart/form-data）が選択できます。この二つの違いは、添付ファイルがあるかどうかです。JSONの場合、添付ファイルは送られてきません。メールに添付ファイルがついてくる可能性がある場合は、後者を選択してください。
今回は添付ファイル付きメールにおけるWebhook処理について紹介します。
サーバ側のコード
サーバ側のコードでは、まず受け取るコントローラ（今回はContactsController）のメソッドだけCSRFを解除します。
protect_from_forgery only: :webhook
そして config/routes.rb にルーティングを追加します。
Rails.application.routes.draw do
# 追加
post 'webhook', to: 'contacts#webhook', as: 'webhook'
end
app/controllers/contacts_controller.rb のwebhookメソッドではparamsでWebhookの内容を受け取れます。
def webhook
logger.debug("件名: #{params["subject"]}")
logger.debug("本文（テキスト）: #{params["text"]}")
logger.debug("本文（HTML）: #{params["html"]}")
logger.debug("FROM: #{params["envelope-from"]}")
logger.debug("TO: #{params["envelope-to"]}")
head :ok
end
この実行結果は次のようになります。
件名: Webhookのテスト 本文（テキスト）: Webhookのテスト用メールです。 本文（HTML）: <div dir="ltr">Webhookのテスト用メールです。<div><br clear="all"><div><div dir="ltr" class="gmail_signature">...</div> FROM: info@smtps.jp TO: user@smtps.jp
実際に受け取る内容は次のようになります。
{ "filter": "info@smtps.jp", "headers": [ : ], "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": 2, "attachment1": ..., "attachment2": ... }
添付ファイルの情報
添付ファイルの情報は次の2種類があります。attachment1やattachment2は添付ファイルの数に合わせて増減します。
- attachments : 添付ファイルの数
- attachment1 : 1つ目の添付ファイルに関する情報
- attachment2 : 2つ目の添付ファイルに関する情報
そこで、このattachmentsの内容に応じてファイルを書き出してみます。attachment は ActionDispatch::Http::UploadedFile クラスなので、通常のファイルアップロードと同じように処理できます。
def webhook
if params['attachments']
i = 1
while i <= params['attachments'].to_i do
# attachmentはActionDispatch::Http::UploadedFile
attachment = params["attachment#{i}"]
f = attachment.tempfile
# ファイル書き出し用
fp = open(Rails.root.join('tmp', 'files', attachment.original_filename), 'wb')
fp.write f.read
fp.close
i += 1
end
end
head :ok
end
Webhookの結果は管理画面で確認
Webhookでデータが送信されたログは管理画面で確認できます。送信時のAPIキー設定など、HTTPヘッダーを編集するといった機能も用意されていますので、運用に応じて細かなカスタマイズが可能です。
まとめ
メールと連携したシステムはよくあります。通常、メールサーバを立てて、その中で処理することが多いのですが、メールサーバが落ちてしまうとシステムが稼働しなくなったり、メール文面の解析が煩雑でした。Customers Mail Cloudを使えばそうした手間なくJSONで処理できて便利です。
