Documentation

EmailText
in package

Table of Contents

Methods

adminEditUrl()  : mixed
Return the URL to use for editing a given template Note that this method creates a template record if it doesn't yet exist
getFieldDefs()  : mixed
Return an array of name => desc for the field definitions for a given email template Used for the admin ui
getHtml()  : mixed
Return email text HTML

Methods

adminEditUrl()

Return the URL to use for editing a given template Note that this method creates a template record if it doesn't yet exist

public static adminEditUrl(mixed $code) : mixed
Parameters
$code : mixed

getFieldDefs()

Return an array of name => desc for the field definitions for a given email template Used for the admin ui

public static getFieldDefs(mixed $code) : mixed
Parameters
$code : mixed

getHtml()

Return email text HTML

public static getHtml(string $code, array<string|int, mixed> $field_values) : mixed
Parameters
$code : string

The email template to use

$field_values : array<string|int, mixed>

The field values to replace into the template. Don't escape these, they'll be escaped for you.

On this page

Search results