Notify

Notify - notify users of system changes

Ian Malpass <ian@aptest.com>

Copyright 2001-2006 Applied Testing and Technology, Inc. All Rights Reserved.

use Notify;

# get a hash of testChange trigger information
$testCreate = Notify->triggers( trigger => "testChange" );

# get a hash of only Edit triggers
%triggers = Notify->triggers( category => "Edit" );

# get a hash of all triggers
%triggers = Notify->triggers();

# check a trigger;
my $valid = Notify->validTrigger( "testCreate" );

# send notifcation mail
Notify->notify(
    suite   => $suite,
    trigger => "testChange",
    message => "$user created $test",
);

$notificationTriggers{ 'aTrigger' } = {
    title    => 'Bing',
    note     => 'The machine goes "bing"',
    subject  => 'The machine went "bing"',
    category => 'System administration',
    perSuite => 0,
};

Each trigger is a hash of five keys:

title

The text that gets displayed in the column headers of the administrative interfaces.

note

The tooltip that accompanies the title. Typically a fuller explanation of what trips the trigger. The note is inserted as an HTML tag attribute, so it needs double quotes escaped as in the example above.

subject

The default subject line for the email. In a per-suite email, this will have the suite name appended in parentheses.

category

A category for the trigger. Categories are only used to group triggers in the administrative interfaces. The category is an arbitrary string - if you use a string that hasn't been used before, a new category will appear in the display.

perSuite

A boolean argument. If set to 1, a user can have different settings for this trigger in different suites. If set to 0, the trigger is "global" - i.e. not suite-specific, such as administrative changes.

triggers - get trigger information

%widetTrigger = Notify->triggers( trigger => 'testChange' );
%editTriggers = Notify->triggers( category => 'Edit' );
%triggers     = Notify->triggers();

triggersInCategories - get the triggers, divided into categories

%triggerCats = Notify->triggersInCategories( perSuite => $perSuite );

validTrigger - is a named trigger valid?

if ( Notify->validTrigger( $trigger ) {
    ...
}

notify - send a notification email

# send to any user subscribed to testChange
Notify->notify(
    suite   => $suite,
    trigger => "testChange",
    message => "$user created $test",
);

# send to only Alice and Bob, if they're subscribed to testChange
Notify->notify(
    suite   => $suite,
    trigger => "testChange",
    message => "$user created $test",
    userList => [ "Alice", "Bob" ],
);

# send mail to any user subscribed to testChange except Eve
Notify->notify(
    suite   => $suite,
    trigger => "testChange",
    message => "$user created $test",
    noMail   => [ "Eve" ],
);