Properties

$variables

$variables

$callbacks

$callbacks

$template

$template

$translator

$translator

$translatorEnabled

$translatorEnabled

$translatorTextDomain

$translatorTextDomain

$admin

$admin : bool|\Auth\Entity\User

Organization Admin

Type

bool|\Auth\Entity\User

$callInitOnSetJob

$callInitOnSetJob : bool

Type

bool

$router

$router : \Zend\Mvc\Router\RouteStackInterface

Type

\Zend\Mvc\Router\RouteStackInterface

Methods

__construct()

__construct(array $options)

Parameters

array $options

setVariables()

setVariables( $variables)

Parameters

$variables

addVariables()

addVariables( $variables)

Parameters

$variables

setVariable()

setVariable( $name,  $value)

Parameters

$name
$value

setCallbacks()

setCallbacks( $callbacks)

Parameters

$callbacks

addCallbacks()

addCallbacks( $callbacks)

Parameters

$callbacks

setCallback()

setCallback( $name,  $callable)

Parameters

$name
$callable

getBodyText()

getBodyText()

getTranslator()

getTranslator() : \Zend\I18n\Translator\Translator

Returns

\Zend\I18n\Translator\Translator

getTranslatorTextDomain()

getTranslatorTextDomain()

hasTranslator()

hasTranslator()

isTranslatorEnabled()

isTranslatorEnabled()

setTranslator()

setTranslator(\Zend\I18n\Translator\TranslatorInterface $translator,  $textDomain)

Parameters

\Zend\I18n\Translator\TranslatorInterface $translator
$textDomain

setTranslatorEnabled()

setTranslatorEnabled( $enabled)

Parameters

$enabled

setTranslatorTextDomain()

setTranslatorTextDomain( $textDomain)

Parameters

$textDomain

setSubject()

setSubject(string $subject, bool|mixed $translate) : \Core\Mail\Message

Sets the message subject.

The passed string is automatically translated. Any additional argument is passed in to sprintf to replace placeholders in the subject string.

If the $translate is FALSE, the subject is NOT translated.

setSubject('translated subject');
     $mail->setSubject('translated %s with placeholder', 'subject');
     $mail->setSubject('untranslated subject', false);
?>

Parameters

string $subject
bool|mixed $translate

Returns

\Core\Mail\Message

setFormattedSubject()

setFormattedSubject(mixed $formatString) : \Zend\Mail\Message

Parameters

mixed $formatString

Returns

\Zend\Mail\Message

setOptions()

setOptions( $options)

Parameters

$options

init()

init()

setUser()

setUser(\Auth\Entity\User $user) : $this

Parameters

\Auth\Entity\User $user

Returns

$this

parseVariables()

parseVariables( $body)

Parameters

$body

parseCallbacks()

parseCallbacks( $body)

Parameters

$body

getNamePattern()

getNamePattern( $name)

Parameters

$name

updateAddressList()

updateAddressList(\Zend\Mail\AddressList $addressList,  $emailOrAddressOrList,  $name,  $callingMethod)

Parameters

\Zend\Mail\AddressList $addressList
$emailOrAddressOrList
$name
$callingMethod