1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1999
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either of the GNU General Public License Version 2 or later (the "GPL"),
26 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38 #include "nsISupports.idl"
39 #include "nsMsgFilterCore.idl"
40 #include "nsIMsgFilter.idl"
41 interface nsIMsgWindow;
42
43 ///////////////////////////////////////////////////////////////////////////////
44 // nsIMsgFilterHitNotify is an interface designed to make evaluating filters
45 // easier. Clients typically open a filter list and ask the filter list to
46 // evaluate the filters for a particular message, and pass in an
47 // interface pointer to be notified of hits. The filter list will call the
48 // ApplyFilterHit method on the interface pointer in case of hits, along with
49 // the desired action and value.
50 // return value is used to indicate whether the
51 // filter list should continue trying to apply filters or not.
52 //
53 ///////////////////////////////////////////////////////////////////////////////
54
55 [scriptable, uuid(c9f15174-1f3f-11d3-a51b-0060b0fc04b7)]
56 interface nsIMsgFilterHitNotify : nsISupports {
57 boolean applyFilterHit(in nsIMsgFilter filter, in nsIMsgWindow msgWindow);
58 };