WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIMsgSearchTerm

IID:2B753A24-DAB4-4DA0-B9B1-6655C2F1D352
Inherits From:nsISupports

This interface is implemented by the following components:

Properties

ACString arbitraryHeader

nsMsgSearchAttribValue attrib

PRBool beginsGrouping

PRBool booleanAnd

PRBool endsGrouping

PRBool matchAll

readonly PRBool matchAllBeforeDeciding

nsMsgSearchOpValue op

readonly ACString termAsString

nsIMsgSearchValue value

Methods

PRBool matchAge ( PRTime days ) [noscript] PRBool matchArbitraryHeader ( nsIMsgSearchScopeTerm scopeTerm , PRUint32 offset , PRUint32 length , char* charset , PRBool charsetOverride , nsIMsgDBHdr msg , nsIMsgDatabase db , char* headers , PRUint32 headerLength , PRBool forFilters ) PRBool matchBody ( nsIMsgSearchScopeTerm scopeTerm , PRUint32 offset , PRUint32 length , char* charset , nsIMsgDBHdr msg , nsIMsgDatabase db ) PRBool matchDate ( PRTime time ) PRBool matchJunkStatus ( char* junkScore ) PRBool matchKeyword ( char* keyword ) PRBool matchLabel ( nsMsgLabelValue labelValue ) PRBool matchPriority ( nsMsgPriorityValue priority ) PRBool matchRfc2047String ( char* string , char* charset , PRBool charsetOverride ) PRBool matchRfc822String ( char* string , char* charset , PRBool charsetOverride ) PRBool matchSize ( PRUint32 size ) PRBool matchStatus ( PRUint32 status )

PRBool matchAge ( PRTime days )

Arguments:
days

PRBool matchArbitraryHeader ( nsIMsgSearchScopeTerm scopeTerm , PRUint32 offset , PRUint32 length , char* charset , PRBool charsetOverride , nsIMsgDBHdr msg , nsIMsgDatabase db , char* headers , PRUint32 headerLength , PRBool forFilters )

Arguments:
scopeTerm
offset
length
charset
charsetOverride
msg
db
headers
headerLength
forFilters

PRBool matchBody ( nsIMsgSearchScopeTerm scopeTerm , PRUint32 offset , PRUint32 length , char* charset , nsIMsgDBHdr msg , nsIMsgDatabase db )

Arguments:
scopeTerm
offset
length
charset
msg
db

PRBool matchDate ( PRTime time )

Arguments:
time

PRBool matchJunkStatus ( char* junkScore )

Arguments:
junkScore

PRBool matchKeyword ( char* keyword )

Arguments:
keyword

PRBool matchLabel ( nsMsgLabelValue labelValue )

Arguments:
labelValue

PRBool matchPriority ( nsMsgPriorityValue priority )

Arguments:
priority

PRBool matchRfc2047String ( char* string , char* charset , PRBool charsetOverride )

Arguments:
string
charset
charsetOverride

PRBool matchRfc822String ( char* string , char* charset , PRBool charsetOverride )

Arguments:
string
charset
charsetOverride

PRBool matchSize ( PRUint32 size )

Arguments:
size

PRBool matchStatus ( PRUint32 status )

Arguments:
status

References

This interface is passed as an argument to the following methods:

nsIMsgFilter.appendTerm, nsIMsgMailView.appendTerm, nsIMsgSearchSession.appendTerm

This interface is returned from the following methods:

nsIMsgFilter.createTerm, nsIMsgMailView.createTerm, nsIMsgSearchSession.createTerm

Reference documentation is generated from Mozilla's source.