thunderbird-dev 11.0.1+build1-0ubuntu2 / usr / share / idl / thunderbird-11.0.1 / nsIMsgSearchTerm.idl

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mozilla Communicator client code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Alec Flett <alecf@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "nsMsgSearchCore.idl"
#include "nsIMsgSearchValue.idl"

interface nsIMsgDBHdr;
interface nsIMsgDatabase;
interface nsIMsgSearchScopeTerm;

[scriptable, uuid(dfd25cbe-2e86-4ff0-b78e-494bc65d344e)]
interface nsIMsgSearchTerm : nsISupports {
    attribute nsMsgSearchAttribValue attrib;
    attribute nsMsgSearchOpValue op;
    attribute nsIMsgSearchValue value;

    attribute boolean booleanAnd;
    attribute ACString arbitraryHeader;
    /**
     * Not to be confused with arbitraryHeader, which is a header in the
     * rfc822 message. This is a property of the nsIMsgDBHdr, and may have
     * nothing to do the message headers, e.g., gloda-id.
     * value.str will be compared with nsIMsgHdr::GetProperty(hdrProperty).
     */
    attribute ACString hdrProperty;

    /// identifier for a custom id used for this term, if any.
    attribute ACString customId;

    attribute boolean beginsGrouping;
    attribute boolean endsGrouping;

    boolean matchRfc822String(in string aString, in string charset, in boolean charsetOverride);
    boolean matchRfc2047String(in string aString, in string charset, in boolean charsetOverride);
    boolean matchDate(in PRTime aTime);
    boolean matchStatus(in unsigned long aStatus);
    boolean matchPriority(in nsMsgPriorityValue priority);
    boolean matchAge(in PRTime days);
    boolean matchSize(in unsigned long size);
    boolean matchLabel(in nsMsgLabelValue aLabelValue);
    boolean matchJunkStatus(in string aJunkScore);
    /*
     * Test search term match for junkpercent
     *
     * @param  aJunkPercent  junkpercent for message (0-100, 100 is junk)
     * @return               true if matches
     */   
    boolean matchJunkPercent(in unsigned long aJunkPercent);
    /*
     * Test search term match for junkscoreorigin
     * @param  aJunkScoreOrigin  Who set junk score? Possible values:
     *                           plugin filter imapflag user whitelist
     * @return                   true if matches
     */
    boolean matchJunkScoreOrigin(in string aJunkScoreOrigin);

    /**
     * Test if the body of the passed in message matches "this" search term.
     * @param aScopeTerm scope of search
     * @param aOffset offset of message in message store.
     * @param aLength length of message.
     * @param aCharset folder charset.
     * @param aMsg db msg hdr of message to match.
     * @param aDB db containing msg header.
     */
    boolean matchBody(in nsIMsgSearchScopeTerm aScopeTerm,
                      in unsigned long long aOffset,
                      in unsigned long aLength,
                      in string aCharset,
                      in nsIMsgDBHdr aMsg,
                      in nsIMsgDatabase aDb);

    /**
     * Test if the arbitrary header specified by this search term
     * matches the corresponding header in the passed in message.
     *
     * @param aScopeTerm scope of search
     * @param aLength length of message
     * @param aCharset The charset to apply to un-labeled non-UTF-8 data.
     * @param aCharsetOverride If true, aCharset is used instead of any
     *                         charset labeling other than UTF-8.
     *
     * N.B. This is noscript because headers is a null-separated list of
     * strings, which is not scriptable.
     */
    [noscript]
    boolean matchArbitraryHeader(in nsIMsgSearchScopeTerm aScopeTerm,
                                 in unsigned long aLength,
                                 in string aCharset,
                                 in boolean aCharsetOverride,
                                 in nsIMsgDBHdr aMsg,
                                 in nsIMsgDatabase aDb,
                                 //[array, size_is(headerLength)] in string headers,
                                 in string aHeaders,
                                 in unsigned long aHeaderLength,
                                 in boolean aForFilters);

    /**
     * Compares value.str with nsIMsgHdr::GetProperty(hdrProperty).
     * @param msg   msg to match db hdr property of.
     *
     * @returns     true if msg matches property, false otherwise.
     */
    boolean matchHdrProperty(in nsIMsgDBHdr msg);

    /**
     * Compares value.status with nsIMsgHdr::GetUint32Property(hdrProperty).
     * @param msg   msg to match db hdr property of.
     *
     * @returns     true if msg matches property, false otherwise.
     */
    boolean matchUint32HdrProperty(in nsIMsgDBHdr msg);

    /**
     * Compares value.status with the folder flags of the msg's folder.
     * @param msg   msgHdr whose folder's flag we want to compare.
     *
     * @returns     true if folder's flags match value.status, false otherwise.
     */
    boolean matchFolderFlag(in nsIMsgDBHdr msg);

    readonly attribute boolean matchAllBeforeDeciding;

    readonly attribute ACString termAsString;
    boolean matchKeyword(in ACString keyword); // used for tag searches
    attribute boolean matchAll;
    /**
     * Does the message match the custom search term?
     *
     * @param  msg  message database object representing the message
     *
     * @return      true if message matches
     */
    boolean matchCustom(in nsIMsgDBHdr msg);
};