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: External Newsletter Subscription (EZMLM)¶

Author:	Kasper Skårhøj
Created:	2002-11-01T00:32:00
Changed by:	Paolo
Changed:	2006-09-30T18:37:49
Author:	Paolo Nugnes
Email:	paolonu@libero.it
Info 3:
Info 4:

EXT: External Newsletter Subscription (EZMLM)¶

Extension Key: external_nl_subscription

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: External Newsletter Subscription (EZMLM) 1

Introduction 1

What does it do? 1

Screenshots 1

Users manual 3

FAQ 4

Adminstration 4

Configuration 5

Reference 5

Used CSS 5

Known problems 5

To-Do list 6

Introduction¶

What does it do?¶

- The extension, after convalidating the email sent by the form, gives as a result a message of confirmation/error on the Typo3 site as well as sending a subscription/unsubscription mail to the mailing list service relative to the domain indicated through the configuration of extension itself.

- I needed to let site users to register to an newsletter external to Typo3 without needing their registration to the site. All the extensions i evaluated needed, instead, of a front-end user registration as well. So I wrote this extension that permits, through a form and a message of confirmation/error, the registration to an external EZMLM service.At the moment the extension has been tested and works for sure for registrations to EZMLM services by italian provider Aruba. By the way it will surely work for any service that involves the registration to a newsletter through email in listname-subscribe- emailname=domainname.com@registrationdomain.com format.

Screenshots¶

- Back-end screenshot

- How the form appears (buttons and message can be configured by flexform/typoscript).

- H ow the final message appears (ending formula and signature can be configured by flexform/typoscript).

¶

Users manual¶

- Download the plugin from the Extensions Manager and install it.

- Insert the plugin as content inside the page.

((generated))¶

WARNING! The plugin must be inserted in two places. As a Form and as a confirmation message.¶

FORM

Fill following fields:

Select “Form” from dropdown menu

Target domain

Example¶

If the newsletter is called newsletter@francescoadessi.it , the domain will be “francescoadessi.it”

Newsletter name

Example¶

If the newsletter is called newsletter@francescoadessi.it , the newsletter name will be “newsletter”

The id of the confirmation/error message visualization page

Check this if you want graphic subscription/unsubscription buttons (optional)

Insert the “subscribe” button file path

Insert the “unsubscribe” button file path

MESSAGE

Fill following fields:

Select “Message” from dropdown menu

Target domain

Example¶

If the newsletter is called newsletter@francescoadessi.it , the domain will be “francescoadessi.it”

Newsletter name

Example¶

If the newsletter is called newsletter@francescoadessi.it , the newsletter name will be “newsletter”

Insert your personalized final message in case of newsletter subscription

Insert your personalized final message in case of newsletter unsubscription

Insert your signature

Done! ;)

FAQ¶

- Q. How do i change the way form and message are visualized?

A. Use css! Inside the “Configuration” section are listed all the used css names

- Q. How do i insert the form inside the site template?

Use typoscript! And remember to configure required fields!!!

Example¶

lib.formNewsletter < plugin.tx_externalnlsubscription_pi1
lib.formNewsletter {
        domainName = francescoadessi.it
        listName = newsletter
        whatToDisplay = form
        messagePage = 110
        btnImg = 1
        subscribeBtnImg = fileadmin/templates/gfx/button-sottoscrivi.gif
        unsubscribeBtnImg = fileadmin/templates/gfx/button-rimuovi.gif
}

Adminstration¶

- Nothing to do

Configuration¶

- This extension has been written thinking about user registration to the newsletter without registering as site user “too”. To be more specific the extension has been written to register to Aruba italian provider mailing lists.

The mail sent by the extension has, as “To:” address, the name of the newsletter, to action to achieve (subscribe/unsubscribe), the address to be registered with the “@” substituted by “=” sign, the mailing list manager domain name, in the following format:

listname-subscribe-emailname=domainname.com@registrationdomain.com

In the next future, if I discover new possibilities, i will think to implement different ways to register to different services than EZMLM.

Reference¶

- plugin.tx_externalnlsubscription_pi1: TS configuration.

whatToDisplay¶

Property

whatToDisplay

Data type

string

Description

It says which part of the extension to show.

It can be configured in the following ways:

configure/form/message

In the first case it will display an error message, in the second the form, in the third case it will display the result messaof the email subscription/unsubscription.

Default

configure

domainName¶

Property

domainName

Data type

string

Description

Name of the domain relative to the newsletter to subscribe.

Default

listName¶

Property

listName

Data type

string

Description

Name of the newsletter to subscribe.

Default

messagePage¶

Property

messagePage

Data type

string

Description

Page Id of the message result

Default

btnImg¶

Property

btnImg

Data type

boolean

Description

If True it transform the subscribe/unsubscribe buttons into graphic format

Default

subscribeBtnImg¶

Property

subscribeBtnImg

Data type

string

Description

Subscription button image path

Default

EXT:external_nl_subscription/res/button-subscribe.gif

unsubscribeBtnImg¶

Property

unsubscribeBtnImg

Data type

string

Description

Unsubscription button image path

Default

EXT:external_nl_subscription/res/button-unsubscribe.gif

finalFormula¶

Property

finalFormula

Data type

string

Description

Subscription message ending sentence

Example:

plugin.tx_externalnlsubscription_pi1.finalFormula = Thank you for subscribing our newsletter

Default

finalFormulaRemove¶

Property

finalFormulaRemove

Data type

string

Description

Unsubscription message ending sentence

Example:

plugin.tx_externalnlsubscription_pi1.finalFormulaRemove = We hope that our newsletter has been useful to you since now. We'll wait for you in case you want to subscribe back.

Default

signature¶

Property

signature

Data type

string

Description

Signature

Example:

plugin.tx_externalnlsubscription_pi1.signature = The Firm

Default

[tsref:tx_externalnlsubscription_pi1]

Used CSS¶

tx-externalnlsubscription-pi1-email

tx-externalnlsubscription-pi1-message

tx-externalnlsubscription-pi1-message-title

tx-externalnlsubscription-pi1-action-message

tx-externalnlsubscription-pi1-email-sent

tx-externalnlsubscription-pi1-what-to-do

tx-externalnlsubscription-pi1-final-formula

tx-externalnlsubscription-pi1-signature

Known problems¶

- None at the moment

To-Do list¶

- Adding a configuration parameter to personalize the email sent to the service.

For more information you can go to typo3.org .

EXT: External Newsletter Subscription (EZMLM) - 6