Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgFilterPlugin.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 2002
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Dan Mosedale <dmose@netscape.com> (Original Author)
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsISupports.idl"
00041 #include "MailNewsTypes2.idl"
00042 
00043 interface nsIMsgFilterHitNotify;
00044 interface nsIMsgWindow;
00045 interface nsIMsgDBHdr;
00046 interface nsIStreamListener;
00047 
00052 [scriptable, uuid(e2e56690-a676-11d6-80c9-00008646b737)]
00053 interface nsIMsgFilterPlugin : nsISupports
00054 {
00058     void shutdown();
00059 
00065     readonly attribute boolean shouldDownloadAllHeaders;
00066 
00067 };
00068 
00074 [scriptable, uuid(0243f3d6-d583-11d6-898a-00039310a47a)]
00075 interface nsIJunkMailClassificationListener : nsISupports
00076 {
00077     void onMessageClassified(in string aMsgURI, in nsMsgJunkStatus aClassification);
00078 };
00079 
00080 [scriptable, uuid(caf3d467-d57c-11d6-96a9-00039310a47a)]
00081 interface nsIJunkMailPlugin : nsIMsgFilterPlugin
00082 {
00086     const nsMsgJunkStatus UNCLASSIFIED = 0;
00087     const nsMsgJunkStatus GOOD = 1;
00088     const nsMsgJunkStatus JUNK = 2;
00089 
00094     void classifyMessage(in string aMsgURI, in nsIMsgWindow aMsgWindow,
00095                          in nsIJunkMailClassificationListener aListener);
00096 
00097     void classifyMessages(in unsigned long aCount,
00098                           [array, size_is(aCount)] in string aMsgURIs,
00099                           in nsIMsgWindow aMsgWindow,
00100                           in nsIJunkMailClassificationListener aListener);
00101     
00112     void setMessageClassification(
00113         in string aMsgURI, in nsMsgJunkStatus aOldUserClassification,
00114         in nsMsgJunkStatus aNewClassification,
00115         in nsIMsgWindow aMsgWindow,
00116         in nsIJunkMailClassificationListener aListener);
00117 
00118     readonly attribute boolean userHasClassified;
00119  
00123     void resetTrainingData();
00124 };