Laravel Mail Intercept
A testing package for intercepting mail sent from Laravel
This testing suite intercepts Laravel Mail just before they are sent out, allowing all kinds of assertions to be made on the actual emails themselves.
Mail isn't faked here. You get to inspect the actual mail ensuring you are sending exactly what you want!
Requirements
This testing package requires Laravel 5.5 or higher.
Installation
composer require kirschbaum-development/mail-intercept --dev
Usage
Next you can use the KirschbaumDevelopment\MailIntercept\WithMailInterceptor trait in your test class:
namespace Tests;
use App\Mail\TestMail;
use Illuminate\Support\Facades\Mail;
use Illuminate\Foundation\Testing\WithFaker;
use KirschbaumDevelopment\MailIntercept\WithMailInterceptor;
class MailTest extends TestCase
{
use WithFaker,
WithMailInterceptor;
public function testMail()
{
$this->interceptMail();
$email = $this->faker->email;
Mail::to($email)->send(new TestMail());
$interceptedMail = $this->interceptedMail()->first();
$this->assertMailSentTo($email, $interceptedMail);
}
}
That's it! Pretty simple, right?!
Testing API
$this->interceptMail()
This method MUST be called first, similar to how Mail::fake() works. But unlike the mail fake, mail is not faked, it is intercepted.
$this->interceptedMail()
This should be called after Mail has been sent, but before your assertions, otherwise you won't have any emails to work with. It returns a Collection of emails so you are free to use any of the methods available to a collection.
| Assertions | Parameters |
|---|---|
$this->assertMailSentTo($to, $mail); |
$to string, array$mail Swift_Message |
$this->assertMailNotSentTo($to, $mail); |
$to string, array$mail Swift_Message |
$this->assertMailSentFrom($from, $mail); |
$from string, array$mail Swift_Message |
$this->assertMailNotSentFrom($from, $mail); |
$from string, array$mail Swift_Message |
$this->assertMailSubject($subject, $mail); |
$subject string$mail Swift_Message |
$this->assertMailNotSubject($subject, $mail); |
$subject string$mail Swift_Message |
$this->assertMailBodyContainsString($content, $mail); |
$content string$mail Swift_Message |
$this->assertMailBodyNotContainsString($content, $mail); |
$content string$mail Swift_Message |
$this->assertMailRepliesTo($reply, $mail); |
$reply string, array$mail Swift_Message |
$this->assertMailNotRepliesTo($reply, $mail); |
$reply string, array$mail Swift_Message |
$this->assertMailCc($cc, $mail); |
$cc string, array$mail Swift_Message |
$this->assertMailNotCc($cc, $mail); |
$cc string, array$mail Swift_Message |
$this->assertMailBcc($cc, $mail); |
$bcc string, array$mail Swift_Message |
$this->assertMailNotBcc($cc, $mail); |
$bcc string, array$mail Swift_Message |
$this->assertMailSender($sender, $mail); |
$sender string, array$mail Swift_Message |
$this->assertMailNotSender($sender, $mail); |
$sender string, array$mail Swift_Message |
$this->assertMailIsPlain($mail); |
$mail Swift_Message |
$this->assertMailIsNotPlain($mail); |
$mail Swift_Message |
$this->assertMailIsHtml($mail); |
$mail Swift_Message |
$this->assertMailIsNotHtml($mail); |
$mail Swift_Message |
| Header Assertions | Parameters |
|---|---|
$this->assertMailHasHeader($header, $mail); |
$header string$mail Swift_Message |
$this->assertMailMissingHeader($header, $mail); |
$header string$mail Swift_Message |
$this->assertMailHeaderIs($header, $value, $mail); |
$header string$value string$mail Swift_Message |
$this->assertMailHeaderIsNot($header, $value, $mail); |
$header string$value string$mail Swift_Message |
You should use each item of the interceptedMail() collection as the mail object for all assertions.
If you are injecting your own headers or need access to other headers in the email, use this assertion to verify they exist and are set properly. These assertions require the header name and the compiled email.
Other assertions
Since $this->interceptedMail() returns a collection of Swift_Message objects, you are free to dissect and look into those objects using any methods available to Swift's Message API. Head over to the Swift Mail Docs for more detailed info.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] or [email protected] instead of using the issue tracker.
Credits
Sponsorship
Development of this package is sponsored by Kirschbaum Development Group, a developer driven company focused on problem solving, team building, and community. Learn more about us or join us!
License
The MIT License (MIT). Please see License File for more information.
1k Jan 4, 2023
54 Dec 16, 2022
64 Dec 24, 2022
34 Dec 24, 2022
94 Aug 30, 2022
88 Dec 29, 2022
2 Sep 30, 2022
43 Jan 7, 2023
82 Jan 16, 2022
755 Jan 3, 2023
61 Dec 6, 2022
684 Dec 26, 2022
4 Nov 16, 2021
2 Dec 8, 2021
2 Jun 21, 2022
2 Dec 12, 2022
300 Dec 30, 2022
530 Jan 6, 2023