Skip to content

Commit

Permalink
[TASK] Adjust Documentation for TYPO3 9 compatible version
Browse files Browse the repository at this point in the history
- Change for new usage of cli script using symphony/console
- Rewrite default extension requirements
  • Loading branch information
jokumer committed Oct 14, 2019
1 parent 505e6d3 commit 60b4513
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 40 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. ==================================================
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
Expand All @@ -16,8 +16,6 @@ engine.

#. The CLI script

#. Using scheduled task with Gabriel (Ext: Gabriel)

It's :underline:`recommended` to use the scheduler option to
automatically invoking the mailer engine.

Expand All @@ -40,28 +38,14 @@ with checked “Save these settings as draft” checkbox.
Configuring the CLI script
""""""""""""""""""""""""""

Since TYPO3 4.x there is a CLI mode for TYPO3. The direct\_mail CLI
script uses the new CLI-API, which is available since TYPO3 4.1.x.

Before writing a cron task in your crontab, a BE-user with the name of
\_cli\_direct\_mail” has to be created. This user must have no
administrator right. After creating the BE-user, you can write the
following line in the crontab:
Send newsletters directly via CLI by invoking mailer engine is done by:

.. code-block:: shell
*/5 * * * * /ABS/PATH/TO/SITE/typo3/cli_dispatch.phpsh direct_mail masssend
This will call the CLI-script with two parameters: the extension's key
(direct\_mail) and a task (masssend).
/ABS/PATH/TO/BINARY/typo3 direct_mail:invokemailerengine
For help and further information or options, execute following command:

Configuring direct\_mail on Gabriel
"""""""""""""""""""""""""""""""""""

This is also deprecated, since Gabriel extension is renamed Scheduler
and since 4.5.x a system extension.

Please refer to the documentation of Gabriel. The direct\_mail task
will be shown in the list of task automatically.
.. code-block:: shell
/ABS/PATH/TO/BINARY/ direct_mail:invokemailerengine --help
11 changes: 5 additions & 6 deletions Documentation/Introduction/Requirements/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,14 @@ Requirements
------------

Extension Direct Mail (extension key: direct\_mail) requires TYPO3
6.2.2+ and PHP 5.3.3+.
9.5 which requires PHP 7.2

Version 1.1.0 is the last version of this extension that will work
with TYPO3 3.8.
Prerequisites
'''''''''''''

Version 3.1.2 is the last version of this extension that will work
with TYPO3 4.5
Extension Address list (tt\_address)

Extension Address list (tt\_address) is a prerequisite.
Extension rdct

Please read the upgrading section, before you're upgrading your
direct\_mail installation.
4 changes: 2 additions & 2 deletions Documentation/Settings.cfg
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[general]

project = Direct mail system
version = 5.2
release = 5.2.2
version = 6.0
release = 6.0.0
t3author = Ivan Kartolo
copyright = 2002-2019

Expand Down
11 changes: 1 addition & 10 deletions Documentation/Upgrading/UpgradingToVersion600/Index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,9 @@


.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. ==================================================
.. DEFINE SOME TEXTROLES
.. --------------------------------------------------
.. role:: underline
.. role:: typoscript(code)
.. role:: ts(typoscript)
:class: typoscript
.. role:: php(code)
.. include:: ../../Includes.txt


Upgrading to version 6.0.0
Expand Down

0 comments on commit 60b4513

Please sign in to comment.