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

serpapi logo
SerpApi

The Web Search API for Your LLM and AI Applications

Visit SerpApi

The latest

View all →
Laravel Rulebook: Business Rules That Change by Date image

Laravel Rulebook: Business Rules That Change by Date

Read article
Taylor disabled GitHub Issues on most Laravel open-source packages. image

Taylor disabled GitHub Issues on most Laravel open-source packages.

Read article
Exclude Vendor and Default Commands in `php artisan dev` image

Exclude Vendor and Default Commands in `php artisan dev`

Read article
The Laracon Archive image

The Laracon Archive

Read article
Group Adjacent Collection Items in Laravel with chunkBy() image

Group Adjacent Collection Items in Laravel with chunkBy()

Read article
Laravel queue:work Now Prints Why the Worker Stopped image

Laravel queue:work Now Prints Why the Worker Stopped

Read article