For easy email sending, Laravel, one of the most well-liked PHP frameworks, has a powerful mailing system. The Mail facade, which Laravel leverages, makes it simple to set up and send emails using a variety of providers, including SMTP, Mailgun, Postmark, and Amazon SES. In this article, we will learn to know about sending emails in Laravel, from configuration to sending dynamic emails with attachments.
1. Configuring Email in Laravel
Before sending emails, you need to configure Laravel to use a mail driver. Open the .env file and set up your mail credentials:
MAIL_MAILER=smtp MAIL_HOST=smtp.mailtrap.io MAIL_PORT=2525 MAIL_USERNAME=your_username MAIL_PASSWORD=your_password MAIL_ENCRYPTION=tls MAIL_FROM_ADDRESS=example@example.com MAIL_FROM_NAME="Your Application"
You must configure each service's unique credentials if you're using Mailgun, Postmark, or SES.
2. Creating Mailable Class
Laravel provides the php artisan make:mail command to create a mailable class:
php artisan make:mail OrderShipped
This command generates a new file in app/Mail/OrderShipped.php. Open this file and modify the build() method to define the email content:
namespace App\Mail;
use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
class OrderShipped extends Mailable
{
use Queueable, SerializesModels;
public $order;
public function __construct($order)
{
$this->order = $order;
}
public function build()
{
return $this->from('example@example.com')
->subject('Order Shipped')
->view('emails.orders.shipped')
->with(['order' => $this->order]);
}
}
3. Creating an Email View
In resources/views/emails/orders/shipped.blade.php, create an email template:
<!DOCTYPE html>
<html>
<head>
<title>Order Shipped</title>
</head>
<body>
<h1>Your Order has been Shipped</h1>
<p>Order ID: {{ $order->id }}</p>
<p>Thank you for shopping with us!</p>
</body>
</html>
4. Sending an Email
To send an email, use the Mail::to() method in a controller:
use App\Mail\OrderShipped;
use Illuminate\Support\Facades\Mail;
use App\Models\Order;
public function sendOrderShippedEmail($orderId)
{
$order = Order::find($orderId);
Mail::to('customer@example.com')->send(new OrderShipped($order));
return "Email sent successfully!";
}
5. Sending Emails with Attachments
To send emails with attachments, modify the build() method:
public function build()
{
return $this->from('example@example.com')
->subject('Order Shipped')
->view('emails.orders.shipped')
->with(['order' => $this->order])
->attach(storage_path('invoices/order-' . $this->order->id . '.pdf'));
}
6. Queueing Emails
To send emails asynchronously, use Laravel’s queue system. Modify the OrderShipped mailable class:
class OrderShipped extends Mailable implements ShouldQueue
Then, dispatch the email using the queue() method:
Mail::to('customer@example.com')->queue(new OrderShipped($order));
Run the queue worker:
php artisan queue:work
7. Sending Emails to Multiple Recipients
To send emails to multiple recipients:
Mail::to(['user1@example.com', 'user2@example.com'])->send(new OrderShipped($order));
You can also send emails using cc() and bcc():
Mail::to('customer@example.com')
->cc('manager@example.com')
->bcc('admin@example.com')
->send(new OrderShipped($order));
8. Testing Email Sending in Laravel
Laravel provides Mail::fake() for testing email sending:
use Illuminate\Support\Facades\Mail;
use Tests\TestCase;
use App\Mail\OrderShipped;
public function test_email_is_sent()
{
Mail::fake();
$order = Order::factory()->create();
Mail::to('test@example.com')->send(new OrderShipped($order));
Mail::assertSent(OrderShipped::class);
}
Conclusion
With this guide, you can easily incorporate email sending into your Laravel projects. Laravel offers all the tools you need for efficient email handling, whether you need to send basic emails, attach files, queue emails, send Markdown emails, schedule emails, or send to multiple recipients.
