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.
EXT: Birthday Mail¶
| Author: | Kasper Skårhøj |
|---|---|
| Created: | 2002-11-01T00:32:00 |
| Changed: | 2010-01-01T13:43:57.150000000 |
| Classification: | birthdaymail |
| Description: | The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- |
| Keywords: | birthday, mail, scheduler, cron, forAdmins, forBeginners |
| Author: | Peter Schuster |
| Email: | typo3@peschuster.de |
| Info 4: | |
| Language: | en |
EXT: Birthday Mail - birthdaymail
EXT: Birthday Mail¶
Extension Key: birthdaymail
Language: en
Keywords: birthday, mail, scheduler, cron, forAdmins, forBeginners
Copyright 2009-2010, Peter Schuster, <typo3@peschuster.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.org
Table of Contents¶
`Introduction 3 <#1.1.Introduction|outline>`_
`Installation 4 <#1.2.Installation|outline>`_
`Configuration 5 <#1.3.Configuration|outline>`_
Introduction¶
What does it do?¶
This extension sends birthday mails to frontend users. The mail content is defined global for each user, but can consist of markers for placing the username or other values from user record.
The extension works with tx_scheduler for cron job execution.
Credits¶
The icon of this extension comes from the Silk Icons library ( http://www.famfamfam.com/lab/icon/silk/ ), which got developed under the Creative Commons license by Mark James.
Installation¶
Requirements¶
- A column for birth dates must exist in the fe_users database table.
- tx_scheduler must be installed
Step-by-Step¶
Install the extension in extension manager
Set all configuration options like sender-email, path to the file with your birthday greeting message and the name which is shown as sender name.
Create a recurring task which is executed at least every day in scheduler module.
Birthday greetings are only send out once per year, of course.
Configuration¶
Available markers in mail body¶
###FIRST_NAME###¶
Marker
###FIRST_NAME###
Description
First name column of fe_users table
###LAST_NAME###¶
Marker
###LAST_NAME###
Description
Last name column of fe_users table
###NAME###¶
Marker
###NAME###
Description
Name column of fe_users table
###USERNAME###¶
Marker
###USERNAME###
Description
Username column of fe_users table
###SENDER_NAME###¶
Marker
###SENDER_NAME###
Description
value of extension configuration 'senderName'
All column names can be configured in extension configuration (in extension manager).
Extension Configuration¶
To configure the extension just go to the extension manager and click on the extension title.
Basic¶
Birthday Mail Template¶
Name
Birthday Mail Template
Description
Path to the template for the e-mail send out to a user.
Sender Email¶
Name
Sender Email
Description
Sender email for sending the birthday message to a user.
Sender Name¶
Name
Sender Name
Description
Sender name for sending the birthday message to a user.
Reply-To Email¶
Name
Reply-To Email
Description
Reply-To email for sending the birthday message to a user.
Mail Subject¶
Name
Mail Subject
Description
Subject of birthday mail. Same markers as in mail body are available!
Extended¶
Enable output¶
Name
Enable output
Description
Enable output to stdout on execution
Birthdate field¶
Name
Birthdate field
Description
Column name of birth date field in table fe_users.
Email field¶
Name
Email field
Description
Column name of email field in table fe_users.
Username field¶
Name
Username field
Description
Column name of username field in table fe_users.
First name field¶
Name
First name field
Description
Column name of first name field in table fe_users.
Last name field¶
Name
Last name field
Description
Column name of last name field in table fe_users.