1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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 Communicator client 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) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Alec Flett <alecf@netscape.com>
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either of the GNU General Public License Version 2 or later (the "GPL"),
27 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39 #include "nsISupports.idl"
40 #include "nsMsgSearchCore.idl"
41 #include "nsIMsgSearchValue.idl"
42
43 interface nsIMsgDBHdr;
44 interface nsIMsgDatabase;
45 interface nsIMsgSearchScopeTerm;
46
47 [scriptable, uuid(2B753A24-DAB4-4DA0-B9B1-6655C2F1D352)]
48 interface nsIMsgSearchTerm : nsISupports {
49 attribute nsMsgSearchAttribValue attrib;
50 attribute nsMsgSearchOpValue op;
51 attribute nsIMsgSearchValue value;
52
53 attribute boolean booleanAnd;
54 attribute ACString arbitraryHeader;
55
56 attribute boolean beginsGrouping;
57 attribute boolean endsGrouping;
58
59 boolean matchRfc822String(in string aString, in string charset, in boolean charsetOverride);
60 boolean matchRfc2047String(in string aString, in string charset, in boolean charsetOverride);
61 boolean matchDate(in PRTime aTime);
62 boolean matchStatus(in unsigned long aStatus);
63 boolean matchPriority(in nsMsgPriorityValue priority);
64 boolean matchAge(in PRTime days);
65 boolean matchSize(in unsigned long size);
66 boolean matchLabel(in nsMsgLabelValue aLabelValue);
67 boolean matchJunkStatus(in string aJunkScore);
68
69 boolean matchBody(in nsIMsgSearchScopeTerm scopeTerm,
70 in unsigned long offset,
71 in unsigned long length,
72 in string charset,
73 in nsIMsgDBHdr msg,
74 in nsIMsgDatabase db);
75
76 // marking noscript because headers is a null-separated list of strings,
77 // which is not scriptable
78 [noscript]
79 boolean matchArbitraryHeader(in nsIMsgSearchScopeTerm scopeTerm,
80 in unsigned long offset,
81 in unsigned long length,
82 in string charset,
83 in boolean charsetOverride,
84 in nsIMsgDBHdr msg,
85 in nsIMsgDatabase db,
86 //[array, size_is(headerLength)] in string headers,
87 in string headers,
88 in unsigned long headerLength,
89 in boolean forFilters);
90
91 readonly attribute boolean matchAllBeforeDeciding;
92
93 readonly attribute ACString termAsString;
94 boolean matchKeyword(in string keyword); // used for tag searches
95 attribute boolean matchAll;
96 };