‪TYPO3CMS  11.5
TYPO3\CMS\Core\Mail\FluidEmail Class Reference
Inheritance diagram for TYPO3\CMS\Core\Mail\FluidEmail:

Public Member Functions

 __construct (?TemplatePaths $templatePaths=null, ?Headers $headers=null, ?AbstractPart $body=null)
 
 format (string $format)
 
 setTemplate (string $templateName)
 
 assign ($key, $value)
 
 assignMultiple (array $values)
 
 setRequest (ServerRequestInterface $request)
 
 ensureValidity ()
 
 getBody ()
 
resource string null getHtmlBody (bool $forceBodyGeneration=false)
 
resource string null getTextBody (bool $forceBodyGeneration=false)
 
ViewHelperVariableContainer getViewHelperVariableContainer ()
 

Public Attributes

const FORMAT_HTML = 'html'
 
const FORMAT_PLAIN = 'plain'
 
const FORMAT_BOTH = 'both'
 

Protected Member Functions

 initializeView (?TemplatePaths $templatePaths=null)
 
 getDefaultVariables ()
 
 generateTemplatedBody (string $forceFormat='')
 
 renderContent (string $format)
 
 resetBody ()
 

Protected Attributes

string[] $format = array( 'html', 'plain' )
 
string $templateName = 'Default'
 
StandaloneView $view
 

Detailed Description

Send out templated HTML/plain text emails with Fluid.

Definition at line 34 of file FluidEmail.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Mail\FluidEmail::__construct ( ?TemplatePaths  $templatePaths = null,
?Headers  $headers = null,
?AbstractPart  $body = null 
)

Definition at line 52 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\initializeView().

Member Function Documentation

◆ assign()

TYPO3\CMS\Core\Mail\FluidEmail::assign (   $key,
  $value 
)

Definition at line 93 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\resetBody().

◆ assignMultiple()

TYPO3\CMS\Core\Mail\FluidEmail::assignMultiple ( array  $values)

Definition at line 100 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\resetBody().

◆ ensureValidity()

TYPO3\CMS\Core\Mail\FluidEmail::ensureValidity ( )

◆ format()

◆ generateTemplatedBody()

◆ getBody()

TYPO3\CMS\Core\Mail\FluidEmail::getBody ( )

◆ getDefaultVariables()

TYPO3\CMS\Core\Mail\FluidEmail::getDefaultVariables ( )
protected

Definition at line 122 of file FluidEmail.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Mail\FluidEmail\initializeView().

◆ getHtmlBody()

resource string null TYPO3\CMS\Core\Mail\FluidEmail::getHtmlBody ( bool  $forceBodyGeneration = false)
Returns
‪resource|string|null

Definition at line 152 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\generateTemplatedBody().

◆ getTextBody()

resource string null TYPO3\CMS\Core\Mail\FluidEmail::getTextBody ( bool  $forceBodyGeneration = false)
Returns
‪resource|string|null

Definition at line 165 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\generateTemplatedBody().

◆ getViewHelperVariableContainer()

ViewHelperVariableContainer TYPO3\CMS\Core\Mail\FluidEmail::getViewHelperVariableContainer ( )
Returns
‪ViewHelperVariableContainer

Only used for ext:form, not part of TYPO3 Core API.

Definition at line 179 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\resetBody().

◆ initializeView()

TYPO3\CMS\Core\Mail\FluidEmail::initializeView ( ?TemplatePaths  $templatePaths = null)
protected

◆ renderContent()

TYPO3\CMS\Core\Mail\FluidEmail::renderContent ( string  $format)
protected

◆ resetBody()

◆ setRequest()

TYPO3\CMS\Core\Mail\FluidEmail::setRequest ( ServerRequestInterface  $request)

◆ setTemplate()

TYPO3\CMS\Core\Mail\FluidEmail::setTemplate ( string  $templateName)

Member Data Documentation

◆ $format

string [] TYPO3\CMS\Core\Mail\FluidEmail::$format = array( 'html', 'plain' )
protected

◆ $templateName

string TYPO3\CMS\Core\Mail\FluidEmail::$templateName = 'Default'
protected

Definition at line 46 of file FluidEmail.php.

Referenced by TYPO3\CMS\Core\Mail\FluidEmail\setTemplate().

◆ $view

StandaloneView TYPO3\CMS\Core\Mail\FluidEmail::$view
protected

Definition at line 50 of file FluidEmail.php.

◆ FORMAT_BOTH

◆ FORMAT_HTML

◆ FORMAT_PLAIN