E-mail versturen

Wat is de mailfunctionaliteit van Laravel

De mailfunctionaliteit van Laravel is gebouwd op Symfony Mailer en ondersteunt drivers als SMTP, Mailgun, Postmark, Resend, Amazon SES en sendmail.

SwiftMailer, dat in oudere versies van Laravel werd gebruikt, is uitgefaseerd. Vanaf Laravel 9 wordt Symfony Mailer gebruikt.

De mailconfiguratie beheer je in config/mail.php. In het .env-bestand wissel je van driver.

MAIL_MAILER=smtp
MAIL_HOST=smtp.example.com
MAIL_PORT=587
MAIL_USERNAME=your-username
MAIL_PASSWORD=your-password
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS="[email protected]"
MAIL_FROM_NAME="${APP_NAME}"

Een Mailable-klasse aanmaken

In Laravel wordt elke e-mail die de applicatie verstuurt weergegeven als een “Mailable”-klasse. Je genereert de klasse met het Artisan-commando make:mail.

php artisan make:mail OrderShipped

De gegenereerde klasse wordt geplaatst in de directory app/Mail/.

De Mailable configureren

De gegenereerde Mailable-klasse heeft drie methoden: envelope(), content() en attachments().

<?php

namespace App\Mail;

use App\Models\Order;
use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Mail\Mailables\Content;
use Illuminate\Mail\Mailables\Envelope;
use Illuminate\Queue\SerializesModels;

class OrderShipped extends Mailable
{
    use Queueable, SerializesModels;

    public function __construct(
        public Order $order,
    ) {}

    public function envelope(): Envelope
    {
        return new Envelope(
            subject: 'Je bestelling is verzonden',
        );
    }

    public function content(): Content
    {
        return new Content(
            view: 'mail.orders.shipped',
        );
    }

    public function attachments(): array
    {
        return [];
    }
}

De afzender instellen

In de methode envelope() geef je de afzender op.

use Illuminate\Mail\Mailables\Address;
use Illuminate\Mail\Mailables\Envelope;

public function envelope(): Envelope
{
    return new Envelope(
        from: new Address('[email protected]', 'Shop Support'),
        subject: 'Je bestelling is verzonden',
    );
}

Stel je in config/mail.php een globaal afzenderadres in, dan kun je de opgave in individuele Mailables achterwege laten.

'from' => [
    'address' => env('MAIL_FROM_ADDRESS', '[email protected]'),
    'name' => env('MAIL_FROM_NAME', 'Example'),
],

De mailinhoud instellen

In de methode content() geef je de Blade-template op. Data die je in de constructor aan public-properties toewijst, is automatisch beschikbaar in de template.

public function content(): Content
{
    return new Content(
        view: 'mail.orders.shipped',
    );
}

Maak de bijbehorende Blade-template aan (resources/views/mail/orders/shipped.blade.php).

<!DOCTYPE html>
<html>
<body>
    <h1>Je bestelling is verzonden</h1>
    <p>Bestelnummer: {{ $order->id }}</p>
    <p>Totaalbedrag: ¥{{ number_format($order->total) }}</p>
    <p>Bedankt voor je bestelling.</p>
</body>
</html>

Je kunt data ook expliciet doorgeven via de parameter with. In dat geval maak je de properties protected of private.

public function __construct(
    protected Order $order,
) {}

public function content(): Content
{
    return new Content(
        view: 'mail.orders.shipped',
        with: [
            'orderId' => $this->order->id,
            'total' => $this->order->total,
        ],
    );
}

Met de methode to() van de Mail-facade geef je de ontvanger op en met send() verstuur je de e-mail.

<?php

namespace App\Http\Controllers;

use App\Mail\OrderShipped;
use App\Models\Order;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Mail;

class OrderShipmentController extends Controller
{
    public function store(Request $request): RedirectResponse
    {
        $order = Order::findOrFail($request->order_id);

        Mail::to($request->user())->send(new OrderShipped($order));

        return redirect('/orders');
    }
}

Je kunt ook CC en BCC opgeven.

Mail::to($request->user())
    ->cc($ccUsers)
    ->bcc($bccUsers)
    ->send(new OrderShipped($order));

Om via een specifieke mailer te versturen gebruik je de methode mailer().

Mail::mailer('postmark')
    ->to($request->user())
    ->send(new OrderShipped($order));

E-mail versturen via de queue

Omdat het versturen van e-mail de responstijd beïnvloedt, wordt aanbevolen om via de queue op de achtergrond te versturen.

Mail::to($request->user())->queue(new OrderShipped($order));

Om de queue te gebruiken moet je vooraf de queue configureren en een worker starten.

Vertraagd versturen kan ook.

Mail::to($request->user())
    ->later(now()->plus(minutes: 10), new OrderShipped($order));

Implementeert de Mailable-klasse ShouldQueue, dan gaat de e-mail altijd de queue in, ook als je send() aanroept.

use Illuminate\Contracts\Queue\ShouldQueue;

class OrderShipped extends Mailable implements ShouldQueue
{
    // ...
}

De queueverbinding en queuenaam opgeven met PHP-attributen

Met PHP-attributen geef je de queueverbinding en queuenaam direct op de Mailable-klasse op. In plaats van de methodchain on()->queue() kun je dit declaratief op klasseniveau instellen.

use Illuminate\Queue\Attributes\Connection;
use Illuminate\Queue\Attributes\Queue;

#[Connection('sqs')]
#[Queue('emails')]
class OrderShipped extends Mailable implements ShouldQueue
{
    // ...
}

Op deze manier maak je in de klassedefinitie expliciet dat deze Mailable altijd naar de emails-queue van de SQS-verbinding wordt gestuurd.

Markdown-mails maken

Met e-mails in Markdown-formaat profiteer je van de fraaie, responsive HTML-templates die Laravel meelevert.

Een Markdown-Mailable genereren

Genereer de Mailable met de optie --markdown.

php artisan make:mail OrderShipped --markdown=mail.orders.shipped

In de methode content() gebruik je de parameter markdown.

use Illuminate\Mail\Mailables\Content;

public function content(): Content
{
    return new Content(
        markdown: 'mail.orders.shipped',
        with: [
            'url' => route('orders.show', $this->order),
        ],
    );
}

De Markdown-template schrijven

Je stelt de mailinhoud samen met de Blade-componenten die Laravel meelevert.

<x-mail::message>
# Je bestelling is verzonden

Hierbij laten we je weten dat je bestelling is verzonden.

<x-mail::button :url="$url">
Bestelling bekijken
</x-mail::button>

Bedankt voor je bestelling.<br>
{{ config('app.name') }}
</x-mail::message>

De beschikbare componenten zijn als volgt.

Component	Beschrijving
`<x-mail::button>`	Knoplink (voor `color` kun je `primary`, `success` of `error` opgeven)
`<x-mail::panel>`	Opvallend paneelgebied
`<x-mail::table>`	Tabel in Markdown-formaat

Van Markdown-mails wordt automatisch ook een platte-tekstversie gegenereerd. Zo zijn ze ook leesbaar in mailclients die geen HTML-mail ondersteunen.

E-mails previewen

Geef je in een route een Mailable-instantie terug, dan kun je de e-mail in de browser previewen. Handig om te controleren tijdens de ontwikkeling.

// routes/web.php
Route::get('/mailable', function () {
    $order = App\Models\Order::first();
    return new App\Mail\OrderShipped($order);
});

E-mail tijdens lokale ontwikkeling

Om te voorkomen dat je per ongeluk e-mails in productie verstuurt, is het handig om bij lokale ontwikkeling tools als Mailpit te gebruiken.

# .env (Mailpit)
MAIL_MAILER=smtp
MAIL_HOST=127.0.0.1
MAIL_PORT=1025

In Laragon en Laravel Herd is Mailpit standaard inbegrepen.

Met de log-driver wordt de inhoud van e-mails vastgelegd in het logbestand. Wil je alleen controleren dat er e-mail wordt verstuurd, dan is dit de eenvoudigste methode.

MAIL_MAILER=log

Samenvatting

Wat je wilt doen	Hoe
Een Mailable aanmaken	`php artisan make:mail ClassName`
De afzender instellen	De parameter `from` van `envelope()`
Een Blade-template gebruiken	De parameter `view` van `content()`
Een Markdown-template gebruiken	De parameter `markdown` van `content()`
E-mail versturen	`Mail::to()->send()`
Versturen via de queue	`Mail::to()->queue()`
Vertraagd versturen	`Mail::to()->later()`

Architectuur

Database

Eloquent

Beveiliging

Events

E-mail en notificaties

Betalingen

Asynchrone verwerking

Realtime communicatie

Taakplanning

Caching en optimalisatie

Internationalisatie

Bestanden en opslag

Debugging en monitoring

Console en CLI

Performance

Frontend

AI-ontwikkeling

Ontwikkelomgeving

E-mail versturen

Wat is de mailfunctionaliteit van Laravel

Een Mailable-klasse aanmaken

De Mailable configureren

De afzender instellen

De mailinhoud instellen

E-mail versturen

E-mail versturen via de queue

De queueverbinding en queuenaam opgeven met PHP-attributen

Markdown-mails maken

Een Markdown-Mailable genereren

De Markdown-template schrijven

E-mails previewen

E-mail tijdens lokale ontwikkeling

Samenvatting

​Wat is de mailfunctionaliteit van Laravel

​Een Mailable-klasse aanmaken

​De Mailable configureren

​De afzender instellen

​De mailinhoud instellen

​E-mail versturen

​E-mail versturen via de queue

​De queueverbinding en queuenaam opgeven met PHP-attributen

​Markdown-mails maken

​Een Markdown-Mailable genereren

​De Markdown-template schrijven

​E-mails previewen

​E-mail tijdens lokale ontwikkeling

​Samenvatting

Wat is de mailfunctionaliteit van Laravel

Een Mailable-klasse aanmaken

De Mailable configureren

De afzender instellen

De mailinhoud instellen

E-mail versturen

E-mail versturen via de queue

De queueverbinding en queuenaam opgeven met PHP-attributen

Markdown-mails maken

Een Markdown-Mailable genereren

De Markdown-template schrijven

E-mails previewen

E-mail tijdens lokale ontwikkeling

Samenvatting