sendmail::milter(3pm) [debian man page]

Sendmail::Milter(3pm)					User Contributed Perl Documentation				     Sendmail::Milter(3pm)

NAME

       Sendmail::Milter - compatibility interface for Sendmail::PMilter

SYNOPSIS

	   use Sendmail::Milter;

	   Sendmail::Milter::auto_setconn(NAME);
	   Sendmail::Milter::register(NAME, { CALLBACKS }, FLAGS);
	   Sendmail::Milter::main();

DESCRIPTION

       This is a compatibility interface which emulates the "standard" Sendmail::Milter API.

FUNCTIONS

       The following functions are available in this module.  Unlike "Sendmail::PMilter", this interface involves a single, global instance of
       milter data, so these functions are called without an object reference.

       For each function, see the description of its object-based counterpart in Sendmail::PMilter.

       Sendmail::Milter::auto_getconn(NAME[, CONFIG])
       Sendmail::Milter::auto_setconn(NAME[, CONFIG])
       Sendmail::Milter::main([MAXCHILDREN[, MAXREQ]])
       Sendmail::Milter::register(NAME, CALLBACKS[, FLAGS])
       Sendmail::Milter::setconn(DESC)

       One extension function is provided by this implementation.

       Sendmail::Milter::get_milter()
	   Returns the "Sendmail::PMilter" instance underlying this emulation layer.  This allows mostly-unmodified milter scripts to set PMilter
	   extensions (such as dispatcher and sendmail.cf values).  It is recommended, however, that new code use the object instance methods
	   described in Sendmail::PMilter.

EXPORTS

       In order to preserve compatibility with the standard "Sendmail::Milter" interface, all SMFI* constants described in Sendmail::PMilter are
       exported into the caller's namespace by default.

       (Note that "Sendmail::PMilter" itself does not export these symbols by default.)

perl v5.10.1							    2011-02-12						     Sendmail::Milter(3pm)

Mail::Milter::Object(3pm)				User Contributed Perl Documentation				 Mail::Milter::Object(3pm)

NAME

       Mail::Milter::Object - Perl extension to encapsulate a milter in an object

SYNOPSIS

	   package Foo;
	   use base Mail::Milter::Object;

	   sub connect_callback {
	       my $this = shift;
	       my $ctx = shift;
	       my @connect_args = @_;
	       ...
	   }

	   ...
	   my $milter = new Foo;

DESCRIPTION

       Normally, milters passed to "Sendmail::Milter" consist of nondescript hash references.  "Mail::Milter::Object" transforms these callback
       hashes into fully qualified objects that are easier to maintain and understand.	In conjunction with "Mail::Milter::Chain", this also
       allows for a more modular approach to milter implementation, by allowing each milter to be a small, granular object that can exist indepen-
       dently of other milters.

       Each object inheriting from this class has access to the hash reference making up the object itself.  Two caveats must be noted when
       accessing this hashref:

       * Key names used for private data should be prefixed by an underscore (_) in order to prevent accidental recognition as a callback name.

       * Since a milter object can be reused many times throughout its existence, and perhaps reentrantly if threads are in use, the hashref
       should contain only global configuration data for this object rather than per-message data.  Data stored per message or connection should
       be stashed in the milter context object by calling "getpriv()" and "setpriv()" on the context object.

METHODS

       new()
	   Creates a new "Mail::Milter::Object".  The fully qualified class is scanned for milter callback methods with names of the form CALL-
	   BACK_callback.  If such a method exists, a corresponding callback entry point is added to this object.

AUTHOR

       Todd Vierling, <tv@duh.org> <tv@pobox.com>

SEE ALSO

       Mail::Milter, Sendmail::Milter.

perl v5.8.8							    2004-02-26						 Mail::Milter::Object(3pm)