Mail::SpamAssassin::Client
Mail::SpamAssassin::Client
NAMESYNOPSIS
DESCRIPTION
PUBLIC METHODS
PRIVATE METHODS
NAME
Mail::SpamAssassin::Client − Client for spamd Protocol
SYNOPSIS
my $client = new Mail::SpamAssassin::Client({
port => 783,
host => 'localhost',
username => 'someuser'});
or
my $client = new Mail::SpamAssassin::Client({
socketpath => '/path/to/socket',
username => 'someuser'});
Optionally takes timeout, which is applied to IO::Socket for the
initial connection. If not supplied, it defaults to 30 seconds.
if ($client−>ping()) {
print "Ping is ok\n";
}
my $result = $client−>process($testmsg);
if ($result−>{isspam} eq 'True') {
do something with spam message here
}
DESCRIPTION
Mail::SpamAssassin::Client is a module which provides a perl implementation of the spamd protocol.
PUBLIC METHODS
new
public class (Mail::SpamAssassin::Client) new (\%
$args)
Description: This method creates a new Mail::SpamAssassin::Client object.
process
public instance (\%) process (String $msg)
Description: This method calls the spamd server with the PROCESS command.
The return value is a hash reference containing several pieces of information, if available:
content_length
isspam
score
threshold
message
check
public instance (\%) check (String $msg)
Description: The method implements the check call.
See the process method for the return value.
headers
public instance (\%) headers (String $msg)
Description: This method implements the headers call.
See the process method for the return value.
learn
public instance (Boolean) learn (String $msg,
Integer $learntype)
Description: This method implements the learn call. $learntype should be an integer, 0 for spam, 1 for ham and 2 for forget. The return value is a boolean indicating if the message was learned or not.
An undef return value indicates that there was an error and you should check the resp_code/resp_msg values to determine what the error was.
report
public instance (Boolean) report (String $msg)
Description: This method provides the report interface to spamd.
revoke
public instance (Boolean) revoke (String $msg)
Description: This method provides the revoke interface to spamd.
ping
public instance (Boolean) ping ()
Description: This method performs a server ping and returns 0 or 1 depending on if the server responded correctly.
PRIVATE METHODS
_create_connection
private instance (IO::Socket) _create_connection ()
Description: This method sets up a proper IO::Socket connection based on the arguments used when creating the client object.
On failure, it sets an internal error code and returns undef.
_parse_response_line
private instance (@) _parse_response_line (String
$line)
Description: This method parses the initial response line/header from the server and returns its parts.
We have this as a separate method in case we ever decide to get fancy with the response line.
_clear_errors
private instance () _clear_errors ()
Description: This method clears out any current errors.
_filter
private instance (\%) _filter (String $msg, String
$command)
Description: Makes the actual call to the spamd server for the various filter method (ie PROCESS , CHECK , HEADERS , etc). The command that is passed in is sent to the spamd server.
The return value is a hash reference containing several pieces of information, if available:
content_length
isspam
score
threshold
message (if available)
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
