Mail templates in Laravel

Introduction

Mail templates help you send emails with a nice, consistent look. They save time by reusing the same design for many emails.

When sending welcome emails to new users.

When notifying users about password resets.

When sending order confirmations in an online store.

When sending newsletters or updates to subscribers.

When you want all your emails to have the same style and branding.

Syntax

Laravel

php artisan make:mail YourMailName --markdown=emails.template_name

// In the generated mail class:
public function build()
{
    return $this->markdown('emails.template_name')
                ->with(['data' => $this->data]);
}

Use --markdown to create a mail template using Markdown syntax.

The markdown() method points to the Blade template for the email.

Examples

This command creates a mail class named WelcomeUser with a Markdown template at resources/views/emails/welcome.blade.php.

Laravel

php artisan make:mail WelcomeUser --markdown=emails.welcome

This method tells Laravel to use the emails.welcome template and pass the user data to it.

Laravel

public function build()
{
    return $this->markdown('emails.welcome')
                ->with(['user' => $this->user]);
}

This is a simple Markdown mail template. The subject sets the email subject, and the body uses Blade syntax to show the user's name.

Laravel

---
subject: "Welcome to Our Site"
---

# Hello, {{ $user->name }}!

Thanks for joining us.

Sample Program

This example shows a mail class WelcomeUser that sends a welcome email using a Markdown template. The template greets the user by name. The mail is sent to the user's email address.

Laravel

<?php

namespace App\Mail;

use Illuminate\Mail\Mailable;

class WelcomeUser extends Mailable
{
    public $user;

    public function __construct($user)
    {
        $this->user = $user;
    }

    public function build()
    {
        return $this->markdown('emails.welcome')
                    ->with(['user' => $this->user]);
    }
}

// resources/views/emails/welcome.blade.php
---
subject: "Welcome to Our Site"
---

# Hello, {{ $user->name }}!

Thanks for joining us.

// Usage example in a controller or route:
use App\Mail\WelcomeUser;
use Illuminate\Support\Facades\Mail;

$user = (object) ['name' => 'Alice'];
Mail::to('[e-mail]')->send(new WelcomeUser($user));

Important Notes

Mail templates use Blade and Markdown for easy formatting.

You can customize the email subject in the template front matter.

Always test emails locally using tools like MailHog or Mailtrap before sending to real users.

Summary

Mail templates let you create reusable email designs.

Use php artisan make:mail with --markdown to create templates.

Pass data to templates using the with() method in the mail class.

Practice

1. What is the main purpose of using mail templates in Laravel?

easy

A. To create reusable and consistent email designs

B. To store user passwords securely

C. To manage database migrations

D. To handle HTTP requests routing

Solution

1. Step 1: Understand mail templates role

   Mail templates are used to design emails that can be reused for sending consistent messages.

2. Step 2: Compare with other options

   Options B, C, and D relate to security, database, and routing, which are unrelated to mail templates.

3. Final Answer:

   To create reusable and consistent email designs -> Option A

4. Quick Check:

   Mail templates = reusable email designs [OK]

Hint: Mail templates are for email design reuse [OK]

Common Mistakes:

• Confusing mail templates with database or routing features
• Thinking mail templates handle security
• Assuming mail templates manage HTTP requests

2. Which artisan command creates a new mail class with a markdown template in Laravel?

easy

A. php artisan make:mail -m

B. php artisan make:mail --markdown

C. php artisan mail:create --template

D. php artisan make:mail --template

Solution

1. Step 1: Recall the correct artisan command

   The correct command to create a mail class with a markdown template is php artisan make:mail MailName --markdown.

2. Step 2: Check other options

   Options B, C, and D are incorrect because they use wrong flags or commands that do not exist.

3. Final Answer:

   php artisan make:mail --markdown -> Option B

4. Quick Check:

   Correct artisan command = php artisan make:mail --markdown [OK]

Hint: Use --markdown flag with make:mail command [OK]

Common Mistakes:

• Using shorthand -m which is invalid here
• Trying non-existent commands like mail:create
• Using --template instead of --markdown

3. Given this mail class snippet, what will be the value of $this->name inside the markdown template?

class WelcomeMail extends Mailable {
    public $name;
    public function __construct($name) {
        $this->name = $name;
    }
    public function build() {
        return $this->markdown('emails.welcome')->with(['name' => $this->name]);
    }
}

If you send new WelcomeMail('Alice'), what is $name in the template?

medium

A. 'Alice'

B. null

C. 'name'

D. An error occurs

Solution

1. Step 1: Understand constructor assignment

   The constructor sets $this->name to the passed value 'Alice'.

2. Step 2: Check data passed to template

   The with() method passes ['name' => $this->name], so 'Alice' is passed as 'name'.

3. Final Answer:

   'Alice' -> Option A

4. Quick Check:

   Passed name = 'Alice' [OK]

Hint: Constructor sets property, with() passes it to template [OK]

Common Mistakes:

• Assuming $name is null if not explicitly set in build()
• Confusing property name with string 'name'
• Expecting an error due to missing data

4. Identify the error in this mail class code snippet:

class NotifyUser extends Mailable {
    public function build() {
        return $this->markdown('emails.notify')->with('user', $user);
    }
}

medium

A. with() method requires an array, not two arguments

B. The markdown method should be markdownView()

C. Variable $user is undefined in build() method

D. Class must extend Mail instead of Mailable

Solution

1. Step 1: Check variable usage in build()

   The variable $user is used but not defined or passed to the method.

2. Step 2: Verify method names and parameters

   markdown() is correct; with() accepts key-value pairs or array, so usage is okay if $user existed.

3. Final Answer:

   Variable $user is undefined in build() method -> Option C

4. Quick Check:

   Undefined variable $user causes error [OK]

Hint: Check all variables are defined before use [OK]

Common Mistakes:

• Assuming with() needs only arrays
• Thinking markdown() method name is wrong
• Confusing Mailable with Mail class

5. You want to send a mail with a markdown template that shows a list of products. Which approach correctly passes the products array to the template?

hard

A. Pass products as a constructor argument but do not use with()

B. Set a private property $products but do not pass it to the template

C. Call markdown('emails.products', $products) directly

D. Use with(['products' => $products]) in the build() method

Solution

1. Step 1: Understand data passing to templates

   Data must be passed explicitly using with() or public properties.

2. Step 2: Evaluate each option

   Use with(['products' => $products]) in the build() method correctly uses with() to pass the products array. Pass products as a constructor argument but do not use with() misses passing data to template. Call markdown('emails.products', $products) directly uses wrong markdown method signature. Set a private property $products but do not pass data sets property but does not pass data.

3. Final Answer:

   Use with(['products' => $products]) in the build() method -> Option D

4. Quick Check:

   Pass data with with() method [OK]

Hint: Always pass data with with() or public properties [OK]

Common Mistakes:

• Not passing data to template after setting property
• Using markdown() with wrong parameters
• Assuming constructor argument auto-passes data