/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * The contents of this file are subject to the Netscape Public License
 * Version 1.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1999 Netscape Communications Corporation.  All Rights
 * Reserved.
 */


#include "nsISupports.idl"
#include "nsMsgFilterCore.idl"

%{C++
#include "nsMsgSearchScopeTerm.h"
%}

[ptr] native nsMsgSearchScopeTerm(nsMsgSearchScopeTerm);

interface nsOutputStream;

[scriptable, uuid(605db0f8-04a1-11d3-a50a-0060b0fc04b7)]
interface nsIMsgFilter : nsISupports {
    readonly attribute nsMsgFilterTypeType filterType;
    attribute boolean enabled;
    attribute string filterName;
    attribute string filterDesc;
    void AddTerm(in nsMsgSearchAttribute attrib,
                 in nsMsgSearchOperator op,
                 in nsMsgSearchValue value,
                 in boolean BooleanAND,
                 in string arbitraryHeader);

    readonly attribute long numTerms;
    void GetTerm(in long termIndex,
                 out nsMsgSearchAttribute attrib,
                 out nsMsgSearchOperator op,
                 in nsMsgSearchValue value, // bad! using shared structure
                 out boolean BooleanAND,
                 out string arbitraryHeader);

    attribute nsMsgSearchScopeTerm scope;

    void SetAction(in nsMsgRuleActionType type, in voidStar value);
    void GetAction(out nsMsgRuleActionType type, out voidStar value);

    void MatchHdr(in nsIMsgDBHdr msgHdr, in nsIMsgFolder folder,
                  in nsIMsgDatabase db, in string headers,
                  in unsigned long headerSize);

    void LogRuleHit(in nsOutputStream stream, in nsIMsgDBHdr header);


};
