[EmailToSender]

Properties

implementationClassName

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.implementationClassName
Data type
string
Needed by
Frontend
Mandatory
Yes
Default value
1
2
EmailToSender:
  implementationClassName: TYPO3\CMS\Form\Domain\Finishers\EmailFinisher
Good to know
Description
Classname which implements the finisher.

options.subject

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

options.recipientAddress

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.recipientAddress
Data type
string
Needed by
Frontend
Mandatory
Yes
Default value
undefined
Good to know
Description
Email address of the recipient (To).

options.recipientName

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.recipientName
Data type
string
Needed by
Frontend
Mandatory
No
Default value
empty string
Good to know
Description
Human-readable name of the recipient.

options.senderAddress

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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.replyToAddress

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.replyToAddress
Data type
string/ array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Email address of to be used as reply-to email (use multiple addresses with an array).

Note

For the moment, the form editor cannot deal with multiple reply-to addresses (use multiple addresses with an array)

options.carbonCopyAddress

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.carbonCopyAddress
Data type
string/ array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Email address of the copy recipient (use multiple addresses with an array)

Note

For the moment, the form editor cannot deal with multiple copy recipient addresses (use multiple addresses with an array)

options.blindCarbonCopyAddress

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.blindCarbonCopyAddress
Data type
string
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Email address of the blind copy recipient (use multiple addresses with an array)

Note

For the moment, the form editor cannot deal with multiple blind copy recipient addresses (use multiple addresses with an array)

options.format

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.format
Data type
string
Needed by
Frontend
Mandatory
No
Default value
html
Possible values
html/ plaintext
Good to know
Description
The format of the email. By default mails are sent as HTML.

options.attachUploads

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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.translation.language

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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 sys_language isocode, e.g ‘dk’ or ‘de’. Read Translate finisher options for more informations.

options.translation.translationFiles

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.translation.translationFiles
Data type
string/ 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.templatePathAndFilename

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.templatePathAndFilename
Data type
string
Needed by
Frontend
Mandatory
Yes
Default value
1
2
3
EmailToSender:
  options:
    templatePathAndFilename: 'EXT:form/Resources/Private/Frontend/Templates/Finishers/Email/{@format}.html'
Good to know
Description
Template path and filename for the mail body. The placeholder {@format} will be replaced with the value from option format.

options.partialRootPaths

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.partialRootPaths
Data type
array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Fluid layout paths.

options.layoutRootPaths

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.layoutRootPaths
Data type
array
Needed by
Frontend
Mandatory
No
Default value
undefined
Good to know
Description
Fluid partial paths.

options.variables

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.formEditor.iconIdentifier
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
EmailToSender:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label
    predefinedDefaults:
      options:
        subject: ''
        recipientAddress: ''
        recipientName: ''
        senderAddress: ''
        senderName: ''
        replyToAddress: ''
        carbonCopyAddress: ''
        blindCarbonCopyAddress: ''
        format: html
        attachUploads: true
        translation:
          language: ''
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
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.formEditor.label
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
EmailToSender:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label
    predefinedDefaults:
      options:
        subject: ''
        recipientAddress: ''
        recipientName: ''
        senderAddress: ''
        senderName: ''
        replyToAddress: ''
        carbonCopyAddress: ''
        blindCarbonCopyAddress: ''
        format: html
        attachUploads: true
        translation:
          language: ''
Good to know
Description
This label will be shown within the - “Inspector [CollectionElementHeaderEditor]” if the finisher is selected.

formeditor.predefinedDefaults

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.formEditor.predefinedDefaults
Data type
array
Needed by
Backend (form editor)
Mandatory
No
Default value
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
EmailToSender:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label
    predefinedDefaults:
      options:
        subject: ''
        recipientAddress: ''
        recipientName: ''
        senderAddress: ''
        senderName: ''
        replyToAddress: ''
        carbonCopyAddress: ''
        blindCarbonCopyAddress: ''
        format: html
        attachUploads: true
        translation:
          language: ''
Description
Defines predefined defaults for finisher options which are prefilled, if the finisher is added to a form.

FormEngine.label

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.FormEngine.label
Data type
array
Needed by
Backend (plugin)
Mandatory
Yes
Default value
1
2
3
EmailToSender:
  FormEngine:
    label: tt_content.finishersDefinition.EmailToSender.label
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.

FormEngine.elements

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.FormEngine.elements
Data type
array
Needed by
Backend (plugin)
Mandatory
Yes
Default value
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
EmailToSender:
  FormEngine:
    label: tt_content.finishersDefinition.EmailToSender.label
    elements:
      subject:
        label: tt_content.finishersDefinition.EmailToSender.subject.label
        config:
          type: input
      recipientAddress:
        label: tt_content.finishersDefinition.EmailToSender.recipientAddress.label
        config:
          type: input
          eval: required
      recipientName:
        label: tt_content.finishersDefinition.EmailToSender.recipientName.label
        config:
          type: input
      senderAddress:
        label: tt_content.finishersDefinition.EmailToSender.senderAddress.label
        config:
          type: input
          eval: required
      senderName:
        label: tt_content.finishersDefinition.EmailToSender.senderName.label
        config:
          type: input
      replyToAddress:
        label: tt_content.finishersDefinition.EmailToSender.replyToAddress.label
        config:
          type: input
      carbonCopyAddress:
        label: tt_content.finishersDefinition.EmailToSender.carbonCopyAddress.label
        config:
          type: input
      blindCarbonCopyAddress:
        label: tt_content.finishersDefinition.EmailToSender.blindCarbonCopyAddress.label
        config:
          type: input
      format:
        label: tt_content.finishersDefinition.EmailToSender.format.label
        config:
          type: select
          renderType: selectSingle
          minitems: 1
          maxitems: 1
          size: 1
          items:
            10:
              - tt_content.finishersDefinition.EmailToSender.format.1
              - html
            20:
              - tt_content.finishersDefinition.EmailToSender.format.2
              - plaintext
      translation:
        language:
          label: tt_content.finishersDefinition.EmailToSender.language.label
          config:
            type: select
            renderType: selectSingle
            minitems: 1
            maxitems: 1
            size: 1
            items:
              10:
                - tt_content.finishersDefinition.EmailToSender.language.1
                - default
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 TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements. The configuration within TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.elements.pageUid must follow the TCA syntax.