Public Member Functions |
|
| __construct ($imapObj, $parent) | |
| __get ($name) | |
| __set ($name, $value) | |
| addListener ($address) | |
| configAccessControl () | |
| getAllowStartTls () | |
| getGreetingsText () | |
| getImapObj () | |
| getLogHost () | |
| getLogLevel () | |
| getLogType () | |
| getMaxAuthErrors () | |
| getMaxConnThreads () | |
| getMaxErrors () | |
| getMinConnThreads () | |
| getPlainConnectionAllowLogin () | |
| getPlainConnectionAuthTypes () | |
| getSecureConnectionAllowLogin () | |
| getSecureConnectionAuthTypes () | |
| getSessionObj () | |
| getUserdbConnectorName () | |
| getUserdbConnectorType () | |
| listListeners () | |
| removeListener ($address) | |
| reset () | |
| save () | |
| setAllowStartTls ($value) | |
| setGeetingsText ($value) | |
| setLogHost ($value) | |
| setLogLevel ($value) | |
| setLogType ($value) | |
| setMaxAuthErrors ($value) | |
| setMaxConnThreads ($value) | |
| setMaxErrors ($value) | |
| setMinConnThreads ($value) | |
| setPlainConnectionAllowLogin ($value) | |
| setPlainConnectionAuthTypes ($value) | |
| setSecureConnectionAllowLogin ($value) | |
| setSecureConnectionAuthTypes ($value) | |
| setUserdbConnectorName ($value) | |
| setUserdbConnectorType ($value) | |
| start () | |
| stop () | |
| updateListener ($address) | |
Member Function Documentation
| Imap::__get | ( | $ | name | ) |
Get member.
|
member |
description |
|---|---|
|
maxConnThreads |
the maximum number of threads involved in I/O for the IMAP service |
|
minConnThreads |
the minimum number of threads involved in I/O for the IMAP service |
|
maxErrors |
the maximum number of protocol errors after which the connection is terminated |
|
maxAuthErrors |
the maximum number of authentication errors after which the connection is terminated |
|
allowStartTls |
the secure connection (which start with STARTTLS) |
|
secureConnectionAllowLogin |
if plain text authentication is allowed on secure connections |
|
secureConnectionAuthTypes |
the allowed authentication methods on a secure connection |
|
plainConnectionAuthTypes |
the allowed authentication methods on a plain connection |
|
plainConnectionAllowLogin |
if plain text authentication is allowed on plain connections |
|
userdbConnectorType |
the userdb connector type |
|
userdbConnectorName |
the userdb connector name |
|
logLevel |
the log level for the IMAP service |
|
logHost |
the address of the host that offers log services |
|
logType |
the log type for the IMAP service |
|
greetingsText |
the greeting text for this service |
| Imap::__set | ( | $ | name, | |
| $ | value | |||
| ) |
Set member.
|
member |
description |
|---|---|
|
maxConnThreads |
the maximum number of threads involved in I/O for the IMAP service |
|
minConnThreads |
the minimum number of threads involved in I/O for the IMAP service |
|
maxErrors |
the maximum number of protocol errors after which the connection is terminated |
|
maxAuthErrors |
the maximum number of authentication errors after which the connection is terminated |
|
allowStartTls |
the secure connection (which start with STARTTLS) |
|
secureConnectionAllowLogin |
if plain text authentication is allowed on secure connections |
|
secureConnectionAuthTypes |
the allowed authentication methods on a secure connection |
|
plainConnectionAuthTypes |
the allowed authentication methods on a plain connection |
|
plainConnectionAllowLogin |
if plain text authentication is allowed on plain connections |
|
userdbConnectorType |
the userdb connector type |
|
userdbConnectorName |
the userdb connector name |
|
logLevel |
the log level for the IMAP service |
|
logHost |
the address of the host that offers log services |
|
logType |
the log type for the IMAP service |
|
greetingsText |
the greeting text for this service |
| Imap::addListener | ( | $ | address | ) |
This function adds a listener to this service
- Returns:
- bool
- Parameters:
-
$address string the listener address (ex: 127.0.0.1:143)
| Imap::configAccessControl | ( | ) |
This function returns an access control object for this service
- Returns:
- object AccessControl
| Imap::listListeners | ( | ) |
This function lists the listeners for this service
- Returns:
- array
| Imap::removeListener | ( | $ | address | ) |
This function removes a listener from this service
- Returns:
- bool
- Parameters:
-
$address string the listener address (ex: 127.0.0.1:143)
| Imap::start | ( | ) |
This function starts the IMAP service
- Returns:
- bool
| Imap::stop | ( | ) |
This function stops the IMAP service
- Returns:
- bool
| Imap::updateListener | ( | $ | address | ) |
This function updates a listener of this service
- Returns:
- object Listener
- Parameters:
-
$address string the listener address (ex: 127.0.0.1:143)