Mailable classes in Laravel - Mini Project: Build & Apply

Creating a Simple Laravel Mailable Class

📖 Scenario: You are building a Laravel application that needs to send a welcome email to new users. To do this, you will create a Mailable class that holds the user's name and email content.

🎯 Goal: Build a Laravel Mailable class named WelcomeEmail that accepts a user's name, stores it, and sets up the email subject and view.

📋 What You'll Learn

Create a Mailable class named WelcomeEmail

Add a public property userName to hold the user's name

Create a constructor that accepts a $userName parameter and assigns it to the property

Set the email subject to 'Welcome to Our Platform!'

Use the view named emails.welcome for the email content

💡 Why This Matters

🌍 Real World

Mailable classes in Laravel help send emails with dynamic content, such as welcome messages, notifications, or password resets.

💼 Career

Understanding Mailable classes is essential for backend developers working with Laravel to implement email features in web applications.

1

Create the Mailable class with a public property

Create a Laravel Mailable class named WelcomeEmail that extends Illuminate\Mail\Mailable. Add a public property called userName to hold the user's name.

Laravel

<?php

namespace App\Mail;

use Illuminate\Mail\Mailable;

class WelcomeEmail extends Mailable
{
    // Your code here
}

Hint

Remember to declare the property public $userName; inside the class.

2

Add the constructor to accept and assign the user name

Add a constructor method __construct to the WelcomeEmail class that accepts a parameter $userName and assigns it to the public property userName.

Laravel

<?php

namespace App\Mail;

use Illuminate\Mail\Mailable;

class WelcomeEmail extends Mailable
{
    public $userName;

    // Add the constructor here
}

Hint

The constructor should assign the passed $userName to the class property $this->userName.

3

Set the email subject and view in the build method

Add a build method to the WelcomeEmail class that sets the email subject to 'Welcome to Our Platform!' and uses the view 'emails.welcome'.

Laravel

userName = $userName;
    }

    // Add the build method here
}

Hint

The build method should return $this->subject(...)->view(...).

4

Complete the Mailable class with namespace and imports

Ensure the WelcomeEmail class has the correct namespace App\Mail and imports Illuminate\Mail\Mailable. The class should be fully ready to send emails with the user's name accessible in the view.

Laravel

<?php

// Verify namespace and imports are correct

// Your code here

Hint

Check that the namespace and import statements are exactly as shown.

Practice

1. What is the main purpose of a Mailable class in Laravel?

easy

A. To organize email content and settings in one place

B. To handle database migrations

C. To manage user authentication

D. To define API routes

Solution

1. Step 1: Understand the role of Mailable classes

   Mailable classes are designed to organize email content and settings such as subject, recipients, and views.

2. Step 2: Compare with other Laravel features

   Database migrations, authentication, and routing are handled by other parts of Laravel, not Mailable classes.

3. Final Answer:

   To organize email content and settings in one place -> Option A

4. Quick Check:

   Mailable class purpose = Organize email content [OK]

Hint: Mailable classes bundle email setup and content [OK]

Common Mistakes:

• Confusing Mailable with database or routing features
• Thinking Mailable handles user login
• Assuming Mailable manages API endpoints

2. Which method must you define inside a Laravel Mailable class to set the email's view and subject?

easy

A. send()

B. compose()

C. build()

D. render()

Solution

1. Step 1: Recall Mailable class structure

   The build() method is where you define the email's view and subject in Laravel Mailable classes.

2. Step 2: Eliminate incorrect methods

   Methods like send(), compose(), and render() are not used in Laravel Mailable classes for this purpose.

3. Final Answer:

   build() -> Option C

4. Quick Check:

   Set email view and subject = build() method [OK]

Hint: Use build() to configure email content and subject [OK]

Common Mistakes:

• Using send() instead of build()
• Confusing build() with render()
• Trying to use compose() which is not a Laravel Mailable method

3. Given this Mailable class snippet, what will be the subject of the sent email?

class OrderShipped extends Mailable {
  public function build() {
    return $this->subject('Your order has shipped')->view('emails.shipped');
  }
}

medium

A. Your order has shipped

B. emails.shipped

C. OrderShipped

D. No subject set

Solution

1. Step 1: Analyze the build() method

   The build() method sets the subject using subject('Your order has shipped').

2. Step 2: Understand what the subject() method does

   This method sets the email's subject line to the given string.

3. Final Answer:

   Your order has shipped -> Option A

4. Quick Check:

   Email subject = 'Your order has shipped' [OK]

Hint: Subject is set by subject() inside build() [OK]

Common Mistakes:

• Confusing view name with subject
• Assuming class name is subject
• Thinking no subject is set without explicit call

4. Identify the error in this Mailable class code:

class WelcomeUser extends Mailable {
  public $user;

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

  public function build() {
    return $this->view('emails.welcome')->with('user');
  }
}

medium

A. Wrong method name instead of build()

B. Incorrect property declaration

C. Missing return statement in constructor

D. Missing argument in with() method

Solution

1. Step 1: Check the with() method usage

   The with() method requires a key-value pair or an array to pass data to the view, but here it only has a key string without a value.

2. Step 2: Verify other parts of the class

   Property declaration and constructor are correct, and the method name build() is correct.

3. Final Answer:

   Missing argument in with() method -> Option D

4. Quick Check:

   with() needs key and value [OK]

Hint: with() needs key and value to pass data [OK]

Common Mistakes:

• Passing only key without value to with()
• Forgetting to return in build()
• Misnaming build() method

5. You want to send an email with a Mailable class that passes a user's name and order ID to the view. Which is the correct way to pass this data inside the build() method?

hard

A. return $this->view('emails.order')->with('name', $this->name, 'orderId', $this->orderId);

B. return $this->view('emails.order')->with(['name' => $this->name, 'orderId' => $this->orderId]);

C. return $this->view('emails.order')->with('name', $this->name)->with('orderId');

D. return $this->view('emails.order')->with(['name', $this->name, 'orderId', $this->orderId]);

Solution

1. Step 1: Understand how to pass multiple data items

   The with() method accepts an associative array to pass multiple variables to the view.

2. Step 2: Analyze each option's syntax

   return $this->view('emails.order')->with(['name' => $this->name, 'orderId' => $this->orderId]); correctly uses an array with keys and values. return $this->view('emails.order')->with('name', $this->name)->with('orderId'); misses value for 'orderId'. return $this->view('emails.order')->with('name', $this->name, 'orderId', $this->orderId); passes too many arguments. return $this->view('emails.order')->with(['name', $this->name, 'orderId', $this->orderId]); uses a numeric array instead of associative.

3. Final Answer:

   return $this->view('emails.order')->with(['name' => $this->name, 'orderId' => $this->orderId]); -> Option B

4. Quick Check:

   Pass multiple data as associative array in with() [OK]

Hint: Use associative array in with() for multiple data [OK]

Common Mistakes:

• Passing multiple arguments instead of one array
• Omitting values for keys in with()
• Using numeric array instead of associative