recranet/symfony-skills

symfony-mailer

Send email with symfony/mailer - Email and TemplatedEmail, transports and DSNs, async sending via Messenger, Mailpit in dev.

Voir la source

Mode d’emploi

  1. Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
  2. Consultez le document original pour les outils, identifiants et environnements requis.
  3. Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/recranet/symfony-skills --skill symfony-mailer

Avant de commencer

  • L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
  • Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Document Skill original

Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.

symfony/mailer

If the project contains .ddev/config.yaml, prefix every shell command with ddev (full mapping in the symfony skill's references/ddev.md). Examples target Symfony 7.4, 8.0 and newer — verify the installed version before using newer features.

When to use

You need to send email — transactional notifications, password resets, digest emails, etc. Supports SMTP, plus transports for SendGrid, Mailgun, Postmark, SES, Brevo, and others.

Replaces

  • PHPMailer
  • SwiftMailer (EOL)
  • Vendor SDKs called purely to send mail (SendGrid, Mailgun PHP SDK, etc.)
  • Raw mail() calls

Install

composer require symfony/mailer
# transport bridges (pick one):
composer require symfony/sendgrid-mailer
composer require symfony/mailgun-mailer
composer require symfony/amazon-mailer

Set MAILER_DSN in .env (e.g., sendgrid+api://KEY@default).

Minimal example

php
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\Mailer\MailerInterface;

public function __construct(private MailerInterface $mailer) {}

public function sendWelcome(string $to): void
{
    $email = (new TemplatedEmail())
        ->from('noreply@example.com')
        ->to($to)
        ->subject('Welcome!')
        ->htmlTemplate('emails/welcome.html.twig')
        ->context(['user' => $to]);

    $this->mailer->send($email);
}

Common patterns

Plain Email (no Twig)

php
use Symfony\Component\Mime\Email;

$email = (new Email())
    ->from('noreply@example.com')
    ->to('alice@example.com')
    ->subject('Receipt')
    ->text('Plain body')
    ->html('<p>HTML body</p>');

$this->mailer->send($email);

Attachments

php
$email->attachFromPath('/path/to/invoice.pdf', 'invoice.pdf', 'application/pdf');
// or inline:
$email->embedFromPath('/path/to/logo.png', 'logo');
// reference in template as <img src="cid:logo">

Async via Messenger (recommended for any user-facing flow)

In Flex projects MAILER_DSN is wired through Messenger automatically if a messenger.transport.async is configured. Otherwise:

yaml
# config/packages/messenger.yaml
framework:
    messenger:
        transports:
            async: '%env(MESSENGER_TRANSPORT_DSN)%'
        routing:
            'Symfony\Component\Mailer\Messenger\SendEmailMessage': async

The mailer then enqueues SendEmailMessage; a worker consumes and sends.

Multiple mailer transports

yaml
framework:
    mailer:
        transports:
            main: '%env(MAILER_DSN)%'
            newsletter: '%env(NEWSLETTER_DSN)%'

Pick at send time:

php
$email->getHeaders()->addTextHeader('X-Transport', 'newsletter');

Gotchas

  • TemplatedEmail requires symfony/twig-bundle.
  • from() is mandatory; configure a project-wide default via

framework.mailer.envelope to avoid setting it everywhere.

  • In dev, use MAILER_DSN=null://null to swallow mail, or point at

Mailpit/MailHog for inspection. ddev bundles Mailpit by default — see the symfony skill's references/ddev.md for the DSN and how to open its UI.

  • For DKIM/SPF you must configure the transport's account — Symfony just

hands the message off.

Docs

https://symfony.com/doc/7.4/mailer.html

Tâches connexes