/koning_mailchimp_signup

TYPO3 Extension: MailChimp sign up form

Primary LanguagePHP

koning_mailchimp_signup

This extension allows website visitors to sign up for a MailChimp list. It features:

  • A Scheduler task to retrieve MailChimp lists
  • Frontend plugin to show the form
  • Validation: the form will check if the e-mail address already exists in the MailChimp list
  • Subscribers are first saved into TYPO3: a Scheduler task will save them into to MailChimp database to optimise frontend performance
  • Easily override the template

Setup

  • Install the extension
  • Install drewm/mailchimp-api using composer (composer require drewm/mailchimp-api) or include it manually
  • Configure the extension in the Extension Manager
  • Configure Scheduler tasks

Extension Manager setup

You will need an API key. Check http://kb.mailchimp.com/accounts/management/about-api-keys for more information.

Scheduler tasks

  • Configure the Extbase CommandController Task koning_mailchimp_signup:mailchimp:lists to synchronise subscriber lists from MailChimp to TYPO3 (recommende to run once a day).
  • Configure the Extbase CommandController Task koning_mailchimp_signup:mailchimp:subscribers to synchronise subscribers from TYPO3 to MailChimp (depending on how busy your site is I would recommend to run this once every hour).

Frontend

When the MailChimp lists are synced to TYPO3 you can add the MailChimp sign up form to your page. Configure the list it should save subscribers to and you're done! The Scheduler task should now update your MailChimp list with new entries.

All data (lists and subscribers) is saved on the rootpage (page=0). Subscribers are removed after they are saved in the MailChimp list

Override the template

You can override the template by using standard TypoScript:

plugin.tx_koningmailchimpsignup_form {
    view {
        templateRootPaths {
            10 = EXT:tx_koningmailchimp_signup/Resources/Private/Templates
            15 = EXT:your_extension/Resources/Private/Templates
        }
        partialRootPaths {
            10 = EXT:tx_koningmailchimp_signup/Resources/Private/Partials
            15 = EXT:your_extension/Resources/Private/Partials
        }
        layoutRootPaths {
            10 = EXT:tx_koningmailchimp_signup/Resources/Private/Layouts
            15 = EXT:your_extension/Resources/Private/Layouts
        }
    }
}

Example RealURL configuration

Add this to your postVarSets:

'newsletter' => array(
    array(
        'GETvar' => 'tx_koningmailchimpsignup_form[controller]',
        'noMatch' => 'bypass'
    ),
    array(
        'GETvar' => 'tx_koningmailchimpsignup_form[action]',
        'valueMap' => array(
            'form' => 'form',
            'subscribe' => 'create',
            'subscribed' => 'success',
            'error' => 'error'
        ),
        'noMatch' => 'bypass'
    ),
),