3c9ceda872
- Replaced instances of `vendor/bin/sail` with `php` in various documentation files to standardize command usage. - Updated `.mcp.json` and `.cursor/mcp.json` to reflect the new command for Laravel Boost. - Adjusted skill documentation files for Cashier, Horizon, MCP, Passport, Pest, and Wayfinder to enhance clarity and ensure proper command execution. - Disabled Sail support in `boost.json` and added "codex" as a new agent. Co-authored-by: Cursor <cursoragent@cursor.com>
27 lines
1.2 KiB
Markdown
27 lines
1.2 KiB
Markdown
# Mail Best Practices
|
|
|
|
## Implement `ShouldQueue` on the Mailable Class
|
|
|
|
Makes queueing the default regardless of how the mailable is dispatched. No need to remember `Mail::queue()` at every call site — `Mail::send()` also queues it.
|
|
|
|
## Use `afterCommit()` on Mailables Inside Transactions
|
|
|
|
A queued mailable dispatched inside a transaction may process before the commit. Use `$this->afterCommit()` in the constructor.
|
|
|
|
## Use `assertQueued()` Not `assertSent()` for Queued Mailables
|
|
|
|
`Mail::assertSent()` only catches synchronous mail. Queued mailables fail `assertSent` with a "Did you mean to use assertQueued()?" hint.
|
|
|
|
Incorrect: `Mail::assertSent(OrderShipped::class);` when mailable implements `ShouldQueue`.
|
|
|
|
Correct: `Mail::assertQueued(OrderShipped::class);`
|
|
|
|
## Use Markdown Mailables for Transactional Emails
|
|
|
|
Markdown mailables auto-generate both HTML and plain-text versions, use responsive components, and allow global style customization. Generate with `--markdown` flag.
|
|
|
|
## Separate Content Tests from Sending Tests
|
|
|
|
Content tests: instantiate the mailable directly, call `assertSeeInHtml()`.
|
|
Sending tests: use `Mail::fake()` and `assertSent()`/`assertQueued()`.
|
|
Don't mix them — it conflates concerns and makes tests brittle.
|