[TASK] Document further options for mail post processor 39/47739/5
authorDaniel Siepmann <daniel.siepmann@typo3.org>
Mon, 18 Apr 2016 09:33:13 +0000 (11:33 +0200)
committerNicole Cordes <typo3@cordes.co>
Fri, 22 Apr 2016 11:25:37 +0000 (13:25 +0200)
* As it's possible to configure the template to use for each instance of
  the post processor, this should be documented.
* Also grouped options regarding part. E.g. email or frontend
* messages.

Resolves: #75754
Releases: master
Change-Id: Ie8cd0702ced989bd4d9306ffe50506981f4c47e4
Reviewed-on: https://review.typo3.org/47739
Reviewed-by: Frank Naegler <frank.naegler@typo3.org>
Tested-by: Frank Naegler <frank.naegler@typo3.org>
Reviewed-by: Nicole Cordes <typo3@cordes.co>
Tested-by: Nicole Cordes <typo3@cordes.co>
typo3/sysext/form/Documentation/Configuration/Postprocessors/Mail/Index.rst

index 0a7e1b5..66027f4 100644 (file)
@@ -9,11 +9,18 @@ mail
 
 The mail postProcessor sends submitted data by mail.
 
+.. _reference-postProcessor-mail-mail:
+
+Mail
+====
+
+Configuration options for the mail to deliver.
+
 
 .. _reference-postprocessors-mail-ccemail:
 
 ccEmail
-=======
+-------
 
 :aspect:`Property:`
     ccEmail
@@ -22,93 +29,13 @@ ccEmail
     string
 
 :aspect:`Description:`
-    Email address the submitted data gets sent to as a carbon copy.
-
-
-.. _reference-postprocessors-mail-messages-error:
-
-messages.error
-==============
-
-:aspect:`Property:`
-    messages.error
-
-:aspect:`Data type:`
-    string/ cObject
-
-:aspect:`Description:`
-    Overriding the default text of the error message, describing the error.
-
-    When no cObject type is set, the message is a simple string. The value
-    can directly be assigned to the messages.error property. If one needs
-    the functionality of cObjects, just define the message appropriately.
-    Any cObject is allowed.
-
-    For more information about cObjects, take a look in the document TSREF.
-
-    **Example:**
-
-    .. code-block:: typoscript
-
-      messages.error = TEXT
-      messages.error {
-        data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:messagesError
-      }
-
-    **Example:**
-
-    .. code-block:: typoscript
-
-      messages.error = Error while submitting form
-
-:aspect:`Description:`
-    *Local language:*"There was an error when sending the form by mail"
-
-
-.. _reference-postprocessors-mail-messages-success:
-
-messages.success
-================
-
-:aspect:`Property:`
-    messages.success
-
-:aspect:`Data type:`
-    string/ cObject
-
-:aspect:`Description:`
-    Overriding the default text of the confirmation message.
-
-    When no cObject type is set, the message is a simple string. The value
-    can directly be assigned to the messages.success property. If one needs
-    the functionality of cObjects, just define the message appropriately.
-    Any cObject is allowed.
-
-    For more information about cObjects, take a look in the document TSREF.
-
-    **Example:**
-
-    .. code-block:: typoscript
-
-      messages.success = TEXT
-      messages.success {
-        data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:messagesSuccess
-      }
-
-    **Example:**
-
-    .. code-block:: typoscript
-
-      messages.success = Thanks for submitting
-
-:aspect:`Default:`
-    *Local language:*"The form has been sent successfully by mail"
+    Email address the submitted data is sent to as a carbon copy.
 
 
 .. _reference-postprocessors-mail-organization:
 
 organization
-============
+------------
 
 :aspect:`Property:`
     organization
@@ -123,7 +50,7 @@ organization
 .. _reference-postprocessors-mail-priority:
 
 priority
-========
+--------
 
 :aspect:`Property:`
     priority
@@ -143,7 +70,7 @@ priority
 .. _reference-postprocessors-mail-recipientemail:
 
 recipientEmail
-==============
+--------------
 
 :aspect:`Property:`
     recipientEmail
@@ -152,13 +79,13 @@ recipientEmail
     string
 
 :aspect:`Description:`
-    Email address the submitted data gets sent to.
+    Email address the submitted data is sent to.
 
 
 .. _reference-postprocessors-mail-senderemail:
 
 senderEmail
-===========
+-----------
 
 :aspect:`Property:`
     senderEmail
@@ -176,7 +103,7 @@ senderEmail
 .. _reference-postprocessors-mail-senderemailfield:
 
 senderEmailField
-================
+----------------
 
 :aspect:`Property:`
     senderEmailField
@@ -198,7 +125,7 @@ senderEmailField
 .. _reference-postprocessors-mail-sendername:
 
 senderName
-==========
+----------
 
 :aspect:`Property:`
     senderName
@@ -216,7 +143,7 @@ senderName
 .. _reference-postprocessors-mail-sendernamefield:
 
 senderNameField
-===============
+---------------
 
 :aspect:`Property:`
     senderNameField
@@ -237,7 +164,7 @@ senderNameField
 .. _reference-form-subject:
 
 subject
-=======
+-------
 
 :aspect:`Property:`
     subject
@@ -255,7 +182,7 @@ subject
 .. _reference-postprocessors-mail-subjectfield:
 
 subjectField
-============
+------------
 
 :aspect:`Property:`
     subjectField
@@ -274,3 +201,122 @@ subjectField
 
 [tsref:(cObject).FORM->postProcessor.mail]
 
+
+.. _reference-postprocessors-mail-htmlMailTemplatePath:
+
+htmlMailTemplatePath
+--------------------
+
+:aspect:`Property:`
+    htmlMailTemplatePath
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Name of the template to use for HTML-Content.
+
+    Default is `Html`. Useful to use multiple Mail Postprocessors with different templates.
+
+
+.. _reference-postprocessors-mail-plaintextMailTemplatePath:
+
+plaintextMailTemplatePath
+-------------------------
+
+:aspect:`Property:`
+    plaintextMailTemplatePath
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Name of the template to use for Plaintext-Content.
+
+    Default is `Plain`. Useful to use multiple Mail Postprocessors with different templates.
+
+.. _reference-postProcessor-mail-messages:
+
+Messages
+========
+
+.. _reference-postprocessors-mail-messages-error:
+
+messages.error
+--------------
+
+:aspect:`Property:`
+    messages.error
+
+:aspect:`Data type:`
+    string/ cObject
+
+:aspect:`Description:`
+    Overriding the default text of the error message, describing the error.
+
+    When no cObject type is set, the message is a simple string. The value
+    can directly be assigned to the messages.error property. If one needs
+    the functionality of cObjects, just define the message appropriately.
+    Any cObject is allowed.
+
+    For more information about cObjects, take a look in the document TSREF.
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      messages.error = TEXT
+      messages.error {
+        data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:messagesError
+      }
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      messages.error = Error while submitting form
+
+:aspect:`Description:`
+    *Local language:*"There was an error when sending the form by mail"
+
+
+.. _reference-postprocessors-mail-messages-success:
+
+messages.success
+----------------
+
+:aspect:`Property:`
+    messages.success
+
+:aspect:`Data type:`
+    string/ cObject
+
+:aspect:`Description:`
+    Overriding the default text of the confirmation message.
+
+    When no cObject type is set, the message is a simple string. The value
+    can directly be assigned to the messages.success property. If one needs
+    the functionality of cObjects, just define the message appropriately.
+    Any cObject is allowed.
+
+    For more information about cObjects, take a look in the document TSREF.
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      messages.success = TEXT
+      messages.success {
+        data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:messagesSuccess
+      }
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      messages.success = Thanks for submitting
+
+:aspect:`Default:`
+    *Local language:*"The form has been sent successfully by mail"
+
+