技術資料

ローカルでWebアプリケーションのメール送信処理を確認するとき、実在するメールアドレスへ送信する方法は避けたいものです。

例えばLaravelにはログへ出力する方法もありますが、実際のメール本文やHTML、ヘッダーなどを確認したい場合は、ローカルでSMTPサーバーを動かすと分かりやすくなります。

今回は、Windows 11にMailpitを導入し、Laravelからテストメールを送信して、MailpitのWeb UIで受信内容を確認してみます。

前提

今回の環境は以下の通りです。

• OS: Windows 11
• PHP: 8.3.15
• Laravel Framework: 13.24.0
• Mailpit: Windows向けバイナリ
• ターミナル: PowerShell

Mailpitのバージョンによって起動オプションや画面が変更される可能性があるため、ダウンロード時は公式のリリースページとMailpit公式ドキュメントを確認してください。

Mailpitとは

Mailpitは、開発・テスト環境で送信されたメールを受け取り、ブラウザ上で確認するためのローカルSMTPサーバーです。

アプリケーションからは通常のSMTPサーバーとして見えますが、受信したメールを実在する宛先へ配送するのではなく、MailpitのWeb UIで確認できる状態に保存します。

今回の構成は次のようになります。

Laravel
  ↓ SMTP送信
Mailpit SMTPサーバー（127.0.0.1:1025）
  ↓ 受信・保存
Mailpit Web UI（http://127.0.0.1:8025）

Mailpitの既定ポートは、Web UIが8025、SMTPが1025です。Mailpitは単一の実行ファイルとして配布されており、Windowsでは公式のリリースページからバイナリをダウンロードして使用できます。詳しくはMailpitのインストール方法を参照してください。

Windows 11にMailpitを導入する

実行ファイルを配置する

Mailpitのリリースページから、Windows用のZIPファイルをダウンロードします。x64のWindows 11を使用している場合は、通常はファイル名にwindows-amd64を含むものを選択します。ARM版Windowsの場合は、環境に合うバイナリを選択してください。

ZIPファイルを展開し、今回は次のような構成にします。

C:\Tools\Mailpit
├─ mailpit.exe
└─ data

dataフォルダーは、Mailpitの受信メールをSQLiteデータベースへ保存する場合に使用します。PowerShellで作成する場合は、次のコマンドを実行します。

New-Item -ItemType Directory -Force C:\Tools\Mailpit\data

Windowsによって実行ファイルがブロックされた場合は、ファイルのプロパティからブロックを解除するか、次のコマンドを実行します。

Unblock-File C:\Tools\Mailpit\mailpit.exe

Mailpitを起動する

PowerShellでMailpitの配置先へ移動し、次のコマンドを実行します。

cd C:\Tools\Mailpit

.\mailpit.exe `
    --listen 127.0.0.1:8025 `
    --smtp 127.0.0.1:1025 `
    --database "C:\Tools\Mailpit\data\mailpit.db"

--listenはWeb UIの待受アドレス、--smtpはSMTPサーバーの待受アドレスです。今回はどちらも127.0.0.1にして、このPCからだけ接続できるようにしています。

Mailpitの既定の待受アドレスは0.0.0.0です。ローカル開発だけで使用する場合は、待受アドレスを明示して外部ネットワークから接続できないようにしておく方が安全です。起動オプションの詳細はMailpitのランタイムオプションを参照してください。

--databaseを指定すると、受信メールを指定したSQLiteファイルへ保存できます。指定しない場合は一時データベースが使われ、Mailpit終了時に削除されます。

Mailpitを起動したPowerShellは、確認作業が終わるまで開いたままにします。別のPowerShellで、SMTPポートを確認します。

Test-NetConnection 127.0.0.1 -Port 1025

次のようにTcpTestSucceeded : Trueと表示されれば、SMTPポートへ接続できます。

TcpTestSucceeded : True

ブラウザでhttp://127.0.0.1:8025を開き、Mailpitの受信箱が表示されることも確認します。

Laravelのメール設定を変更する

Laravel 13のSMTP設定

Laravel 13の標準構成では、config/mail.phpのSMTP設定が、MAIL_SCHEME、MAIL_HOST、MAIL_PORTなどの環境変数を参照します。LaravelのLaravel 13.xのconfig/mail.phpでも、この構成を確認できます。

Laravelプロジェクトのルートにある.envを開き、メール設定を次のように変更します。

MAIL_MAILER=smtp
MAIL_SCHEME=null
MAIL_HOST=127.0.0.1
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null

MAIL_FROM_ADDRESS="noreply@example.test"
MAIL_FROM_NAME="${APP_NAME}"

Mailpitの既定SMTPは暗号化と認証を使用しないため、MAIL_SCHEME、MAIL_USERNAME、MAIL_PASSWORDはこの設定にしています。MailpitのSMTP設定を変更した場合は、その内容に合わせてLaravel側も変更してください。

古いLaravelプロジェクトや既存設定を引き継いだプロジェクトでは、MAIL_SCHEMEではなくMAIL_ENCRYPTIONを参照している場合があります。設定を変更する前に、対象プロジェクトのconfig/mail.phpを確認してください。

設定キャッシュを削除する

.envを変更したら、Laravelプロジェクトのルートで次のコマンドを実行します。

php artisan config:clear

Laravelで設定がキャッシュされている場合、.envを変更しただけでは新しい値が反映されないことがあります。config:clearは、キャッシュされた設定を削除するためのコマンドです。詳しくはLaravelの設定キャッシュに関する公式ドキュメントを参照してください。

現在読み込まれている値は、Tinkerで確認できます。

php artisan tinker

config('mail.default');
config('mail.mailers.smtp.host');
config('mail.mailers.smtp.port');

今回の設定では、主に次の値になっていれば問題ありません。

default mailer: smtp
SMTP host: 127.0.0.1
SMTP port: 1025

Tinkerはexitを入力して終了します。

Laravelからテストメールを送信する

Tinkerから送信する

Laravel Tinkerを起動します。

php artisan tinker

次のコードを実行して、Mailpitへテストメールを送信します。

use Illuminate\Support\Facades\Mail;

Mail::raw(
    'Mailpitへの接続テストです。',
    function ($message): void {
        $message
            ->to('test@example.com')
            ->subject('Mailpit接続テスト');
    }
);

エラーが発生せずにTinkerのプロンプトへ戻れば、LaravelからSMTP送信処理が実行されています。続いて、ブラウザでMailpitのWeb UIを開きます。

受信箱に「Mailpit接続テスト」という件名のメールが表示されれば、LaravelからMailpitへの送信と、Mailpitでの受信確認は完了です。

アプリケーションのMailableを確認する

実際のアプリケーションでMailableを使っている場合は、TinkerからMailableを送信して確認することもできます。

php artisan make:mail TestMail

Mailableを実装した後、Tinkerで次のように送信します。

use App\Mail\TestMail;
use Illuminate\Support\Facades\Mail;

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

HTMLメールや添付ファイルを確認したい場合は、実際にアプリケーションで使用するMailableを送信し、Mailpitの画面で内容を確認するとよいでしょう。

キュー送信を使う場合

Mailableがキュー送信の対象になっている場合、送信処理はすぐにSMTPへ渡らないことがあります。その場合は、Laravelのキューワーカーも起動します。

php artisan queue:work

単純なSMTP接続の確認では、まずMail::raw()やsend()を使い、キューを介さずに確認すると原因を切り分けやすくなります。Laravelでキューへメールを送信する場合は、Laravelのメールキューに関する公式ドキュメントも参照してください。

トラブルシューティング

Connection refusedになる

MailpitのSMTPポートへ接続できていない可能性があります。まずMailpitを起動したPowerShellにエラーが表示されていないか確認し、次のコマンドを実行します。

Test-NetConnection 127.0.0.1 -Port 1025

TcpTestSucceededがFalseの場合は、Mailpitが起動しているか、LaravelのMAIL_HOSTとMAIL_PORTが起動時の指定と一致しているかを確認します。

Web UIを開けない

MailpitのWeb UIは127.0.0.1:8025で起動しています。別のアプリケーションが8025番ポートを使っている場合は、Mailpitの起動ポートを変更します。

.\mailpit.exe `
    --listen 127.0.0.1:8026 `
    --smtp 127.0.0.1:1026 `
    --database "C:\Tools\Mailpit\data\mailpit.db"

この場合は、Laravel側のMAIL_PORTも1026へ変更し、Web UIはhttp://127.0.0.1:8026で開きます。

.envの変更が反映されない

MAIL_MAILERがsmtpになっているか、MAIL_HOSTとMAIL_PORTが正しいかを確認します。そのうえで、設定キャッシュを削除します。

php artisan config:clear

Tinkerでconfig('mail.default')やconfig('mail.mailers.smtp.port')を確認すると、Laravelが読み込んでいる値を確認できます。

送信したメールが表示されない

キュー送信を使用している場合は、キューワーカーが起動しているか確認します。まずはキューを使わないMail::raw()で送信し、Mailpitに表示されるかを確認すると、SMTP設定の問題とキュー処理の問題を分けて調べられます。

また、MailpitのWeb UIを別のポートで開いていないか、送信先を別のMailpitへ向けていないかも確認します。

MailpitとメールFakeの使い分け

Mailpitは、LaravelからSMTPサーバーへ接続し、最終的なメール内容を確認するためのツールです。一方、LaravelのメールFakeは、テスト中に実際のメール送信を行わず、送信されたMailableなどを検証するために使います。

例えば、メールが送信対象になったことだけをテストする場合は、次のようにMail::fake()を使います。

use App\Mail\TestMail;
use Illuminate\Support\Facades\Mail;

Mail::fake();

// メール送信処理を実行

Mail::assertSent(TestMail::class);

メールFakeでは、実際のSMTP接続やMailpitのWeb UI表示までは確認しません。SMTP設定、HTMLメールの表示、ヘッダー、添付ファイルなどを確認したい場合は、Mailpitへ実際に送信します。

このように、通常の自動テストではメールFake、手動の疎通確認や結合確認ではMailpit、というように目的を分けると扱いやすくなります。

注意点

• Mailpitは開発・テスト用のツールであり、本番環境のメール配送サービスとして使用しない。
• Web UIとSMTPの待受アドレスは、必要がなければ127.0.0.1に限定する。
• 既定のSMTPは暗号化・認証なしなので、外部ネットワークへ公開しない。
• Mailpitのデータベースにはメール本文や個人情報が保存される可能性があるため、実在する個人情報をテストに使わない。
• mailpit.dbや関連するSQLiteファイルをGitの管理対象へ含めない。
• Mailpitを終了するときは、起動中のPowerShellでCtrl + Cを押す。

MailpitのSMTPは既定で暗号化と認証を使用しません。ローカル環境で使う場合でも、待受アドレスを限定し、本番用の認証情報や実在するメールデータを流用しないようにしてください。詳しくはMailpitのSMTP設定に関する公式ドキュメントを参照してください。

まとめ

今回は、Windows 11にMailpitを導入し、Laravelからテストメールを送信して、Web UIで受信内容を確認しました。

Mailpitを127.0.0.1:8025と127.0.0.1:1025で起動し、Laravelの.envでSMTPの接続先を設定すれば、外部へメールを配送せずに送信処理を確認できます。

今回の環境はWindows 11、PHP 8.3.15、Laravel Framework 13.24.0です。実際に送信テストと受信確認を行い、特にエラーなく完了しました。

メール送信の自動テストではメールFakeを使い、SMTP接続や最終的なメール内容を確認するときはMailpitを使う、というように目的に応じて使い分けるとよいかと思います。