FluidEmail extends Email
Send out templated HTML/plain text emails with Fluid.
Table of Contents
Constants
- FORMAT_BOTH = 'both'
- FORMAT_HTML = 'html'
- FORMAT_PLAIN = 'plain'
Properties
- $format : array<string|int, string>
- $templateName : string
- $view : StandaloneView
Methods
- __construct() : mixed
- assign() : static
- assignMultiple() : static
- ensureValidity() : void
- format() : static
- getBody() : AbstractPart
- getHtmlBody() : resource|string|null
- getTextBody() : resource|string|null
- getViewHelperVariableContainer() : ViewHelperVariableContainer
- setRequest() : static
- setTemplate() : static
- generateTemplatedBody() : void
- getDefaultVariables() : array<string|int, mixed>
- initializeView() : void
- renderContent() : string
- resetBody() : void
Constants
FORMAT_BOTH
public
mixed
FORMAT_BOTH
= 'both'
FORMAT_HTML
public
mixed
FORMAT_HTML
= 'html'
FORMAT_PLAIN
public
mixed
FORMAT_PLAIN
= 'plain'
Properties
$format
protected
array<string|int, string>
$format
= ['html', 'plain']
$templateName
protected
string
$templateName
= 'Default'
$view
protected
StandaloneView
$view
Methods
__construct()
public
__construct([TemplatePaths|null $templatePaths = null ][, Headers|null $headers = null ][, AbstractPart|null $body = null ]) : mixed
Parameters
- $templatePaths : TemplatePaths|null = null
- $headers : Headers|null = null
- $body : AbstractPart|null = null
assign()
public
assign(mixed $key, mixed $value) : static
Parameters
- $key : mixed
- $value : mixed
Return values
staticassignMultiple()
public
assignMultiple(array<string|int, mixed> $values) : static
Parameters
- $values : array<string|int, mixed>
Return values
staticensureValidity()
public
ensureValidity() : void
format()
public
format(string $format) : static
Parameters
- $format : string
Return values
staticgetBody()
public
getBody() : AbstractPart
Return values
AbstractPartgetHtmlBody()
public
getHtmlBody([bool $forceBodyGeneration = false ]) : resource|string|null
Parameters
- $forceBodyGeneration : bool = false
Return values
resource|string|nullgetTextBody()
public
getTextBody([bool $forceBodyGeneration = false ]) : resource|string|null
Parameters
- $forceBodyGeneration : bool = false
Return values
resource|string|nullgetViewHelperVariableContainer()
public
getViewHelperVariableContainer() : ViewHelperVariableContainer
Only used for ext:form, not part of TYPO3 Core API.
Return values
ViewHelperVariableContainersetRequest()
public
setRequest(ServerRequestInterface $request) : static
Parameters
- $request : ServerRequestInterface
Return values
staticsetTemplate()
public
setTemplate(string $templateName) : static
Parameters
- $templateName : string
Return values
staticgenerateTemplatedBody()
protected
generateTemplatedBody([string $forceFormat = '' ]) : void
Parameters
- $forceFormat : string = ''
getDefaultVariables()
protected
getDefaultVariables() : array<string|int, mixed>
Return values
array<string|int, mixed>initializeView()
protected
initializeView([TemplatePaths|null $templatePaths = null ]) : void
Parameters
- $templatePaths : TemplatePaths|null = null
renderContent()
protected
renderContent(string $format) : string
Parameters
- $format : string
Return values
stringresetBody()
protected
resetBody() : void