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: Direct mail unsubscription¶

Author:	Kasper Skårhøj
Created:	2002-11-01T00:32:00
Changed by:	Roman Büchler
Changed:	2012-02-21T08:30:30.360000000
Classification:	dmail_unsubscribe
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:	direct_mail, dmail, unsubscription
Author:	Roman Büchler
Email:	rb@synac.com
Info 4:
Language:	en

EXT: Direct mail unsubscription - dmail_unsubscribe

EXT: Direct mail unsubscription¶

Extension Key: dmail_unsubscribe

Language: en

Keywords: direct_mail, dmail, unsubscription

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¶

EXT: Direct mail unsubscription 1

`Introduction 3 <#__RefHeading__418_1030571592>`_

What does it do? 3

Screenshots 3

Sponsors 3

`Users manual 4 <#__RefHeading__424_1030571592>`_

Unsubscription link 4

`Configuration 5 <#__RefHeading__446_1030571592>`_

TS-Setup 5

`Known problems 6 <#__RefHeading__450_1030571592>`_

Jumpurl 6

`To-Do list 7 <#__RefHeading__454_1030571592>`_

`ChangeLog 8 <#__RefHeading__456_1030571592>`_

Introduction¶

What does it do?¶

Allows a direct_mail recipient to unsubscribe himself from receiving direct mail newsletters by clicking on a link provided in the newsletter.
The recipient might come from fe_users or tt_address table.
Recipients belonging to fe_users are unsubscribed by unchecking 'module_sys_dmail_newsletter'.
Recipients belonging to tt_address are unsubscribed by marking its hidden flag.

Screenshots¶

Sponsors¶

Mario Stadelmann, http://www.mastamedia.at/

THANK YOU!

Users manual¶

Install the extension.
Add the plug-in to a page beeing shown when a user clicks on a link to unsubscribe.
Add static from extension (Direct mail unsubscription) to template. This enables inclusion from default CSS embedding.
Configure a unsubscription link for the newsletters.

Unsubscription link¶

<a href="index.php?¶

a

<a href="index.php?

b

((Unknown Property))¶

a

b

id=1226&¶

a

id=1226&

b

Page where plug-in is inserted to

cmd=unsubscribe&¶

a

cmd=unsubscribe&

b

Command signaling that users likes to unsubscribe

aC=###SYS_AUTHCODE###&¶

a

aC=###SYS_AUTHCODE###&

b

Calculated authentification code to prevent abuse

rid=###SYS_TABLE_NAME_CHAR###_###USER_uid###¶

a

rid=###SYS_TABLE_NAME_CHAR###_###USER_uid###

OR

rid=###SYS_TABLE_NAME###_###USER_uid###

b

Receiver id:

There are two possibilities to define the receiver id. To identify the table you might put just the first letter of the table or the entire name. To reference the record with uid=8 from the table fe_users rid might be:

f_8 OR fe_users_8

((Unknown Property))¶

a

b

">Unsubscribe</a>¶

a

">Unsubscribe</a>

b

Configuration¶

TS-Setup¶

template¶

Property

template

Data type

string

Description

Template file.

Default

'EXT:dmail_unsubscribe/res/html/template.html'

authCode_fieldList¶

Property

authCode_fieldList

Data type

string

Description

Same as for direct_mail

Default

uid

((Unknown Property))¶

Property

Data type

Description

Default

((Unknown Property))¶

Property

Data type

Description

Default

[tsref:tx_dmailunsubscribe_pi1]

((generated))¶

Example¶

Plugin.tx_dmailunsubscribe_pi1.template = fileadmin/mytemplate.html

Known problems¶

Jumpurl¶

Problem description¶

When the jumpurl feature (mod.web_modules.dmail.enable_jump_url=1) is enabled the unsubscription link doesn't work any more.

Corrective action¶

Link¶

Add the the following jumpurl control segment to the url:

<a href="index.php?id=1226&noJumpUrl=1&cmd=unsubscribe&......">Unsubscribe from this newsletter</a>

Direct Mail¶

Exclude url exchange for url's containing above segment by adding the below highlighted line to the file typo3conf/ext/direct_mail/res/scripts/class.dmailer.php.

function substHREFsInHTML() {
        if (!is_array($this->theParts['html']['hrefs'])) return;
                foreach ($this->theParts['html']['hrefs'] as $urlId => $val) {
                        if(strstr($val['ref'],'noJumpUrl=1')!==false) continue;
                                // Form elements cannot use jumpurl!
                        if ($this->jumperURL_prefix && ($val['tag'] != 'form') && ( !strstr( $val['ref'], 'mailto:' ))) {

To-Do list¶

None

ChangeLog¶

V 0.4.0 Update documentation regarding jumpurl-fix
V 0.3.0 Add additional rid specification (now rid=fe_users_8 is recognized)
V 0.2.0 Update document
V 0.1.0 Initial release

8