Skip to content

Added hints to spool config section #5848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Added hints to spool config section #5848

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2459f2
Added hints to spool config section
martinczerwi Oct 29, 2015
a854c7f
Added label for the old headline and fixed a typo
martinczerwi Oct 30, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions cookbook/email/spool.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add label for the old headline before:

.. _spool-using-a-file:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry, I don't get it. The Table of contents is updated automatically. Why should we do this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With a little icon next to each headline on symfony.com, we allow the readers to link to specific sections on a page. This is done by using the automatically created anchor (slugified headline text).

If we change the headline, the automatically generated anchor changes as well (in this case it was spool-using-a-file and now is spool-using-files). This means that all links to the specific section are broken. If we add the old anchor as well, both anchors will link to this section. It's like backwards compatibility for documentations.

------------------

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::

Expand All @@ -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

Expand All @@ -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>
Expand All @@ -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',
),
));

Expand Down