Docs For Class IMP

Description

The IMP_Filter:: class contains all functions related to handling filtering messages in IMP.

For full use, the following Horde API calls should be defined (These API methods are not defined in IMP): mail/applyFilters mail/canApplyFilters mail/showFilters mail/blacklistFrom mail/showBlacklist mail/whitelistFrom mail/showWhitelist

$Horde: imp/lib/Filter.php,v 1.56.10.16 2009/01/06 15:24:03 jan Exp $

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

author: Michael Slusarz <slusarz@horde.org>

Located in /lib/Filter.php (line 26)

Method Summary

boolean blacklistMessage (array $indices, [boolean $show_link = true])

void filter (string $mbox)

void whitelistMessage (array $indices, [boolean $show_link = true])

Methods

blacklistMessage (line 63)

Adds the From address from the message(s) to the blacklist and deletes the message(s).

return: True if the messages(s) were delete.

boolean blacklistMessage (array $indices, [boolean $show_link = true])

array $indices: See IMP::parseIndicesList().
boolean $show_link: Show link to the blacklist management in the notification message?

filter (line 33)

Runs the filters if they are able to be applied manually.

void filter (string $mbox)

string $mbox: The mailbox to apply the filters to.

whitelistMessage (line 89)

Adds the From address from the message(s) to the whitelist.

void whitelistMessage (array $indices, [boolean $show_link = true])

array $indices: See IMP::parseIndicesList().
boolean $show_link: Show link to the whitelist management in the notification message?