[PHP]Laravelを使ったメールフォームの作り方

Laravel 5.6 を使い、お問い合わせ用のコンタクトフォームを作っていきます。
古いバージョンでも概ね同じですが、Bootstrap 4 が使われていることに注意して下さい。

まず最初にメールに関する初期設定を行っておきます。設定箇所は .env ファイルの「MAIL_」から始まる項目です。お使いのアカウントに合わせて各項目を書き換えて下さい。
MAIL_ENCRYPTION には tls, ssl, null のいずれかが設定できます。

次の２行がない場合は .env に書き足すか、 config/mail.php の from の項目を編集して下さい。

MAIL_FROM_ADDRESS=送信元のメールアドレス
MAIL_FROM_NAME=送信者の名前

次に routes/web.php でルーティングを用意します。

Route::get('/contact', 'ContactController@form')->name('contact');
Route::post('/contact', 'ContactController@send')->name('contact.send');
Route::get('/contact/result', 'ContactController@result')->name('contact.result');

それぞれフォーム画面、送信処理、送信結果の３つです。

artisan のコマンドを使ってコントローラーを作成します。

php artisan make:controller ContactController

app\Http\Controller に ContactController.php が作られます。
まずはフォーム画面となる form() メソッドを追加します。

    public function form()
    {
        return view('contact.form');
    }

ひとまず最低限ビューが表示できるようにしたので Blade テンプレートファイルを用意します。場所は resources/views です。contact フォルダを新しく作り、その中に form.blade.php ファイルを作成します。
すでに layouts/app.blade.php などの親テンプレートが存在する場合はそのまま使っていきますが、ない場合は作成します。

layouts/app.blade.php

<!DOCTYPE html>
<html lang="{{ app()->getLocale() }}">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <!-- CSRF Token -->
    <meta name="csrf-token" content="{{ csrf_token() }}">

    <title>{{ config('app.name', 'Laravel') }}</title>

    <!-- Styles -->
    <link href="{{ asset('css/app.css') }}" rel="stylesheet">
</head>
<body>
    <div id="app">
        @yield('content')
    </div>

    <!-- Scripts -->
    <script src="{{ asset('js/app.js') }}"></script>
</body>
</html>

contact/form.blade.php

@extends('layouts.app')

@section('content')
<div class="container">
    <div class="card">
        <div class="card-body">
            <form method="POST" action="{{ route('contact.send') }}">
                {{ csrf_field() }}

                <div class="form-group">
                    <label for="formInputName">Name</label>
                    <input type="text" class="form-control" id="formInputName" name="name" value="{{ old('name') }}">

                    @if ($errors->has('name'))
                        <span class="help-block">
                            <strong>{{ $errors->first('name') }}</strong>
                        </span>
                    @endif
                </div>

                <div class="form-group">
                    <label for="formInputEmail">Email address</label>
                    <input type="text" class="form-control" id="formInputEmail" name="email" value="{{ old('email') }}">

                    @if ($errors->has('email'))
                        <span class="help-block">
                            <strong>{{ $errors->first('email') }}</strong>
                        </span>
                    @endif
                </div>

                <div class="form-group">
                    <label for="formInputEmail">Message</label>
                    <textarea class="form-control" id="formInputMessage" name="message" value="{{ old('message') }}">{{ old('message') }}</textarea>

                    @if ($errors->has('message'))
                        <span class="help-block">
                            <strong>{{ $errors->first('message') }}</strong>
                        </span>
                    @endif
                </div>

                <button type="submit" class="btn btn-primary">Submit</button>
            </form>
        </div>
    </div>
</div>
@endsection

Laravel ではメールの送信を Mailable クラスを通して行っています。メールの種類ごとに次のコマンドでメールを処理するためのクラスを作ります。「Contact」の部分は好きな名前にして下さい。（例: OrderShipped）

php artisan make:mail Contact

これで app\Mail フォルダに Contact.php が作られます。
入力内容に合わせて文面を表示するために、引数として受け取れるようにしていきます。

class Contact extends Mailable
{
    use Queueable, SerializesModels;

    public $data = [];

    /**
     * Create a new message instance.
     *
     * @return void
     */
    public function __construct($data)
    {
        $this->data['inputs'] = $data;
    }

    /**
     * Build the message.
     *
     * @return $this
     */
    public function build()
    {
        return $this->view('emails.contact')->with($this->data);
    }
}

プロパティ $data を追加し、コンストラクタで inputs に代入します。（inputs の名前は何でも構いません）代入したデータは build() の with() でビューに渡しています。
連想配列 inputs に入れずに直接代入するのが一般的ですが、Mailable では $message という変数は他のデータが入っていて使えないため、上書きされるのを防ぐためにこのような形をとっています。

そして build() で指定したメールの文面となるビューファイルを用意します。view() を使ったときは html メールになります。プレーンテキストで送りたい場合は代わりに text() を使って下さい。

emails/contact.blade.php

<p>Name: {{ $inputs['name'] }}</p>
<p>Email: {{ $inputs['email'] }}</p>
<p>{!! nl2br( $inputs['message'] ) !!}</p>

次は ContactController に戻り、冒頭に use を書き足します。

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

そして送信処理 send() を実装します。

    public function send(Request $request)
    {
        $rules = [
            'name' => 'required|string',
            'email' => 'required|email',
            'message' => 'required'
        ];
        $this->validate($request, $rules);

        $to = [
            ['email' => 'example@gmail.com', 'name' => 'Your Name']
        ];

        $data = $request->only('name', 'email', 'message');
        Mail::to($to)->send(new Contact($data));

        return redirect()->route('contact.result');
    }

送信時にバリデーションを行って入力欄に空欄がないか、メールアドレスは正しいかをチェックしています。入力内容に問題がなければ送信処理を行います。$to には送信先を指定します。複数指定することができます。名前が必要ない場合は null にしておきます。

今回作った Contact クラスの引数として入力内容を渡し、send() で送信です。

送信が終わったら redirect() で完了ページに移動します。送信完了ページはテンプレートを表示するだけです。

    public function result()
    {
        return view('contact.result');
    }

contact/result.blade.php

@extends('layouts.app')

@section('content')
<div class="container">
    <div class="card">
        <div class="card-body">
            <h3>Thanks.</h3>
            <p>Your email has been successfully sent.</p>
        </div>
    </div>
</div>
@endsection

try catch や Mail::failures() を使ってエラー時の処理を追加するのも良いと思いますが、基本的には送信時のエラーしか拾えません。送信には成功したものの実際には受信側の容量が不足していて受け取れなかったなどのケースもありえますので注意して下さい。

PHP Archive

Webサイト開発初心者の備忘録