Laravel Tutorials

Avoiding Accidental Email Sends with alwaysTo()

Published
Avoiding Accidental Email Sends with alwaysTo() image

There's an (as of yet) undocumented way in Laravel to prevent it from sending emails to any old address.

Why is this useful? Well, some of us aren't perfect 😅. Sometimes we accidentally send thousands of emails to real customers from our staging environment or even in our tests.

There are lots of ways to avoid this, but Laravel has a nice, easy method out of the box!

# File app/Providers/AppServiceProvider.php
 
use Illuminate\Support\Facades\Mail;
use Illuminate\Support\ServiceProvider;
 
class AppServiceProvider extends ServiceProvider
{
// Stuff omitted
 
public function boot()
{
f (! app()->environment('production')) {
Mail::alwaysTo('foo@example.org');
}
}
}

What's Happening with alwaysTo?

The handy alwaysTo() method will over-ride all addresses added in the to, cc, and bcc within an email message.

This is done within the Illuminate\Mail\Mailer class (see here). Note the code comment:

// If a global "to" address has been set, we will set that address on the mail
// message. This is primarily useful during local development in which each
// message should be delivered into a single mail address for inspection.
if (isset($this->to['address'])) {
$this->setGlobalToAndRemoveCcAndBcc($message);
}

So, in our code up above, we tell Laravel to only send emails to foo@example.org if we are NOT in the production environment!

Chris Fidao photo

Teaching coding and servers at CloudCasts and Servers for Hackers. Co-founder of Chipper CI.

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
Lerd: A Free, Open Source Herd Alternative for Linux and macOS image

Lerd: A Free, Open Source Herd Alternative for Linux and macOS

Read article
Let's Encrypt HTTPS on an IP Address With FrankenPHP image

Let's Encrypt HTTPS on an IP Address With FrankenPHP

Read article
Laravel Chores: Resumable Data Operations and Cleanups image

Laravel Chores: Resumable Data Operations and Cleanups

Read article
NativePHP v4: Build Native iOS and Android UI in Blade image

NativePHP v4: Build Native iOS and Android UI in Blade

Read article
Laravel Lock: Distributed Locks for Models and Routes image

Laravel Lock: Distributed Locks for Models and Routes

Read article
Laravel Image Responses: Serve Resized Images From Routes image

Laravel Image Responses: Serve Resized Images From Routes

Read article