はじめに
サービス登録時にメールを送ることがよくあると思います。今回はLaravelでメールを送る方法として比較的簡単なGmailを使った方法を紹介します。
準備
事前にGmailアカウントを作成し、Googleアカウントのセキュリティから、安全性の低いアプリからのアカウントへのアクセスを許可しておいてください(本番で使う場合はアプリパスワードを発行するほうが良いです)
実装
ユーザ登録時に招待メールを送るというシチュエーションを想定して解説していきます。
Mailableクラスの作成
メールの送信はmailableクラスを通して行います。以下のコマンドで作成します。
1 | $php artisan make:mail UserRegistered |
このコマンドを実行すると、 app/Mail ディレクトリに UserRegistered.php が作成されます。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | <?php namespaceApp\Mail; useIlluminate\Bus\Queueable; useIlluminate\Mail\Mailable; useIlluminate\Queue\SerializesModels; useIlluminate\Contracts\Queue\ShouldQueue; classUserRegisteredextendsMailable { useQueueable,SerializesModels; /** * Create a new message instance. * * @return void */ publicfunction__construct() { // } /** * Build the message. * * @return $this */ publicfunctionbuild() { return$this->view('view.name'); } } |
テンプレートの作成
mailableクラスを作成したら、メールのテンプレートを作成します。メールのテンプレートは resources/views ディレクトリの中であればどこに配置しても構いません。今回は emails/users ディレクトリを作成し、その中に registered.blade.php を作成します。
作成したBladeファイルは以下のように実装します。
1 2 3 4 5 6 7 8 9 | <html> <head> <title>登録ありがとうございます</title> </head> <body> ようこそ{{@user->name}} さん。 ログインは<ahref="{{ url('/login') }}">こちら</a>からお願いします。 </body> </html> |
Mailableクラスの修正
テンプレートを作成したら、 UserRegistered クラスを以下のように修正します。なお、Userクラスは事前に作成してあるものとします。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | <?php namespaceApp\Mail; useApp\User;// 追加 useIlluminate\Bus\Queueable; useIlluminate\Mail\Mailable; useIlluminate\Queue\SerializesModels; useIlluminate\Contracts\Queue\ShouldQueue; classUsersRegisteredextendsMailable { useQueueable,SerializesModels; // ビューへ渡すインスタンス public$user; /** * Create a new message instance. * * @return void */ publicfunction__construct(User$user) { $this->user=$user;// 追加 } /** * Build the message. * * @return $this */ publicfunctionbuild() { // テンプレートファイルを指定する return$this->view('emails.users.registered'); } } |
mailableクラスで定義したpublicプロパティは、Bladeテンプレートでそのまま利用することができます。
コントローラの作成
コントローラにメール送信処理を実装します。コントローラは以下のコマンドで作成できます。
1 | $php artisan make:cotroller UsersController |
作成したコントローラを以下のように修正します。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | <?php namespaceApp\Http\Controllers; useApp\User; useApp\Mail\UserRegistered; useIlluminate\Http\Request; useIlluminate\Support\Facades\Mail; useApp\Http\Controllers\Controller; classUserControllerextendsController { /** * ユーザ登録 * * @param Request $request * @return Response */ publicfunctionstore(Request$request) { $user=User::create($request); Mail::to($user->email)->send(newUserRegistered($user)); } } |
コンフィグの修正
最後に.envを以下のように修正します。MAIL_USERNAMEとMAIL_PASSWORDは作成したGmailの設定に沿って変更してください。
1 2 3 4 5 6 | MAIL_DRIVER=smtp MAIL_HOST=smtp.googlemail.com MAIL_PORT=465 MAIL_USERNAME=XXXXXXXX@gmail.com MAIL_PASSWORD=XXXXXXXX MAIL_ENCRYPTION=ssl |
さいごに
Laravelからメールを送る方法として比較的簡単なGmailを使った方法を紹介しました。