Laravel 11 - Welcome Notification Email

Quick Overview

Step # 1 : Set Up Laravel Project with Breeze Authentication.

laravel new notification

composer create-project laravel/laravel --prefer-dist notification

• Would you like to install the starter kit? — Select Breeze.
• After selecting Breeze, you'll be asked to choose your stack? — Select Blade.
• After selecting Blade, you'll be asked for dark mode support? — Select No.
• After selecting No, you'll be asked about testing framework? — Select PHPUnit.
• After selecting PHPUnit, you'll be asked if you want to initialize git repo? — Select No.
• After selecting no, you'll be asked to select the database for your application? — Select Mysql.
• After selecting MySql, you'll be asked if you want to run the default database migration? — Select Yes.
  
  

Step # 2 : Access the project.

cd c:xampp/htdocs/notification

Step # 3 : Create the Notification.

php artisan make:notification WelcomeMailNotification

    public function toMail(object $notifiable): MailMessage
    {
        return (new MailMessage)
                    ->line('Welcome To Code Shotcut')
                    ->action('Action Url', url('/'))
                    ->line('Thank you for using Code Shotcut!');
    }

Step # 4 : Create a Mailtrap Account.

• Visit https://mailtrap.io and sign up for an account.
• After registration, create a new project for testing purposes.
• Inside the project, you'll find all the required details for the next steps.
  
  

Step # 5: Update .env Configuration.

MAIL_MAILER=smtp
MAIL_HOST=sandbox.smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME="Your Mailtrap username"
MAIL_PASSWORD="Your Mailtrap password"
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="Your email address"
MAIL_FROM_NAME="${APP_NAME}"

Step # 6 : Modify RegisteredUserController.

use App\Notifications\WelcomeMailNotification;

public function store(Request $request): RedirectResponse
{
    $request->validate([
        'name' => ['required', 'string', 'max:255'],
        'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],
        'password' => ['required', 'confirmed', Rules\Password::defaults()],
    ]);
    $user = User::create([
        'name' => $request->name,
        'email' => $request->email,
        'password' => Hash::make($request->password),
    ]);
    event(new Registered($user));
    //Send Welcome Mail Notification
    $user->notify(new WelcomeMailNotification());
    Auth::login($user);
    return redirect(route('dashboard', absolute: false));
}

Step # 7 : It's time to test.

php artisan serve

    public function store(Request $request): RedirectResponse
    {
        $request->validate([
            'name' => ['required', 'string', 'max:255'],
            'email' => ['required', 'string', 'lowercase', 'email', 'max:255', 'unique:'.User::class],
            'password' => ['required', 'confirmed', Rules\Password::defaults()],
        ]);
        $user = User::create([
            'name' => $request->name,
            'email' => $request->email,
            'password' => Hash::make($request->password),
        ]);
        event(new Registered($user));
        //Send Welcome Mail Notification and pass user.
        $user->notify(new WelcomeMailNotification($user));
        Auth::login($user);
        return redirect(route('dashboard', absolute: false));
    }

<?php
namespace App\Notifications;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Notification;
class WelcomeMailNotification extends Notification
{
    use Queueable;
    protected $user;
    // Constructor to accept the user object
    public function __construct($user)
    {
        $this->user = $user;
    }
    public function via($notifiable)
    {
        return ['mail'];
    }
    // Customize the email using a view and pass the user data
    public function toMail($notifiable)
    {
        return (new MailMessage)
        ->subject('Welcome to Code Shotcut')
            ->view('welcome-email', ['user' => $this->user]);
            // Use custom view
        }
        public function toArray($notifiable)
        {
            return [];
        }
    }

<!DOCTYPE html>
<html>
<head>
    <title>Welcome to Code Shotcut</title>
</head>
<body>
    <h1>Welcome, {{ $user->name }}!</h1>
    <p>Thank you for joining us.</p>
    <p>Your email is: {{ $user->email }}</p>
</body>
</html>

Conclusion