• Главная
• Horde
• ManageSieve

PHP Класс Horde\ManageSieve

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$supportedAuthMethods	array	Can be overwritten if having problems with certain methods.
$supportedSASLAuthMethods	array	SASL authentication methods that require Auth_SASL.

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_logger	string | array	Logging handler.
$_maxReferralCount	array	Maximum number of referral loops
$_params	array	Parameters and connection information.
$_sock	Horde\Socket\Client	The socket client.
$_state	integer	One of the STATE_* constants.

Открытые методы

Метод	Описание
__construct ( array $params = [] )	Constructor.
connect ( string $host = null, string $port = null, array $context = null, boolean $secure = null )	Handles connecting to the server and checks the response validity.
disconnect ( boolean $sendLogoutCMD = true )	Disconnect from the Sieve server.
getActive ( ) : string	Returns the active script.
getAuthMechs ( ) : array	Returns the list of authentication methods the server supports.
getExtensions ( ) : array	Returns the list of extensions the server supports.
getScript ( string $scriptname ) : string	Retrieves a script.
hasAuthMech ( string $method ) : boolean	Returns whether the server supports an authentication method.
hasExtension ( string $extension ) : boolean	Returns whether the server supports an extension.
hasSpace ( string $scriptname, integer $size ) : boolean	Checks if the server has space to store the script by the server.
installScript ( string $scriptname, string $script, boolean $makeactive = false )	Adds a script to the server.
listScripts ( ) : array	Returns an indexed array of scripts currently on the server.
login ( string $user = null, string $password = null, string $authmethod = null, string $euser = null )	Logs into server.
removeScript ( string $scriptname )	Removes a script from the server.
setActive ( string $scriptname )	Sets the active script.
setLogger ( object $logger )	Passes a logger for debug logging.

Защищенные методы

Метод	Описание
_authCRAMMD5 ( string $user, string $pass, string $euser )	Authenticates the user using the CRAM-MD5 method.
_authDigestMD5 ( string $user, string $pass, string $euser )	Authenticates the user using the DIGEST-MD5 method.
_authEXTERNAL ( string $user, string $pass, string $euser )	Authenticates the user using the EXTERNAL method.
_authLOGIN ( string $user, string $pass, string $euser )	Authenticates the user using the LOGIN method.
_authPLAIN ( string $user, string $pass, string $euser )	Authenticates the user using the PLAIN method.
_checkAuthenticated ( )	Asserts that the client is in authenticated state.
_checkConnected ( )	Asserts that the client is in disconnected state.
_cmdAuthenticate ( string $uid, string $pwd, string $authmethod = null, string $euser = '' )	Handles the authentication using any known method.
_cmdCapability ( )	Sends the CAPABILITY command
_cmdDeleteScript ( string $scriptname )	Removes a script from the server.
_cmdGetScript ( string $scriptname ) : string	Retrieves the contents of the named script.
_cmdListScripts ( ) : array	Returns the list of scripts on the server.
_cmdLogout ( boolean $sendLogoutCMD = true )	Logs out of the server and terminates the connection.
_cmdPutScript ( string $scriptname, string $scriptdata )	Adds a script to the server.
_cmdSetActive ( string $scriptname )	Sets the active script, i.e. the one that gets run on new mail by the server.
_debug ( string $message )	Write debug text to the current log handler.
_doCmd ( string $cmd = '', boolean $auth = false ) : string	Send a command and retrieves a response from the server.
_escape ( string $string ) : string	Converts strings into RFC's quoted-string or literal-c2s form.
_getBestAuthMethod ( string $authmethod = null ) : string	Returns the name of the best authentication method that the server has advertised.
_handleConnectAndLogin ( )	Connects to the server and logs in.
_parseCapability ( string $data )	Parses the response from the CAPABILITY command and stores the result in $_capability.
_recvBytes ( integer $length ) : string	Receives a number of bytes from the server.
_recvLn ( ) : string	Receives a single line from the server.
_sendCmd ( string $cmd )	Sends a command to the server
_sendStringResponse ( string $str )	Sends a string response to the server.

Описание методов

Описание свойств