FRED™  3.0
FRED™: Framework for Rapid and Easy Development
Mail Class Reference
Inheritance diagram for Mail:
Authenticator Component Thing

Public Member Functions

 token ($email)
 
 verify ($token)
 
- Public Member Functions inherited from Authenticator
 verified ($result)
 Process the result of a verification. More...
 
 regenerateSessionId ()
 
 invalidate ()
 
- Public Member Functions inherited from Component
 __construct ($fred, $config=null)
 
 __destruct ()
 
 clientConfig ()
 Public configuration. More...
 
 config ($key, $default=null)
 Retrieve a config value. More...
 
 ping ()
 Ping function. More...
 
 filemtime ($filename)
 Filemtime with session cache. More...
 
 component ($name)
 Get a component (local or default). More...
 
 components (... $names)
 Get multiple components in an array. More...
 
- Public Member Functions inherited from Thing
 propertyExists ($property)
 Check if a property exists (public or published). More...
 
 constants ($prefix=null)
 Return all constants. More...
 
 get ($key)
 Get one or more properties. More...
 
 set ($key, $value=null)
 Set one or more properties. More...
 
 __get ($key)
 
 __set ($key, $value)
 

Data Fields

 $tokenLength = 8
 
 $tokenChars = '234678ACEFGHJKLMNPQRTUVWXYZ'
 
 $tokenTime = 300
 Time (in seconds) for which the token is valid. More...
 
 $tokenTries = 5
 Maximum number of times to enter the correct token. More...
 
 $mailFrom = null
 Mail message sender address (default when empty). More...
 
 $mailSubject = 'Authentication token'
 
 $mailBody = '[token]'
 
 $mailHtml = false
 True when the message body is in HTML format. More...
 
- Data Fields inherited from Authenticator
 $maxSessionTime = null
 Maximum duration of a session (minutes; empty = infinite). More...
 
 $maxInactiveTime = null
 Maximum period of inactivity (minutes; empty = infinite). More...
 
 $controllerName = null
 Controller to redirect the user to if more information is required (e.g. a username and. More...
 
- Data Fields inherited from Component
 $filemtimeTtl = 0
 
- Data Fields inherited from Thing
const HIDDEN = 0
 Property is hidden. More...
 
const READABLE = 1
 Property is readable. More...
 
const WRITEABLE = 2
 Property is writeable. More...
 
const READWRITE = 3
 Property is readable and writeable. More...
 

Protected Member Functions

 check ()
 
 tags ($token)
 
- Protected Member Functions inherited from Authenticator
 check ()
 Perform the check. More...
 
 getAuthenticated ()
 
 getChecked ()
 
 setChecked ($value)
 
- Protected Member Functions inherited from Component
 init ()
 
 done ()
 
 getSession ()
 
- Protected Member Functions inherited from Thing
 publish ($property, $visibility=self::READABLE)
 Publish a property (or hide it again). More...
 
 configure ($config)
 Configure the object. More...
 
 _get ($key)
 Default getter if no specific setter is defined, and the property is also not published (readable). More...
 
 _set ($key, $value)
 Default setter if no specific setter is defined, and the property is also not published (writeable). More...
 

Additional Inherited Members

- Protected Attributes inherited from Component
 $_fred = null
 
 $_config = null
 
 $_name = null
 
 $_components = []
 Local components (key = component name, value = component). More...
 
 $_session = null
 
- Protected Attributes inherited from Thing
 $_published = []
 Published properties (key = name of property, value = visibility). More...
 

Detailed Description

Definition at line 5 of file Mail.php.

Member Function Documentation

◆ check()

check ( )
protected

Definition at line 17 of file Mail.php.

◆ tags()

tags (   $token)
protected

Definition at line 21 of file Mail.php.

◆ token()

token (   $email)

Definition at line 25 of file Mail.php.

◆ verify()

verify (   $token)

Definition at line 37 of file Mail.php.

Field Documentation

◆ $mailBody

$mailBody = '[token]'

Definition at line 14 of file Mail.php.

◆ $mailFrom

$mailFrom = null

Mail message sender address (default when empty).

Definition at line 12 of file Mail.php.

◆ $mailHtml

$mailHtml = false

True when the message body is in HTML format.

Definition at line 15 of file Mail.php.

◆ $mailSubject

$mailSubject = 'Authentication token'

Definition at line 13 of file Mail.php.

◆ $tokenChars

$tokenChars = '234678ACEFGHJKLMNPQRTUVWXYZ'

Definition at line 8 of file Mail.php.

◆ $tokenLength

$tokenLength = 8

Definition at line 7 of file Mail.php.

◆ $tokenTime

$tokenTime = 300

Time (in seconds) for which the token is valid.

Definition at line 9 of file Mail.php.

◆ $tokenTries

$tokenTries = 5

Maximum number of times to enter the correct token.

Definition at line 10 of file Mail.php.


The documentation for this class was generated from the following file: