SpamAssassin_Client
[ class tree: SpamAssassin_Client ] [ index: SpamAssassin_Client ] [ all elements ]
Packages:
SpamAssassin_Client


Files:
Client.php
Exception.php
Result.php

Classes:
SpamAssassin_Client
SpamAssassin_Client_Exception
SpamAssassin_Client_Result

Element index for package SpamAssassin_Client

[ c ] [ e ] [ g ] [ h ] [ i ] [ l ] [ o ] [ p ] [ r ] [ s ] [ t ] [ w ] [ _ ]

_

__construct
in file Client.php, method SpamAssassin_Client::__construct()
    Class constructor
top

c

$contentLenght
in file Result.php, variable SpamAssassin_Client_Result::$contentLenght
    Response content lenght
check
in file Client.php, method SpamAssassin_Client::check()
    Checks if a message is spam with the CHECK protocol command
Client.php
procedural page Client.php
top

e

Exception.php
procedural page Exception.php
exec
in file Client.php, method SpamAssassin_Client::exec()
    Sends a command to the server and returns an object with the result
top

g

getSocket
in file Client.php, method SpamAssassin_Client::getSocket()
    Creates a new socket connection with data provided in the constructor
getSpamReport
in file Client.php, method SpamAssassin_Client::getSpamReport()
    Returns a detailed report if the message is spam or null if it's ham
top

h

$hostname
in file Client.php, variable SpamAssassin_Client::$hostname
headers
in file Client.php, method SpamAssassin_Client::headers()
    Processes the message and returns it's headers
top

i

$isSpam
in file Result.php, variable SpamAssassin_Client_Result::$isSpam
    Is it spam or not?
isSpam
in file Client.php, method SpamAssassin_Client::isSpam()
    Shortcut to check() method that returns a boolean
top

l

$learnTypes
in file Client.php, variable SpamAssassin_Client::$learnTypes
learn
in file Client.php, method SpamAssassin_Client::learn()
    Uses SpamAssassin learning feature with TELL. Must be enabled on the server.
LEARN_FORGET
in file Client.php, class constant SpamAssassin_Client::LEARN_FORGET
LEARN_HAM
in file Client.php, class constant SpamAssassin_Client::LEARN_HAM
LEARN_SPAM
in file Client.php, class constant SpamAssassin_Client::LEARN_SPAM
top

o

$output
in file Result.php, variable SpamAssassin_Client_Result::$output
    Raw output from SpamAssassin server
top

p

$port
in file Client.php, variable SpamAssassin_Client::$port
$protocolVersion
in file Client.php, variable SpamAssassin_Client::$protocolVersion
parseOutput
in file Client.php, method SpamAssassin_Client::parseOutput()
    Parses SpamAssassin output ($header and $message)
ping
in file Client.php, method SpamAssassin_Client::ping()
    Pings the server to check the connection
process
in file Client.php, method SpamAssassin_Client::process()
    Processes the message, checks it for spam and returning it's modified version
top

r

$responseCode
in file Result.php, variable SpamAssassin_Client_Result::$responseCode
    Response code.
$responseMessage
in file Result.php, variable SpamAssassin_Client_Result::$responseMessage
    Response message. EX_OK for sucess.
Result.php
procedural page Result.php
read
in file Client.php, method SpamAssassin_Client::read()
    Reads all input from the SpamAssassin server after data was written
report
in file Client.php, method SpamAssassin_Client::report()
    Report message as spam, both local and remote
revoke
in file Client.php, method SpamAssassin_Client::revoke()
    Revokes a message previously reported as spam
top

s

$score
in file Result.php, variable SpamAssassin_Client_Result::$score
    SpamAssassin score
$socket
in file Client.php, variable SpamAssassin_Client::$socket
$socketPath
in file Client.php, variable SpamAssassin_Client::$socketPath
SpamAssassin_Client
in file Client.php, class SpamAssassin_Client
SpamAssassin_Client_Exception
in file Exception.php, class SpamAssassin_Client_Exception
SpamAssassin_Client_Result
in file Result.php, class SpamAssassin_Client_Result
    Represents the result from an API call on the SpamAssassin server
symbols
in file Client.php, method SpamAssassin_Client::symbols()
    Returns all rules matched by the message
top

t

$thresold
in file Result.php, variable SpamAssassin_Client_Result::$thresold
    How many points the message must score to be considered spam
top

w

write
in file Client.php, method SpamAssassin_Client::write()
    Writes data to the socket
top
Documentation generated on Tue, 04 May 2010 15:12:08 -0300 by phpDocumentor 1.4.3