KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > mail > spam > ISpamPlugin


1 // The contents of this file are subject to the Mozilla Public License Version
2 // 1.1
3 //(the "License"); you may not use this file except in compliance with the
4 //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
5 //
6 //Software distributed under the License is distributed on an "AS IS" basis,
7 //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
8 //for the specific language governing rights and
9 //limitations under the License.
10 //
11 //The Original Code is "The Columba Project"
12 //
13 //The Initial Developers of the Original Code are Frederik Dietz and Timo
14 // Stich.
15 //Portions created by Frederik Dietz and Timo Stich are Copyright (C) 2003.
16 //
17 //All Rights Reserved.
18 package org.columba.mail.spam;
19
20 import org.columba.api.plugin.IExtensionInterface;
21 import org.columba.mail.folder.IMailbox;
22
23 public interface ISpamPlugin extends IExtensionInterface{
24
25     /**
26      * Score message. Check if message is spam or non spam.
27      *
28      * @param mailbox
29      * @param uid
30      * @return
31      * @throws Exception
32      */
33     boolean scoreMessage(IMailbox mailbox, Object JavaDoc uid) throws Exception JavaDoc;
34     
35     /**
36      * Add this message to the token database as spam.
37      *
38      * @param mailbox
39      * @param uid
40      * @throws Exception
41      */
42     void trainMessageAsSpam(IMailbox mailbox, Object JavaDoc uid) throws Exception JavaDoc;
43     
44     /**
45      * Add this message to the token database as ham.
46      *
47      * @param mailbox
48      * @param uid
49      * @throws Exception
50      */
51     void trainMessageAsHam(IMailbox mailbox, Object JavaDoc uid) throws Exception JavaDoc;
52     
53     void save();
54     
55     void load();
56 }
57
Popular Tags