Finisher\Mail
Sends emails to specified addresses using following subparts in the HTML template:
Properties
.limitMailsToUser
Limits the amount of mails sent to users. If more addresses than this value are specified, emails are only sent to the first x recipients.
Data type
Integer - cObj
Default value
2
Version added
1.0.0
.checkBinaryCrLf
Comma separated list of fields. Converts chr(13) line breaks to break tags.
Data type
String | cObj
Version added
1.0.0
.mailer
Optional:
Use your own class to send the emails.
As of version 1.2.0 there is a second mailer class to be used: Mailer\TYPO3Mailer. This mailer uses the TYPO3 mail classes which were introduced in TYPO3 4.5.
In version 2.1.0 Mailer\HtmlMail was removed! So, the only available mailer is Mailer\TYPO3Mailer.
Data type
Array
Default value
mailer {
class = Mailer\TYPO3Mailer
}
Version added
1.0.0
.view
Class name of the view to be used for the generation of the email content.
Data type
String | cObj
Default value
View\Mail
Version added
1.0.0
.admin.header
Manually configure the email header. All options can be strings, TypoScript objects or names of form fields.
Data type
String | cObj
Version added
1.0.0
admin.templateFile
Path to template file or template code. Allows to use a separate template file for emails.
Data type
String | cObj
Version added
1.0.0
.admin.to_email
Comma separated list of email addresses. Can be addresses or form fields.
Data type
String | cObj
Version added
1.0.0
.admin.to_name
Comma separated list of names corresponding to the addresses in to_email. Can be names or form fields.
Data type
String | cObj
Version added
1.0.0
.admin.sender_email
Email address to be set as sender of the email. Can be addresses or form fields.
Data type
String | cObj
Version added
1.0.0
.admin.sender_name
Name of the email sender. Can be name or form fields.
Data type
String | cObj
Version added
1.0.0
.admin.return_path
Email address to be set as return path.
Data type
String | cObj
Version added
1.0.0
Important
In TYPO3 4.5 this works only if "$TYPO3_CONF_VARS['SYS']['forceReturnPath'] = '1';" is set.
.admin.attachment
Comma separated list of form fields or file names to be attached to the email.
Data type
String | cObj
Version added
1.0.0
.admin.embedFiles
You can embed images in the email rather than attaching it.
Configure the file paths here, defining a key for each file. Using this key, you can access the values in the HTML template by using the markers ###embed_[key]###.
Data type
Array
Version added
2.0.0
Example code
#define the files in TypoScript embedFiles { myFile1 = fileadmin/formhandler_uploads/test.jpg myFile2 = TEXT myFile2.value = fileadmin/formhandler_uploads/Koala.jpg myFile3 = IMG_RESOURCE myFile3 { file = fileadmin/formhandler_uploads/Lighthouse.jpg file.maxW = 100 } } #Access them in HTML <img src="###embed_myFile1###" alt=""> <img src="###embed_myFile2###" alt=""> <img src="###embed_myFile3###" alt="">
.admin.attachGeneratedFiles
Attaches the submitted values as files. You can add as many Generators as you like.
Data type
Array
Version added
1.0.0
Example code
attachGeneratedFiles { 1.class = Generator\TcPdf 1.config { … } 2.class = Generator\Csv 2.config { ... } }
.admin.deleteGeneratedFiles
Delete generated files configured in attachGeneratedFiles after the emails where sent.
Data type
Boolean | cObj
Version added
1.6.0
.admin.htmlEmailAsAttachment
Attaches the generated HTML email to the outgoing email.
Data type
Integer (0,1,2)
Version added
1.0.0
.admin.filePrefix
Sets the prefix of the generated PDF and HTML files attached to email. Use this setting as an array to set different prefixes for the two files.
Data type
String | Array
Default value
formhandler_
Version added
1.0.0
Example code
admin.filePrefix = myForm or for different prefixes: admin.filePrefix { html = myFormHTML pdf = myFormPDF }
.admin.plain.arrayValueSeparator
Specify your own separator for array values in this type of emails. See arrayValueSeparator for more details.
Data type
String | cObj
Default value
,
Version added
1.0.0
.admin.html.arrayValueSeparator
Specify your own separator for array values in this type of emails. See arrayValueSeparator for more details.
Data type
String | cObj
Default value
,
Version added
1.0.0