Installation¶

1

$ composer require symfony/mailer

Usage¶

The Mailer component has two main classes: a Transport and the Mailer itself:

1
2
3
4
5
6

use Symfony\Component\Mailer\Mailer;
use Symfony\Component\Mailer\Transport\Smtp\SmtpTransport;

$transport = new SmtpTransport('localhost');
$mailer = new Mailer($transport);
$mailer->send($email);

The $email object is created via the Mime component.

Transport¶

The only transport that comes pre-installed is SMTP.

Below is the list of other popular providers with built-in support:

For example, suppose you want to use Google's Gmail SMTP server. First, install it:

1

$ composer require symfony/google-mailer

Then, use the SMTP Gmail transport:

1
2
3
4
5

use Symfony\Component\Mailer\Bridge\Google\Smtp\GmailTransport;

$transport = new GmailTransport('user', 'pass');
$mailer = new Mailer($transport);
$mailer->send($email);

Each provider provides up to 3 transports: standard SMTP, HTTP (it uses the provider's API but the body is created by the mailer component), API (it uses the full API of the provider with no control over the body creation -- features might be limited as well).

The mailer component provides a convenient way to create a transport from a DSN:

use Symfony\Component\Mailer\Transport;

$transport = Transport::fromDsn($dsn);

Where $dsn depends on the provider you want to use. For plain SMTP, use smtp://user:pass@example.com or smtp://sendmail to use the sendmail binary. For third-party providers, refers to the following table:

Failover Transport¶

You can create failover transport with the help of || operator:

$dsn = 'api://[email protected] || smtp://[email protected]';

So if the first transport fails, the mailer will attempt to send through the second transport.

Round Robin¶

If you want to send emails by using multiple transports in a round-robin fashion, you can use the && operator between the transports:

$dsn = 'api://[email protected] && smtp://[email protected]'

Sending emails asynchronously¶

If you want to send emails asynchronously, install the Messenger component.

1

$ composer require symfony/messenger

Then, instantiate and pass a MessageBus as a second argument to Mailer:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

use Symfony\Component\Mailer\Mailer;
use Symfony\Component\Mailer\Messenger\MessageHandler;
use Symfony\Component\Mailer\Messenger\SendEmailMessage;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport;
use Symfony\Component\Messenger\Handler\HandlersLocator;
use Symfony\Component\Messenger\MessageBus;
use Symfony\Component\Messenger\Middleware\HandleMessageMiddleware;
use Symfony\Component\Mime\Address;

$dsn = 'change-dsn-accordingly';

$transport = Transport::fromDsn($dsn);
$handler = new MessageHandler($transport);

$bus = new MessageBus([
    new HandleMessageMiddleware(new HandlersLocator([
        SendEmailMessage::class => [$handler],
    ])),
]);

$mailer = new Mailer($transport, $bus);
$mailer->send($email);

// you can pass an optional Envelope
$mailer->send($email, new SmtpEnvelope(
    new Address('[email protected]'),
    [
        new Address('[email protected]'),
    ]
));

Learn More¶

To learn more about how to use the mailer component, refer to the Symfony Framework Mailer documentation.