[TASK] EXT:form - Update documentation
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Configuration / Postprocessors / Mail / Index.rst
1 .. include:: ../../../Includes.txt
2
3
4 .. _reference-postprocessors-mail:
5
6 ====
7 mail
8 ====
9
10 The mail postProcessor sends submitted data by mail.
11
12 .. _reference-postProcessor-mail-mail:
13
14 Mail
15 ====
16
17 Configuration options for the mail to deliver.
18
19
20 .. _reference-postprocessors-mail-ccemail:
21
22 ccEmail
23 -------
24
25 :aspect:`Property:`
26     ccEmail
27
28 :aspect:`Data type:`
29     string
30
31 :aspect:`Description:`
32     Email address the submitted data is sent to as a carbon copy.
33
34
35 .. _reference-postprocessors-mail-organization:
36
37 organization
38 ------------
39
40 :aspect:`Property:`
41     organization
42
43 :aspect:`Data type:`
44     string
45
46 :aspect:`Description:`
47     Organization mail header.
48
49
50 .. _reference-postprocessors-mail-priority:
51
52 priority
53 --------
54
55 :aspect:`Property:`
56     priority
57
58 :aspect:`Data type:`
59     integer
60
61 :aspect:`Description:`
62     Priority of the email. Integer value between 1 and 5. If the priority is
63     configured, but too high, it will be set to 5, which means very low
64     priority.
65
66 :aspect:`Default:`
67     3
68
69
70 .. _reference-postprocessors-mail-recipientemail:
71
72 recipientEmail
73 --------------
74
75 :aspect:`Property:`
76     recipientEmail
77
78 :aspect:`Data type:`
79     string
80
81 :aspect:`Description:`
82     Email address the submitted data is sent to.
83
84
85 .. _reference-postprocessors-mail-senderemail:
86
87 senderEmail
88 -----------
89
90 :aspect:`Property:`
91     senderEmail
92
93 :aspect:`Data type:`
94     string
95
96 :aspect:`Description:`
97     Email address which is shown as sender of the email (from header).
98
99 :aspect:`Default:`
100     TYPO3\_CONF\_VARS['MAIL']['defaultMailFromAddress']
101
102
103 .. _reference-postprocessors-mail-senderemailfield:
104
105 senderEmailField
106 ----------------
107
108 :aspect:`Property:`
109     senderEmailField
110
111 :aspect:`Data type:`
112     string
113
114 :aspect:`Description:`
115     Name of the form field which holds the sender's email address (from
116     header).
117
118     Normally, you can find the (filtered) name in the HTML output between
119     the square brackets like tx\_form[name] where name is the name of the
120     object.
121
122     Only used if senderEmail is not set.
123
124
125 .. _reference-postprocessors-mail-sendername:
126
127 senderName
128 ----------
129
130 :aspect:`Property:`
131     senderName
132
133 :aspect:`Data type:`
134     string
135
136 :aspect:`Description:`
137     Name which is shown as sender of the email (from header).
138
139 :aspect:`Default:`
140     TYPO3\_CONF\_VARS['MAIL']['defaultMailFromName']
141
142
143 .. _reference-postprocessors-mail-sendernamefield:
144
145 senderNameField
146 ---------------
147
148 :aspect:`Property:`
149     senderNameField
150
151 :aspect:`Data type:`
152     string
153
154 :aspect:`Description:`
155     Name of the form field which holds the sender's name (from header).
156
157     Normally you can find the (filtered) name in the HTML output between the
158     square brackets like tx\_form[name] where name is the name of the
159     object.
160
161     Only used if senderName is not set.
162
163
164 .. _reference-form-subject:
165
166 subject
167 -------
168
169 :aspect:`Property:`
170     subject
171
172 :aspect:`Data type:`
173     string
174
175 :aspect:`Description:`
176     Subject of the email sent by the form.
177
178 :aspect:`Default:`
179     Formmail on 'Your\_HOST'
180
181
182 .. _reference-postprocessors-mail-subjectfield:
183
184 subjectField
185 ------------
186
187 :aspect:`Property:`
188     subjectField
189
190 :aspect:`Data type:`
191     string
192
193 :aspect:`Description:`
194     Name of the form field which holds the subject.
195
196     Normally you can find the (filtered) name in the HTML output between the
197     square brackets like tx\_form[name] where name is the name of the
198     object.
199
200     Only used if subject is not set.
201
202 [tsref:(cObject).FORM->postProcessor.mail]
203
204
205 .. _reference-postprocessors-mail-htmlMailTemplatePath:
206
207 htmlMailTemplatePath
208 --------------------
209
210 :aspect:`Property:`
211     htmlMailTemplatePath
212
213 :aspect:`Data type:`
214     string
215
216 :aspect:`Description:`
217     Name of the template to use for HTML-Content.
218
219     Default is `Html`. Useful to use multiple Mail Postprocessors with different templates.
220
221
222 .. _reference-postprocessors-mail-plaintextMailTemplatePath:
223
224 plaintextMailTemplatePath
225 -------------------------
226
227 :aspect:`Property:`
228     plaintextMailTemplatePath
229
230 :aspect:`Data type:`
231     string
232
233 :aspect:`Description:`
234     Name of the template to use for Plaintext-Content.
235
236     Default is `Plain`. Useful to use multiple Mail Postprocessors with different templates.
237
238 .. _reference-postProcessor-mail-messages:
239
240 Messages
241 ========
242
243 .. _reference-postprocessors-mail-messages-error:
244
245 messages.error
246 --------------
247
248 :aspect:`Property:`
249     messages.error
250
251 :aspect:`Data type:`
252     string/ cObject
253
254 :aspect:`Description:`
255     Overriding the default text of the error message, describing the error.
256
257     When no cObject type is set, the message is a simple string. The value
258     can directly be assigned to the messages.error property. If one needs
259     the functionality of cObjects, just define the message appropriately.
260     Any cObject is allowed.
261
262     For more information about cObjects, take a look in the document TSREF.
263
264     **Example:**
265
266     .. code-block:: typoscript
267
268       messages.error = TEXT
269       messages.error {
270         data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:messagesError
271       }
272
273     **Example:**
274
275     .. code-block:: typoscript
276
277       messages.error = Error while submitting form
278
279 :aspect:`Description:`
280     *Local language:*"There was an error when sending the form by mail"
281
282
283 .. _reference-postprocessors-mail-messages-success:
284
285 messages.success
286 ----------------
287
288 :aspect:`Property:`
289     messages.success
290
291 :aspect:`Data type:`
292     string/ cObject
293
294 :aspect:`Description:`
295     Overriding the default text of the confirmation message.
296
297     When no cObject type is set, the message is a simple string. The value
298     can directly be assigned to the messages.success property. If one needs
299     the functionality of cObjects, just define the message appropriately.
300     Any cObject is allowed.
301
302     For more information about cObjects, take a look in the document TSREF.
303
304     **Example:**
305
306     .. code-block:: typoscript
307
308       messages.success = TEXT
309       messages.success {
310         data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:messagesSuccess
311       }
312
313     **Example:**
314
315     .. code-block:: typoscript
316
317       messages.success = Thanks for submitting
318
319 :aspect:`Default:`
320     *Local language:*"The form has been sent successfully by mail"
321