nsIMsgSearchTerm Interface Reference

import "nsIMsgSearchTerm.idl";

Inheritance diagram for nsIMsgSearchTerm:

Collaboration diagram for nsIMsgSearchTerm:

List of all members.

Public Member Functions
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)
boolean	matchJunkPercent (in unsigned long aJunkPercent)
boolean	matchJunkScoreOrigin (in string aJunkScoreOrigin)
boolean	matchBody (in nsIMsgSearchScopeTerm scopeTerm, in unsigned long offset, in unsigned long length, in string charset, in nsIMsgDBHdr msg, in nsIMsgDatabase db)
boolean	matchArbitraryHeader (in nsIMsgSearchScopeTerm scopeTerm, in unsigned long offset, in unsigned long length, in string charset, in boolean charsetOverride, in nsIMsgDBHdr msg, in nsIMsgDatabase db, in string headers, in unsigned long headerLength, in boolean forFilters)
boolean	matchHdrProperty (in nsIMsgDBHdr msg)
	Compares value.str with nsIMsgHdr::GetProperty(hdrProperty).
boolean	matchUint32HdrProperty (in nsIMsgDBHdr msg)
	Compares value.status with nsIMsgHdr::GetUint32Property(hdrProperty).
boolean	matchFolderFlag (in nsIMsgDBHdr msg)
	Compares value.status with the folder flags of the msg's folder.
boolean	matchKeyword (in ACString keyword)
boolean	matchCustom (in nsIMsgDBHdr msg)
	Does the message match the custom search term?
Public Attributes
attribute nsMsgSearchAttribValue	attrib
attribute nsMsgSearchOpValue	op
attribute nsIMsgSearchValue	value
attribute boolean	booleanAnd
attribute ACString	arbitraryHeader
attribute ACString	hdrProperty
	Not to be confused with arbitraryHeader, which is a header in the rfc822 message.
attribute ACString	customId
	identifier for a custom id used for this term, if any.
attribute boolean	beginsGrouping
attribute boolean	endsGrouping
readonly attribute boolean	matchAllBeforeDeciding
readonly attribute ACString	termAsString
attribute boolean	matchAll

---

Member Function Documentation

boolean nsIMsgSearchTerm::matchAge

(

in PRTime

days

)

boolean nsIMsgSearchTerm::matchArbitraryHeader	(	in nsIMsgSearchScopeTerm	scopeTerm,
		in unsigned long	offset,
		in unsigned long	length,
		in string	charset,
		in boolean	charsetOverride,
		in nsIMsgDBHdr	msg,
		in nsIMsgDatabase	db,
		in string	headers,
		in unsigned long	headerLength,
		in boolean	forFilters
	)

boolean nsIMsgSearchTerm::matchBody	(	in nsIMsgSearchScopeTerm	scopeTerm,
		in unsigned long	offset,
		in unsigned long	length,
		in string	charset,
		in nsIMsgDBHdr	msg,
		in nsIMsgDatabase	db
	)

boolean nsIMsgSearchTerm::matchCustom

(

in nsIMsgDBHdr

msg

)

Does the message match the custom search term?

Parameters:

msg

message database object representing the message

Returns:

true if message matches

boolean nsIMsgSearchTerm::matchDate

(

in PRTime

aTime

)

boolean nsIMsgSearchTerm::matchFolderFlag

(

in nsIMsgDBHdr

msg

)

Compares value.status with the folder flags of the msg's folder.

Parameters:

msg

msgHdr whose folder's flag we want to compare.

Returns:

true if folder's flags match value.status, false otherwise.

boolean nsIMsgSearchTerm::matchHdrProperty

(

in nsIMsgDBHdr

msg

)

Compares value.str with nsIMsgHdr::GetProperty(hdrProperty).

Parameters:

msg

msg to match db hdr property of.

Returns:

true if msg matches property, false otherwise.

boolean nsIMsgSearchTerm::matchJunkPercent

(

in unsigned long

aJunkPercent

)

boolean nsIMsgSearchTerm::matchJunkScoreOrigin

(

in string

aJunkScoreOrigin

)

boolean nsIMsgSearchTerm::matchJunkStatus

(

in string

aJunkScore

)

boolean nsIMsgSearchTerm::matchKeyword

(

in ACString

keyword

)

boolean nsIMsgSearchTerm::matchLabel

(

in nsMsgLabelValue

aLabelValue

)

boolean nsIMsgSearchTerm::matchPriority

(

in nsMsgPriorityValue

priority

)

boolean nsIMsgSearchTerm::matchRfc2047String	(	in string	aString,
		in string	charset,
		in boolean	charsetOverride
	)

boolean nsIMsgSearchTerm::matchRfc822String	(	in string	aString,
		in string	charset,
		in boolean	charsetOverride
	)

boolean nsIMsgSearchTerm::matchSize

(

in unsigned long

size

)

boolean nsIMsgSearchTerm::matchStatus

(

in unsigned long

aStatus

)

boolean nsIMsgSearchTerm::matchUint32HdrProperty

(

in nsIMsgDBHdr

msg

)

Compares value.status with nsIMsgHdr::GetUint32Property(hdrProperty).

Parameters:

msg

msg to match db hdr property of.

Returns:

true if msg matches property, false otherwise.

---

Member Data Documentation

attribute ACString nsIMsgSearchTerm::arbitraryHeader

attribute nsMsgSearchAttribValue nsIMsgSearchTerm::attrib

attribute boolean nsIMsgSearchTerm::beginsGrouping

attribute boolean nsIMsgSearchTerm::booleanAnd

attribute ACString nsIMsgSearchTerm::customId

identifier for a custom id used for this term, if any.

attribute boolean nsIMsgSearchTerm::endsGrouping

attribute ACString nsIMsgSearchTerm::hdrProperty

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 boolean nsIMsgSearchTerm::matchAll

readonly attribute boolean nsIMsgSearchTerm::matchAllBeforeDeciding

attribute nsMsgSearchOpValue nsIMsgSearchTerm::op

readonly attribute ACString nsIMsgSearchTerm::termAsString

attribute nsIMsgSearchValue nsIMsgSearchTerm::value

---

The documentation for this interface was generated from the following file:

• nsIMsgSearchTerm.idl