DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
dkd_news2directmail¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed by: | Ivan Kartolo |
Changed: | 2010-05-28T19:03:09 |
Author: | Ivan Kartolo |
Email: | ivan.kartolo@dkd.de |
Info 3: | |
Info 4: |
dkd_news2directmail¶
Extension Key: dkd_news2directmail
Copyright 2000-2007, Ivan Kartolo, <ivan.kartolo@dkd.de>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.com
Table of Contents¶
dkd_news2directmail 1
Introduction 1
What does it do? 1
Screenshots 1
Users manual 2
Configuration 2
Reference 4
Known problems 4
To-Do list 4
Changelog 4
Introduction¶
What does it do?¶
This extension creates a newsletter based on a tt_news record. The sending of the newsletter is done by Direct Mail ( direct_mail ).
To make sure that this extension is working, you should be sure that tt_news and direct_mail are installed and worked.
The version 0.1.0 of dkd_news2directmail is working with direct_mail version lower than 2.5.x or higher than 2.5.x.
Users manual¶
To send a tt_news record as a newsletter, you only need to check the “send as direct mail” flag. This flag is placed on the end of tt_news BE-form (see second screenshot)
Configuration¶
Before configuring this extension, you should make sure that tt_news and direct_mail are working. It means that you should be able to send a newsletter using direct_mail.
In the page, which will be you newsletter, there should be a single view of tt_news. How to create this view, please review the manual of tt_news
After installing this extension, there is a static template ( news2directmail Plaintext ), that should be added to your Newsletter TypoScript Template. Beside that you have to also include one of the static template of tt_news
After including the static template, you can view the page via browser by calling a URL like:
http://www.example.com/index.php?id= *page_id* &tx_ttnews[tt_news]= *tt_news_id*
and for plaintext version:
http://www.example.com/index.php?id= *page_id* &tx_ttnews[tt_news]= *tt_news_id* &type=99
If you like, you can also manually send a test newsletter using direct_mail by adding “&tx_ttnews[tt_news]= *tt_news_id* ” parameter.
After making sure that the tt_news article is correctly rendered in frontend, we can start configuring the cli script of dkd_news2directmail.
Create a BE User "_cli_dkd_news2direct", which have the permission to select and modify tables of direct_mail, tt_news and your newsletter recipients table (tt_address or fe_user)
In Web module, you'll find a new module called “News 2 Directmail” (Web > News 2 Directmail). Upon opening this module you'll have to choose a SysFolder containing your direct_mail.
Next you can put in some configuration parameters:
- recipient list -> you can only put ONE recipient ID, which you have created with directmail extension (see Directmail manual how to do this)
- time interval -> is the time interval between the news2directmail cli script compiling the news and directmail cli script start sending the newsletter
- Domain of internal link -> because the base URL of the link is not known in the cli mode, you have to set it here.
Next you have to call the cli script from the command line. the command is:
/path_to_php/php /absolute_path_to_your_site/typo3conf/ext/dkd_ news2directmail/cli/cli_dkdnews2directmail.php *xxx*
where xxx is the page ID, which contains tt_news extension displaying the news detail.
Reference¶
The configurations, which are inserted from the “News 2 Directmail” module, are saved in the SysFolder as PageTS. The following properties are children of mod.web_modules.news2directmail
recipient_list¶
Property
recipient_list
Data type
Int
Description
UID of the recipient lists, to which you're sending newsletter. To create a new recipient list, use the “Recipients Lists” module of direct_mail.
Default
send_time¶
Property
send_time
Data type
Int
Description
Number of minutes from the creation of a newsletter until direct_mail start sending it.
Default
URL¶
Property
URL
Data type
String
Description
This will be used as domain for all internal link, since in CLI Mode the URL of a site is unknown.
Default
Known problems¶
There's no problems known. But if you encounter one, please contact me ivan.kartolo@dkd.de
If you have patch to your problem, please send them. It's welcomed.
To-Do list¶
Missing a feature? Please contact me ivan.kartolo@dkd.de . If you can't implement it, just send your idea. Some donation will support me on maintaining this extension.
Changelog¶
Changes version 0.1.0:
added documentation
compatible to direct_mail version 2.5.x
Changes version 0.0.1:
initial upload in TER
dkd_news2directmail - 4