nsIMsgSearchTerm

Defined in mozilla/ mailnews/ base/ search/ public/ nsIMsgSearchTerm.idl

Attributes

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;

Methods

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);

matchBody

/**
 * 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);