KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jsmtpd > core > common > filter > IFilter


1 /*
2  *
3  * Jsmtpd, Java SMTP daemon
4  * Copyright (C) 2005 Jean-Francois POUX, jf.poux@laposte.net
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  *
20  */

21 package org.jsmtpd.core.common.filter;
22
23 import org.jsmtpd.core.common.IGenericPlugin;
24 import org.jsmtpd.core.mail.Email;
25
26 /**
27  * Return true if the filter is passed successfully<br>
28  * Return false if the filter is not passed<br>
29  * <br>
30  * Chain will go on until its end, or if FilterTreeFailureException or
31  * FilterTreeSuccesException are thrown. Theses exceptions causes the
32  * immediate succes or failure of the chain
33  * <br>
34  * A filter that causes a failure of chain should excplitly create a new mail
35  * to inform the sender of the failure.
36  * @author Jean-Francois POUX
37  *
38  */

39 public interface IFilter extends IGenericPlugin {
40
41     /**
42      * Processes the mail throught the filter
43      * @param input the mail to process
44      * @return true if filter pass, false otherwise
45      */

46     public boolean doFilter(Email input) throws FilterTreeFailureException, FilterTreeSuccesException;
47
48 }
Popular Tags