Todd Vierling > Mail-Milter > Mail::Milter::Wrapper

Download:
Mail-Milter-0.07.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.03   Source  

NAME ^

Mail::Milter::Wrapper - Perl extension for wrappering milter objects

SYNOPSIS ^

    use Mail::Milter::Wrapper;

    my $milter = ...;
    my $wrapper = new Mail::Milter::Wrapper($milter, \&foo);

    use Sendmail::Milter;
    ...
    Sendmail::Milter::register('foo', $wrapper, SMFI_CURR_ACTS);

DESCRIPTION ^

Mail::Milter::Wrapper wraps another milter, allowing for interception of the passed arguments and/or return code of the contained milter.

METHODS ^

new(MILTER, CODEREF[, CALLBACK ...])

Creates a Mail::Milter::Wrapper object.

MILTER is the milter to wrap, which may be a plain hash reference or an instance of a hashref object such as Mail::Milter::Object. CODEREF is the wrapper subroutine. CALLBACKs, if specified, are named callbacks which are needed by the wrapper, even if the contained milter does not use them.

The wrapper subroutine will be called with the following arguments, in this order:

 * reference to the wrapper
 * name of callback
 * subroutine reference to call into the wrapped milter
 * arguments for the callback (>= 0)

This subroutine should ALWAYS pass the "close" callback through to the contained milter. Failure to do so may corrupt the contained milter's state information and cause memory leaks.

As an example, a simple subroutine which just passes the callback through might be written as:

    sub callback_wrapper {
        shift; # don't need $this
        my $cbname = shift;
        my $callback_sub = shift;

        &$callback_sub(@_);
    }

AUTHOR ^

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

SEE ALSO ^

Mail::Milter, Sendmail::Milter

syntax highlighting: