SendEmail
extends Action
in package
Table of Contents
- EVENT_BEFORE_SEND = 'event-before-send'
- $email : string
- $emails : array<string|int, mixed>
- $sources : array<string|int, mixed>
- $users : array<string|int, mixed>
- apply() : mixed
- configTemplate() : string|null
- defineRules() : array<string|int, mixed>
- getAllEmails() : array<string|int, mixed>
- Get all emails
- getAllRecipients() : array<string|int, mixed>
- Get all recipients
- getDescription() : string
- getEmailObject() : Email|null
- Get email object
- getHandle() : string
- getName() : string
- getSourceObjects() : array<string|int, EmailSourceInterface>
- Get source objects
- getUserElements() : array<string|int, mixed>
- Get user elements from their ids
- hasConfig() : bool
Constants
EVENT_BEFORE_SEND
public
mixed
EVENT_BEFORE_SEND
= 'event-before-send'
Properties
public
string
$email
$emails
public
array<string|int, mixed>
$emails
= []
$sources
public
array<string|int, mixed>
$sources
= []
$users
public
array<string|int, mixed>
$users
= []
Methods
apply()
public
apply(TriggerInterface $trigger, array<string|int, mixed> $data) : mixed
Parameters
- $trigger : TriggerInterface
- $data : array<string|int, mixed>
Tags
Return values
mixed —configTemplate()
public
configTemplate() : string|null
Tags
Return values
string|null —defineRules()
public
defineRules() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getAllEmails()
Get all emails
public
getAllEmails() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAllRecipients()
Get all recipients
public
getAllRecipients() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDescription()
public
getDescription() : string
Tags
Return values
string —getEmailObject()
Get email object
public
getEmailObject() : Email|null
Return values
Email|null —getHandle()
public
getHandle() : string
Tags
Return values
string —getName()
public
getName() : string
Tags
Return values
string —getSourceObjects()
Get source objects
public
getSourceObjects() : array<string|int, EmailSourceInterface>
Return values
array<string|int, EmailSourceInterface> —getUserElements()
Get user elements from their ids
public
getUserElements() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasConfig()
public
hasConfig() : bool