Configuration
Configuration keys for the Solar_Auth_Adapter_Mail class.
expire
(int) Authentication lifetime in seconds; zero is forever. Default is 14400 (4 hours). If this value is greater than the non-zero PHP ini setting for
session.cookie_lifetime, it will throw an exception.Default:
14400
idle
(int) Maximum allowed idle time in seconds; zero is forever. Default is 1440 (24 minutes). If this value is greater than the the PHP ini setting for
session.gc_maxlifetime, it will throw an exception.Default:
1440
allow
(bool) Whether or not to allow automatic login/logout at start() time. Default true.
Default:
true
cache
(dependency) A Solar_Cache dependency to store user data. Default is to create a Solar_Cache_Adapter_Session object internal to this instance.
Default:
array ( 'adapter' => 'Solar_Cache_Adapter_Session', 'prefix' => 'Solar_Auth_Adapter', )
source
(string) The source for auth credentials, 'get' (via the for GET request vars) or 'post' (via the POST request vars). Default is 'post'.
Default:
'post'
source_handle
(string) Username key in the credential array source, default 'handle'.
Default:
'handle'
source_passwd
(string) Password key in the credential array source, default 'passwd'.
Default:
'passwd'
source_redirect
(string) Element key in the credential array source to indicate where to redirect on successful login or logout, default 'redirect'.
Default:
'redirect'
source_process
(string) Element key in the credential array source to indicate how to process the request, default 'process'.
Default:
'process'
process_login
(string) The source_process element value indicating a login request; default is the 'PROCESS_LOGIN' locale key value.
Default:
null
process_logout
(string) The source_process element value indicating a logout request; default is the 'PROCESS_LOGOUT' locale key value.
Default:
null
login_callback
(callback) A callback to execute as part of the login process, whether or not login was successful.
Default:
null
logout_callback
(callback) A callback to execute as part of the logout process.
Default:
null
mailbox
(string) An imap_open() mailbox string, for example "mail.example.com:143/imap" or "mail.example.com:110/pop3".
Default:
null