[EmailToReceiver]

Properties

implementationClassName

Option path

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

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

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 'dk' 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
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

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

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

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 .. _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
  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          required: true
 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                label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
 23                config:
 24                  type: email
 25                  required: true
 26              name:
 27                label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
 28                config:
 29                  type: input
 30      senderAddress:
 31        label: tt_content.finishersDefinition.EmailToReceiver.senderAddress.label
 32        config:
 33          type: input
 34          required: true
 35      senderName:
 36        label: tt_content.finishersDefinition.EmailToReceiver.senderName.label
 37        config:
 38          type: input
 39      replyToRecipients:
 40        title: tt_content.finishersDefinition.EmailToReceiver.replyToRecipients.label
 41        type: array
 42        section: true
 43        sectionItemKey: email
 44        sectionItemValue: name
 45        el:
 46          _arrayContainer:
 47            type: array
 48            title: tt_content.finishersDefinition.EmailToSender.replyToRecipients.item.label
 49            el:
 50              email:
 51                label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
 52                config:
 53                  type: email
 54                  required: true
 55              name:
 56                label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
 57                config:
 58                  type: input
 59      carbonCopyRecipients:
 60        title: tt_content.finishersDefinition.EmailToReceiver.carbonCopyRecipients.label
 61        type: array
 62        section: true
 63        sectionItemKey: email
 64        sectionItemValue: name
 65        el:
 66          _arrayContainer:
 67            type: array
 68            title: tt_content.finishersDefinition.EmailToSender.carbonCopyRecipients.item.label
 69            el:
 70              email:
 71                label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
 72                config:
 73                  type: email
 74                  required: true
 75              name:
 76                label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
 77                config:
 78                  type: input
 79      blindCarbonCopyRecipients:
 80        title: tt_content.finishersDefinition.EmailToReceiver.blindCarbonCopyRecipients.label
 81        type: array
 82        section: true
 83        sectionItemKey: email
 84        sectionItemValue: name
 85        el:
 86          _arrayContainer:
 87            type: array
 88            title: tt_content.finishersDefinition.EmailToSender.blindCarbonCopyRecipients.item.label
 89            el:
 90              email:
 91                label: tt_content.finishersDefinition.EmailToSender.recipients.email.label
 92                config:
 93                  type: email
 94                  required: true
 95              name:
 96                label: tt_content.finishersDefinition.EmailToSender.recipients.name.label
 97                config:
 98                  type: input
 99      addHtmlPart:
100        label: tt_content.finishersDefinition.EmailToReceiver.addHtmlPart.label
101        config:
102          type: check
103          default: 1
104      translation:
105        language:
106          label: tt_content.finishersDefinition.EmailToReceiver.language.label
107          config:
108            type: select
109            renderType: selectSingle
110            minitems: 1
111            maxitems: 1
112            size: 1
113            items:
114              10:
115                - tt_content.finishersDefinition.EmailToReceiver.language.1
116                - default
117      title:
118        label: tt_content.finishersDefinition.EmailToReceiver.title.label
119        config:
120          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 prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements. The configuration within prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.elements.pageUid must follow the TCA syntax.