User_Password_Request extends Email
Sent to users for resetting password.
Table of Contents
- $body : string
- Email body.
- $context : array<string|int, mixed>
- Object context values.
- $headers : array<string|int, mixed>
- Email headers.
- $meta : array<string|int, mixed>
- Class meta values.
- $recipient : string
- Email recipient.
- $subject : string
- Email subject.
- $tokens : array<string|int, mixed>
- Email tokens.
- __construct() : mixed
- Class constructor.
- get_body() : string
- Gets email body.
- get_context() : mixed
- Gets object context values.
- get_meta() : mixed
- Gets class meta values.
- get_subject() : string
- Gets email subject.
- get_tokens() : array<string|int, mixed>
- Gets email tokens.
- init() : mixed
- Class initializer.
- send() : bool
- Sends email.
- boot() : mixed
- Bootstraps email properties.
- set_meta() : mixed
- Sets class meta values.
- set_property() : mixed
- Sets a property value.
Properties
$body
Email body.
protected
string
$body
$context
Object context values.
protected
array<string|int, mixed>
$context
= []
$headers
Email headers.
protected
array<string|int, mixed>
$headers
= []
$meta
Class meta values.
protected
static array<string|int, mixed>
$meta
= []
$recipient
Email recipient.
protected
string
$recipient
$subject
Email subject.
protected
string
$subject
$tokens
Email tokens.
protected
array<string|int, mixed>
$tokens
= []
Methods
__construct()
Class constructor.
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
-
Email arguments.
Return values
mixed —get_body()
Gets email body.
public
final get_body() : string
Return values
string —get_context()
Gets object context values.
public
final get_context([string $name = null ][, mixed $default = null ]) : mixed
Parameters
- $name : string = null
-
Context name.
- $default : mixed = null
-
Default value.
Return values
mixed —get_meta()
Gets class meta values.
public
final static get_meta([string $name = '' ]) : mixed
Parameters
- $name : string = ''
-
Meta name.
Return values
mixed —get_subject()
Gets email subject.
public
final get_subject() : string
Return values
string —get_tokens()
Gets email tokens.
public
final get_tokens() : array<string|int, mixed>
Return values
array<string|int, mixed> —init()
Class initializer.
public
static init([array<string|int, mixed> $meta = [] ]) : mixed
Parameters
- $meta : array<string|int, mixed> = []
-
Class meta values.
Return values
mixed —send()
Sends email.
public
final send() : bool
Return values
bool —boot()
Bootstraps email properties.
protected
boot() : mixed
Return values
mixed —set_meta()
Sets class meta values.
protected
final static set_meta(array<string|int, mixed> $meta) : mixed
Parameters
- $meta : array<string|int, mixed>
-
Meta values.
Return values
mixed —set_property()
Sets a property value.
protected
final set_property(string $name, mixed $value[, string $prefix = '' ]) : mixed
Parameters
- $name : string
-
Property name.
- $value : mixed
-
Property value.
- $prefix : string = ''
-
Method prefix.