Académique Documents
Professionnel Documents
Culture Documents
Table of Contents
Introduction
What does it do?
This tutorial is divided into 3 parts. Move from one page, starting at the top and you will create your own mailing easily.
'Web->Plugin->Direct Mail'
'Address list'
This is how your Mail User Administration Typo3 Template should look.
I went to the Direct Mail Example and copied the template from there.
1. This ID is the for the 'Direct Mail Module' Folder you are using. You can create a new one in your website or use the one
from the example outside your website. They both will work.
2. The code here needs to be all on one line. I only split it up to make it visible.
The template file could also be moved to the fileadmin/media/scripts folder and the link will just have to be changed
accordingly here.
In the 'Direct Mail folder' all the subscribers are stored and the newsletters are stored in subfolders. In the "Direct Mail folder"
you'll also find a template which determines the design of the newsletters and furthermore there are "Direct Mail records" which
represents a 'direct mail campaign' based on a certain newsletter and bound for a certain selection of subscribers.
If you created a new folder you can follow the information given under 'Module Configuration' and set it up the way you want it
or start of with this information in the Tsconfig field and then make changes later in the 'Module Configuration'.
## CONFIGURATION of the direct mail module:
mod.web_modules.dmail {
from_name = John Spam Doe
from_email= john.doe@nothing.test
organisation = John Does Testsite
replyto_email =
replyto_name =
plainParams = &type=99
HTMLParams =
# UID's of the tt_address records to use for test-sending:
test_tt_address_uids = 13,14
# table name of a userdefined table similar to tt_address (same fields) which may be used for distribution
also.
userTable =
enablePlain = 1
enableHTML = 1
http_username =
http_password =
sendOptions=3
categories {
1 = Food
2 = Books
3 = Sport
4 = Religion
}
mod.web_dmail.test_dmail_group_uids=1,2
mod.web_modules.dmail.categories.0=Food
mod.web_modules.dmail.categories.1=Books
mod.web_modules.dmail.categories.2=Sport
mod.web_modules.dmail.categories.3=Religion
mod.web_modules.dmail.categories.4=
mod.web_modules.dmail.sendOptions=3
mod.web_modules.dmail.long_link_mode=0
mod.web_modules.dmail.quick_mail_encoding=0
Note
Make sure that you have selected Direct Mail from the drop down menu in the 'Contains plugin section.
This is the Typo3 Template that is associated with the Direct Mail Module.
Constants and Setup fields are empty.
Include Static has template; NEWSLETTER, plugin.alt.plaintext (99) and cSet (default) included (if you include CSet
(default) you will have problems with the emails)
After testing the Direct Mail Module you end up with a whole bunch of sent mail. How do you gain access to those items to
delete them? Simple. Select 'List' in the Typo3 column then click on the 'Direct Mail Module' folder and you will see the screen
shot below in your workarea.
Apart from the normal 'Page' and 'Template' sections there are now Address, Direct Mails and Direct Mail Groups sections.
Address
Here you see at a glance all the addresses of your subscribers.
Direct Mails
All the mailing you have sent are listed here.
Now the Newsletter HTML Template has to be included and changed to reflect our customization.
Template File
This now points to my newsletter template. The default one is at
media/scripts/fe_admin/dmailsubscription.tmpl.
Administration Email
This is an important part, because if you leave it out you will not be notified when people subscribe to your
newsletter.
Record PID
I have the Direct Mail Plugin in the template associated with the Newsletter Page and not the Direct Mail
Module. ID 475 is the ID of the Direct Mail Module in my site structure.
To change the 4 original category names, just replace them with your categories.
If you have more than 4 categories, just copy one cell from <tr>....</tr> and make the changes. Replace the name of the
category and change the number to reflect the number you have in your TypoScript.
You will then see the screen below in the workarea to the right (third column).
link to a webpage with the information you want in your direct mail.
Module Configuration
Here you
'From' name
Enter the sender name. (Required)
Example: Your Name
'Return Path'
Enter the return path email address here. This is the address to which non-deliverable mails will be returned to. If you put in the
marker ###XID### it'll be substituted with the unique id of the mail/recipient.
Organisation name
(Optional)
Example: Company Name
HTML parameters
Enter the additional URL parameters used to fetch the HTML content. If in doubt, leave it blank.
Note: I don't know what these mean. If anybody knows, please contact me so that I can explain it.
HTTP username
If the mail content is protected by a HTTP authentication, enter the username here. The username and password is used to
fetch the mail content. They are NOT sent in the mail!
If you don't enter a username and password and the newsletter pages happens to be protected, an error will occur and no mail
content is fetched.
HTTP password
... and enter the password here.
AVAILABLE CATEGORIES
Category 0
Example: Food
Category 1
Example: Books
Category 2
Example: Sport
Category 3
Example: Religion
Category 4
Category 5
Category 6
Category 7
Category 8
Category 9
(You can use categories from 0-30 inclusive. However this interface shows only 10 categories for your convenience.)
Recipient List
Once you have chosen either to create a new mail group or clicked on the pencil icon
see the screen below.
Depending on the drop down menu you choose under Type: you create different mail groups.
By default it opens to 'From Page' Type.
3. Startingpoint
Select the starting point by clicking on the ' Browse for records' button and select the file you want as starting point for
collecting your address for this group.
4. Recursive
I haven't quite figured out yet what this does exactly
5. Tables
I haven't quite figured out yet what this does exactly
6. Must Attend Categories
If you create lists with subscribers to specific categories you can set that category here. Now all the people on this list will
only get the information destined for that particular category.
7. Save the group.
Direct Mail Tutorial - 19
Newsletter
Selecting Newsletter from the drop down menu will change your screen to the view below
Now you can select a newsletter that you have created previously. You can select the newsletter by either clicking on the yellow
file folder or by clicking on the name of the newsletter.
Or create a new newsletter by clicking on 'Click here to create a new page that you can later send as direct mail'
After you have selected an existing newsletter file as the base for your direct mail you will get the screen below.
1. To see how your newsletter looks online in the browser click on ' View Page'
2. To make changes to your newsletter click on ' Edit Page'
Hold on a minute and don't press the create button just yet!
In the bottom half of the workarea is an other area which needs your attention.
5. When people subscribe to your newsletter their are asked which categoies they are interested in by selecting the check
box. The reason behind this is that now you can create newsletters with information for all categories, but you only want
to send it to subscribers to 'Books' for example. By selecting the 'Books check box your newsletter subscriber will only
see the information you created for the 'Books' section.
6. When you're done click on 'Update category setting'.
Now you can create your direct mailing
3. When you are satisfied that everything is ok you click on '
4. Now you will see the popup window below. As I was testing I kept on creating new direct mails based on the same
newsletter and as you can see the program kept track of my attempts.
Create DirectMail
' Create new direct mail based on this page'. The screen shot below
The Subject is the name you have your newsletter in the 'page header'. I haven't really fully customized the information yet as
you can see from the screen shot. Click on ' Edit' to customize the information to the current newsletter you are sending.
Everything is pretty much self explanatory.
Mail Page is the ID of the newsletter you are sending.
Parameter, Plain text: &type=99 makes the newsletter is ledgeable in plain text.
Parameters, HTML is ok to be empty to work.
Below Edit you have again the option to have another look at your newsletter. Clicking the yellow folder or on the file name will
take you back to your previous screen.
Your next step is now to compile your Direct Mail and you do that by clicking on 'Fetch and compile maildata (read url) from the
drop down menu and you will see the screen below
Now you press the 'Read URL' button and wait. Don't do anything else on the computer or it will not work. Multitasking is out of
the question or you will have to start to read the URL again. And yes, it does take some time (2-3minutes), so get up and do
something else.
Once the URL is read you will back to the screen at the top of this page.
Note
Once the newsletter is read it stays in the memory until it is sent, even if it is the next day and you have turned off Typo3 and
your computer in the meantime.
Mass-send
After the URL is read, you scroll back down to OPTIONS and there will be 2 more added
Mass-send mail.
1. From the drop down menu select the Mail Group you want to use for this mailing
2. Click on the 'Send to all subscribers in mail group' button.
3. Now you will see the screen below
4. Click on the Back button and follow the instructions on the next page 'Send Direct Mail'
So that there is no overlap or unwanted emails being sent I created a Recipient list of the Static Group Type, but left the
Recipients box empty.
To use this option
1. prepare you mailing as usual,
2. after the URL has been read
3. scroll down to the second option 'Send Mail - List of Emails' and place the emails in the box and
4. hit send button.
With this option the mails are sent immediately, there is no need to start the mailer. engine.
Your screen will now look like the one below.
It tells you that the mail was sent and who it was sent to.
Now you select from the drop down menu 'Mailer engine status'.
1. The status of the Mailer engine is indicated and a log given of what transpired.
- The time it was started
- The name of the newsletter that was sent
- How many copies were sent and which address used (tt_address)
- How long it took to send the mail
2. Under the Mail Engine Status you now can see that your newsletter has been delivered and 2 copies sent.
Creating a Newsletter
Compiling the Newsletter
I am using the Newsletter #1 that is included in the 'Direct Mail Example' as a reference to explain how to format the newsletters
you create so that subscribers only see content for which they subscribed.
This is an overview of the newsletter in 'List Mode'
The sample Newsletter has 9 content sections and is setup to use the 'Normal Column' and the 'Border Column'. See screen
shot below.
Plugin: News
Code: LATESTS
Startingpoint: News
Recursive: 2 levels
Layout: Normal
Type: Search
Direct Mail Tutorial - 31
Now that you have created your newsletter you need to match the sections to the categories of your subscribers. Go the the
next page.
Newsletter Categories
You can link the newletter to the categories now or when you are ready to mail the newsletter. Just don't forget to do it. I placed
a reminder in the tutorial under Select Newsletter.
Clicking on Plugins --> Direct Mail Module or the name of the Newsletter you just created will open the Newsletter Direct
Mail Edit Page.
Here you see all the newsletter(s) that you have created. You can view them from here, edit them, create your mailing based on
them and select the categories that go with each content section.
Leaving all the check boxes blank will automatically include that section for all subscribers.
Selecting checkboxes to match subscribers category choices will send that page content only to subscribers.
When you set your categories as you create your newsletter you won't have to worry remembering to set them at the time of
your mailing. This way if you create your newsletters in advance or in bits and pieces, by automatically setting the categories
you are always up-to-date.