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.

Majordomo

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed:2009-09-23T13:21:42
Classification:majordomo
Description:Subscribing to and unsubscribing in majordomo mailing lists. You need a Majordomo list on the same Web-Server or any other Web-Server in the Word Wide Web.
Keywords:forAdmins, forDevelopers, forAdvanced, majordomo, mailing lists, mailing, list
Author:Dirk Wildt, Die Netzmacher
Email:wildt.at.die-netzmacher.de
Website:http://die-netzmacher.de
Language:en

img-1 img-2 Majordomo (extKey: majordomo) img-3

Majordomo - Subscribe to mailing lists

img-4

Version: 1.1.1, 2009-09-23

Extension Key: majordomo

Language: en

Keywords: forAdmins, forDevelopers, forAdvanced, majordomo, mailing lists, mailing, list

Copyright 2007-2009, Dirk Wildt, Die Netzmacher, <wildt.at.die- netzmacher.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

Introduction

What does it do?

Extension for subscribing to and unsubscribing in majordomo mailing lists.

Features

A plugin with two frontend elements

  • a form for subscribing and unsubscribing,
  • a content element with a confirmation message.
  • The plugin verifies mail addresses.
  • Subscribers and unsubscribers will get a confirmation mail.
  • You can configure the plugin with an interface, you don't need to know nothing about TypoScript.
  • The plugin is configurable by editors.
  • With DRS - Development Reporting System. It supports you in cases of a unsuccessfully configuration.
  • Language support.

What do you need

  • A majordomo installation on your server or on a third party server.
  • An existing majordomo mailing list.

Update

Please read the section "Update" below.

Screenshots

Frontend

Frame80 Frame80

Configuration

Frame80 Frame80

DRS - Development Reporting System

Frame80

Installation

Extension Manager

Download the extension Majordomo form the TYPO3 online repository.

Frame80 Frame80

  • If you don't have installed the extension "devlog" (Developer Log), Majordomo will suggest to install it.You need "devLog", if you want to use the DRS - Development Reporting System.
  • Than load the extension Majordomo.
Option: DRS - Development Reporting System

You can enable the DRS - Development Reporting System - with options in the select menu. If you enable it, the DRS will report every action of Majordomo to the Developer Log. See the section "Test it! below.

Option Check Mode

You can enable the Check Mode. The Majordomo extension will doesn't send any email and doesn't subrcribe or unsubsribe anybody. See the section "Test it! below.

Include Static Template

Frame80

Select the item "Template" in the web modul.

Select your root page or the page in the page tree, where you want to use the majordomo plugin.

Click on the line "Click here to edit ..." below the table template tools.

Frame80

  • Select in the tab [Includes] the item "Majordomo (majordomo)"
  • "Majordomo (majordomo)" will be added to the selected items.

Create three Pages

Frame80

Create three pages like in the example above

  • Configuration (it has the uid 378 in our example)
  • Form (uid 22)
  • Confirmation (uid 21)

Add a Majordomo Configure Record

Frame80 Frame80

Add the Majordomo Configuration Record to the Sysfolder Configuration (uid 378) like in the illustrations above.

Configure Majordomo

Basics

Frame80

Name your configuration.

Recommended titles are

  • Name of the website
  • Name of the majordomo list
Form

Frame80

Configure some HTML capabilities.

You can set a tab index to your form.

If you are allocates to this field the string "2|3|4" you will get the following tab indexes:

  • 2: Input Field: 2
  • 3: Unsubscribe Button
  • 4: Subscribe Button

Frame80

Confirmation

Frame80

HTML properties for the content element Confirmation.

Majordomo Server

Frame80

  • Majordomo List

    Its the name of the majordomo list.

  • Email of the Majordomo Server

    It is the email address of the majordomo server. The majordomo server will process emails to this address as commands for subscribing and unsubscribing. Frame80

  • Email of the List Owner

    The email of the list owner. It has to be the majordomo list owner email.

  • Default Email in the Input Field of the Form

  • Forbidden Mails (comma separated)

    A comma separated list of emails. The email of the majordomo server, the list owner and the default form email will added self-acting.

Email

Frame80

Configuring of the confirmation email.

This email has a template. If you want to edit the template, please read section "Configure the Email Template" below.

The illustration below displays an email to a subscriber in the email client application thunderbird.

Frame80

Remove the Cache

Please remove the TYPO3 cache, if you have changed any value in the Majordomo configuration.

Configure the Plugins

Confirmation

Edit in the page properties of the page confirmation the general record storage page.

Frame80

Add a plugin to the confirmation page.

Frame80

Select the Majordomo plugin.

Select the content element Confirmation.

Select your configuration.

If there isn't any configuration, it can have two reasons:

  • You didn't configure a record. Please read the section "Add a Configure Record" in this case.
  • The page configuration record hasn't any general record storage.
Form

Frame80

Edit in the page properties of the page form the general record storage page (see example confirmation page above).

Add a plugin to the form page.

Select the Majordomo plugin.

Select the content element Form.

Select your configuration.

Select the confirmation page.

Test it!

Enable the Check Mode

Frame80

Choose Admin Tool > Ext Manager and than the extension Majordomo.

Enable the DRS - Development Reporting System. Select "All".

Enable the Check Mode. Majordomo won't send any email, majordomo won't subscribe or unsubscribe.

Klick [Update].

Subscribe to Majordomo

Frame80

Subscribe to majordomo with the default email.

Investigate the DRS Log!

Frame80

Choose Admin Tools > Developer Log.

Subscribe with a real Email

Now subscribe with a real Email. E.g your email. Don't take the email in our example: angela.merkel@cdu.de.

Investigate the Developer Log.

Frame80

The DRS displays

the email to the majordomo server,

the email to angela.merkel@cdu.de and

last but not least an instruction, how to configure the email template, if you like another text.

Complete the Check Mode

Please

  • disable the DRS and
  • disable the Check Mode.

Configure the Email Template and HTML Output

Frame80

Open the TypoScript Object Browser:

Web > Template

Select your root page or the page with your majordomo static include template.

Select plugin > tx_majodomo_pi1

Click on the item you want to edit e.g. [form_title]

Reference

General Settings

_LOCAL_LANG

Property

_LOCAL_LANG

Data type

array

Description

Default Text for HTML output

plugin.tx_majordomo_pi1 {

_LOCAL_LANG {

default {

form_title = Newsletter

html_subscribe_button_title = Get thenewsletter

html_subscribe_button_value = Subscribe

...

}

}

}

Default

_CSS_DEFAULT_STYLE

Property

_CSS_DEFAULT_STYLE

Data type

text/CSS

Description

Default CSS styles for the majrodomo plugin form.

plugin.tx_majordomo_pi1 {

_CSS_DEFAULT_STYLE (

.tx-majordomo-pi1-buttons {

padding-top:0.4em;

clear:both;

height:2em;

}

.tx-majordomo-pi1-button_left {

float:left;

width:49%;

text-align:left;

}

.tx-majordomo-pi1-button_right {

text-align:right;

float:right;

width:49%;

}

)

}

If you don't need it, please use this snippet in your TypoScript code:

plugin.tx_majordomo_pi1 {

_CSS_DEFAULT_STYLE >

}

Default

Update

From < 1.0

We replaced the configuration by TypoScript with the configuration by a plugin.

You have to copy your datas from your current TypoScript configuration to the configuration record.

Include Static Table

If you make an update, please load the Include Static Template again.

Frame80

Delete tx_majordomo_pi1

Select the Admin Tools > Install

Select Database Analyzer

Select Compare Frame80

Remove the table tx_majordomo_pi1 Frame80

Select Compare a second time.

Remove table zzz_tx_majordomo_pi1.

If you like a last check, please click the option [Compare with $TCA].

Maintaine Your Majordomo Configuration

Create a Majordomo configuration recordSee the section "Installation > Add a Majordomo Configure Record.

Configure your pages with the Majordomo plugins.Every page with a Majordomo plugin needs a general record storage page.See section "Installation > Configure the Plugins > Confirmation.

Configure the PluginsSee section "Installation > Configure the Plugins > Confirmation and Form.

Remove your TypoScript Template, unless you are using TypoScript for removing CSS defaults or for the email templates like the code snippet below:

plugin.tx_majordomo_pi1 {

_LOCAL_LANG {

default {

mail_subscribe_subject = YOUR VALUES

...

}

}

_CSS_DEFAULT_STYLE >

}

Check Your TypoScript with the DRS

You can check your TypoScript code with the DRS - Development Reporting System. You only have

  • to enable the DRS and
  • to subscribe to the Majordomo list.

See section "Test it" above.

Helpful Suggestions

If you have helpful suggestions, feel free to contact me: Dirk Wildt, wildt.at.die-netzmacher.de.

FAQ

SimulateStaticDocuments

There isn't any problem known.

RealUrl

There isn't any problem known.

Further Information

About the plugin icon

img-4 The concept of the icon:

The letter is symbolizing email and email lists

The color yellow is the color of Die Netzmacher ( http://die- netzmacher.de ), the company which created the Majordomo extension.

Mojordomo Website and Wikipedia

Other extensions published by Die Netzmacher

img-6 Browser - Highway to Frontend. The Browser is the fast way for your data to the TYPO3 frontend. It displays content from related tables. You need 1 line typoscript for a result list with a search form, a record browser and an a-z browser. Images are wrapped self- acting. SEO, Search Engine Optimization. DRS supports the TypoScript configuration. http://typo3.org/extensions/repository/view/browser/current/

To-Do List

Nothing to do.

Changelog

  • 1.1.1 New Sub Versio - New Features- Editing of Email Templates and HTML Templates is simplified
  • 1.0.1 Major Version Release - New Features- Configuring with Flexform- DRS - Development Reporting System
  • 0.0.5 Propering Project
  • 0.0.4 Improvement - Configurable charset for mail- Changing status from alpha to beta
  • 0.0.3 Improvement Form and buttons got a class
  • 0.0.2 Manual Publishing the English edition
  • 0.0.1 Initial Release

Illustration Index

Illustration 1: Manual in PDF format 3

Illustration 2: A website with the majordomo plugin "form" 4

Illustration 3: A website with the majordomo plugin "confirm" 4

Illustration 4: Screenshot of the plugin in the backend 4

Illustration 5: Screenshot of the configuration record 4

Illustration 6: Logs with email to majordomo and the subscriber 4

Illustration 7: Import of devlog 5

Illustration 8: Extension manager with Majordomo 5

Illustration 9: Include static template 5

Illustration 10: Include the Static Template 6

Illustration 11: Three pages 6

Illustration 12: Web > List - Add a record 6

Illustration 13: Select the Majordomo configuration record 6

Illustration 14: Basics 7

Illustration 15: Form 7

Illustration 16: Form with Tab Indexes 7

Illustration 17: Confirmation 8

Illustration 18: Mdom Server 8

Illustration 19: Email to the majordomo server 8

Illustration 20: Mdom Server 9

Illustration 21: Mail to the subscriber 9

Illustration 22: General Storage Page 10

Illustration 23: Plugin on the confirmation page 10

Illustration 24: Plugin on the confirmation page 10

Illustration 25: Test configuration 11

Illustration 26: Subscribe 11

Illustration 27: DRS - Development Reporting System 12

Illustration 28: DRS - Development Reporting System with the emails 12

Illustration 29: _LOCAL_LANG array in the TypoScript Object Browser 13

Illustration 30: Include the Static Template 15

Illustration 31: Comparing with the Database Analyzer 15

Illustration 32: Remove tx_majordomo_pi1 15

22