55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
# Mail best practices
|
|
|
|
## Queue slow mail delivery
|
|
|
|
Implement `ShouldQueue` on a mailable when delivery should normally happen in the background. Laravel queues that mailable even when the call site uses `Mail::send()`.
|
|
|
|
```php
|
|
class OrderShipped extends Mailable implements ShouldQueue
|
|
{
|
|
use Queueable, SerializesModels;
|
|
}
|
|
```
|
|
|
|
Keep mail synchronous when the caller must know immediately whether delivery was accepted, or when no queue worker is available.
|
|
|
|
## Dispatch queued mail after commit
|
|
|
|
A queue worker can process a queued mailable dispatched during a database transaction before the transaction commits. Call `afterCommit()` on the mailable, or enable the queue connection's `after_commit` option, when the mail depends on committed records.
|
|
|
|
```php
|
|
Mail::to($user)->send(
|
|
(new OrderShipped($order))->afterCommit()
|
|
);
|
|
```
|
|
|
|
If the transaction rolls back, Laravel does not dispatch an after-commit mailable. The after-commit setting affects only queued mail. It does not defer synchronous delivery.
|
|
|
|
## Assert the delivery mode
|
|
|
|
Use `Mail::assertQueued()` for queued mailables and `Mail::assertSent()` for synchronously sent mailables.
|
|
|
|
Incorrect for a mailable that implements `ShouldQueue`:
|
|
|
|
```php
|
|
Mail::assertSent(OrderShipped::class);
|
|
```
|
|
|
|
Correct:
|
|
|
|
```php
|
|
Mail::assertQueued(OrderShipped::class);
|
|
```
|
|
|
|
## Use Markdown mailables when they fit
|
|
|
|
Markdown mailables render HTML and plain-text versions from Laravel's mail components and support publishable themes. They suit conventional transactional messages. A custom HTML and text pair may fit a specialized design better.
|
|
|
|
```bash
|
|
php artisan make:mail OrderShipped --markdown=mail.orders.shipped
|
|
```
|
|
|
|
## Separate content and delivery tests
|
|
|
|
Test rendered content by instantiating the mailable and using assertions such as `assertSeeInHtml()` and `assertSeeInText()`. Test delivery separately with `Mail::fake()` and `assertSent()` or `assertQueued()` so failures identify the affected behavior.
|