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.

Subscription Plugin

The extension provides a plugin for subscribing and unsubscribing to a newsletter.

Reference

TypoScript reference for the subscription plugin:

Property

settings.eyepinHost

Data type

string / stdWrap

Description

The host name (or IP address) of the eyepin® server.

Default

Property

settings.eyepinUser

Data type

string / stdWrap

Description

The username of the eyepin® newsletter account.

Default

Property

settings.eyepinPassword

Data type

string / stdWrap

Description

The password for the eyepin® newsletter account.

Default

Property

view.templateRootPath

Data type

string

Description

Path to template folders

Default

EXT:eyepin6/Resources/Private/Templates/

Property

mandant

Data type

string / stdWrap

Description

Optional; The ID of the customer where to insert/update the address.

Example:

plugin.tx_eyepin6.settings {
  mandant = 112233
}

Default

Property

requiredFields

Data type

string / stdWrap

Description

A comma separated list of required form fields.

Default

Property

evalFields

Data type

array

Description

An array of field names and their type of evaluation. The key of the index is the field name to evaluate and the value is a comma separated list of evaluation types. Possible types are ‘required’ and ‘isEmail’. Fields defined by the TypoScript setting ‘requiredFields’ are merged into this array with the mode ‘required’.

Example:

plugin.tx_eyepin6.settings.evalFields {
  form_firstname = required
  form_lastname = required
  form_email = required,isEmail
}

This example defines that the three form fields form_firstname, form_lastname, and form_email are required. The form field form_email also has to be a valid e-mail address.

Default

Property

mapping

Data type

array

Description

Mapping of field names in the subscription form to field names in the eyepin® server interface. If no mapping is given the field names in the form are passed one by one to the interface. The key in the mapping array represents the field name in the form and the value of the array is the mapped field name in the interface.

Example:

plugin.tx_eyepin6.settings.mapping {
  form_firstname = interface_firstname
  form_lastname = interface_lastname
}

This example maps the form fields form_firstname and form_lastname to the interface fields interface_firstname and interface_lastname.

Default

Property

Settings.label_myLabelName

Data type

String

Description

Define different labels for eyepin form. Access labels in Template for example: {settings.label_firstname}

Example:

plugin.tx_eyepin6.settings {
  label_firstname = Firstname
  label_lastname = Lastname
}

Default

Example

An example configuration for the newsletter subscription plugin:

plugin.tx_eyepin6{

  view{
    templateRootPath = fileadmin/templates/extensions/eyepin/Templates/
  }

 settings{
    eyepinHost = www.eyepin.com
    eyepinUser = john
    eyepinPassword = 12345
    mandant = 112233

    #Define labels and texts for form – access in template: {settings.label_email}
    label_email = Email

    mapping {
      #myField = eyepinField
      salutation = salutation
      title = title
      firstname = firstname
      lastname = lastname
      email = email
      street = street
      zip = zip
      city = city
      country = country
      phone = phone
      fax = fax
      company = company
      function = function
      mobile = mobile
      internet = internet
      interests = attribute1
      targetgroup = attribute2
      language = language

    }
  }
}

In this example the plugin uses its own default template to create the newsletter sign in form. It connects to the account of user ‘john’ at the eyepin® server at http://www.eyepin.com/ . Additionally the sign in form fields ‘interests’ and ‘targetgroup’ are mapped to the fields ‘attribute1’ and ‘attribute2’ of the eyepin® interface.