mail::spamassassin::util(3) [suse man page]

Mail::SpamAssassin::Util(3)				User Contributed Perl Documentation			       Mail::SpamAssassin::Util(3)

NAME

       Mail::SpamAssassin::Util - utility functions

DESCRIPTION

       A general class for utility functions.  Please use this for functions that stand alone, without requiring a $self object, Portability
       functions especially.

       NOTE: The functions in this module are to be considered private.  Their API may change at any point, and it's expected that they'll only be
       used by other Mail::SpamAssassin modules. (TODO: we should probably revisit this if it's useful for plugin development.)

       NOTE: Utility functions should not be changing global variables such as $_, $1, $2, ... $/, etc. unless explicitly documented.  If these
       variables are in use by these functions, they should be localized.

       $module = first_available_module (@module_list)
	   Return the name of the first module that can be successfully loaded with "require" from the list.  Returns "undef" if none are
	   available.

	   This is used instead of "AnyDBM_File" as follows:

	     my $module = Mail::SpamAssassin::Util::first_available_module
				   (qw(DB_File GDBM_File NDBM_File SDBM_File));
	     tie %hash, $module, $path, [... args];

	   Note that "SDBM_File" is guaranteed to be present, since it comes with Perl.

       my ($filepath, $filehandle) = secure_tmpfile();
	   Generates a filename for a temporary file, opens it exclusively and securely, and returns a filehandle to the open file (opened
	   O_RDWR).

	   If it cannot open a file after 20 tries, it returns "undef".

       my ($dirpath) = secure_tmpdir();
	   Generates a directory for temporary files.  Creates it securely and returns the path to the directory.

	   If it cannot create a directory after 20 tries, it returns "undef".

perl v5.12.1							    2010-03-16					       Mail::SpamAssassin::Util(3)

Courier::Filter::Module::SpamAssassin(3pm)		User Contributed Perl Documentation		Courier::Filter::Module::SpamAssassin(3pm)

NAME

       Courier::Filter::Module::SpamAssassin - SpamAssassin message filter module for the Courier::Filter framework

SYNOPSIS

	   use Courier::Filter::Module::SpamAssassin;

	   my $module = Courier::Filter::Module::SpamAssassin->new(
	       prefs_file  => '/etc/courier/filters/courier-filter-spamassassin.cf',
	       sa_options  => {
		   # any Mail::SpamAssassin options
	       },

	       logger	   => $logger,
	       inverse	   => 0,
	       trusting    => 0,
	       testing	   => 0,
	       debugging   => 0
	   );

	   my $filter = Courier::Filter->new(
	       ...
	       modules	   => [ $module ],
	       ...
	   );

DESCRIPTION

       This class is a filter module class for use with Courier::Filter.  It matches a message if its SpamAssassin spam score exceeds the
       configured threshold.

   Constructor
       The following constructor is provided:

       new(%options): returns Courier::Filter::Module::SpamAssassin
	   Creates a new SpamAssassin filter module.

	   %options is a list of key/value pairs representing any of the following options:

	   prefs_file
	       The path of a SpamAssassin preferences file.  If this option is specified, its value is passed to the Mail::SpamAssassin
	       constructor's "userprefs_filename" option .  If undef, SpamAssassin is instructed not to read any preferences besides its default
	       configuration files.  Defaults to undef.

	   sa_options
	       A hash-ref specifying options for the Mail::SpamAssassin object used by this filter module.  See "new" in Mail::SpamAssassin for
	       the supported options.

	   All options of the Courier::Filter::Module constructor are also supported.  Please see "new" in Courier::Filter::Module for their
	   descriptions.

   Instance methods
       See "Instance methods" in Courier::Filter::Module for a description of the provided instance methods.

SEE ALSO

       Courier::Filter::Module, Courier::Filter::Overview.

       For AVAILABILITY, SUPPORT, COPYRIGHT, and LICENSE information, see Courier::Filter::Overview.

AUTHOR

       Julian Mehnle <julian@mehnle.net>

perl v5.14.2							    2011-12-27				Courier::Filter::Module::SpamAssassin(3pm)