メール送信 on ララジャパン

DKIM署名を含むメールのユニットテスト

Tue, 06 Feb 2024 12:51:34 +0900

「LaravelでメールをDKIM署名」で作成したメールのDKIM署名が正しいかどうかを判断するには、Gmailアプリなら受信したメールの「メッセージのソースの表示」でDKIMがPASSあるいはFAILで判定が表示されるのでわかります。しかし、ユニットテストでそれと同様な判断するにはどうしたらよいのか、というのが今回のお話です。

メールのDKIM署名をチェックするツール

さきに話したようにGmailでは、以下のように「メッセージのソースの表示」でソースを見ると、DKIMの署名が正しいならPASSと出ます。

しかし、ユニットテストでDKIM署名のチェックするには、配信したメールをファイルに落としてそれをチェックできるコマンドが必要です。

運よくそのツールを見つけることができました。ツールは残念ながらphpではなくpythonで書かれたものですが、以下の実行でインストールできます。

$ pip install dkimpy

このコマンドを利用するとDKIM署名のチェックの実行はとても簡単です。先ほどのGmailからダウンロードしたファイルをtest.emlとしてチェックしてみましょう。

$ dkimverify < test.eml
signature ok

署名OKです！

テストしたメールの送り元（From）はhello@lotsofbytes.comで、lotsofbytes.comのドメインには前回説明したようにAmazonのRoute53のDNSサーバーにTXTに公開鍵のエントリーが登録されています。このツールはそれを取得してメールのDKIM署名が正しいかどうかチェックしてくれます。

配信するメールをファイルに落とす

DKIM署名の正負を判断してくれるコマンドを見つけたところで、こんどはそのコマンドにフィードするためのメールデータが必要です。メールを作成するのは前回に開発したDKIM署名処理を行うMailableなので、それで生成されたメールのデータをファイルに落とす必要あります。しかし、Mailableから直接出力できるメソッドがあれば良いのですが、Mailableを使用するメーラー（smtpとかの）との関わりのため、そのようなメソッドはMailableには存在しません。

そこで考えるのは、メーラーをログとして、つまり.envでMAIL_MAILER=logと設定してファイルに落とすことです。しかし、ファイルはデフォルトではlaravel.logとなるし、出力はログなので記録時の日時の余計な文字列が含まれ、加工が必要となります。

ちなみに、ユニットテストの設定のXMLファイルでは、以下のようにメーラーは配列に落とすのがデフォルトとなっています。

phpunit.xml

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
         bootstrap="vendor/autoload.php"
         colors="true"
>
...
    <php>
...
        <env name="MAIL_MAILER" value="array"/>
...
    </php>
</phpunit>

ということは、メールの送信のテストがあれば、メモリにその内容が入ることになります。つまり、メール配信後にメモリから送信した内容を取得すればよいのです。

これは意外に簡単で、通常のメール送のコードにtoString()の文字列化のメソッドを追加するだけです。以下、tinkerで見てみましょう。

まず、ユニットテストのようにメーラーを配列とします。

> config(['mail.default' => 'array']);
= null

宛先を変数として、

> use App\Mail\Newsletter;
> $email = 'test@example.com';
= "test@example.com"

NewsletterのMailableを初期化してMailのファサードで送信すると、

>  Mail::to($email)->send(new Newsletter($email))->toString();

DKIM署名のメールのデータが返ってきます。

= """
  From: Mailable Test <hello@lotsofbytes.com>\r\n
  To: test@example.com\r\n
  Subject: =?utf-8?Q?=E3=83=A1=E3=83=AB=E3=83=9E=E3=82=AC?=\r\n
   =?utf-8?Q?=E3=81=AE=E9=85=8D=E4=BF=A1=E3=81=A7=E3=81=99?=\r\n
  MIME-Version: 1.0\r\n
  Date: Sun, 04 Feb 2024 21:58:58 +0000\r\n
  Message-ID: <bfe853f9bd87f57ab1f02e48f3465bd9@lotsofbytes.com>\r\n
  DKIM-Signature: v=1; q=dns/txt; a=rsa-sha256;\r\n
   bh=Ueb0qJ5i58RAOT361r7NWPIoj8dj5uSTjaEHFZSj/p8=; d=lotsofbytes.com; h=From:\r\n
   To: Subject: MIME-Version: Date: Message-ID; i=@lotsofbytes.com; s=default;\r\n
   t=1707083938; c=relaxed/relaxed;\r\n
   b=EiklbRI4G7Q8VpIM4LAXfyCJKJveXZQMdRza/Q1g/XyAG0wEp5HfXa33RnylIB27C1gozstjp\r\n
   InPV6cqTrWI1SF0xQaBjknHqVIR+eh/Eh+zEidYgmP4Ocs2QC/6iAtx1UpCvgIk4AnvgM/y3q\r\n
   RW+3DkVmIu79nGSRzBtwG3BlG5iA1Eo4NGZt//k70Qi8Ngkl33ce0VeyYZ5EzHVokupnzJiB3\r\n
   yZeWtUEBERog12/kKeLYSLLN8nvGRY1mByWLwPuWF3zYVX3Luji9nMmYRqNKCWZbhe+SFTxwJ\r\n
   yWLYYgYXqZDkw0pdgI2g62Xb9xfsySAIIbcphrceDUM1E82w5A==\r\n
  List-Unsubscribe: <http://localhost/unsubscribe?token=eyJpdiI6IjRhRGNvdnJHWEdFd1pRWmZhNmhBbFE9PSIsInZhbHVlIjoiSit0WmxBWE5JSTdvK3FCNjFJempDUWY3SmVEWFo0NXZhTjRDc215cmxUUT0iLCJtYWMiOiJhNmJkNmQyMmVlMzI3YjJmZDdkMGMyMGRiNjhhYjhiNTgyOTEyZGFjYTFhNzkzZWIxOTQ5MzU1MTlhZDJkMjYzIiwidGFnIjoiIn0%3D>\r\n
  List-Unsubscribe-Post: List-Unsubscribe=One-Click\r\n
  Content-Type: text/html; charset=utf-8\r\n
  Content-Transfer-Encoding: quoted-printable\r\n
  \r\n
  <html>\r\n
      <body>\r\n
          <h1>=E3=83=A1=E3=83=AB=E3=83=9E=E3=82=AC=E3=81=AE=E9=85=8D=E4=BF=\r\n
  =A1=E3=81=A7=E3=81=99</h1>\r\n
          <p>=E3=81=84=E3=81=A4=E3=82=82=E3=83=A1=E3=83=AB=E3=83=9E=E3=82=\r\n
  =AC=E3=82=92=E8=B3=BC=E8=AA=AD=E3=81=97=E3=81=A6=E9=A0=82=E3=81=84=E3=81=\r\n
  =A6=E3=81=82=E3=82=8A=E3=81=8C=E3=81=A8=E3=81=86=E3=81=94=E3=81=96=E3=81=\r\n
  =84=E3=81=BE=E3=81=99=E3=80=82</p>\r\n
      </body>\r\n
  </html>\r\n
  """

>

この文字列をファイルに保存して、dkimverifyのコマンドにフィードすればユニットテストの作成が可能ですね。

ユニットテストを作成

以下、Dkim署名のユニットテストを作成してみました。

tests/Unit/NewsletterTest

namespace Tests\Unit;

use Tests\TestCase;
use App\Mail\Newsletter;
use Illuminate\Support\Facades\Mail;

class NewsletterTest extends TestCase
{
    protected $exportFileName, $emlPath;

    protected function setUp(): void
    {
        parent::setUp();

        // テスト用のファイル名を設定
        $this->exportFileName = 'NewsletterTest.eml';
        $this->emlPath = storage_path('app/'.$this->exportFileName);

        // テスト用のファイルが存在する場合は削除
        @unlink($this->emlPath);
    }

    /**
     * @test
     *
     * @covers App\Mail\NewsletterMessage
     */
    public function buildWithDkim(): void
    {
        $email = 'test@example.com';

        $mailable = new Newsletter($email);

        // メール送信して文字列化
        $data = Mail::to($email)->send($mailable)->toString();

        // メールをファイルに保存
        file_put_contents($this->emlPath, $data);

        //DKIM情報チェック
        $output = shell_exec('/usr/local/bin/dkimverify < '.$this->emlPath);
        $this->assertEquals("signature ok\n", $output);
    }
}

テストを実行してみましょう。

$ php artisan test --filter NewsletterTest

   PASS  Tests\Unit\NewsletterTest
  ✓ build with dkim                                                                                                                                                                                       0.33s

  Tests:    1 passed (1 assertions)
  Duration: 0.37s

問題なくパスです。

メールをログに出力する

Wed, 24 Jan 2024 07:40:40 +0900

ローカル環境におけるメール送信部分を確認する際に以前の記事でMailtrapやMailhogを活用した方法を紹介していますが、もっと原始的且つ手っ取り早い方法としてLogに出力して確認するというオプションもあります。今回はそちらの方法をご紹介致します。

メールをログに出力する

メールをログに出力するにはメーラーにlogを指定するだけです。特定の場面においてlog出力に切り替えたいなら以下のようにmailer()を使って指定できます。過去の記事で紹介されたraw()を使えばMailableクラスを作成せずに簡単にテスト用のメールが送信できますよ。

Mail::mailer('log')->raw('This ia a test mail.', fn($m) => $m->subject('Test mail')->to('test@example.com'));

するとデフォルトの設定では、storage/logs/laravel.logに出力されるはずです。

storage/logs/laravel.log

[2024-01-21 02:23:12] local.DEBUG: From: Example <hello@example.com>
Subject: Test mail
To: test@example.com
MIME-Version: 1.0
Date: Sun, 21 Jan 2024 02:23:12 +0000
Message-ID: <2c6e264f57ffa38f94b5bee86bdb1493@example.com>
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable

This ia a test mail.

デフォルトのメーラーをlogに切り替えたい場合は.envのMAIL_MAILERにlogを指定すればOKです。

.env

...
#MAIL_MAILER=smtp    // デフォルトではsmtpが設定されていますね
MAIL_MAILER=log
...

そうすれば、mailer()で指定せずともlogメーラーが採用されます。

Mail::raw('This ia a test mail.', fn($m) => $m->subject('Test mail')->to('test@example.com'));

設定を理解する

何がどうしてlaravel.logに出力されたのか解説します。まず、MAIL_MAILERにlogを指定した場合、config/mail.phpにて以下の設定が使用されます。

config/mail.php

...
'mailers' => [
...
        'log' => [
            'transport' => 'log',
            'channel' => env('MAIL_LOG_CHANNEL'),
        ],
...

出力先のログチャンネルを.envのMAIL_LOG_CHANNELから取得していますね。しかし、先ほどの実行時にはMAIL_LOG_CHANNELを定義していません。故にこちらの値はnullとなります。チャンネルの指定が無い場合、ログ出力においてはdefaultのチャンネルが採用されます。config/logging.phpを見てみましょう。

config/logging.php

...
'default' => env('LOG_CHANNEL', 'stack'),    // ←①
...
    'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['single'],    // ←②
            'ignore_exceptions' => false,
        ],

        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),    // ←③
            'level' => env('LOG_LEVEL', 'debug'),
            'replace_placeholders' => true,
        ],
...

①defaultのチャンネルはstackです。②stackチャンネルではstackドライバが指定されており、ログの出力先を複数指定したい場合にそれらをバインドして指定できます。デフォルトの設定ではsingleチャンネルのみが指定されていました。そして、③このsingleチャンネルの出力先がlaravel.logと言うわけです。文章にするとやや複雑に感じますが、実際にconfigを辿るとそれほどでもありません。

出力先ログチャンネルを変更する

logメーラーを使用した際の出力先ログチャンネルを変更したい場合は、.envにおいてMAIL_LOG_CHANNELを指定すればOKです。試しにmail_debugログチャンネルを新たに作成し、そちらに出力してみましょう。まずは、config/logging.phpにおいて、channelsにmail_debugチャンネルを追加します。

config/logging.php

...
    'channels' => [
...
        'mail_debug' => [
            'driver'    => 'single',
            'path' => storage_path('logs/mail_debug.log'),
            'level' => env('LOG_LEVEL', 'debug'),
        ],
...

出力先のログファイルは、storage/logs/mail_debug.logとしました。次に、.envにおいてMAIL_LOG_CHANNELを指定します。

.env

...
MAIL_LOG_CHANNEL=mail_debug
...

設定はこれだけです。メールを送信してmail_debug.logに出力されるか確認してみましょう。

Mail::raw('mail_log.logに出力されるはず。', fn($m) => $m->subject('Test mail')->to('test@example.com'));

mail_debug.logを確認すると意図通りにログが出力されているのが確認できるかと思います。

storage/logs/mail_debug.log

[2024-01-21 02:55:47] local.DEBUG: From: Example <hello@example.com>
Subject: Test mail
To: test@example.com
MIME-Version: 1.0
Date: Sun, 21 Jan 2024 02:55:47 +0000
Message-ID: <bbe1cccad557301198e97d3badb384f0@example.com>
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable

mail_log.logに出力されるはず。

nullチャンネルの活用

ここからは少し応用編です。config/logging.phpの設定にnullと言うチャンネルがあります。

config/logging.php

...
        'null' => [
            'driver' => 'monolog',
            'handler' => NullHandler::class,
        ],
...

これはログはどこにも出力せず破棄する設定です。以前から一体何に使うのだろう？と疑問でしたが先日、logメーラーと組み合わせる事で大量メールを送信する際のメール生成部分のパフォーマンステストに活用できる事が分かり、実際に以前の記事でkhino氏が紹介したDKIM署名のテストにおいてこれを活用しました。DKIM署名の記事はこちらです。

DKIM署名はMailableクラスのbuild()内で行うので、DKIM署名を行う場合と行わない場合でどのようにパフォーマンスが変わるのかを実際のメルマガと同じ送信件数でテストする必要がありました。ここでテストしたかったのはDKIM署名によりメール生成部分がボトルネックにならないか、のチェックであり送信部分ではありません。故に実際にメールを送信する必要は無く、生成したメールはlogメーラーでnullチャンネルに吐き出して破棄する方法を試みました。nullチャンネルを指定するには.envのMAIL_LOG_CHANNELにnullを指定するのですが、ここでも１つ工夫が必要でした。

.env

...
MAIL_LOG_CHANNEL=null
...

このように.envに指定した場合、nullは文字列ではなくnull型として扱われてしまうのです。故に、出力先のチャンネルが未指定となりdefaultチャンネルが採用されlaravel.logに送信したメールが出力されてしまいます。そこで、config/logging.phpにてnullチャンネルをコピーしたsilentチャンネルを追加し、そちらを.envで指定するようにしました。

config/logging

...
        'silent' => [
            'driver' => 'monolog',
            'handler' => NullHandler::class,
        ],
...

.env

...
MAIL_LOG_CHANNEL=silent
...

今度は意図通り、送信したメールはどこにも出力されず破棄されました。かなりニッチな活用法ですが、覚えておくと他にも色々と応用が効くかもしれません。

LaravelでメールをDKIM署名

Wed, 03 Jan 2024 02:38:56 +0900

Googleのメルマガ配信に対する要求は、前回の「メルマガをワンクリックで登録解除」だけでなく、配信するすべてのメールは、「ドメインに SPF および DKIM メール認証を設定します。」とあります。SPFはDNSでの設定のみですが、DKIMメール認証のためには、それぞれの配信メールの内容を元にDKIM署名のヘッダーの追加が必要です。私のクライアントの環境では、postfix + opendkimとシステムレベルで対応としました。ところが、

そのパフォーマンスが非常に悪く配信時間が以前の何倍もかかるようになりました。パフォーマンスの悪さの原因がわからず悩んでいたところ、Laravelで（正確にはSymfonyで）、DKIM署名が可能なことを発見しました。試した結果、postfix + opendkimの半分以上の配信時間が可能となりました。

DKIM認証の仕組み

まず、DKIM認証の仕組みを簡単に説明します。DKIM認証のためには、配信側においてsshと同様に秘密キーと公開キーを作成します。公開キーはドメインのDNSにエントリーを作成して保存します。メール配信側（通常はMTA）は、送信メールのデータと秘密キーでDKIM署名を作成してメールのヘッダーに、DKIM-Signatureの値として追加します。メール送信先のMTAでは、このメールを受け取ると配信者のDNSから先の公開鍵を取得して、メールに含まれるDKIM署名の正当性を検証します。

以下、DKIM認証されたメールのソースです。Dkim-Signatureヘッダーとしてあり、受け取り側のgoogle.comでDKIMの認証がOK（dkim=pass）なことが伺えます。

DKIMのキーを作成

DKIM認証の対象となるドメイン（上の例では、lotsofbytes.com）のために、秘密キーと公開キーを以下のコマンド実行で作成します。

$ openssl genrsa -out dkim_private.key 2048
Generating RSA private key, 2048 bit long modulus
............................+++
......................................+++
e is 65537 (0x10001)

次に、それをもとに公開キーを作成します。

$ openssl rsa -in dkim_private.key -pubout -outform der 2>/dev/null | openssl base64 -A
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2Em6C71Rcvf9qsRJciVRjuqcJQRzMeNRMK7Kizz2jfPxnx7XBu7hg2lJ3AvJj86pXJE2DASR0LmXMUfwOyXQ5dCJrBdfYK31ZCuBfVN1Vz/9utupyq1zPfAoteB8biR+mvc5MinrY2kj6LDBbuYU3Ff930AOVig/5ExAKfrSvt9gqrSSbZn36L/MnigcJWmB61mbCDXEPxTsZ8C+X7OsplpSdmHM3VpL9Dzo6FPyFwNnKMcGMBpgnTGo8PfN7H+Fh5n7QTv42f6BLEiWd47JoBU5yRnRqjVCFenTI1Gu/8RlwaWUJBZ7+eDeJmaPONb6WFjRlVD8ScU0qzEpKi71mQIDAQAB

これをDNSに以下のように、TXTレコードとして追加します。公開キーは長いので１つの文字列で収めることができません。キーの適当な場所で引用符を使って２つの文字列にする必要があります。以下は、AWSでのRoute53でのDNSエントリーの例です。

アプリでDKIM署名

DKIMの署名の機能はLaravelには存在しないので、Laravelが使用しているSymfony MailerのDKIM署名を使います。

「メルマガをワンクリックで解除」で使用したMailableのコードを編集しました。以下では差分を掲載しています。

app/Mail/Newsletter.php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Symfony\Component\Mime\Email;
use Illuminate\Mail\Mailables\Content;
use Illuminate\Mail\Mailables\Headers;
use Illuminate\Queue\SerializesModels;
use Illuminate\Mail\Mailables\Envelope;
use Symfony\Component\Mime\Crypto\DkimSigner;

class Newsletter extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * @var DkimSigner
     */
    public static $signer;

    /**
     * Create a new message instance.
     */
    public function __construct(public string $email)
    {
        $this->email = $email;

        if (! self::$signer) {
            // 署名者のインスタンスを作成
            self::$signer = new DkimSigner(
                'file://'.storage_path('dkim_private.key'), // 秘密キーのパス
                config('mail.dkim.domain'), // DKIM対象のドメイン名
                'default' // DNSのセレクター
            );
        }
    }

    /**
     * Build the message.
     */
    public function build(): static
    {
        $html = view('newsletter')->render();

        // 以下で、メールにDKIM署名
        $this->withSymfonyMessage(function (Email $symfonyMessage) use($html) {
            $symfonyMessage->html($html); // symfonyのコンポーネントにデータを入れる
            $signedEmail = self::$signer->sign($symfonyMessage); // 署名
            $symfonyMessage->setHeaders($signedEmail->getHeaders()); // ヘッダーに追加
        });

        return $this;
    }

...
}

コードの変更箇所は、２つあります。

まずコンストラクターにおいて署名者のインスタンスを作成して、これをクラス変数として$signerに収めます。ここで必要な情報は、

秘密キーのパス：これは先に作成したdkim_private.keyをstorageのディレクトリに置いておくことが必要。Laravelのプロジェクトの.gitignoreには、/storage/*.keyの行が含まれるので、バージョン管理からは除外となります。
DKIMの対象となるドメイン名：ここでは以下のように、congig/mail.phpに項目を追加しておき、.envにて、MAIL_DKIM_DOMAIN=で値を渡します。ちなみに、ここでドメインは、メールの差出人Fromで使われるドメイン（例えば、hello@lotsofbytes.comnならlotsofbytes.com）となります。
config/mail.php
```php return [ ... 'dkim' => [ 'domain' => env('MAIL_DKIM_DOMAIN'), ] ];
公開キーのレコード名のセレクター名：ここでは先にDNSに登録した名前の、default._domainkey.lotsofbytes.comのdefaultを指定。

次に、build()のメソッドを追加します。これは、Laravel 9x以前にEnvelopeやContentなどのコンポートがないときにメールを構築するために使われていたメソッドです。しかし、ここにおいてSymfony MailのモジュールにアクセスしてDKIM署名を実行する機能のために使います。ここで大事なのは、SymfonyのDKIM署名を使用するために、Symfonyのメールのインスタンス（Symfony\Component\Mime\Email）においてメールの内容となるデータを先に注入することです。もちろん、後にLaravel側でも同様な作業が行われますが、それはメール配信時の作業で、この時点ではDKIM署名のために必要なメールの内容がありません。それゆえにです。

最後に

postfix+opendkimのDKIM署名のパフォーマンスが悪かったために、このような一時対応となりましたが、これが複数のMailableで必要となると管理は先のシステムレベルで行えることに越したことはありません（改善方法を知っているお客様がいれば是非ご連絡を！）。しかし、レンタルサーバーでpostfixなどの管理権限がないときは、今回の方法が役に立つと思います。

メルマガをワンクリックで登録解除

Thu, 23 Nov 2023 12:10:48 +0900

Gmailは 2024 年 2 月以降、Gmail アカウントに 1 日あたり 5,000 件以上のメールを送信する送信者に対していくつかの義務付けを発表しました。その１つに、「受信者がメールの配信登録を容易に解除できるようにすること」とあります。毎日何十万というメルマガを送信する私のクライアントではメルマガの受信者の大半がGmailのメールアドレスを使用しています。メルマガはLaravelのプログラムから送信されます。対応しないと迷惑メールになりますよというGoogleの警告は恐ろしいですが、Laravelなら簡単に対応できます。

※11/25：以下においてCSRFトークンに関して書き忘れがあったの追加しています。

メールの配信登録を容易に解除できるとは？

Googleが発表したメール送信のガイドラインは以下で詳細が閲覧できます。 https://support.google.com/mail/answer/81126?sjid=16148365418482843036-NC

サーバーでのSPFとDKIMの両方の対応はサーバーのシステムでの設定ですが、アプリ側では以下の要求があります。

そこで言及されているワンクリックとは、PCのブラウザで開いたウェブのGmailで、以下のように、受信メールの送信元の隣に表示される登録解除のリンクのことです。

これをクリックすると以下のようなポップアップの画面が表示され「登録解除」のボタンを押すと、送信者のサイトに遷移することなくメルマガの登録解除が実行されます。

これがどうして可能なのかなのですが、受信したメールのソースコードを見ると、

先のガイドラインで指示したように、List-UnsubscribeとList-Unsubscribe-Postのヘッダーが含まれているからです。

つまりそれらのヘッダーを含むメールを送信すれば、対応できるわけです。

ワンクリックのリンクを含むMailableを作成

もう１度、Googleが勧める追加すべきヘッダーを見てみましょう。

    List-Unsubscribe-Post: List-Unsubscribe=One-Click
    List-Unsubscribe: <https://solarmora.com/unsubscribe/example>

最初の方は固定のヘッダーですが、後者の方はリンクは購読解除のプログラムの作成が必要とされます。

まず、このヘッダーを含むMailableを作成します。以下のコードでは、送信先のメールアドレスを暗号化して、List-Unsubscribeの登録解除のURLでtokenの引数とします。実際には、暗号化にはメールアドレスだけでなく発行した日時やどのキャンペーンのメルマガかなどの他の情報と合わせて入れる必要があるかもしれません。

app/Mail/Newsletter.php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Mail\Mailables\Content;
use Illuminate\Mail\Mailables\Headers;
use Illuminate\Queue\SerializesModels;
use Illuminate\Mail\Mailables\Envelope;

class Newsletter extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     */
    public function __construct(public string $email)
    {
        $this->email = $email;
    }

    /**
     * Get the message headers.
     */
    public function headers(): Headers
    {
        // 送信先のメールアドレスを暗号化する
        $url = route('unsubscribe.store',['token' => encrypt($this->email)]);

        return new Headers(
            text: [
                'List-Unsubscribe' => '<'.$url.'>',
                'List-Unsubscribe-Post' =>'List-Unsubscribe=One-Click',
            ],
        );
    }

    /**
     * Get the message envelope.
     */
    public function envelope(): Envelope
    {
        return new Envelope(
            subject: 'メルマガの配信です',
        );
    }

    /**
     * Get the message content definition.
     */
    public function content(): Content
    {
        return new Content(
            view: 'newsletter',
        );
    }
}

上のMailableで使用されるブレードは以下です。

resources/views/newsletter.blade.php

<html>
    <body>
        <h1>メルマガの配信です</h1>
        <p>いつもメルマガを購読して頂いてありがとうございます。</p>
    </body>
</html>

さてこれで、メルマガ登録解除のヘッダーを含むメールの送信が可能です。 tinkerを使い、メルマガを送信します。$emailの変数の値は自分のGmailのメールアドレスを使用してくださいね。

> use App\Mail\Newsletter;

> $email = 'test@example.com';
= "test@example.com"

> Mail::to($email)->send(new Newsletter($email));
= Illuminate\Mail\SentMessage {#7251}

さて、届いた部分をGmailで開くと、なんと「メールリスト登録解除」のリンクが表示されていません！

しかし、ソースコードを見ると、必要なヘッダーはしっかり含まれています。

これではテストできませんね。ネットで調査したところ、メール送信元のサイトの評価と関係しているとかで、評価が良くないと逆に使用されたメールアドレスが正しいということでスパムをたくさん送信されるとかの理由らしいです。つまり開発環境などから送信したメールは評価がないので、リンクは表示されないのです。評価が良い私のクライアントからのメルマガでは、受信したメールに登録解除のリンクは表示されていました。

しかしながら、どうテストしたらよいものか。

登録解除のPOSTを受け取るコントローラ

とりあえず、登録解除のPOSTを受け取るコントローラが必要です。以下に作成してみました。

app/Http/Controllers/UnsubscribeController.php

namespace App\Http\Controllers;

use App\Models\User;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log;

class UnsubscribeController extends Controller
{
    /**
     * Store a newly created resource in storage.
     */
    public function store(Request $request)
    {
        $email = decrypt($request->token); //非暗号化してメールアドレスを取り出す

        // 実際はメールアドレスを将来メルマガに使用しないようなDB処理が必要なところ
        // ログファイルにメールアドレスを保存
        Log::debug('email: '.$email);
    }
}

POSTを受け取るのでこのデモではstore()だけにしています。

それを使うルートの方は、こんな感じ。

routes/web.php

use App\Http\Controllers\UnsubscribeController;
use Illuminate\Support\Facades\Route;

Route::get('/', function () {
    return view('welcome');
});

Route::resource('unsubscribe', UnsubscribeController::class)->only('store');

さらに、通常のCSRFトークンは意味がないので、以下で例外とします。

app/Http/Middleware/VerifyCsrfToken.php

namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;

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

さて、届いたメールに登録解除のリンクがなくて、どうこのPOSTを確認するかですが、これもtinkerで可能です。ローカル環境でまずウェブサーバーを立ち上げます。

$ php artisan serve
   INFO  Server running on [http://127.0.0.1:8000].

tinkerで、以下のようにLaravelのHttp Clientを使用してPOSTを実行します。$tokenの値はさきほどのメールのソースコードから持ってきます。

> $token='eyJpdiI6IkxaaWhEeW5OSnl4OTZYWkJCMG5ZaEE9PSIsInZhbHVlIjoib2VCNFhBaWZCak1PUGZsN3Q2RFphTEZZc25TN2UwT29wOXZyMitrd0pPST0iLCJtYWMiOiJmODY4YjZmOGU1NzYxODg3NDJjZmRmM2JmMTA3YTdiMDQzNzQ4YTY1NTJmZmI0ZjZmZmIxMGY5NDNhMzExYTY5IiwidGFnIjoiIn0%3D';
> Http::post('http://127.0.0.1:8000/unsubscribe?token='.$token)->body();
= ""

実行後にlaravel.logの中身を見ると、

[2023-11-23 01:39:06] local.DEBUG: email: test@example.com

しっかり、非暗号化してメールアドレスを取り出すことができました。

最後に

ワンクリックのメルマガ登録解除の簡単な対応を紹介しましたが、注意が必要なのは今回はPCのブラウザでGmailを開いたときの対応だけだということです。他のOutlookなどのメールクライアントには関係のないことです。また、スマホのGmailのアプリでも解除のリンクは表示されません。それゆえに、メールの内容にもメールの登録解除のリンクを入れて対応することが必要です。

Laravel × MJMLでレスポンシブメールを送信

Wed, 04 Oct 2023 00:06:23 +0900

HTMLでデザインされたメールは読みやすく、視覚的に訴求しやすいというメリットがあります。ですが、多様なメーラーに対応するため通常のwebページとは異なるコーディングが必要であり、レスポンシブも考慮すると１通のメールを作成するのも大変です。

そこで、簡単にレスポンシブなHTMLメールが作成できるMJMLというツールをLaravel10.xのプロジェクトで試してみました。

MJMLをプロジェクトにインストール

ベースとなるメールクラスは前回作成したものを使用し、MJMLを使えるよう修正を加えてゆきます。

Laravel用にパッケージが用意されていますので、まずはこちらをインストールします。

$ composer require asahasrabuddhe/laravel-mjml

次に、フロントエンド用のライブラリをインストールします。

npm install --save mjml

ここまででインストールは完了です。

ビューファイル作成

次に、メールの本文となるビューファイルを作成します。

MJMLではmj-bodyやmj-columnなどの独自タグを使って画面を組み立てます。テンプレートやドキュメントにたくさん使用例が載っていますので、ご参照ください。オンラインエディタではリアルタイムに表示を確認できるので便利です。

今回はシンプルに、ナビゲーションとカラムだけのメールを作成しました。先にPCビューの完成形をお見せします。

このHTMLメールをMJMLで記述したものが、以下となります。

resources/views/emails/mjml.blade.php

<mjml>
  <mj-head>
    <mj-attributes>
      <mj-all font-family="Ubuntu, Helvetica, Arial, sans-serif" />
      <mj-class name="nav-item" font-size="14px" color="#fff" />
      <mj-class name="column" font-size="16px" color="#333" align="center" padding="25px" font-weight="bold" />
    </mj-attributes>
  </mj-head>
  <mj-body background-color="#FFC3BA">
    <!-- header navigation -->
    <mj-section background-color="#ef6451">
      <mj-column>
        <mj-navbar base-url="https://example.com" hamburger="hamburger" ico-color="#ffffff">
          <mj-navbar-link mj-class="nav-item" href="/page1">メニュー１</mj-navbar-link>
          <mj-navbar-link mj-class="nav-item" href="/page2">メニュー２</mj-navbar-link>
          <mj-navbar-link mj-class="nav-item" href="/page3">メニュー３</mj-navbar-link>
          <mj-navbar-link mj-class="nav-item" href="/page4">メニュー４</mj-navbar-link>
        </mj-navbar>
      </mj-column>
    </mj-section>
    <!-- ３column section -->
    <mj-section background-color="#FAD74D" padding-bottom="15px">
      <mj-column>
        <mj-text mj-class="column">カラムA</mj-text>
      </mj-column>
      <mj-column>
        <mj-text mj-class="column">カラムB</mj-text>
      </mj-column>
      <mj-column>
        <mj-text mj-class="column">カラムC</mj-text>
      </mj-column>
    </mj-section>
  </mj-body>
</mjml>

大きく、mj-headとmj-bodyで構成されています。

背景色や文字色など、個別に指定したいCSSはインラインでの記述が可能です。ですが、全てのCSSをインラインで書くとコードが読みにくくなったり修正が大変になりますので、繰り返しになるものは mj-head > mj-attributes 内でまとめて指定しました。

その際２つのタグを使用しています。mj-allは、全体のフォントと文字色の指定に。またmj-classでは、クラスとCSSの定義をしています。これはメニューリストのような複数あるアイテムに便利です。

mj-classの記述を上のコードから抜粋すると、mj-head内ではnav-itemクラスを以下のように定義しています。

mj-head内

      <mj-class name="nav-item" font-size="14px"/>

そしてこのnav-itemをbody内で使用するには、適用させたいタグにmj-classを指定すればOKです。以下のようになります。

mj-body内

      <mj-navbar-link mj-class="nav-item" href="/page1">メニュー1</mj-navbar-link>

また本文の要素は、セクションごとに mj-section（セクション） > mj-column（列） > 中身の要素　という形に配置してゆきます。mj-columnの中は、メニューボタンにはmj-navbar、テキストにはmj-text、のように要素に応じたタグが用意されているのでこれらを使って画面を構成します。

レスポンシブなメールを送信

最後に、Mailableの修正です。修正箇所は２つで、１つはuseするMailableを今回インストールしたパッケージのクラスへ変更。２つめは、contentの記述です。

以下は、修正前のコードです。

app/Mail/TestMail.php

...
use Illuminate\Mail\Mailable;
...
    public function content(): Content
    {
        return new Content(
            view: 'view.name',
        );
     }
...

修正後は、以下のようになります。mjml・buildMjmlViewといった新しいメソッドが使えるようになるのでそちらを使用します。

...
use Asahasrabuddhe\LaravelMJML\Mail\Mailable;
...
    public function content(): Content
    {
        return new Content(
            view: $this->mjml('emails.mjml')->buildMjmlView()['html'],
        );
     }
...

この記述だけで、先ほどのMJMLタグがHTMLに変換されます。早速Tinkerでメールを送信してみましょう。

$ php artisan tinker
Psy Shell v0.11.20 (PHP 8.1.17 — cli) by Justin Hileman
> use App\Mail\TestMail;
> Mail::to('mjml-test@example.com')->send(new TestMail);
= Illuminate\Mail\SentMessage {#6325}

PCビューは先ほどと同じなので省略です。モバイル表示では、どうでしょうか。

PCビューでは横並びだったナビゲーションはハンバーガーメニューに、３カラムは縦並びに変わりました。ちゃんと画面サイズに最適化された表示になっていますね。

ソースを見てみると、以下のようなHTMLに変換されています。全体はもっと長いので、MJMLを使うことでコードをだいぶ簡略化できることがわかります。

Laravelの新しいMailableでHTMLメールを送信

Mon, 25 Sep 2023 23:38:49 +0900

当サイトでも以前ご紹介しているLaravelのMailableですが、Laravel9.xから新しくなったようです。今までの書き方と何が違うのか？試してみました。使用バージョンはLaravel10.19になります。

以前のMailableの記事はこちら

HTMLメールを送信

まずは、新しいMailableクラスを作成します。以下のコマンドでTestMail.phpというファイルが作成されます。

$ php artisan make:mail TestMail

作成されたファイルを見てみると、旧Mailableにはあったbuildが無くなっています。代わりにenvelope、content、attachmentsというメソッドが用意されていますね。

app/Mail/TestMail.php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Mail\Mailables\Content;
use Illuminate\Mail\Mailables\Envelope;
use Illuminate\Queue\SerializesModels;

class TestMail extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     */
    public function __construct()
    {
        //
    }

    /**
     * Get the message envelope.
     */
    public function envelope(): Envelope
    {
        return new Envelope(
            subject: 'Test Mail',
        );
    }

    /**
     * Get the message content definition.
     */
    public function content(): Content
    {
        return new Content(
            view: 'view.name',
        );
    }

    /**
     * Get the attachments for the message.
     *
     * @return array<int, \Illuminate\Mail\Mailables\Attachment>
     */
    public function attachments(): array
    {
        return [];
    }
}

ここから、今回必要な箇所を編集してゆきます。

１つ目のenvelopeでは、件名・送信者・返信先に関する情報を設定できます。新しくAddressクラスが使えるようになっており、名前つきメールアドレスが作成できます。

Addressを使用する際は、クラスをuseしてくださいね。

use Illuminate\Mail\Mailables\Address;

    public function envelope(): Envelope
    {
        return new Envelope(
            subject: 'Test Mail',
            from: new Address('from@example.com', 'テスト送信者'),
        );
    }

次のcontentでは本文の設定を行います。今回はHTMLメールを送信するので、簡単なものですが以下のようなブレードを作成しました。

resources/views/emails/test.blade.php

<html>
  <body>
    <h1>新しいMailableです</h1>
  </body>
</html>

このブレードのパスを、contentに記述します。パスはresources/views以下の部分のみでOKです。

app/Mail/TestMail.php

    public function content(): Content
    {
        return new Content(
            html: 'emails.test',
        );
    }

最後のAttachmentは、添付ファイルについて定義します。

AttachmentのfromPathメソッドに、添付ファイルへのパスを渡します。あらかじめstorage/app/img内にtestmail.jpgという画像ファイルを用意したので、そちらを記述しました。

use Illuminate\Mail\Mailables\Attachment;

    public function attachments(): array
    {
        return [
            Attachment::fromPath(storage_path('app/img/testmail.jpg')),
        ];
    }

Attachmentを使用する場合も、useが必要ですのでお忘れなく。

これで設定は完了です！さっそくtinkerでメールを送信します。

$ php artisan tinker
Psy Shell v0.11.20 (PHP 8.1.17 — cli) by Justin Hileman
> use App\Mail\TestMail;
> Mail::to('test@example.com')->send(new TestMail);
= Illuminate\Mail\SentMessage {#6331}

受信をメールを確認してみましょう。私のローカル環境では、Mailtrapに届くように設定しています。

件名、From、本文、いずれも設定した通りになっていますね。画像ファイルも添付されています。

今回は新しくなったMailableを試してみました。8.x系で使用していたbuildは新しいMailableでも引き続き使用可能ですが、設定項目がそれぞれの関数に分かれている新しいMailableの方が、より分かりやすくなったように感じます。

次回は、Mailableで簡単にレスポンシブなHTMLメールが作成できる、MJMLというライブラリをご紹介します。

DNSを使ってメールアドレスをチェック

Sun, 09 Jan 2022 01:43:32 +0900

「お客さんにメールが届かないのでどうかして？」というＣＳからの質問。見てみるとexample@yahoo.comであるところ、example@yahpo.comになっていたりします。たった１文字違いですが、会員登録してもこのためにメールが届かないばかりか、次回からは多分ログインもできません。もちろんお客さんの間違いですが、登録時にこれが通ってしまうというのは問題です。これをどうかしたいです。

緩いメールアドレスのバリデーション

Laravelのデフォルトのメールアドレスのバリデーションemailは、結構緩いです。どれだけ緩いが実例見てみましょう。以下は、tinkerを使って、test@gmailという不正なメールアドレスチェックします。

>>> $v = validator(['email' => 'test@gmail'], ['email' => 'required|email'])
=> Illuminate\Validation\Validator {#3534
     +customMessages: [],
     +fallbackMessages: [],
     +customAttributes: [],
     +customValues: [],
     +excludeUnvalidatedArrayKeys: null,
     +extensions: [],
     +replacers: [],
   }
>>> $v->passes()
=> true

あっさり、通ってしまいます。

また、example.comとかのドメイン名は実在しないのに、これも通ります。

>>> $v = validator(['email' => 'test@example.com'], ['email' => 'required|email'])
...
>>> $v->passes()
=> true

email:dnsの登場

メールアドレスの＠マークの後ろの部分、例えば、test@example.comなら、example.comの部分、はドメイン名と言ってインターネットでは非常に重要なデータなのですが、このドメインが実在するかどうか、そしてメールを受け取るかどうかがわかれば、少なくともメールアドレスのタイポは登録時に警告できますね。

それを利用したのが、email:dnsのバリデーションルールです。早速、tinkerで試してみましょう。

>>> $v = validator(['email' => 'test@gmail'], ['email' => 'required|email:dns'])
...
>>> $v->passes()
=> false

>>> $v = validator(['email' => 'test@example.com'], ['email' => 'required|email:dns'])
...
>>> $v->passes()
=> false

>>> $v = validator(['email' => 'test@yahpo.com'], ['email' => 'required|email:dns'])
...
>>> $v->passes()
=> false

素晴らしいです、みな通りません！

email:dnsの使用において注意が必要なのは、それを利用するには、以下の国際化関数、intlのライブラリが必要です。 https://www.php.net/manual/ja/book.intl.php

dns_get_record()

ちょっとemail:dnsの仕組みを探ってみましょう。Laravelのマニュアルによると、egulias/email-validatorのパッケージを使用しているそうな。そこから関心のコードの一部を掲載します。

https://github.com/egulias/EmailValidator/blob/3.x/src/Validation/DNSCheckValidation.php

...
class DNSCheckValidation implements EmailValidation
{
    /**
     * @var int
     */
    protected const DNS_RECORD_TYPES_TO_CHECK = DNS_MX + DNS_A + DNS_AAAA;

    /**
     * Reserved Top Level DNS Names (https://tools.ietf.org/html/rfc2606#section-2),
     * mDNS and private DNS Namespaces (https://tools.ietf.org/html/rfc6762#appendix-G)
     */
    const RESERVED_DNS_TOP_LEVEL_NAMES = [ //これらのドメイン名はみなエラーとなります
        // Reserved Top Level DNS Names
        'test',
        'example',
        'invalid',
        'localhost',

        // mDNS
        'local',

        // Private DNS Namespaces
        'intranet',
        'internal',
        'private',
        'corp',
        'home',
        'lan',
    ];
   ...

 private function validateDnsRecords($host) : bool
    {
        // A workaround to fix https://bugs.php.net/bug.php?id=73149
        /** @psalm-suppress InvalidArgument */
        set_error_handler(
            static function (int $errorLevel, string $errorMessage): ?bool {
                throw new \RuntimeException("Unable to get DNS record for the host: $errorMessage");
            }
        );

        try {
            // Get all MX, A and AAAA DNS records for host
            $dnsRecords = dns_get_record($host, static::DNS_RECORD_TYPES_TO_CHECK);
        } catch (\RuntimeException $exception) {
            $this->error = new InvalidEmail(new UnableToGetDNSRecord(), '');

            return false;
        } finally {
            restore_error_handler();
        }
...

上の４５行目見てください。dns_get_record()なるphp関数があったのですね。 https://www.php.net/manual/ja/function.dns-get-record.php

上の説明によると、こんなしてドメイン情報取得できるようです。

>>> dns_get_record("yahpo.com", DNS_MX);
=> [
     [
       "host" => "yahpo.com",
       "class" => "IN",
       "ttl" => 0,
       "type" => "MX",
       "pri" => 0,
       "target" => "",
     ],
   ]
>>> dns_get_record("yahoo.com", DNS_MX);
=> [
     [
       "host" => "yahoo.com",
       "class" => "IN",
       "ttl" => 0,
       "type" => "MX",
       "pri" => 1,
       "target" => "mta5.am0.yahoodns.net",
     ],
     [
       "host" => "yahoo.com",
       "class" => "IN",
       "ttl" => 0,
       "type" => "MX",
       "pri" => 1,
       "target" => "mta6.am0.yahoodns.net",
     ],
     [
       "host" => "yahoo.com",
       "class" => "IN",
       "ttl" => 0,
       "type" => "MX",
       "pri" => 1,
       "target" => "mta7.am0.yahoodns.net",
     ],
   ]

最初のタイポのドメイン名のtargetは存在しないけれど、正式なドメインは３つtargetを返しています。Laravelのemail:dnsはこれを利用しているのですね。

最後に

メールのバリデーションには、email:dnsの他にもrfcとかstrictとかspoofとかあります。 emailとemail:rfcは同じです。また、email:rfc,dnsとように合わせての使用も可能です。

あと大事なのは、バリデーションでは必ず弾かれてしまうが、test.@docomo.ne.jpのようにドットが不正な場所にあるにもかかわらず実在するメールアドレスの対応です。docomo.ne.jpやezweb.ne.jpではその不正を許す必要あります。まだ使っている人いるんですよ。

メールの送信（６）Notificationを使ってメールを送信

Sun, 07 Feb 2021 02:45:46 +0900

前回はMailableを使ってのメール送信の話でした。今回は、もう１つLaravelからメールを送信する方法としてNotificationの話です。

Notificationを使用してメールを送信

Mailableを使ってメールを送信するには、

use App\Mail\SomeMailableClass;

Mail::to("test@example.com")->send(new SomeMailableClass);

が典型的な送信の仕方です。

一方、今回紹介するNotificationは、Notifiableのトレイトを使ったモデルクラスにメールを送信する機能を与えます。

例えば、このようにUserのクラスにNotifiableを追加すると、

namespace App;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable implements MustVerifyEmail
{
    use Notifiable;
..
}

以下のように、Userのモデルのインスタンスのメソッドとして、notify()でメールを送信できます。

use App\User;
use App\Notifications\Hello;

$user = User::find(1);
$user->notify(new Hello);

上では、$userのオブジェクトの項目である、$user->emailが自動的にメール送信の宛先となります。

さて、送信するメールの内容の方は、Notificationのクラス（上ではHelloのクラス）の作成が必要です。

$ php artisan make:notification Hello

を実行して、作成されたファイルを以下のように編集します。

app/Notifications/Hello.php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;

class Hello extends Notification
{
    use Queueable;

    /**
     * Create a new notification instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return ['mail'];
    }

    /**
     * Get the mail representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Illuminate\Notifications\Messages\MailMessage
     */
    public function toMail($notifiable)
    {
        return (new MailMessage)
                    ->subject('こんにちは')
                    ->greeting('こんにちは！')
                    ->line('メールの内容')
                    ->action('ホームページへ', url('/'))
                    ->line('ありがとうございます');
    }

    /**
     * Get the array representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function toArray($notifiable)
    {
        return [
            //
        ];
    }
}

さてtinkerで送信してみます。

>>> $user = User::find(1);
[!] Aliasing 'User' to 'App\User' for this Tinker session.
=> App\User {#4072
     id: 1,
     name: "test",
     email: "test@example.com",
     email_verified_at: null,
     created_at: "2020-12-30 23:14:29",
     updated_at: "2020-12-30 23:14:29",
   }

>>> $user->notify(new App\Notifications\Hello);
=> null

MailTrapで送信したメールを見ると、

もうすでにHTMLのメールとなっています。

以下のように、文言はすべてMailMessageのクラスのメソッドで簡単に与えるだけOKです。上の例で、まだ英語として残っているRegards, Laravelの部分を変えたいなら、以下のように、salutationのメソッドに引数を渡します。

...
   public function toMail($notifiable)
    {
        return (new MailMessage)
                    ->subject('こんにちは')
                    ->greeting('こんにちは！')
                    ->line('メールの内容')
                    ->action('ホームページへ', url('/'))
                    ->line('ありがとうございます')
                    ->salutation('Larajapan');
    }
..

送信メールをカスタマイズ

もっとHTMLメールをカスタマイズしたいなら、以下を実行してデフォルトのブレードを自分のプロジェクトのディレクトリに出力します。

$ php artisan vendor:publish --tag=laravel-notifications
Copied Directory [/vendor/laravel/framework/src/Illuminate/Notifications/resources/views] To [/resources/views/vendor/notifications]
Publishing complete.

作成された、email.blade.phpは以下のようなマークダウンのブレードです。Laravelのコンポーネントとマークダウンのシンボルが混ざっていて少しわかりづらいですが、上で使用されたメソッド名がブレードでは変数名となっているのがわかります。line()に関してはボタンの表示を境に上と下で、$introLinesと$outroLinesに分かれます。

resources/views/vendor/notifications/email.blade.php

@component('mail::message')
{{-- Greeting --}}
@if (! empty($greeting))
# {{ $greeting }}
@else
@if ($level === 'error')
# @lang('Whoops!')
@else
# @lang('Hello!')
@endif
@endif

{{-- Intro Lines --}}
@foreach ($introLines as $line)
{{ $line }}

@endforeach

{{-- Action Button --}}
@isset($actionText)
<?php
    switch ($level) {
        case 'success':
        case 'error':
            $color = $level;
            break;
        default:
            $color = 'primary';
    }
?>
@component('mail::button', ['url' => $actionUrl, 'color' => $color])
{{ $actionText }}
@endcomponent
@endisset

{{-- Outro Lines --}}
@foreach ($outroLines as $line)
{{ $line }}

@endforeach

{{-- Salutation --}}
@if (! empty($salutation))
{{ $salutation }}
@else
@lang('Regards'),<br>
{{ config('app.name') }}
@endif

{{-- Subcopy --}}
@isset($actionText)
@slot('subcopy')
@lang(
    "If you’re having trouble clicking the \":actionText\" button, copy and paste the URL below\n".
    'into your web browser:',
    [
        'actionText' => $actionText,
    ]
) <span class="break-all">[{{ $displayableActionUrl }}]({{ $actionUrl }})</span>
@endslot
@endisset
@endcomponent

もちろん、前回のように独自のマークダウンのブレードを作成して利用することも可能です。その場合は以下のように、markdown()メソッドにブレード名を入れます。

app/Notifications/Hello.php

...
   /**
     * Get the mail representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Illuminate\Notifications\Messages\MailMessage
     */
    public function toMail($notifiable)
    {
        return (new MailMessage)
                    ->subject('こんにちは！マークダウン')
                    ->markdown('emails.hello-markdown');
    }
...

メールの送信（５）HTMLメールのフォントなどをカスタマイズ

Sat, 30 Jan 2021 08:04:00 +0900

HTMLメールをマークダウンで簡単に作成して送信できることができたので、今度はフォントや色などのカスタマイズを試みます。

前回のマークダウンメールでに使われているコンポーネントやCSSの定義は、Laravelのパッケージの奥深くに隠れています。カスタマイズのためにはそれを日の目に出してあげる必要があります。まず以下をコマンドラインで実行します。

$ php artisan vendor:publish --tag=laravel-mail

resources/views/vendor/mailのディレクトリに以下のようにファイル作成されます。

resources
└── views
    ├── emails
    │   ├── hello.blade.php
    │   └── hello-markdown.blade.php
    ├── vendor
    │   └── mail
    │       ├── html
    │       │   ├── button.blade.php
    │       │   ├── footer.blade.php
    │       │   ├── header.blade.php
    │       │   ├── layout.blade.php
    │       │   ├── message.blade.php
    │       │   ├── panel.blade.php
    │       │   ├── subcopy.blade.php
    │       │   ├── table.blade.php
    │       │   └── themes
    │       │       └── default.css
    │       └── text
    │           ├── button.blade.php
    │           ├── footer.blade.php
    │           ├── header.blade.php
    │           ├── layout.blade.php
    │           ├── message.blade.php
    │           ├── panel.blade.php
    │           ├── subcopy.blade.php
    │           └── table.blade.php
    └── welcome.blade.php

resources/views/vendor/mailのhtmlのディレクトリには、HTML用メールのコンポーネント、textにはテキストメール用のコンポーネントの定義のファイルが作成されます。

これらのファイルがいったん作成されると、Laravelのパッケージの定義でなくこれらのファイルの定義がマークダウンのメール送信に使用されます。

今回は、ブレードのコンポーネントの理解などにば深入りはしたくないので、HTMLのカスタマイズにはCSSの定義だけを変更してみます。

デフォルトのCSSは、上に見られるのように、html/themes/default.cssにあります。以下にその内容の一部を掲載します。

/* Base */

body,
body *:not(html):not(style):not(br):not(tr):not(code) {
    box-sizing: border-box;
    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif,
        'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol';
    position: relative;
}

body {
    -webkit-text-size-adjust: none;
    background-color: #ffffff;
    color: #718096;
    height: 100%;
    line-height: 1.4;
    margin: 0;
    padding: 0;
    width: 100% !important;
}

p,
ul,
ol,
blockquote {
    line-height: 1.4;
    text-align: left;
}

a {
    color: #3869d4;
}

a img {
    border: none;
}

/* Typography */

h1 {
    color: #3d4852;
    font-size: 18px;
    font-weight: bold;
    margin-top: 0;
    text-align: left;
}
...

font-familyの定義を見てわかる通りに、フォントなどは日本語のフォントを意識はしていません。

まず、そこを変えてみます。このデフォルトのCSSファイルを直接編集してもよいですが、将来を考慮してこのファイルのコピー、larajapan.cssを作成して編集します。

bodyのfont-familyのフォントとh1の色を変更します。

resources/views/vendor/mail/html/themes/laravel.css

/* Base */

body,
body *:not(html):not(style):not(br):not(tr):not(code) {
    box-sizing: border-box;
    font-family: "Lucida Grande", "Hiragino Kaku Gothic ProN", Meiryo, sans-serif; /*日本語のフォントを指定 */
    position: relative;
}
...
h1 {
    color: blue;　/* 青に変更 */
    font-size: 18px;
    font-weight: bold;
    margin-top: 0;
    text-align: left;
}
...

さて、このCSSの変更を反映してメールを送信するには、いくつか方法あります。

最初の方法は、config/mail.phpにおいて以下のように定義、

config/mail.php

return [
...
   /*
    |--------------------------------------------------------------------------
    | Markdown Mail Settings
    |--------------------------------------------------------------------------
    |
    | If you are using Markdown based email rendering, you may configure your
    | theme and component paths here, allowing you to customize the design
    | of the emails. Or, you may simply stick with the Laravel defaults!
    |
    */

    'markdown' => [
        'theme' => 'larajapan', // defaultからlarajapanに変更

        'paths' => [
            resource_path('views/vendor/mail'),
        ],
    ],

];

次の方法は、Mailableのクラスで定義。

app/MailHelloMarkdown

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;

class HelloMarkdown extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->theme = 'larajapan';　//ここで指定
    }

    /**
     * Build the message.
     *
     * @return $this
     */
    public function build()
    {
        return $this->subject('こんにちは！マークダウン')
            ->markdown('emails.hello-markdown');
    }
}

最後は、HelloMarkdownのインスタンスで変更します。以下はtinkerでの例。

Psy Shell v0.10.6 (PHP 7.2.24 — cli) by Justin Hileman
>>> $mailable = new App\Mail\HelloMarkdown;
=> App\Mail\HelloMarkdown {#3283
     +locale: null,
     +from: [],
     +to: [],
     +cc: [],
     +bcc: [],
     +replyTo: [],
     +subject: null,
     +view: null,
     +textView: null,
     +viewData: [],
     +attachments: [],
     +rawAttachments: [],
     +diskAttachments: [],
     +callbacks: [],
     +theme: null,
     +mailer: null,
     +connection: null,
     +queue: null,
     +chainConnection: null,
     +chainQueue: null,
     +delay: null,
     +middleware: [],
     +chained: [],
   }

>>> $mailable->theme = 'larajapan';
=> "larajapan"

>>> Mail::to('test@example.com')->send($mailable);
=> null

さて、送信した結果をMailtrapで見てみます。

h1の部分は変更した通りに、青色になっていますが、フォントはそうたいした変化ないですね。HTMLソースを見てみましょう。

変更した定義のフォント（赤箱）になっていますね。MailtrapのCSSが上書きしているのかな？

このソースを見て気づいたと思いますが、HTMLメールでは、画面のHTMLと違って、

  <link rel="stylesheet" href="larajapan.css">

のような指定がソースにはなく、すべて定義に置き換えられています。

メールの送信（４）ブレードを使ってHTMLメールを作成

Sat, 23 Jan 2021 03:25:11 +0900

コントローラでブレードを指定して画面を作成するように、メールでもブレードを使ってメールの作成が可能です。今回はそれを可能にしてくれるMailableのお話です。

HTMLメールの送信

まず、Mailableの作成から。

$ php artisan make:mail HelloHtml

を実行すると、Mailableのクラス、HelloHtml.phpを作成してくれます。

これを以下のように編集します。

app/Mail/HelloHtml.php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;

class HelloHtml extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Build the message.
     *
     * @return $this
     */
    public function build()
    {
       return $this->subject('こんにちは！') // メールの件名
            ->view('emails.hello');　// ここでブレードを指定
    }
}

ブレードの中身は、簡単に以下とします。

resources/views/emails/hello.blade.php

<html>
  <body>
    <h1>こんにちは！</h1>
  </body>
</html>

これをtinkerで送信します。

$ php artisan tinker
Psy Shell v0.10.6 (PHP 7.2.24 — cli) by Justin Hileman
>>> use App\Mail\HelloHtml;
>>> Mail::to('test@example.com')->send(new HelloHtml);
=> null

Mailtrapで送信されたメールを見てましょう。

HTMLメールとして届いていますね。

ここでひとつ修正です。前回にMailtrapの無料プランは３ヶ月までと書きましたが、それは大間違いで永遠に無料でした。毎月500通までの受信などの制限ありますが、私の使用頻度では十分です。

マークダウンを使ってもっとHTMLの要素をメールに

先に送信したメールは、HTMLですがとてもベーシックでつまらないですね。せっかくのHTMLだから、画像を入れたり色変えたりボタンを入れたりしたいです。しかし、コントローラの画面と違って、いちいちデザイナーに頼むのもなんです。

そこで、Laravelのマークダウンメールの登場です。

マークダウンのためのMailableのクラスの作成は、先のMailableのクラスと同じで、先のコマンドの実行に、–markdownの引数の指定するだけです。

$ php artisan make:mail HelloMarkdown --markdown=emails.hello-markdown

これで、HelloMarkdown.phpとhello-markdown.blade.phpが作成されます。

これらを以下のように編集します。

app/Mail/HelloMarkdown.php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;

class HelloMarkdown extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Build the message.
     *
     * @return $this
     */
    public function build()
    {
        return $this->subject('こんにちは！マークダウン')
            ->markdown('emails.hello-markdown'); // viewでなくmarkdownメソッドを使用
    }
}

resources/views/emails/hello-markdown.blade.php

@component('mail::message')
# こんにちは

![Gmail](https://example.com/gmail.png)

ここにメールの内容が入る

@component('mail::button', ['url' => ''])
ホームページへ
@endcomponent

ありがとうございます<br>
{{ config('app.name') }}
@endcomponent

先と同様に、tinkerで送信します。

Psy Shell v0.10.6 (PHP 7.2.24 — cli) by Justin Hileman
>>> use App\Mail\HelloMarkdown;

>>> Mail::to('test@example.com')->send(new HelloMarkdown);
=> null

結果を、Mailtrapで見ると、以下のようになります。

メールの送信（３）メール受信サービス　Mailhog

Sun, 10 Jan 2021 13:03:22 +0900

前回紹介したMailtrapに比べて機能は劣りますが、十分代わりとなるしかもオープンスース（つまり無料）のMailhogの紹介です。このプログラムと知り合ったのは、Laravelの最新バージョン8のsailのパッケージで使用されていたからです。sailはDockerを使用して簡単に開発環境を作成できる素晴らしいものなのですが、Dockerの１つのコンテイナーとしてMailhogがインストールされます。sailの紹介は別の機会として、今回は単独でのインストールです。

インストール

まず、Mailhogはphpで作成されたプログラムでなく、Goの言語で書かれコンパイルされたバイナリのプログラムです。

以下がソースコードのレポジトリです。

https://github.com/mailhog/MailHog

しかし、ソースコードをコンパイルするやっかいなことは必要でありません。すでにコンパイルされたバイナリを以下からダウンロードできます。

https://github.com/mailhog/MailHog/releases/v1.0.0

この最新のリリースはもう３年以上も前なのは少し気になりますが、上のリンク先の画面の下方にOSごとのバイナリのダウンロードリンクがあります。

ここでは、私のFedoraの仮想環境でLinuxバージョンを選択します。

これをダウンロードして、mailhogと改名して/usr/local/binに移します。また、chmodを実行して適切なパーミッションを与えます。

# mv MailHog_linux_386 /usr/local/bin/mailhog
# chmod 755 mailhog

次にコマンドラインで、mailhogを実行します。このリンク先のようなスクリプトを作成して、OSのサービスとして立ち上げてもOKです。

$ mailhog 
2021/01/07 08:42:42 Using in-memory storage
2021/01/07 08:42:42 [SMTP] Binding to address: 0.0.0.0:1025
[HTTP] Binding to address: 0.0.0.0:8025
2021/01/07 08:42:42 Serving under http://0.0.0.0:8025/
Creating API v1 with WebPath: 
Creating API v2 with WebPath:

これでMailhogがメールを受信できる準備ができました。

Laravelの環境変数の設定

Laravelのプロジェクトでは、.envを編集して以下のようにメール送信の設定をします。

...
MAIL_MAILER=smtp
MAIL_HOST=0.0.0.0
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWIRD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=test@example.com
MAIL_FROM_NAME=test
...

MailTrapのような設定ですが、PortやEncryptが違うことに注意を。

メール送信テスト

準備が整ったところで、tinkerでまずテキストメールを送信

$ php artisan tinker
Psy Shell v0.10.4 (PHP 7.2.24 — cli) by Justin Hileman
>>> Mail::raw('Hello', function($m) { $m->subject('hello')->to('test@example.com'); });
=> null
>>>

ブラウザを開いて、http://localhost:8025にアクセスすると、以下の画面が表示されます。

メール届いていますね！

メールの中身も閲覧できます。

今度は、アプリからHTMLのメールを送信します。

いいですね。ちゃんと表示されています。

さて、HTMLソースはどうでしょう。

う～ん。Quoted-printableがそのままです。例えば、上の画面の青背景は、「確認」の日本語なのですがこれじゃ読めません。もちろん、メールをファイルとしてダウンロードしてOutlookでHTMLソースを見ることが可能ですが、ちょいと不便です。

ここの部分残念ですが、自分のメールアカウントを使用せずに開発のテストとしては十分と思います。無料であることを考えたら、なおさら。

最後に、先のmailhogのプログラムの実行を停止したら、デフォルトではメモリにメールを保存なので受信したメールはすべて消えてしまいます。それが嫌なら、mongodbにメールを保存するオプションもあります。

メールの送信（２）メール受信サービス　Mailtrap

Sun, 03 Jan 2021 03:20:18 +0900

LaravelのマニュアルのMailのセクションでは、Mailtrapというサービスが紹介されています。開発中はGmailのアドレスの送信すればいいものの、なにゆえに必要なのか疑問を持っていました。しかし、先日LaravelのNotificationのHTMLメールでHTMLのタグがどう使われているかチェックするのに困ったことがあり、Mailtrapのサービスを使用してみました。

Mailtrapのようなサービスの必要性

これ考えてみましょう。開発では、これが意外と理由あるのです。

まず、通常使用している自分のメールアカウントに開発サイトから送信されるメールを一緒にしたくありません。しかも、テストのために何回も何回もプログラムからメールを送信して、いつもそれらを読んだ後削除するから、Gmailなどは学習して勝手にスパムあるいはゴミ箱に入れてしまいます。いちいちゴミ箱を見るのも面倒です。

それなら、メールフィルターで送信元で仕分ければとか、違うGmailアカウントを作成すれば、とか言われそうです。

しかし、開発では、１つのプロジェクトで複数の届け先のテストが必要なときがあります。例えば、違う会員で違う内容の送信となるときでは、違うメールアドレスでのテストが必要です。そうなら、いくつものフィルターの設定やメールアカウントが必要となり、いちいち設定が面倒なのです。

また、HTMLメールだと、特にLaravelでは最近マークダウンとかコンポーネントとか使用していて、最終的に生成されるメールのHTMLがどうなるかをチェックしたいときがあります。しかし、HTMLだとQuoted-printableのフォーマットであるし、Gmailでオリジナルのデータを見ても通常のHTMLとは違うのでわけがわからないのです。こんな感じです。

ということで、これらの開発者が直面する問題を解決すべく、このようなサービスがあるわけです。

サインアップ

英語版しかないのですが、まずサインアップ。アカウントは、メールアドレスとパスワードだけで作成可能です。GoogleやGithubなどのアカウントがすでにあるならそれを通してログインしてもOKです。

無料版なのでチャージされることないので心配ないです。

Laravelの環境変数の設定

以下の画面で、Laravelを選択したら、.envにそのままコピーできる環境設定を表示してくれます。

Mailtrapのインボックス

さっそく、メールを送信してみます。Laravelで会員登録完了時に送信されるメールアドレス確認のメールです。HTMLのメールです。

見れましたね。どのメールアドレスに送信してもmailtrapのInboxに入ります。

中身のHTMLソースを見てみましょう。

これなら、通常のブラウザで見るHTMLソースと同じようです。つまり読めます。並んでいるタブの「Raw」をクリックして比べてみてください。

無料はいつまで？

この時点においては、無料版は1ヶ月500通までの受信OKで、~~3ヶ月まで~~永遠に無料です。有料のプランとしては、月9ドルから始まります。

メールの送信（１）メール送信の確認

Fri, 25 Dec 2020 01:22:52 +0900

先日、Laravelのメール送信の設定、つまり、.envでメールに関わる環境変数の設定をいじっていて、設定が正しいかどうかをテストすることで学んだことを共有です。

メール送信のテストは、メールサーバーが走っている環境下なら以下のようなシェルのコマンドラインで実行できます。

$ echo Hello | mail -s hello test@examle.com

届け先は、test@example.com、件名は、hello、内容は、Helloのメールが届きます。

しかし、Laravelのプロジェクトを通して同様にメールを送るには、Mailのファサードの登場です。tinkerで実行してみましょう。

Psy Shell v0.10.4 (PHP 7.2.16 — cli) by Justin Hileman
>>> Mail::raw('Hello', function($m) { $m->subject('hello')->to('test@example.com'); });
=> null

これでメールが届けば、実際使用するプロジェクトのメール関連の環境設定が正しいということです。便利です。

先ほどのは、テキストメールの送信の確認ですが、HTMLのメールの送信も確認したいです。

以下のように、今度は Mail::htmlのコールとなりました。

Psy Shell v0.10.4 (PHP 7.2.16 — cli) by Justin Hileman
>>> Mail::html('<h1>Hello</h1>', function($m) { $m->subject('hello')->to('test@example.com'); });
=> null

メール送信 on ララジャパン

DKIM署名を含むメールのユニットテスト

メールのDKIM署名をチェックするツール

配信するメールをファイルに落とす

ユニットテストを作成

メールをログに出力する

メールをログに出力する

設定を理解する

出力先ログチャンネルを変更する

nullチャンネルの活用

LaravelでメールをDKIM署名

DKIM認証の仕組み

DKIMのキーを作成

アプリでDKIM署名

最後に

メルマガをワンクリックで登録解除

メールの配信登録を容易に解除できるとは？

ワンクリックのリンクを含むMailableを作成

登録解除のPOSTを受け取るコントローラ

最後に

Laravel × MJMLでレスポンシブメールを送信

MJMLをプロジェクトにインストール

ビューファイル作成

レスポンシブなメールを送信

Laravelの新しいMailableでHTMLメールを送信

HTMLメールを送信

DNSを使ってメールアドレスをチェック

緩いメールアドレスのバリデーション

email:dnsの登場

dns_get_record()

最後に

メールの送信（６）Notificationを使ってメールを送信

Notificationを使用してメールを送信

送信メールをカスタマイズ

メールの送信（５）HTMLメールのフォントなどをカスタマイズ

メールの送信（４）ブレードを使ってHTMLメールを作成

HTMLメールの送信

マークダウンを使ってもっとHTMLの要素をメールに

メールの送信（３）メール受信サービス Mailhog

インストール

Laravelの環境変数の設定

メール送信テスト

メールの送信（２）メール受信サービス Mailtrap

Mailtrapのようなサービスの必要性

サインアップ

Laravelの環境変数の設定

Mailtrapのインボックス

無料はいつまで？

メールの送信（１）メール送信の確認

メールの送信（３）メール受信サービス　Mailhog

メールの送信（２）メール受信サービス　Mailtrap