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: Web>Plugins, Direct Mail - Extended

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Stanislas Rolland
Changed:2006-03-03T16:07:41
Email:stanislas.rolland@fructifor.ca
Info 2:
Info 3:
Info 4:

EXT: Web>Plugins, Direct Mail - Extended

Extension Key: sr_direct_mail_ext

Copyright 2003-2005, stanislas.rolland@fructifor.ca, <stanislas.rolland@fructifor.ca>

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

EXT: Web>Plugins, Direct Mail - Extended 1

Introduction 1

What does it do? 1

Languages 2

Requirements 2

Credits 2

Configuration 2

Extension configuration 2

UserTSConfig 2

Module configuration 3

Mailer Engine cron task configuration 3

Known problems 3

To-Do list 3

Change log 3

Introduction

What does it do?

This extension extends the Web>Plugins, Direct Mail module in the following ways:

the Web>Plugins, Direct Mail module, extension key direct_mail, and most of its submodules may be translated through the language files of this extension (except the module configuration submodule and the mailing list CSV import dialog);

  • the main menu of Direct Mail is also translated (by extending module Web>Plugins, extension key plugin_mgm);
  • UserTSConfig may actually be used to control access to the submodules of the Direct Mail module (by extending module Web>Plugins, extension key plugin_mgm);
  • honor $TYPO3_CONF_VARS["SYS"]["curlUse"] (by extending system class t3lib_dmailer);
  • correctly set the return path (by extending system class t3lib_dmailer);
  • correct some misbehaviors: new dmail record being created instead of editing a newly created dmail record, erroneous list of pages shown under "Create a new Direct Mail from newsletter" (by extending module Web>Plugins, Direct Mail module, extension key direct_mail);
  • newsletters sent by the mailer engine receive less bad points from spam filtering software; this extension allows to configure the mailer to use quoted-printable or 8bit encoding in place of base64 encoding, corrects the message id, corrects missing boundary, etc. (by extending system class t3lib_dmailer);
  • the number of newsletters sent per cycle by the mailer engine and the language used in its notification messages may also be configured with extension configuration variables (by extending system class t3lib_dmailer);
  • the use of jump URL's may be configured with the module configuration submodule;
  • perform further analysis of the reason texts for the returned mails (by extending system class t3lib_readmail);
  • provide finer options for action on returned mails (by extending Web>Plugins, Direct Mail module).

Languages

The extension is currently available in Brazilian, Dutch, English, Finnish, French, German and Spanish.

Requirements

TYPO3 3.5.0 or more recent.

Version 0.3.1 is the last version of this extension. All corrections and features of this extension are now moved into the base extension : Direct Mail 2.0 for use with TYPO3 4.0+.

Credits

Thanks to Martin Kutschker , Robert Böttner , Andreas Schwarzkopf , Bertrand Mure and Urs Weiss for sharing their improvements and corrections to this extension.

Configuration

Extension Web>Plugins, Direct Mail (direct_mail) must be installed before this extension can be installed.

Extension Return mail analysis – Extended (sr_readmail_analyse) becomes obsolete and must be uninstalled before this extension can be installed.

Extension configuration

Upon installation, the following extension configuration variables may be set:

  • the encoding to be used to send the direct mails; default value is “quoted-printable”;
  • the TYPO3 language code of the language to be used by the mailing engine cron task when progress messages are sent to the administrator; default value is “en”;
  • number of messages sent per cycle of the mailing engine cron task; default value is 50;
  • additional DB fields of the recipient : additional fields that may be substituted in the direct mail messages.

UserTSConfig

UserTSConfig may be used to control access to the submodules of the Direct Mail module with statements such has:

mod.web_modules.dmail.menu.dmail_mode {

## Enabling the 'Newsletters' submodule:

news= 1

## Enabling the 'Direct Mails' submodule:

direct= 1

## Enabling the 'Mailer Engine Status' submodule:

mailerengine = 1

## Enabling the 'Recipient list' submodule:

recip = 1

## Enabling the 'QuickMail' submodule:

quick= 1

## Enabling the 'Module Configuration' submodule:

conf = 1

## Enabling the 'Instructions' submodule:

help = 1

}

Module configuration

This extension adds a new module configuration variable allowing to enable or disable the use of jump URL's.

Mailer Engine cron task configuration

This extension also provides an alternative mailer engine script that may be configured as a cron task on the server with a statement such as:

/home/....../public_html/typo3conf/ext/sr_direct_mail_ext/mod/dmai lerd.phpsh> /dev/null

or

/home/....../public_html/typo3/ext/sr_direct_mail_ext/mod/dmailerd .phpsh> /dev/null

Note that the absolute path to the script must be specified.

dmailerd.phpsh is a shell script and requires the availability of a PHP binary, "/usr/bin/php”. Depending on your server configuration, you may have to edit the first line of the script to refer to the location of the PHP binary.

Note that the extension is designed to localize the messages issued by the mailer engine. For this reason, the dmailer cron task provided with the base extension may not work once this extension is installed.

Known problems

No know problem.

To-Do list

Complete insertion of language labels.

Change log

Version 0.2.0:

Initial public version.

Version 0.2.1:

Finnish translation added. Thanks to the translator.

Version 0.2.2:

German translation added. Thanks to Udo von Eynern < udo@voneynern.de >.

Version 0.2.3:

Correction to the encoding domain specified in multipart email headers.

Version 0.2.4:

Documentation update.

Version 0.2.5:

Dutch translation. Thanks to Vincent < cu@vincnet.nl >.

Version 0.2.6:

Update to the German translation.

Version 0.2.7:

  • Update to the Dutch translation.
  • Integrating a modification proposed by Martin Kutschker to modify the way line breaks are applied in quoted-printable encodings.

Version 0.2.8:

Correction to the use of messade-id in multipart headers.

Version 0.2.9:

  • Easier to configure at the time of installation.
  • The encoding to be used may be configured as quoted-printable, 8bit or base64.
  • The use of jump URL's may be configured.
  • The message-id is standard-compliant.

Version 0.2.10:

Correction to old code which prevented preview of a newsletter being opened in a separate BE window in TYPO3 3.6+. Thanks to Robert Böttner .

Version 0.2.11:

  • Enable the use of CURL library functions when PHP is configured with allow_url_fopen = off and when $TYPO3_CONF_VARS["SYS"]["curlUse"] = '1'. Thanks to Bertrand Mure .
  • Enable correct setting of return path using sendTheMail function from TYPO3 3.7 class.htmlmail.php . Thanks to Bertrand Mure .
  • Fix bug which creates a new dmail record instead of editing the newly created dmail record. Thanks to Bertrand Mure .
  • Correct the list of pages shown under "Create a new Direct Mail from newsletter". Thanks to Bertrand Mure .
  • Changing the dmailer cron task to a shell script and changing the way it is configured. See Cron task configuration section.

Version 0.2.12:

Modify the way the message-id is constructed in order to avoid reference to t3lib_div::getIndpEnv() when dmailer cron task is executed as shell script.

Version 0.2.13:

  • Correction: sending simple test mails did not work. Thanks to Martin Kutschker .
  • Correction: there was a localization error (a hardcoded Spanish string). Thanks to Martin Kutschker .

Version 0.2.14:

Additional extension configuration variable: Additional DB fields of the recipient. An idea of Martin Kutschker .

Version 0.2.15:

Update to Brazilian translation.

Version 0.2.16:

  • Correction: incorrect message-id structure was causing invalid image references. Thanks to Alexander Bohndorf .
  • Correction: simple mails were always sent with base64 encoding.
  • Correction: png images were sent as text/html content.

Version 0.2.17:

Update to Finnish translation.

Version 0.3:

  • Update to Brazilian translation.
  • Correction to dmailerd.phpsh. The cron task could issue error message “call to member function on non-object in ... dmailerd.phpsh” in some configurations. Thanks to Urs Weiss for this correction.

Version 0.3.1:

  • Add XCLASS declaration in class.ux_t3lib_dmailer.php.
  • This is the last version of this extension. All corrections and features moved into base extension : Direct Mail 2.0 for use with TYPO3 4.0+.

img-1 EXT: Web>Plugins, Direct Mail - Extended - 4