recranet/symfony-skills

symfony-mailer

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

ソースを見る

使い方

  1. インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
  2. 必要なツール、認証情報、対応環境を原文で確認します。
  3. 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/recranet/symfony-skills --skill symfony-mailer

開始前の確認

  • 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
  • スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

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

タスクに関連する項目