Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgFilterHitNotify.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 #include "nsMsgFilterCore.idl"
00040 #include "nsIMsgFilter.idl"
00041 interface nsIMsgWindow;
00042 
00044 // nsIMsgFilterHitNotify is an interface designed to make evaluating filters
00045 // easier. Clients typically open a filter list and ask the filter list to
00046 // evaluate the filters for a particular message, and pass in an
00047 // interface pointer to be notified of hits. The filter list will call the
00048 // ApplyFilterHit method on the interface pointer in case of hits, along with
00049 // the desired action and value.
00050 // return value is used to indicate whether the
00051 // filter list should continue trying to apply filters or not. 
00052 //
00054 
00055 [scriptable, uuid(c9f15174-1f3f-11d3-a51b-0060b0fc04b7)]
00056 interface nsIMsgFilterHitNotify : nsISupports {
00057     boolean applyFilterHit(in nsIMsgFilter filter, in nsIMsgWindow msgWindow);
00058 };
00059