Courier::Filter::Module::Header (3pm)

    use Courier::Filter::Module::Header;

    my $module = Courier::Filter::Module::Header->new(
        fields      => \%patterns_by_field_name,
        response    => $response_text,

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

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

This class is a filter module class for use with Courier::Filter. It matches a message if one of the message's header fields matches the configured criteria.

Constructor

The following constructor is provided:

new(%options): returns Courier::Filter::Module::Header

Creates a new Header filter module. %options is a list of key/value pairs representing any of the following options:

fields

Required. A reference to a hash containing the message header field names and patterns (as key/value pairs) that messages are to be matched against. Field names are matched case-insensitively. Patterns may either be simple strings (for exact, case-sensitive matches) or regular expression objects created by the \*(C`qr//\*(C' operator (for inexact, partial matches). So for instance, to match any message from the \*(L"debian-devel\*(R" mailing list with the subject containing something about 'duelling banjoes', you could set the \*(C`fields\*(C' option as follows: fields => { 'list-id' => '<debian-devel.lists.debian.org>', subject => qr/duell?ing\s+banjoe?s?/i }

response

A string that is to be returned literally as the match result in case of a match. Defaults to \*(L"Prohibited header value detected: <field>: <value>\*(R".

All options of the Courier::Filter::Module constructor are also supported. Please see \*(L"new()\*(R" in Courier::Filter::Module for their descriptions.

Instance methods

See \*(L"Instance methods\*(R" in Courier::Filter::Module for a description of the provided instance methods.

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

For \s-1AVAILABILITY\s0, \s-1SUPPORT\s0, and \s-1LICENSE\s0 information, see Courier::Filter::Overview.

Julian Mehnle <[email protected]>