[EmailToReceiver]

Properties

implementationClassName

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.implementationClassName

Data type

string

Needed by

Frontend

Mandatory

Yes

Default value
1EmailToReceiver:
2  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.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

TYPO3.CMS.Form.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

options.senderAddress

Option path

TYPO3.CMS.Form.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

TYPO3.CMS.Form.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

TYPO3.CMS.Form.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

TYPO3.CMS.Form.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

TYPO3.CMS.Form.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

TYPO3.CMS.Form.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

TYPO3.CMS.Form.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

TYPO3.CMS.Form.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

TYPO3.CMS.Form.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 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.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.templatePathAndFilename

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.templatePathAndFilename

Data type

string

Needed by

Frontend

Mandatory

Yes

Default value
1EmailToReceiver:
2  options:
3    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.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

TYPO3.CMS.Form.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

TYPO3.CMS.Form.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

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.iconIdentifier

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value
1EmailToReceiver:
2  formEditor:
3    iconIdentifier: form-finisher
4    label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label
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.EmailToReceiver.formEditor.label

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value
1EmailToReceiver:
2  formEditor:
3    iconIdentifier: form-finisher
4    label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label
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.EmailToReceiver.formEditor.predefinedDefaults

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Default value
 1EmailToReceiver:
 2  formEditor:
 3    iconIdentifier: form-finisher
 4    label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label
 5    predefinedDefaults:
 6      options:
 7        subject: ''
 8        recipients: {  }
 9        senderAddress: ''
10        senderName: ''
11        replyToRecipients: {  }
12        carbonCopyRecipients: {  }
13        blindCarbonCopyRecipients: {  }
14        addHtmlPart: true
15        attachUploads: true
16        translation:
17          language: 'default'
18        title: ''
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.EmailToReceiver.FormEngine.label

Data type

array

Needed by

Backend (plugin)

Mandatory

Yes

Default value
1EmailToReceiver:
2  FormEngine:
3    label: tt_content.finishersDefinition.EmailToReceiver.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.

@ToDo .. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formengine.elements:

FormEngine.elements

Option path

TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.FormEngine.elements

Data type

array

Needed by

Backend (plugin)

Mandatory

Yes

Default value
  1EmailToReceiver:
  2  FormEngine:
  3    label: tt_content.finishersDefinition.EmailToReceiver.label
  4    elements:
  5      subject:
  6        label: tt_content.finishersDefinition.EmailToReceiver.subject.label
  7        config:
  8          type: input
  9          eval: required
 10      recipients:
 11        title: tt_content.finishersDefinition.EmailToReceiver.recipients.label
 12        type: array
 13        section: true
 14        sectionItemKey: email
 15        sectionItemValue: name
 16        el:
 17          _arrayContainer:
 18            type: array
 19            title: tt_content.finishersDefinition.EmailToSender.recipients.item.label
 20            el:
 21              email:
 22                TCEforms:
 23                  label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
 24                  config:
 25                    type: input
 26                    eval: 'required,email'
 27              name:
 28                TCEforms:
 29                  label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
 30                  config:
 31                    type: input
 32      senderAddress:
 33        label: tt_content.finishersDefinition.EmailToReceiver.senderAddress.label
 34        config:
 35          type: input
 36          eval: required
 37      senderName:
 38        label: tt_content.finishersDefinition.EmailToReceiver.senderName.label
 39        config:
 40          type: input
 41      replyToRecipients:
 42        title: tt_content.finishersDefinition.EmailToReceiver.replyToRecipients.label
 43        type: array
 44        section: true
 45        sectionItemKey: email
 46        sectionItemValue: name
 47        el:
 48          _arrayContainer:
 49            type: array
 50            title: tt_content.finishersDefinition.EmailToSender.replyToRecipients.item.label
 51            el:
 52              email:
 53                TCEforms:
 54                  label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
 55                  config:
 56                    type: input
 57                    eval: 'required,email'
 58              name:
 59                TCEforms:
 60                  label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
 61                  config:
 62                    type: input
 63      carbonCopyRecipients:
 64        title: tt_content.finishersDefinition.EmailToReceiver.carbonCopyRecipients.label
 65        type: array
 66        section: true
 67        sectionItemKey: email
 68        sectionItemValue: name
 69        el:
 70          _arrayContainer:
 71            type: array
 72            title: tt_content.finishersDefinition.EmailToSender.carbonCopyRecipients.item.label
 73            el:
 74              email:
 75                TCEforms:
 76                  label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
 77                  config:
 78                    type: input
 79                    eval: 'required,email'
 80              name:
 81                TCEforms:
 82                  label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
 83                  config:
 84                    type: input
 85      blindCarbonCopyRecipients:
 86        title: tt_content.finishersDefinition.EmailToReceiver.blindCarbonCopyRecipients.label
 87        type: array
 88        section: true
 89        sectionItemKey: email
 90        sectionItemValue: name
 91        el:
 92          _arrayContainer:
 93            type: array
 94            title: tt_content.finishersDefinition.EmailToSender.blindCarbonCopyRecipients.item.label
 95            el:
 96              email:
 97                TCEforms:
 98                  label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
 99                  config:
100                    type: input
101                    eval: 'required,email'
102              name:
103                TCEforms:
104                  label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
105                  config:
106                    type: input
107      addHtmlPart:
108        label: tt_content.finishersDefinition.EmailToReceiver.addHtmlPart.label
109        config:
110          type: check
111          default: 1
112      translation:
113        language:
114          label: tt_content.finishersDefinition.EmailToReceiver.language.label
115          config:
116            type: select
117            renderType: selectSingle
118            minitems: 1
119            maxitems: 1
120            size: 1
121            items:
122              10:
123                - tt_content.finishersDefinition.EmailToReceiver.language.1
124                - default
125      title:
126        label: tt_content.finishersDefinition.EmailToReceiver.title.label
127        config:
128          type: input
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.