mhuber84/form-mailchimp

TYPO3 CMS Extension to connect EXT:form to mailchimp

3.0.0 2024-08-29 11:59 UTC

Requires

• mailchimp/marketing: ^3.0
• typo3/cms-core: ^12.4
• typo3/cms-form: ^12.4

Requires (Dev)

• roave/security-advisories: dev-latest
• typo3/tailor: ^1.5

Replaces

• typo3-ter/form-mailchimp: 3.0.0

GPL-2.0-or-later

• Marco Huber

• mailchimp
• newsletter
• form
• typo3

README

This extension adds a finisher for the TYPO3 sysext "form" to register the user to your Mailchimp audience.

When you add the form finisher, you can select the email field and the newsletter field in your form and define the Mailchimp list id. You can also define tags. If a user submits the form he is added to your Mailchimp audience.

Installation

1. Install with composer require mhuber84/form-mailchimp

2. Include TypoScript Check if this overwrites your own settings and adjust if necessary! :-)

3. Include finisher in your form

4. Configure API in ExtensionManager

Example form with mailchimp finisher

type: Form
identifier: newsletter_registration
label: 'Newsletter registration'
prototypeName: standard
renderingOptions:
  submitButtonLabel: Send
finishers:
  -
    options:
      mailchimpListId: 'YOUR-MAILCHIMP-LIST-ID'
      email: '{email}'
      newsletter: '{newsletter}'
      fieldMapping:
        FNAME: '{firstname}'
        LNAME: '{lastname}'
      mailchimpTags: 'Tag1, Tag2'
    identifier: Mailchimp
renderables:
  -
    renderingOptions:
      previousButtonLabel: 'Previous step'
      nextButtonLabel: 'Next step'
    type: Page
    identifier: page-1
    label: ''
    renderables:
      -
        type: GridRow
        identifier: gridrow-1
        label: 'Grid: Row'
        renderables:
          -
            type: Fieldset
            identifier: fieldset-1
            label: ''
            renderables:
              -
                defaultValue: ''
                type: Text
                identifier: firstname
                label: Firstname
              -
                defaultValue: ''
                type: Text
                identifier: lastname
                label: Lastname
              -
                defaultValue: ''
                type: Email
                identifier: email
                label: E-Mail
                properties:
                  fluidAdditionalAttributes:
                    required: required
                  validationErrorMessages:
                    -
                      code: 1221560910
                      message: Required
                    -
                      code: 1221560718
                      message: Required
                    -
                      code: 1347992400
                      message: Required
                    -
                      code: 1347992453
                      message: Required
                validators:
                  -
                    identifier: EmailAddress
                  -
                    identifier: NotEmpty
              -
                type: Checkbox
                identifier: newsletter
                label: 'Newsletter'

Author

Marco Huber, @[e-mail], [e-mail]

Feel free to contribute and send in pull requests or create an issue on https://gitlab.com/mhuber84/form-mailchimp