Public Member Functions |
|
| __construct ($wmObj, $parent) | |
| __get ($name) | |
| __set ($name, $value) | |
| addHostNameResolver ($host, $domain) | |
| addListener ($address) | |
| addUrlRedirect ($address, $host, $port) | |
| configAccessControl () | |
| getAllowKeepAlive () | |
| getAllowLargeIncomingData () | |
| getEnableActiveSync () | |
| getEnableICALCalendar () | |
| getEnableICALFreeBusy () | |
| getEnableMobileWebmail () | |
| getHttpBodyMaxSize () | |
| getHttpHeadersMaxSize () | |
| getLogHost () | |
| getLogLevel () | |
| getLogType () | |
| getMaxAuthErrors () | |
| getMaxConnThreads () | |
| getMaxErrors () | |
| getMinConnThreads () | |
| getPath () | |
| getSessionActivityTimeout () | |
| getSessionIdleTimeout () | |
| getSessionObj () | |
| getShowDomainList () | |
| getUploadMaxSize () | |
| getUserdbConnectorName () | |
| getUserdbConnectorType () | |
| getWebmailObj () | |
| listHostNameResolvers () | |
| listListeners () | |
| listUrlRedirects () | |
| removeHostNameResolver ($hostname) | |
| removeListener ($address) | |
| removeUrlRedirect ($address) | |
| reset () | |
| save () | |
| setAllowKeepAlive ($value) | |
| setAllowLargeIncomingData ($value) | |
| setEnableActiveSync ($value) | |
| setEnableICALCalendar ($value) | |
| setEnableICALFreeBusy ($value) | |
| setEnableMobileWebmail ($value) | |
| setHttpBodyMaxSize ($value) | |
| setHttpHeadersMaxSize ($value) | |
| setLogHost ($value) | |
| setLogLevel ($value) | |
| setLogType ($value) | |
| setMaxAuthErrors ($value) | |
| setMaxConnThreads ($value) | |
| setMaxErrors ($value) | |
| setMinConnThreads ($value) | |
| setPath ($value) | |
| setSessionActivityTimeout ($value) | |
| setSessionIdleTimeout ($value) | |
| setShowDomainList ($value) | |
| setUploadMaxSize ($value) | |
| setUserdbConnectorName ($value) | |
| setUserdbConnectorType ($value) | |
| start () | |
| stop () | |
| updateHostNameResolver ($hostname, $newDomain) | |
| updateListener ($address) | |
| updateUrlRedirect ($address, $newHost, $newPort) | |
Member Function Documentation
| Webmail::__get | ( | $ | name | ) |
Get member.
|
member |
description |
|---|---|
|
maxConnThreads |
the maximum number of threads involved in I/O for the Webmail service |
|
maxErrors |
the maximum protocol errors number after which the connection is terminated |
|
maxAuthErrors |
the maximum authentication errors number after which the connection is terminated |
|
sessionIdleTimeout |
the time interval after which an idle session is terminated |
|
sessionActivityTimeout |
sets the maximum time interval after which a Webmail session is terminated even if activity exists |
|
allowKeepAlive |
permanent connections |
|
allowLargeIncomingData |
data receiving to be allowed after the session is terminated |
|
httpHeadersMaxSize |
the maximum allowed size for received HTTP headers |
|
httpBodyMaxSize |
the maximum allowed size for incoming HTTP body |
|
uploadMaxSize |
the maximum allowed size for incoming upload data |
|
path |
the Webmail's directory path |
|
showDomainList |
if the domain displaying is enabled |
|
userdbConnectorType |
the userdb connector type |
|
userdbConnectorName |
the userdb connector name |
|
logLevel |
the log level for the Webmail service |
|
logHost |
the address of the host that offers log services |
|
logType |
the log type for the Webmail service |
|
enableIcalCalendar |
enable/disable Calendar (ICS) access through iCal/HTTP |
|
enableIcalFreebusy |
enable/disable Free/Busy (IFB) access through iCal/HTTP |
|
userInterfaceType |
ajax inteface type [<ajaxDefault | ajaxOnly | standardDefault | standardOnly>] |
| Webmail::__set | ( | $ | name, | |
| $ | value | |||
| ) |
Set member.
|
member |
description |
|---|---|
|
maxConnThreads |
the maximum number of threads involved in I/O for the Webmail service |
|
maxErrors |
the maximum protocol errors number after which the connection is terminated |
|
maxAuthErrors |
the maximum authentication errors number after which the connection is terminated |
|
sessionIdleTimeout |
the time interval after which an idle session is terminated |
|
sessionActivityTimeout |
sets the maximum time interval after which a Webmail session is terminated even if activity exists |
|
allowKeepAlive |
permanent connections |
|
allowLargeIncomingData |
data receiving to be allowed after the session is terminated |
|
httpHeadersMaxSize |
the maximum allowed size for received HTTP headers |
|
httpBodyMaxSize |
the maximum allowed size for incoming HTTP body |
|
uploadMaxSize |
the maximum allowed size for incoming upload data |
|
path |
the Webmail's directory path |
|
showDomainList |
if the domain displaying is enabled |
|
userdbConnectorType |
the userdb connector type |
|
userdbConnectorName |
the userdb connector name |
|
logLevel |
the log level for the Webmail service |
|
logHost |
the address of the host that offers log services |
|
logType |
the log type for the Webmail service |
|
enableIcalCalendar |
enable/disable Calendar (ICS) access through iCal/HTTP |
|
enableIcalFreebusy |
enable/disable Free/Busy (IFB) access through iCal/HTTP |
|
userInterfaceType |
ajax inteface type [<ajaxDefault | ajaxOnly | standardDefault | standardOnly>] |
| Webmail::addHostNameResolver | ( | $ | host, | |
| $ | domain | |||
| ) |
This function adds a hostname resolver. This maps a hostname to a domain
- Parameters:
-
$host string hostname $domain string domain name
- Returns:
- bool
| Webmail::addListener | ( | $ | address | ) |
This function adds a listener to this service
- Returns:
- bool
- Parameters:
-
$address string the listener address (ex: 127.0.0.1:25)
| Webmail::addUrlRedirect | ( | $ | address, | |
| $ | host, | |||
| $ | port | |||
| ) |
This function adds a URL redirect. This can be used to redirect the request for a specific host to another address.
- Parameters:
-
$address string the address ex. 127.0.0.1:8000 $host string the hostname $port int the port number
- Returns:
- bool
| Webmail::configAccessControl | ( | ) |
This function returns an access control object for this service
- Returns:
- object AccessControl
| Webmail::listHostNameResolvers | ( | ) |
This method lists the hostname resolvers
- Returns:
- array
| Webmail::listListeners | ( | ) |
This function lists the listeners for this service
- Returns:
- array
| Webmail::listUrlRedirects | ( | ) |
This method lists the URL redirects
- Returns:
- array
| Webmail::removeHostNameResolver | ( | $ | hostname | ) |
This function removes the hostname resolver that matches the given host
- Parameters:
-
$hostname string the hostname
- Returns:
- bool
| Webmail::removeListener | ( | $ | address | ) |
This function removes a listener from this service
- Returns:
- bool
- Parameters:
-
$address string the listener address (ex: 127.0.0.1:25)
| Webmail::removeUrlRedirect | ( | $ | address | ) |
This function removes an URL redirect with the specified address
- Parameters:
-
$address string the address of the URL redirect
- Returns:
- bool
| Webmail::reset | ( | ) |
This function resets the changes made but not yet saved
- Returns:
- bool
| Webmail::start | ( | ) |
This function starts the Webmail service
- Returns:
- bool
| Webmail::stop | ( | ) |
This function stops the Webmail service
- Returns:
- bool
| Webmail::updateHostNameResolver | ( | $ | hostname, | |
| $ | newDomain | |||
| ) |
This function changes the hostname resolver that matches the given host
- Parameters:
-
$hostname string the hostname $newDomain string the new domain value
- Returns:
- bool
| Webmail::updateListener | ( | $ | address | ) |
This function updates a listener of this service
- Returns:
- object Listener
- Parameters:
-
$address string the listener address (ex: 127.0.0.1:25)
| Webmail::updateUrlRedirect | ( | $ | address, | |
| $ | newHost, | |||
| $ | newPort | |||
| ) |
This function changes an existing URL redirect, changing its host and port
- Parameters:
-
$address string the address of the url redirect $newHost string the new host value $newPort int the new port value
- Returns:
- bool