[BUGFIX] Cleanup Spool Mailer feature
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / master / Feature-76349-IntegrateSwiftMailersSpoolTransportIntoTYPO3.rst
1 .. include:: ../../Includes.txt
2
3 =====================================================================
4 Feature: #76349 - Integrate Swift Mailer's spool transport into TYPO3
5 =====================================================================
6
7 See :issue:`76349`
8
9 Description
10 ===========
11
12 The default behavior of the TYPO3 mailer is to send the email messages immediately. You may, however, want to avoid
13 the performance hit of the communication to the email server, which could cause the user to wait for the next page to
14 load while the email is sending. This can be avoided by choosing to "spool" the emails instead of sending them directly.
15
16 This makes the mailer to not attempt to send the email message but instead save it somewhere such as a file. Another
17 process can then read from the spool and take care of sending the emails in the spool. Currently only spooling to file
18 or memory is supported.
19
20 .. note::
21
22    If you are running a multi-head environment consider using a different solution for mail spooling
23    than the options presented here.
24
25
26 Spool Using Memory
27 ==================
28
29 When you use spooling to store the emails to memory, they will get sent right before the kernel terminates. This means
30 the email only gets sent if the whole request got executed without any unhandled exception or any errors. To configure
31 this spool, use the following configuration:
32
33 .. code-block:: php
34
35    $GLOBALS['TYPO3_CONF_VARS']['MAIL']['transport_spool_type'] = 'memory';
36
37
38 Spool Using Files
39 =================
40
41 When using the filesystem for spooling, you need to define in which folder TYPO3 stores the spooled files.
42 This folder will contain files for each email in the spool. So make sure this directory is writable by TYPO3 and not
43 accessible to the world (outside of the webroot).
44
45 In order to use the spool with files, use the following configuration:
46
47 .. code-block:: php
48
49    $GLOBALS['TYPO3_CONF_VARS']['MAIL']['transport_spool_type'] = 'file';
50    $GLOBALS['TYPO3_CONF_VARS']['MAIL']['transport_spool_filepath'] = '/folder/of/choice';
51
52 Now, when TYPO3 is instructed to send an email, it will not actually be sent but instead added to the spool. Sending the
53 messages from the spool is done separately. There is a console command to send the messages in the spool:
54
55 .. code-block:: php
56
57    ./typo3/sysext/core/bin/typo3 swiftmailer:spool:send
58
59
60 It has an option to limit the number of messages to be sent:
61
62 .. code-block:: php
63
64    ./typo3/sysext/core/bin/typo3 swiftmailer:spool:send --message-limit=10
65
66
67 You can also set the time limit in seconds:
68
69 .. code-block:: php
70
71    ./typo3/sysext/core/bin/typo3 swiftmailer:spool:send --time-limit=10
72
73
74 Of course you will not want to run this manually in reality. Instead, the console command should be triggered by a cron
75 job or scheduled task and run at a regular interval.
76
77 .. index:: PHP-API, NotScanned