CoolCMS API

EmailRecipientDTO extends BaseEntity
in package

One recipient of a bulk email. Each recipient has an own language, template values, reply-to addresses and attachments; the message always leaves from the server `from` address, but replies may go to a different address.

Table of Contents

Properties

$files  : array<string|int, mixed>
$langId  : int
$replyTos  : array<string|int, mixed>
$to  : string
$values  : array<string|int, mixed>

Methods

__construct()  : mixed
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getFiles()  : array<string|int, File>
getLangId()  : int
getReplyTos()  : array<int, string>
getTo()  : string
getValues()  : array<string, mixed>
setFiles()  : void
setLangId()  : void
setReplyTos()  : void
setTo()  : void
setValues()  : void
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

Methods

__construct()

public __construct(string $to, int $langId[, array<string, mixed> $values = [] ][, array<int, string> $replyTos = [] ][, array<string|int, File> $files = [] ]) : mixed
Parameters
$to : string
$langId : int
$values : array<string, mixed> = []

Template values

$replyTos : array<int, string> = []

Reply-to addresses for this recipient

$files : array<string|int, File> = []

Extra attachments for this recipient

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getReplyTos()

public getReplyTos() : array<int, string>
Return values
array<int, string>

getValues()

public getValues() : array<string, mixed>
Return values
array<string, mixed>

setReplyTos()

public setReplyTos(array<int, string> $replyTos) : void
Parameters
$replyTos : array<int, string>

setValues()

public setValues(array<string, mixed> $values) : void
Parameters
$values : array<string, mixed>

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results