TYPO3\CMS\Form\Domain\Finishers\EmailFinisher Class Reference

Inheritance diagram for TYPO3\CMS\Form\Domain\Finishers\EmailFinisher:

Public Attributes
const	FORMAT_PLAINTEXT = 'plaintext'
const	FORMAT_HTML = 'html'

Protected Member Functions
	executeInternal ()
StandaloneView	initializeStandaloneView (FormRuntime $formRuntime)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
string array null	parseOption (string $optionName)
array string	translateFinisherOption ( $subject, FormRuntime $formRuntime, string $optionName, $optionValue, array $translationOptions)
mixed	substituteRuntimeReferences ($needle, FormRuntime $formRuntime)
int string array	resolveRuntimeReference (string $property, FormRuntime $formRuntime)
TypoScriptFrontendController	getTypoScriptFrontendController ()

Protected Attributes
array	$defaultOptions
‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
TYPO3 CMS Extbase Object ObjectManagerInterface	$objectManager
string	$finisherIdentifier = ''
string	$shortFinisherIdentifier = ''
array	$options = array( )
array	$defaultOptions = array( )
TYPO3 CMS Form Domain Finishers FinisherContext	$finisherContext

Additional Inherited Members
‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	__construct (string $finisherIdentifier='')
string	getFinisherIdentifier ()
	setOptions (array $options)
	setOption (string $optionName, $optionValue)
string null	execute (FinisherContext $finisherContext)
bool	isEnabled ()

Detailed Description

This finisher sends an email to one recipient

Options:

• ‪templatePathAndFilename (mandatory): Template path and filename for the mail body
• ‪layoutRootPath: root path for the layouts
• ‪partialRootPath: root path for the partials
• ‪variables: associative array of variables which are available inside the Fluid template

The following options control the mail sending. In all of them, placeholders in the form of {...} are replaced with the corresponding form value; i.e. {email} as recipientAddress makes the recipient address configurable.

• ‪subject (mandatory): Subject of the email
• ‪recipientAddress (mandatory): Email address of the recipient
• ‪recipientName: Human-readable name of the recipient
• ‪senderAddress (mandatory): Email address of the sender
• ‪senderName: Human-readable name of the sender
• ‪replyToAddress: Email address of to be used as reply-to email (use multiple addresses with an array)
• ‪carbonCopyAddress: Email address of the copy recipient (use multiple addresses with an array)
• ‪blindCarbonCopyAddress: Email address of the blind copy recipient (use multiple addresses with an array)
• ‪format: format of the email (one of the FORMAT_* constants). By default mails are sent as HTML

Scope: frontend

Definition at line 53 of file EmailFinisher.php.

Member Function Documentation

executeInternal()

TYPO3\CMS\Form\Domain\Finishers\EmailFinisher::executeInternal ( )

protected

Executes this finisher

See also

‪AbstractFinisher::execute()

Exceptions

FinisherException

Reimplemented from TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

Definition at line 73 of file EmailFinisher.php.

References TYPO3\CMS\Form\Service\TranslationService\getInstance(), TYPO3\CMS\Form\Domain\Finishers\EmailFinisher\initializeStandaloneView(), and TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher\parseOption().

initializeStandaloneView()

StandaloneView TYPO3\CMS\Form\Domain\Finishers\EmailFinisher::initializeStandaloneView ( FormRuntime  $formRuntime )

protected

Parameters

FormRuntime

$formRuntime

Returns

‪StandaloneView

Exceptions

FinisherException

Definition at line 159 of file EmailFinisher.php.

References TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher\parseOption().

Referenced by TYPO3\CMS\Form\Domain\Finishers\EmailFinisher\executeInternal().

Member Data Documentation

$defaultOptions

array TYPO3\CMS\Form\Domain\Finishers\EmailFinisher::$defaultOptions

protected

Initial value:

= array( 
        'recipientName' => '',
        'senderName' => '',
        'format' => self::FORMAT_HTML,
        'attachUploads' => true
     )

Definition at line 60 of file EmailFinisher.php.

FORMAT_HTML

const TYPO3\CMS\Form\Domain\Finishers\EmailFinisher::FORMAT_HTML = 'html'

Definition at line 56 of file EmailFinisher.php.

FORMAT_PLAINTEXT

const TYPO3\CMS\Form\Domain\Finishers\EmailFinisher::FORMAT_PLAINTEXT = 'plaintext'

Definition at line 55 of file EmailFinisher.php.