[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.recipients¶
- Option path
- TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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.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.replyToRecipients¶
- Option path
- TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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.EmailToSender.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.EmailToSender.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.EmailToSender.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.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.title¶
- Option path
- TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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.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
- 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
- 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
EmailToSender: formEditor: iconIdentifier: form-finisher label: formEditor.elements.Form.finisher.EmailToSender.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.EmailToSender.formEditor.label
- Data type
- string
- Needed by
- Backend (form editor)
- Mandatory
- Yes
- Default value
1 2 3 4
EmailToSender: formEditor: iconIdentifier: form-finisher label: formEditor.elements.Form.finisher.EmailToSender.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.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: '' recipients: { } senderAddress: '' senderName: '' replyToRecipients: { } carbonCopyRecipients: { } blindCarbonCopyRecipients: { } addHtmlPart: true attachUploads: true translation: language: 'default' 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.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 theform 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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
EmailToSender: FormEngine: label: tt_content.finishersDefinition.EmailToSender.label elements: subject: label: tt_content.finishersDefinition.EmailToSender.subject.label config: type: input eval: required recipients: title: tt_content.finishersDefinition.EmailToSender.recipients.label type: array section: true sectionItemKey: email sectionItemValue: name el: _arrayContainer: type: array title: tt_content.finishersDefinition.EmailToSender.recipients.item.label el: email: TCEforms: label: tt_content.finishersDefinition.EmailToSender.recipients.email.label config: type: input eval: 'required,email' name: TCEforms: label: tt_content.finishersDefinition.EmailToSender.recipients.name.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 replyToRecipients: title: tt_content.finishersDefinition.EmailToSender.replyToRecipients.label type: array section: true sectionItemKey: email sectionItemValue: name el: _arrayContainer: type: array title: tt_content.finishersDefinition.EmailToSender.replyToRecipients.item.label el: email: TCEforms: label: tt_content.finishersDefinition.EmailToSender.recipients.email.label config: type: input eval: 'required,email' name: TCEforms: label: tt_content.finishersDefinition.EmailToSender.recipients.name.label config: type: input carbonCopyRecipients: title: tt_content.finishersDefinition.EmailToSender.carbonCopyRecipients.label type: array section: true sectionItemKey: email sectionItemValue: name el: _arrayContainer: type: array title: tt_content.finishersDefinition.EmailToSender.carbonCopyRecipients.item.label el: email: TCEforms: label: tt_content.finishersDefinition.EmailToSender.recipients.email.label config: type: input eval: 'required,email' name: TCEforms: label: tt_content.finishersDefinition.EmailToSender.recipients.name.label config: type: input blindCarbonCopyRecipients: title: tt_content.finishersDefinition.EmailToSender.blindCarbonCopyRecipients.label type: array section: true sectionItemKey: email sectionItemValue: name el: _arrayContainer: type: array title: tt_content.finishersDefinition.EmailToSender.blindCarbonCopyRecipients.item.label el: email: TCEforms: label: tt_content.finishersDefinition.EmailToSender.recipients.email.label config: type: input eval: 'required,email' name: TCEforms: label: tt_content.finishersDefinition.EmailToSender.recipients.name.label config: type: input addHtmlPart: label: tt_content.finishersDefinition.EmailToSender.addHtmlPart.label config: type: check default: 1 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 title: label: tt_content.finishersDefinition.EmailToSender.title.label config: 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 theform plugin
, then an array keypageUid
has to exists withinTYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements
. The configuration withinTYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.elements.pageUid
must follow the TCA syntax.