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 ()
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 ()
	renderContent (string $format)

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 91 of file FluidEmail.php.

assignMultiple()

TYPO3\CMS\Core\Mail\FluidEmail::assignMultiple

(

array

$values

)

Definition at line 97 of file FluidEmail.php.

ensureValidity()

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

(

)

Definition at line 132 of file FluidEmail.php.

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

format()

TYPO3\CMS\Core\Mail\FluidEmail::format

(

string

$format

)

Definition at line 67 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\$format, TYPO3\CMS\Core\Mail\FluidEmail\FORMAT_BOTH, TYPO3\CMS\Core\Mail\FluidEmail\FORMAT_HTML, and TYPO3\CMS\Core\Mail\FluidEmail\FORMAT_PLAIN.

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

generateTemplatedBody()

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

protected

Definition at line 153 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\format(), TYPO3\CMS\Core\Mail\FluidEmail\initializeView(), and TYPO3\CMS\Core\Mail\FluidEmail\renderContent().

Referenced by TYPO3\CMS\Core\Mail\FluidEmail\ensureValidity(), and TYPO3\CMS\Core\Mail\FluidEmail\getBody().

getBody()

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

(

)

Definition at line 138 of file FluidEmail.php.

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

getDefaultVariables()

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

protected

Definition at line 117 of file FluidEmail.php.

References $GLOBALS.

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

getViewHelperVariableContainer()

ViewHelperVariableContainer TYPO3\CMS\Core\Mail\FluidEmail::getViewHelperVariableContainer

(

)

Returns

‪ViewHelperVariableContainer

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

Definition at line 148 of file FluidEmail.php.

initializeView()

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

protected

Definition at line 58 of file FluidEmail.php.

References $GLOBALS, TYPO3\CMS\Core\Mail\FluidEmail\format(), and TYPO3\CMS\Core\Mail\FluidEmail\getDefaultVariables().

Referenced by TYPO3\CMS\Core\Mail\FluidEmail\__construct(), and TYPO3\CMS\Core\Mail\FluidEmail\generateTemplatedBody().

renderContent()

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

protected

Definition at line 175 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\$format.

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

setRequest()

TYPO3\CMS\Core\Mail\FluidEmail::setRequest

(

ServerRequestInterface

$request

)

Definition at line 106 of file FluidEmail.php.

References TYPO3\CMS\Core\Http\NormalizedParams\createFromServerParams().

setTemplate()

TYPO3\CMS\Core\Mail\FluidEmail::setTemplate

(

string

$templateName

)

Definition at line 85 of file FluidEmail.php.

References TYPO3\CMS\Core\Mail\FluidEmail\$templateName.

Member Data Documentation

$format

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

protected

Definition at line 42 of file FluidEmail.php.

Referenced by TYPO3\CMS\Core\Mail\FluidEmail\format(), and TYPO3\CMS\Core\Mail\FluidEmail\renderContent().

$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

const TYPO3\CMS\Core\Mail\FluidEmail::FORMAT_BOTH = 'both'

Definition at line 38 of file FluidEmail.php.

Referenced by TYPO3\CMS\Form\Domain\Finishers\EmailFinisher\executeInternal(), TYPO3\CMS\Core\Mail\FluidEmail\format(), and TYPO3\CMS\Core\Tests\Functional\Mail\FluidEmailTest\settingFormatWithTextAndHtmlGeneratesTwoBodies().

FORMAT_HTML

const TYPO3\CMS\Core\Mail\FluidEmail::FORMAT_HTML = 'html'

Definition at line 36 of file FluidEmail.php.

Referenced by TYPO3\CMS\Core\Mail\FluidEmail\format(), and TYPO3\CMS\Core\Tests\Functional\Mail\FluidEmailTest\settingFormatWithHtmlOnlyGeneratesHtmlEmail().

FORMAT_PLAIN

const TYPO3\CMS\Core\Mail\FluidEmail::FORMAT_PLAIN = 'plain'

Definition at line 37 of file FluidEmail.php.

Referenced by TYPO3\CMS\Form\Domain\Finishers\EmailFinisher\executeInternal(), TYPO3\CMS\Core\Mail\FluidEmail\format(), and TYPO3\CMS\Core\Tests\Functional\Mail\FluidEmailTest\settingFormatWithTextOnlyGeneratesTextEmail().