[EmailToReceiver]

Properties

implementationClassName

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.implementationClassName
Data type
string
Needed by
Frontend
Mandatory
Yes
Default value
EmailToReceiver:
  implementationClassName: TYPO3\CMS\Form\Domain\Finishers\EmailFinisher
Copied!
Good to know
Description

Classname which implements the finisher.

options.subject

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.subject
Data type
string
Needed by
Frontend
Mandatory
Yes
Default value
undefined
Good to know
Description
Subject of the email.

options.recipients

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.recipients
Data type
array
Needed by
Frontend
Mandatory
Yes
Default value
undefined
Good to know
Description

Email addresses and names of the recipients (To).

The form editor in the backend module provides a visual UI to enter an arbitrary amount of recipients.

This option must contain a YAML hash with email addresses as keys and recipient names as values:

recipients:
  first@example.org: First Recipient
  second@example.org: Second Recipient
Copied!

options.senderAddress

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.senderAddress
Data type
string
Needed by
Frontend
Mandatory
Yes
Default value
undefined
Good to know
Description
Email address of the sender/ visitor (From).

options.senderName

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.senderName
Data type
string
Needed by
Frontend
Mandatory
No
Default value
empty string
Good to know
Description
Human-readable name of the sender.

options.replyToRecipients

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.replyToRecipients
Data type
array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Email addresses of to be used as reply-to emails.

options.carbonCopyRecipients

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.carbonCopyRecipients
Data type
array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Email addresses of the copy recipient.

options.blindCarbonCopyRecipients

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.blindCarbonCopyRecipients
Data type
array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Email address of the blind copy recipient.

options.addHtmlPart

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.addHtmlPart
Data type
bool
Needed by
Frontend
Mandatory
No
Default value
true
Good to know
Description
If set, mails will contain a plaintext and HTML part, otherwise only a plaintext part. That way, it can be used to disable HTML and enforce plaintext-only mails.

options.attachUploads

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.attachUploads
Data type
bool
Needed by
Frontend
Mandatory
No
Default value
true
Good to know
Description
If set, all uploaded items are attached to the email.

options.title

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.title
Data type
string
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
The title, being shown in the email. The templates are based onFluidEmail. The template renders the title field in the header section right above the email body. Do not confuse this field with the subject of the email.

options.translation.language

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.translation.language
Data type
string
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
If not set, the finisher options are translated depending on the current frontend language (if translations exists). This option allows you to force translations for a given language isocode, e.g 'da' or 'de'. Read Translate finisher options for more informations.

options.translation.translationFiles

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.translation.translationFiles
Data type
array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
If set, this translation file(s) will be used for finisher option translations. If not set, the translation file(s) from the 'Form' element will be used. Read Translate finisher options for more informations.

options.partialRootPaths

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.partialRootPaths
Data type
array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Fluid partial paths.

options.layoutRootPaths

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.layoutRootPaths
Data type
array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Fluid layout paths.

options.variables

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.variables
Data type
array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Associative array of variables which are available inside the Fluid template.

formeditor.iconIdentifier

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.iconIdentifier
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value
EmailToReceiver:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label
Copied!
Description

An icon identifier which must be registered through the \TYPO3\CMS\Core\Imaging\IconRegistry . This icon will be shown within the - "Inspector [CollectionElementHeaderEditor]" if the finisher is selected.

formeditor.label

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.label
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value
EmailToReceiver:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label
Copied!
Good to know
Description

This label will be shown within the - "Inspector [CollectionElementHeaderEditor]" if the finisher is selected.

formeditor.predefinedDefaults

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.predefinedDefaults
Data type
array
Needed by
Backend (form editor)
Mandatory
No
Default value
EmailToReceiver:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label
    predefinedDefaults:
      options:
        subject: ''
        recipients: {  }
        senderAddress: ''
        senderName: ''
        replyToRecipients: {  }
        carbonCopyRecipients: {  }
        blindCarbonCopyRecipients: {  }
        addHtmlPart: true
        attachUploads: true
        translation:
          language: 'default'
        title: ''
Copied!
Description

Defines predefined defaults for finisher options which are prefilled, if the finisher is added to a form.

FormEngine.label

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.FormEngine.label
Data type
array
Needed by
Backend (plugin)
Mandatory
Yes
Default value
EmailToReceiver:
  FormEngine:
    label: tt_content.finishersDefinition.EmailToReceiver.label
Copied!
Good to know
Description

Finisher options are overwritable within the form plugin. If the "Override finisher settings" checkbox is selected within the form plugin, every finisher who has a - "FormEngine" configuration, is shown in a separate tab. label is the label for such a tab.

@ToDo .. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.formengine.elements:

FormEngine.elements

Option path
prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.FormEngine.elements
Data type
array
Needed by
Backend (plugin)
Mandatory
Yes
Default value
EmailToReceiver:
  FormEngine:
    label: tt_content.finishersDefinition.EmailToReceiver.label
    elements:
      subject:
        label: tt_content.finishersDefinition.EmailToReceiver.subject.label
        config:
          type: input
          required: true
      recipients:
        title: tt_content.finishersDefinition.EmailToReceiver.recipients.label
        type: array
        section: true
        sectionItemKey: email
        sectionItemValue: name
        el:
          _arrayContainer:
            type: array
            title: tt_content.finishersDefinition.EmailToSender.recipients.item.label
            el:
              email:
                label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
                config:
                  type: email
                  required: true
              name:
                label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
                config:
                  type: input
      senderAddress:
        label: tt_content.finishersDefinition.EmailToReceiver.senderAddress.label
        config:
          type: input
          required: true
      senderName:
        label: tt_content.finishersDefinition.EmailToReceiver.senderName.label
        config:
          type: input
      replyToRecipients:
        title: tt_content.finishersDefinition.EmailToReceiver.replyToRecipients.label
        type: array
        section: true
        sectionItemKey: email
        sectionItemValue: name
        el:
          _arrayContainer:
            type: array
            title: tt_content.finishersDefinition.EmailToSender.replyToRecipients.item.label
            el:
              email:
                label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
                config:
                  type: email
                  required: true
              name:
                label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
                config:
                  type: input
      carbonCopyRecipients:
        title: tt_content.finishersDefinition.EmailToReceiver.carbonCopyRecipients.label
        type: array
        section: true
        sectionItemKey: email
        sectionItemValue: name
        el:
          _arrayContainer:
            type: array
            title: tt_content.finishersDefinition.EmailToSender.carbonCopyRecipients.item.label
            el:
              email:
                label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
                config:
                  type: email
                  required: true
              name:
                label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
                config:
                  type: input
      blindCarbonCopyRecipients:
        title: tt_content.finishersDefinition.EmailToReceiver.blindCarbonCopyRecipients.label
        type: array
        section: true
        sectionItemKey: email
        sectionItemValue: name
        el:
          _arrayContainer:
            type: array
            title: tt_content.finishersDefinition.EmailToSender.blindCarbonCopyRecipients.item.label
            el:
              email:
                label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
                config:
                  type: email
                  required: true
              name:
                label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
                config:
                  type: input
      addHtmlPart:
        label: tt_content.finishersDefinition.EmailToReceiver.addHtmlPart.label
        config:
          type: check
          default: 1
      translation:
        language:
          label: tt_content.finishersDefinition.EmailToReceiver.language.label
          config:
            type: select
            renderType: selectSingle
            minitems: 1
            maxitems: 1
            size: 1
            items:
              10:
                - tt_content.finishersDefinition.EmailToReceiver.language.1
                - default
      title:
        label: tt_content.finishersDefinition.EmailToReceiver.title.label
        config:
          type: input
Copied!
Good to know
Description

Every array key must match to the related finisher option name. For example, the - "[Redirect] finisher" has the option - "pageUid". If you want to make the pageUid overwritable within the form plugin, then an array key pageUid has to exists within prototypes.prototypeIdentifier.finishersDefinition.finisheridentifier.FormEngine.elements. The configuration within prototypes.prototypeIdentifier.finishersDefinition.Redirect.FormEngine.elements.pageUid must follow the TCA syntax.