Change config.php.sample to config.sample.php to allow PHPDocumentor to parse it
[squirrelmail.git] / plugins / filters / setup.php
CommitLineData
849bdf42 1<?php
15e6162e 2/**
5b4ba967 3 * @version $Id$
6c84ba1e 4 * @copyright (c) 1999-2005 The SquirrelMail Project Team
b2d8bc6c 5 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
ea5f4b8e 6 * @package plugins
7 * @subpackage filters
15e6162e 8 */
849bdf42 9
0a1dc88e 10/**
11 * Init plugin
12 * @access private
13 */
10a26cea 14function squirrelmail_plugin_init_filters() {
9c655416 15 @include_once(SM_PATH . 'plugins/filters/filters.php');
16 filters_init_hooks ();
10a26cea 17}
a2a566eb 18
0a1dc88e 19/**
0d725b45 20 * Report spam folder as special mailbox
0a1dc88e 21 * @param string $mb variable used by hook
22 * @return string spam folder name
91e0dccc 23 * @access private
0a1dc88e 24 */
10a26cea 25function filters_special_mailbox( $mb ) {
0a1dc88e 26 global $data_dir, $username;
10a26cea 27 return( $mb == getPref($data_dir, $username, 'filters_spam_folder', 'na' ) );
10a26cea 28}
849bdf42 29
0a1dc88e 30/**
9c655416 31 * Called by hook to Register option blocks
0a1dc88e 32 * @access private
33 */
9c655416 34function filters_optpage_register_block_hook() {
35 @include_once(SM_PATH . 'plugins/filters/filters.php');
36 filters_optpage_register_block ();
37}
849bdf42 38
9c655416 39/**
40 * Called by hook to Start Filtering
41 * @param mixed $args optional variable passed by hook
42 * @access private
43 */
44function start_filters_hook($args) {
45 @include_once(SM_PATH . 'plugins/filters/filters.php');
46 start_filters ();
47}
eec81600 48
9c655416 49/**
50 * Called by hook to Update filters when Folders Change
51 * @access private
52 */
53function update_for_folder_hook() {
54 @include_once(SM_PATH . 'plugins/filters/filters.php');
55 update_for_folder ();
10a26cea 56}
9c655416 57
91e0dccc 58?>