NAME

Kernel::System::PostMaster::Filter

DESCRIPTION

All postmaster database filters

PUBLIC INTERFACE

new()

Don't use the constructor directly, use the ObjectManager instead:

    my $PMFilterObject = $Kernel::OM->Get('Kernel::System::PostMaster::Filter');

FilterList()

get all filter

    my %FilterList = $PMFilterObject->FilterList();

FilterAdd()

add a filter

    $PMFilterObject->FilterAdd(
        UserID         => 1,
        Name           => 'some name',
        StopAfterMatch => 0,
        Match = [
            {
                Key   => 'Subject',
                Value => '^ADV: 123',
        },
            ...
        ],
        Not = [
            {
                Key   => 'Subject',
                Value => '1',
        },
            ...
        ],
        Set = [
            {
                Key   => 'X-OTRS-Queue',
                Value => 'Some::Queue',
            },
            ...
        ],
    );

FilterDelete()

delete a filter

    $PMFilterObject->FilterDelete(
        Name => '123',
    );

FilterUpdate()

update a filter

    $PMFilterObject->FilterUpdate(
        UserID         => 1,
        Name           => 'some name',
        OldName        => 'other name',
        StopAfterMatch => 1,
        Match = [
            {
                Key   => 'Subject',
                Value => '^ADV: 123',
        },
            ...
        ],
        Not = [
            {
                Key   => 'Subject',
                Value => '1',
        },
            ...
        ],
        Set = [
            {
                Key   => 'X-OTRS-Queue',
                Value => 'Some::Queue',
            },
            ...
        ],
    );

FilterGet()

get filter properties, returns HASH ref Match and Set

    my %Data = $PMFilterObject->FilterGet(
        Name => '132',
    );