FlexMailerTask
in package
Class FlexMailerTask
Table of Contents
Properties
- $address : string
- $contactId : int
- $eventQueueId : int
- $hash : string
- $mailParams : array<string|int, mixed>
- The full email message to send to this recipient (per alterMailParams).
Methods
- __construct() : mixed
- FlexMailerTask constructor.
- getAddress() : string
- getContactId() : int
- getEventQueueId() : int
- getHash() : string
- getMailParam() : string
- getMailParams() : array<string|int, mixed>
- hasContent() : bool
- setMailParam() : $this
- setMailParams() : FlexMailerTask
Properties
$address
private
string
$address
Selected/preferred email address of the intended recipient.
$contactId
private
int
$contactId
The ID of the recipiient.
Tags
$eventQueueId
private
int
$eventQueueId
A persistent record for this email delivery.
Tags
$hash
private
string
$hash
An authentication code. The name is misleading - it may be hash, but that implementation detail is outside our purview.
$mailParams
The full email message to send to this recipient (per alterMailParams).
private
array<string|int, mixed>
$mailParams
= []
Tags
Methods
__construct()
FlexMailerTask constructor.
public
__construct(int $eventQueueId, int $contactId, string $hash, string $address) : mixed
Parameters
- $eventQueueId : int
-
A persistent record for this email delivery.
- $contactId : int
-
The ID of the recipiient.
- $hash : string
-
An authentication code.
- $address : string
-
Selected/preferred email address of the intended recipient.
getAddress()
public
getAddress() : string
Return values
string —Selected email address of the intended recipient.
getContactId()
public
getContactId() : int
Tags
Return values
int —The ID of the recipiient.
getEventQueueId()
public
getEventQueueId() : int
Tags
Return values
intgetHash()
public
getHash() : string
Return values
string —An authentication code. The name is misleading - it may be hash, but that implementation detail is outside our purview.
getMailParam()
public
getMailParam(string $key) : string
Parameters
- $key : string
Tags
Return values
stringgetMailParams()
public
getMailParams() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>hasContent()
public
hasContent() : bool
Return values
boolsetMailParam()
public
setMailParam(string $key, string $value) : $this
Parameters
- $key : string
- $value : string
Tags
Return values
$thissetMailParams()
public
setMailParams(array $mailParams) : FlexMailerTask
Parameters
- $mailParams : array