Mail::IspMailGate::Filter::Banner - Add a banner message to outgoing mails


Mail-IspMailGate documentation  | view source Contained in the Mail-IspMailGate distribution.

Index


NAME

Top

Mail::IspMailGate::Filter::Banner - Add a banner message to outgoing mails

SYNOPSIS

Top

 # Create a filter
 my($filter) = Mail::IspMailGate::Filter::Banner->new({
     'plain' => '/etc/mail/banner.plain',
     'html' => '/etc/mail/banner.html'
 });

 # Call him for filtering a given mail (aka MIME::Entity)
 my ($attr) = {
     'entity' => $entity,    # a MIME::Entity object
     'parser' => $parser     # a MIME::Parser object
 };
 my($res) = $filter->doFilter($attr); 




DESCRIPTION

Top

This class can be used for adding a banner message to the top of outgoing E-Mails. It knows about MIME types and can deal with plain text or HTML messages.

PUBLIC INTERFACE

Top

new $ATTR

Class method. Create a new filter instance; you may supply two attributes: plain is the name of a banner file to attach to plain text mails and html is similar for HTML mails. The difference is, that the latter may contain HTML tags.


Mail-IspMailGate documentation  | view source Contained in the Mail-IspMailGate distribution.