Warning: You are browsing the documentation for Symfony 2.0, which is no longer maintained.
Read the updated version of this page for Symfony 5.3 (the current stable version).
How to Spool Emails
How to Spool Emails¶
When you are using the
SwiftmailerBundle to send an email from a Symfony2
application, it will default to sending the email immediately. You may, however,
want to avoid the performance hit of the communication between
and the email transport, which could cause the user to wait for the next
page to load while the email is sending. This can be avoided by choosing
to “spool” the emails instead of sending them directly. This means that
does not attempt to send the email but instead saves the message to somewhere
such as a file. Another process can then read from the spool and take care
of sending the emails in the spool. Currently only spooling to file is supported
In order to use the spool, use the following configuration:
1 2 3 4 5 6
# app/config/config.yml swiftmailer: # ... spool: type: file path: /path/to/spool
1 2 3 4 5 6 7 8 9 10 11 12
<!-- app/config/config.xml --> <!-- xmlns:swiftmailer="http://symfony.com/schema/dic/swiftmailer" http://symfony.com/schema/dic/swiftmailer http://symfony.com/schema/dic/swiftmailer/swiftmailer-1.0.xsd --> <swiftmailer:config> <swiftmailer:spool type="file" path="/path/to/spool" /> </swiftmailer:config>
1 2 3 4 5 6 7 8 9
// app/config/config.php $container->loadFromExtension('swiftmailer', array( // ... 'spool' => array( 'type' => 'file', 'path' => '/path/to/spool', ), ));
If you want to store the spool somewhere with your project directory, remember that you can use the %kernel.root_dir% parameter to reference the project’s root:
Now, when your app sends an email, it will not actually be sent but instead added to the spool. Sending the messages from the spool is done separately. There is a console command to send the messages in the spool:
$ php app/console swiftmailer:spool:send --env=prod
It has an option to limit the number of messages to be sent:
$ php app/console swiftmailer:spool:send --message-limit=10 --env=prod
You can also set the time limit in seconds:
$ php app/console swiftmailer:spool:send --time-limit=10 --env=prod
Of course you will not want to run this manually in reality. Instead, the console command should be triggered by a cron job or scheduled task and run at a regular interval.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.