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.

nsIMsgFilter

IID:346C8CC6-35EA-4F44-B348-94E84D7C03E0
Inherits From:nsISupports

Properties

readonly nsISupportsArray actionList

PRBool enabled

ACString filterDesc

readonly nsIMsgFilterList filterList

AString filterName

nsMsgFilterTypeType filterType

nsIMsgSearchScopeTerm scope

nsISupportsArray searchTerms

PRBool temporary

Some filters are "temporary". For example, the filters we create when the user filters return receipts to the Sent folder. we don't show temporary filters in the UI and we don't write them to disk.

PRBool unparseable

ACString unparsedBuffer

Methods

void AddTerm ( nsMsgSearchAttribValue attrib , nsMsgSearchOpValue op , nsIMsgSearchValue value , PRBool BooleanAND , ACString arbitraryHeader ) void appendAction ( nsIMsgRuleAction action ) void appendTerm ( nsIMsgSearchTerm term ) void clearActionList ( ) nsIMsgRuleAction createAction ( ) nsIMsgSearchTerm createTerm ( ) nsIMsgRuleAction getActionAt ( PRInt32 index ) void getSortedActionList ( nsISupportsArray actionList ) void GetTerm ( PRInt32 termIndex , out nsMsgSearchAttribValue attrib , out nsMsgSearchOpValue op , out nsIMsgSearchValue value , out PRBool BooleanAND , out ACString arbitraryHeader ) void logRuleHit ( nsIMsgRuleAction filterAction , nsIMsgDBHdr header ) [noscript] void MatchHdr ( nsIMsgDBHdr msgHdr , nsIMsgFolder folder , nsIMsgDatabase db , char* headers , PRUint32 headerSize , out PRBool result )

void AddTerm ( nsMsgSearchAttribValue attrib , nsMsgSearchOpValue op , nsIMsgSearchValue value , PRBool BooleanAND , ACString arbitraryHeader )

Arguments:
attrib
op
value
BooleanAND
arbitraryHeader

void appendAction ( nsIMsgRuleAction action )

Arguments:
action

void appendTerm ( nsIMsgSearchTerm term )

Arguments:
term

void clearActionList ( )

nsIMsgRuleAction createAction ( )

nsIMsgSearchTerm createTerm ( )

nsIMsgRuleAction getActionAt ( PRInt32 index )

Arguments:
index

void getSortedActionList ( nsISupportsArray actionList )

Arguments:
actionList

void GetTerm ( PRInt32 termIndex , out nsMsgSearchAttribValue attrib , out nsMsgSearchOpValue op , out nsIMsgSearchValue value , out PRBool BooleanAND , out ACString arbitraryHeader )

Arguments:
termIndex
attrib
op
value
BooleanAND
arbitraryHeader

void logRuleHit ( nsIMsgRuleAction filterAction , nsIMsgDBHdr header )

Arguments:
filterAction
header

void MatchHdr ( nsIMsgDBHdr msgHdr , nsIMsgFolder folder , nsIMsgDatabase db , char* headers , PRUint32 headerSize , out PRBool result )

Arguments:
msgHdr
folder
db
headers
headerSize
result

References

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

nsIMsgFilterHitNotify.applyFilterHit, nsIMsgFilterList.insertFilterAt, nsIMsgFilterList.moveFilter, nsIMsgFilterList.parseCondition, nsIMsgFilterList.removeFilter, nsIMsgFilterList.setFilterAt

This interface is returned from the following methods:

nsIMsgFilterList.createFilter, nsIMsgFilterList.getFilterAt, nsIMsgFilterList.getFilterNamed

Reference documentation is generated from Mozilla's source.