TYPO3 CMS  TYPO3_7-6
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Form\PostProcess\MailPostProcessor Class Reference
Inheritance diagram for TYPO3\CMS\Form\PostProcess\MailPostProcessor:
TYPO3\CMS\Form\PostProcess\AbstractPostProcessor TYPO3\CMS\Form\PostProcess\PostProcessorInterface

Public Member Functions

 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManager $objectManager)
 
 injectSessionUtility (\TYPO3\CMS\Form\Utility\SessionUtility $sessionUtility)
 
 __construct (\TYPO3\CMS\Form\Domain\Model\Element $form, array $typoScript)
 
 process ()
 
- Public Member Functions inherited from TYPO3\CMS\Form\PostProcess\AbstractPostProcessor
 setControllerContext (\TYPO3\CMS\Form\Mvc\Controller\ControllerContext $controllerContext)
 
- Public Member Functions inherited from TYPO3\CMS\Form\PostProcess\PostProcessorInterface
 setControllerContext (\TYPO3\CMS\Form\Mvc\Controller\ControllerContext $controllerContext)
 

Public Attributes

const LOCALISATION_OBJECT_NAME = 'tx_form_view_mail'
 

Protected Member Functions

 setSubject ()
 
 setFrom ()
 
 setTo ()
 
 setCc ()
 
 setReplyTo ()
 
 setPriority ()
 
 setOrganization ()
 
 setCharacterSet ()
 
 setHtmlContent ()
 
 setPlainContent ()
 
 send ()
 
 render ()
 
 sanitizeHeaderString ($string)
 
 addAttachmentsFromSession ()
 
 setTemplatePaths ()
 
 renderMessage ($messageType)
 
 getLocalLanguageLabel ($type='')
 
 getTypoScriptValueFromIncomingData ($propertyName)
 

Protected Attributes

 $objectManager
 
 $sessionUtility
 
 $formUtility
 
 $form
 
 $typoScript
 
 $mailMessage
 
 $htmlMailTemplatePath = 'Html'
 
 $plaintextMailTemplatePath = 'Plain'
 
 $dirtyHeaders = []
 
- Protected Attributes inherited from TYPO3\CMS\Form\PostProcess\AbstractPostProcessor
 $controllerContext
 

Detailed Description

The mail post processor

Definition at line 27 of file MailPostProcessor.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::__construct ( \TYPO3\CMS\Form\Domain\Model\Element  $form,
array  $typoScript 
)

Constructor

Parameters
\TYPO3\CMS\Form\Domain\Model\Element$formForm domain model
array$typoScriptPost processor TypoScript settings

Implements TYPO3\CMS\Form\PostProcess\PostProcessorInterface.

Definition at line 105 of file MailPostProcessor.php.

References TYPO3\CMS\Form\PostProcess\MailPostProcessor\$form, TYPO3\CMS\Form\PostProcess\MailPostProcessor\$typoScript, TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Form\PostProcess\MailPostProcessor\setTemplatePaths().

Member Function Documentation

◆ addAttachmentsFromSession()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::addAttachmentsFromSession ( )
protected

Loop through all elements of the session and attach the file if its a uploaded file

Returns
void

Definition at line 435 of file MailPostProcessor.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\isAllowedAbsPath().

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ getLocalLanguageLabel()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::getLocalLanguageLabel (   $type = '')
protected

Get the local language label(s) for the message In some cases this method will be override by rule class

Parameters
string$typeThe type
Returns
string The local language message label

Definition at line 542 of file MailPostProcessor.php.

References TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\renderMessage().

◆ getTypoScriptValueFromIncomingData()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::getTypoScriptValueFromIncomingData (   $propertyName)
protected

Determines user submitted data from a field that has been defined as TypoScript property.

Parameters
string$propertyName
Returns
NULL|mixed

Definition at line 556 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\setFrom(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setReplyTo(), and TYPO3\CMS\Form\PostProcess\MailPostProcessor\setSubject().

◆ injectObjectManager()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManager  $objectManager)
Parameters
\TYPO3\CMS\Extbase\Object\ObjectManager$objectManager
Returns
void

Definition at line 85 of file MailPostProcessor.php.

References TYPO3\CMS\Form\PostProcess\MailPostProcessor\$objectManager.

◆ injectSessionUtility()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::injectSessionUtility ( \TYPO3\CMS\Form\Utility\SessionUtility  $sessionUtility)
Parameters
\TYPO3\CMS\Form\Utility\SessionUtility$sessionUtility
Returns
void

Definition at line 94 of file MailPostProcessor.php.

References TYPO3\CMS\Form\PostProcess\MailPostProcessor\$sessionUtility.

◆ process()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::process ( )

The main method called by the post processor

Configures the mail message

Returns
string HTML message from this processor

Implements TYPO3\CMS\Form\PostProcess\PostProcessorInterface.

Definition at line 120 of file MailPostProcessor.php.

References TYPO3\CMS\Form\PostProcess\MailPostProcessor\addAttachmentsFromSession(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\render(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\send(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setCc(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setFrom(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setHtmlContent(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setOrganization(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setPlainContent(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setPriority(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setReplyTo(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setSubject(), and TYPO3\CMS\Form\PostProcess\MailPostProcessor\setTo().

◆ render()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::render ( )
protected

Render the message after trying to send the mail

Returns
string HTML message from the mail view

Definition at line 403 of file MailPostProcessor.php.

References TYPO3\CMS\Form\PostProcess\MailPostProcessor\renderMessage().

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ renderMessage()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::renderMessage (   $messageType)
protected

Render the processor message

Parameters
string$messageType
Returns
string

Definition at line 526 of file MailPostProcessor.php.

References TYPO3\CMS\Form\PostProcess\MailPostProcessor\getLocalLanguageLabel().

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\render().

◆ sanitizeHeaderString()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::sanitizeHeaderString (   $string)
protected

Checks string for suspicious characters

Parameters
string$stringString to check
Returns
string Valid or empty string

Definition at line 419 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\setFrom(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\setOrganization(), and TYPO3\CMS\Form\PostProcess\MailPostProcessor\setSubject().

◆ send()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::send ( )
protected

Sends the mail. Sending the mail requires the recipient and message to be set.

Returns
void

Definition at line 391 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ setCc()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setCc ( )
protected

Adds the carbon copy receiver of the mail message when configured

Checks the address if it is a valid email address

Returns
void

Definition at line 259 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ setCharacterSet()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setCharacterSet ( )
protected

Set the default character set used

Respect formMailCharset if it was set, otherwise use metaCharset for mail if different from renderCharset

Returns
void

Definition at line 346 of file MailPostProcessor.php.

References $GLOBALS.

◆ setFrom()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setFrom ( )
protected

Sets the sender of the mail message

Mostly the sender is a combination of the name and the email address

Returns
void

Definition at line 168 of file MailPostProcessor.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MailUtility\getSystemFromAddress(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\getTypoScriptValueFromIncomingData(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\sanitizeHeaderString(), and TYPO3\CMS\Core\Utility\GeneralUtility\validEmail().

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ setHtmlContent()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setHtmlContent ( )
protected

Add the HTML content

Add a MimePart of the type text/html to the message.

Returns
void

Definition at line 366 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ setOrganization()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setOrganization ( )
protected

Add a text header to the mail header of the type Organization

Sanitizes the header string when necessary

Returns
void

Definition at line 324 of file MailPostProcessor.php.

References TYPO3\CMS\Form\PostProcess\MailPostProcessor\sanitizeHeaderString().

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ setPlainContent()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setPlainContent ( )
protected

Add the plain content

Add a MimePart of the type text/plain to the message.

Returns
void

Definition at line 379 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ setPriority()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setPriority ( )
protected

Set the priority of the mail message

When not in settings, the value will be 3. If the priority is configured, but too big, it will be set to 5, which means very low.

Returns
void

Definition at line 302 of file MailPostProcessor.php.

References TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange().

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ setReplyTo()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setReplyTo ( )
protected

Adds the reply to header of the mail message when configured

Checks the address if it is a valid email address

Returns
void

Definition at line 278 of file MailPostProcessor.php.

References TYPO3\CMS\Form\PostProcess\MailPostProcessor\getTypoScriptValueFromIncomingData().

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ setSubject()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setSubject ( )
protected

Sets the subject of the mail message

If not configured, it will use a default setting

Returns
void

Definition at line 144 of file MailPostProcessor.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Form\PostProcess\MailPostProcessor\getTypoScriptValueFromIncomingData(), and TYPO3\CMS\Form\PostProcess\MailPostProcessor\sanitizeHeaderString().

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

◆ setTemplatePaths()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setTemplatePaths ( )
protected

Set the html and plaintext templates

Returns
void

Definition at line 461 of file MailPostProcessor.php.

References TYPO3\CMS\Form\PostProcess\MailPostProcessor\$typoScript.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\__construct().

◆ setTo()

TYPO3\CMS\Form\PostProcess\MailPostProcessor::setTo ( )
protected

Adds the receiver of the mail message when configured

Checks the address if it is a valid email address

Returns
void

Definition at line 240 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\process().

Member Data Documentation

◆ $dirtyHeaders

TYPO3\CMS\Form\PostProcess\MailPostProcessor::$dirtyHeaders = []
protected

Definition at line 79 of file MailPostProcessor.php.

◆ $form

TYPO3\CMS\Form\PostProcess\MailPostProcessor::$form
protected

Definition at line 54 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\__construct().

◆ $formUtility

TYPO3\CMS\Form\PostProcess\MailPostProcessor::$formUtility
protected

Definition at line 49 of file MailPostProcessor.php.

◆ $htmlMailTemplatePath

TYPO3\CMS\Form\PostProcess\MailPostProcessor::$htmlMailTemplatePath = 'Html'
protected

Definition at line 69 of file MailPostProcessor.php.

◆ $mailMessage

TYPO3\CMS\Form\PostProcess\MailPostProcessor::$mailMessage
protected

Definition at line 64 of file MailPostProcessor.php.

◆ $objectManager

TYPO3\CMS\Form\PostProcess\MailPostProcessor::$objectManager
protected

Definition at line 39 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\injectObjectManager().

◆ $plaintextMailTemplatePath

TYPO3\CMS\Form\PostProcess\MailPostProcessor::$plaintextMailTemplatePath = 'Plain'
protected

Definition at line 74 of file MailPostProcessor.php.

◆ $sessionUtility

TYPO3\CMS\Form\PostProcess\MailPostProcessor::$sessionUtility
protected

Definition at line 44 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\injectSessionUtility().

◆ $typoScript

TYPO3\CMS\Form\PostProcess\MailPostProcessor::$typoScript
protected

Definition at line 59 of file MailPostProcessor.php.

Referenced by TYPO3\CMS\Form\PostProcess\MailPostProcessor\__construct(), and TYPO3\CMS\Form\PostProcess\MailPostProcessor\setTemplatePaths().

◆ LOCALISATION_OBJECT_NAME

const TYPO3\CMS\Form\PostProcess\MailPostProcessor::LOCALISATION_OBJECT_NAME = 'tx_form_view_mail'

Definition at line 34 of file MailPostProcessor.php.