From 00049e47f5db7c66254e49df64772e1c574a82da Mon Sep 17 00:00:00 2001 From: David Bruchmann <noreply@example.com> Date: Fri, 26 Nov 2021 09:09:12 +0000 Subject: [PATCH] [DOCS] Add example for finisher option "recipients" The new option is explained here: https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/10.0/Featur e-80420-AllowMultipleRecipientsInEmailFinisher.html Releases: main, 11.5 Resolves: #96086 Change-Id: I740e360735e09d07f5a6f16513317e4b226fd0b1 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/74937 Tested-by: core-ci <typo3@b13.com> Tested-by: Nikita Hovratov <nikita.h@live.de> Reviewed-by: Nikita Hovratov <nikita.h@live.de> --- .../finishers/EmailToReceiver.rst | 27 +++++++++++++------ .../finishers/EmailToSender.rst | 27 +++++++++++++------ 2 files changed, 38 insertions(+), 16 deletions(-) diff --git a/typo3/sysext/form/Documentation/I/Config/proto/finishersDefinition/finishers/EmailToReceiver.rst b/typo3/sysext/form/Documentation/I/Config/proto/finishersDefinition/finishers/EmailToReceiver.rst index 0317118fca7c..d519b2fb06d5 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/finishersDefinition/finishers/EmailToReceiver.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/finishersDefinition/finishers/EmailToReceiver.rst @@ -80,27 +80,38 @@ options.recipients ------------------ :aspect:`Option path` - TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.recipients + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.recipients :aspect:`Data type` - array + array :aspect:`Needed by` - Frontend + Frontend :aspect:`Mandatory` - Yes + Yes :aspect:`Default value` - undefined + undefined :aspect:`Good to know` - - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` - - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :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). + 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 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.senderaddress: diff --git a/typo3/sysext/form/Documentation/I/Config/proto/finishersDefinition/finishers/EmailToSender.rst b/typo3/sysext/form/Documentation/I/Config/proto/finishersDefinition/finishers/EmailToSender.rst index 7f6dea572082..e50f6ee340c0 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/finishersDefinition/finishers/EmailToSender.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/finishersDefinition/finishers/EmailToSender.rst @@ -80,27 +80,38 @@ options.recipients ------------------ :aspect:`Option path` - TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.recipients + TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.recipients :aspect:`Data type` - array + array :aspect:`Needed by` - Frontend + Frontend :aspect:`Mandatory` - Yes + Yes :aspect:`Default value` - undefined + undefined :aspect:`Good to know` - - :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>` - - :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>` + - :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). + 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 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.senderaddress: -- GitLab