Webhook APIを使って添付ファイル付きメールを処理する（PHP + Laravel編）

Customers Mail CloudのWebhookは2種類あります。

メール受信時
メール送信時

メール受信時のWebhookはその名の通り、メールを受け取った際に任意のURLをコールするものです。この記事では添付ファイル付きメールを受け取った際のWebhook処理について解説します。

<!—more—>

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

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

Laravelによる実装

今回はPHP + LaravelでWebhookを受け取った場合について解説します。

まず、コントローラーを作成します。

php artisan make:controller MailController

次にルーティングを routes/web.php に追加します。

Route::post('/mails', 'App\Http\Controllers\MailController@index');

このコントローラーではCSRFがあると動かなくなるので、 app/Http/Middleware/VerifyCsrfToken.php にて除外します。

class VerifyCsrfToken extends Middleware
{
    /**
     * The URIs that should be excluded from CSRF verification.
     *
     * @var array<int, string>
     */
    protected $except = [
        '/mails',
    ];
}

App\Http\Controllers\MailController.php での実装は次のようになります。 $request->all() で送信されてきたデータを受け取れます。なお、 application/json を外した場合には multipart/form-data で送られてきます。

添付ファイルは attachment1 や attachment2 というパラメータ名で受け取ります。この数は添付ファイルの数によって動的に変わります。そこで、 attachments を取得して、その数が0以上であれば添付ファイルがあると判定できます。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class MailController extends Controller
{
    public function index (Request $request)
    {
        $input = $request->all();
        $attachments = $input["attachments"];
        $from = $input["envelope-from"];
        $file = [];
        if ($attachments > 0) {
            for ($i = 1; $i <= $attachments; $i++) {
                $attachment = $request->file("attachment$i");
                $file[] = $attachment->getSize();
            }
        }
        return response()->json(['status' => 'ok', 'from' => $from, 'file' => $file]);
    }
}

ファイル名は getClientOriginalName メソッドで取得します。

$attachment->getClientOriginalName();

送信されてくるデータについて

メールを受信すると、以下のような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": "...."
}