.. include:: /Includes.rst.txt


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver:

=================
[EmailToReceiver]
=================

.. _prototypes.prototypeIdentifier.finishersdefinitionemailtoreceiver-properties:

Properties
==========


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.implementationclassname:

implementationClassName
-----------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.implementationClassName

:aspect:`Data type`
      string

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      Yes

:aspect:`Default value`
      .. code-block:: yaml
         :linenos:
         :emphasize-lines: 2

         EmailToReceiver:
           implementationClassName: TYPO3\CMS\Form\Domain\Finishers\EmailFinisher

:aspect:`Good to know`
      - :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`

:aspect:`Description`
      .. include:: ../properties/implementationClassName.rst.txt


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.subject:

options.subject
---------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.subject

:aspect:`Data type`
      string

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      Yes

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
      - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`

:aspect:`Description`
      Subject of the email.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.recipients:

options.recipients
------------------

:aspect:`Option path`
    prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.recipients

:aspect:`Data type`
    array

:aspect:`Needed by`
    Frontend

:aspect:`Mandatory`
    Yes

:aspect:`Default value`
    undefined

:aspect:`Good to know`
    - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
    - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`

:aspect:`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:

    .. code-block:: yaml

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

.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.senderaddress:

options.senderAddress
---------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.senderAddress

:aspect:`Data type`
      string

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      Yes

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`

:aspect:`Description`
      Email address of the sender/ visitor (From).


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.sendername:

options.senderName
------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.senderName

:aspect:`Data type`
      string

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      empty string

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`

:aspect:`Description`
      Human-readable name of the sender.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.replytorecipients:

options.replyToRecipients
-------------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.replyToRecipients

:aspect:`Data type`
      array

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`

:aspect:`Description`
      Email addresses of to be used as reply-to emails.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.carboncopyrecipients:

options.carbonCopyRecipients
----------------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.carbonCopyRecipients

:aspect:`Data type`
      array

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`

:aspect:`Description`
      Email addresses of the copy recipient.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.blindcarbonCopyrecipients:

options.blindCarbonCopyRecipients
---------------------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.blindCarbonCopyRecipients

:aspect:`Data type`
      array

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`

:aspect:`Description`
      Email address of the blind copy recipient.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.addhtmlpart:

options.addHtmlPart
-------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.addHtmlPart

:aspect:`Data type`
      bool

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      true

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`

:aspect:`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.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.attachuploads:

options.attachUploads
---------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.attachUploads

:aspect:`Data type`
      bool

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      true

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`

:aspect:`Description`
      If set, all uploaded items are attached to the email.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.title:

options.title
-------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.title

:aspect:`Data type`
      string

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`

:aspect:`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.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.translation.language:

options.translation.language
----------------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.translation.language

:aspect:`Data type`
      string

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
      - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`

:aspect:`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 :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.translation.propertiesExcludedFromTranslation:

options.translation.propertiesExcludedFromTranslation
-----------------------------------------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.translation.propertiesExcludedFromTranslation

:aspect:`Data type`
      array

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
      - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`

:aspect:`Description`
      Localization from translation files will be skipped for all specified finisher options.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.translation.translationfiles:

options.translation.translationFiles
------------------------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.translation.translationFiles

:aspect:`Data type`
      array

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
      - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
      - :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`

:aspect:`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 :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.partialrootpaths:

options.partialRootPaths
------------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.partialRootPaths

:aspect:`Data type`
      array

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`

:aspect:`Description`
      Fluid partial paths.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.layoutrootpaths:

options.layoutRootPaths
-----------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.layoutRootPaths

:aspect:`Data type`
      array

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`

:aspect:`Description`
      Fluid layout paths.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.options.variables:

options.variables
-----------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.variables

:aspect:`Data type`
      array

:aspect:`Needed by`
      Frontend

:aspect:`Mandatory`
      No

:aspect:`Default value`
      undefined

:aspect:`Good to know`
      - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`

:aspect:`Description`
      Associative array of variables which are available inside the Fluid template.


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.formeditor.iconidentifier:

formeditor.iconIdentifier
-------------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.iconIdentifier

:aspect:`Data type`
      string

:aspect:`Needed by`
      Backend (form editor)

:aspect:`Mandatory`
      Yes

:aspect:`Default value`
      .. code-block:: yaml
         :linenos:
         :emphasize-lines: 3

         EmailToReceiver:
           formEditor:
             iconIdentifier: form-finisher
             label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label

.. :aspect:`Good to know`
      ToDo

:aspect:`Description`
      .. include:: ../properties/iconIdentifier.rst.txt


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.formeditor.label:

formeditor.label
----------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.label

:aspect:`Data type`
      string

:aspect:`Needed by`
      Backend (form editor)

:aspect:`Mandatory`
      Yes

:aspect:`Default value`
      .. code-block:: yaml
         :linenos:
         :emphasize-lines: 4

         EmailToReceiver:
           formEditor:
             iconIdentifier: form-finisher
             label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label

:aspect:`Good to know`
      - :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
      .. include:: ../properties/label.rst.txt


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.formeditor.predefineddefaults:

formeditor.predefinedDefaults
-----------------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.formEditor.predefinedDefaults

:aspect:`Data type`
      array

:aspect:`Needed by`
      Backend (form editor)

:aspect:`Mandatory`
      No

:aspect:`Default value`
      .. code-block:: yaml
         :linenos:
         :emphasize-lines: 5-

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

.. :aspect:`Good to know`
      ToDo

:aspect:`Description`
      .. include:: ../properties/predefinedDefaults.rst.txt


.. _prototypes.prototypeIdentifier.finishersdefinition.emailtoreceiver.formengine.label:

FormEngine.label
----------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.FormEngine.label

:aspect:`Data type`
      array

:aspect:`Needed by`
      Backend (plugin)

:aspect:`Mandatory`
      Yes

:aspect:`Default value`
      .. code-block:: yaml
         :linenos:
         :emphasize-lines: 3

         EmailToReceiver:
           FormEngine:
             label: tt_content.finishersDefinition.EmailToReceiver.label

:aspect:`Good to know`
      - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
      .. include:: ../properties/formEngine/label.rst.txt


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

FormEngine.elements
-------------------

:aspect:`Option path`
      prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.FormEngine.elements

:aspect:`Data type`
      array

:aspect:`Needed by`
      Backend (plugin)

:aspect:`Mandatory`
      Yes

:aspect:`Default value`
      .. code-block:: yaml
         :linenos:
         :emphasize-lines: 4-

         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

:aspect:`Good to know`
      - :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
      .. include:: ../properties/formEngine/elements.rst.txt
