minor #5848 Added hints to spool config section (martinczerwi)

xabbuh · xabbuh · commit e67030f236af · 2015-12-31T13:54:48.000+01:00
This PR was submitted for the 2.7 branch but it was merged into the 2.3 branch instead (closes #5848). Discussion ---------- Added hints to spool config section | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | - The former explanation suggests that a single file is used for spooling, which is not the case of course. But I ran into that problem and since Symfony falls back to memory if the dir is not writable (as it seems) with no error message, this addition might help some people to get spools running. Commits ------- a460028 Added hints to spool config section
diff --git a/cookbook/email/spool.rst b/cookbook/email/spool.rst
@@ -55,10 +55,17 @@ swiftmailer with the memory option, use the following configuration:
             'spool' => array('type' => 'memory')
         ));
 
-Spool Using a File
+.. _spool-using-a-file:
+
+Spool Using Files
 ------------------
 
-In order to use the spool with a file, use the following configuration:
+When you use the filesystem for spooling, Symfony creates a folder in the given 
+path for each mail service (e.g. "default" for the default service). This folder
+will contain files for each email in the spool. So make sure this directory is 
+writable by Symfony (or your webserver/php)!
+
+In order to use the spool with files, use the following configuration:
 
 .. configuration-block::
 
@@ -69,7 +76,7 @@ In order to use the spool with a file, use the following configuration:
             # ...
             spool:
                 type: file
-                path: /path/to/spool
+                path: /path/to/spooldir
 
     .. code-block:: xml
 
@@ -84,7 +91,7 @@ In order to use the spool with a file, use the following configuration:
             <swiftmailer:config>
                 <swiftmailer:spool
                     type="file"
-                    path="/path/to/spool"
+                    path="/path/to/spooldir"
                 />
             </swiftmailer:config>
         </container>
@@ -97,7 +104,7 @@ In order to use the spool with a file, use the following configuration:
 
             'spool' => array(
                 'type' => 'file',
-                'path' => '/path/to/spool',
+                'path' => '/path/to/spooldir',
             ),
         ));
 
