Docs For Class Net

Net_Sieve (Constructor) [line 159]

Net_Sieve Net_Sieve(
[string
$user = null], [string
$pass = null], [string
$host = 'localhost'], [string
$port = 2000], [string
$logintype = ''], [string
$euser = ''], [
$debug = false], [string
$bypassAuth = false])

Constructor Sets up the object, connects to the server and logs in. stores any generated error in $this->_error, which can be retrieved using the getError() method.

Access: public

Parameters:

string	`$user`	—	Login username
string	`$pass`	—	Login password
string	`$host`	—	Hostname of server
string	`$port`	—	Port of server
string	`$logintype`	—	Type of login to perform
string	`$euser`	—	Effective User (if $user=admin, login as $euser)
string	`$bypassAuth`	—	Skip the authentication phase. Useful if the socket
	`$debug`	—

[ Top ]

disconnect [line 1032]

mixed disconnect(
[
$sendLogoutCMD = true], string
$scriptname)

Disconnect from the Sieve server

Return: true on success, PEAR_Error on failure
Access: public

Parameters:

string	`$scriptname`	—	The name of the script to be set as active
	`$sendLogoutCMD`	—

[ Top ]

getActive [line 259]

mixed getActive(
)

Returns the active script

Return: The active scriptname or PEAR_Error on failure
Access: public

[ Top ]

getAuthMechs [line 1140]

mixed getAuthMechs(
)

Return the list of auth methods the server supports

Return: array on success, PEAR_Error on failure
Access: public

[ Top ]

getError [line 335]

mixed getError(
)

Returns any error that may have been generated in the constructor

Return: False if no error, PEAR_Error otherwise
Access: public

[ Top ]

getExtensions [line 1093]

mixed getExtensions(
)

Return the list of extensions the server supports

Return: array on success, PEAR_Error on failure
Access: public

[ Top ]

getScript [line 289]

mixed getScript(
string
$scriptname)

Retrieves a script

Return: The script on success, PEAR_Error on failure
Access: public

Parameters:

string $scriptname — The name of the script to be retrieved

[ Top ]

hasAuthMech [line 1164]

mixed hasAuthMech(
string
$method)

Return true if the server has that extension

Return: array on success, PEAR_Error on failure
Access: public

Parameters:

string $method — the extension to compare

[ Top ]

hasExtension [line 1115]

mixed hasExtension(
string
$extension)

Return true if tyhe server has that extension

Return: array on success, PEAR_Error on failure
Access: public

Parameters:

string $extension — the extension to compare

[ Top ]

haveSpace [line 808]

mixed haveSpace(
string
$scriptname, 
$quota)

Checks if the server has space to store the script by the server

Return: True on success, PEAR_Error otherwise
Access: public

Parameters:

string	`$scriptname`	—	The name of the script to mark as active
	`$quota`	—

[ Top ]

installScript [line 303]

mixed installScript(
string
$scriptname, string
$script, [bool
$makeactive = false])

Adds a script to the server

Return: true on success, PEAR_Error on failure
Access: public

Parameters:

string	`$scriptname`	—	Name of the script
string	`$script`	—	The script
bool	`$makeactive`	—	Whether to make this the active script

[ Top ]

listScripts [line 243]

mixed listScripts(
)

Returns an indexed array of scripts currently on the server

Return: Indexed array of scriptnames or PEAR_Error on failure
Access: public

[ Top ]

login [line 404]

mixed login(
string
$user, string
$pass, [string
$logintype = null], [string
$euser = ''], [boolean
$bypassAuth = false])

Logs into server.

Return: True on success, PEAR_Error otherwise
Access: public

Parameters:

string	`$user`	—	Login username
string	`$pass`	—	Login password
string	`$logintype`	—	Type of login method to use
string	`$euser`	—	Effective UID (perform on behalf of $euser)
boolean	`$bypassAuth`	—	Do not perform authentication

[ Top ]

removeScript [line 323]

mixed removeScript(
string
$scriptname)

Removes a script from the server

Return: True on success, PEAR_Error on failure
Access: public

Parameters:

string $scriptname — Name of the script

[ Top ]

setActive [line 277]

mixed setActive(
string
$scriptname)

Sets the active script

Return: true on success, PEAR_Error on failure
Access: public

Parameters:

string $scriptname — The name of the script to be set as active

[ Top ]

setDebug [line 1020]

void setDebug(
[
$debug = true])

Sets the bebug state

Access: public

Parameters:

$debug —

[ Top ]

_startTLS [line 1188]

mixed _startTLS(
)

Return true if the TLS negotiation was successful

Return: true on success, PEAR_Error on failure
Access: public

[ Top ]

Class: Net_Sieve

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$supportedAuthMethods = array('DIGEST-MD5', 'CRAM-MD5', 'PLAIN' , 'LOGIN')

$supportedSASLAuthMethods = array('DIGEST-MD5', 'CRAM-MD5')

Method Detail

Net_Sieve (Constructor) [line 159]

Parameters:

disconnect [line 1032]

Parameters:

getActive [line 259]

getAuthMechs [line 1140]

getError [line 335]

getExtensions [line 1093]

getScript [line 289]

Parameters:

hasAuthMech [line 1164]

Parameters:

hasExtension [line 1115]

Parameters:

haveSpace [line 808]

Parameters:

installScript [line 303]

Parameters:

listScripts [line 243]

login [line 404]

Parameters:

removeScript [line 323]

Parameters:

setActive [line 277]

Parameters:

setDebug [line 1020]

Parameters:

_startTLS [line 1188]