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.

nsIMsgFilterList

IID:BC32C05E-4E4E-4F08-BF01-157A0CE71874
Inherits From:nsISupports

Constants

nsMsgFilterFileAttribValue attribNone = 0
nsMsgFilterFileAttribValue attribVersion = 1
nsMsgFilterFileAttribValue attribLogging = 2
nsMsgFilterFileAttribValue attribName = 3
nsMsgFilterFileAttribValue attribEnabled = 4
nsMsgFilterFileAttribValue attribDescription = 5
nsMsgFilterFileAttribValue attribType = 6
nsMsgFilterFileAttribValue attribScriptFile = 7
nsMsgFilterFileAttribValue attribAction = 8
nsMsgFilterFileAttribValue attribActionValue = 9
nsMsgFilterFileAttribValue attribCondition = 10

Properties

readonly ACString arbitraryHeaders

nsILocalFile defaultFile

readonly PRUint32 filterCount

nsIMsgFolder folder

PRBool loggingEnabled

nsIOutputStream logStream

readonly ACString logURL

readonly PRBool shouldDownloadAllHeaders

readonly PRInt16 version

Methods

[noscript] void applyFiltersToHdr ( nsMsgFilterTypeType filterType , nsIMsgDBHdr msgHdr , nsIMsgFolder folder , nsIMsgDatabase db , char* headers , PRUint32 headerSize , nsIMsgFilterHitNotify listener , nsIMsgWindow msgWindow , nsILocalFile messageFile ) void clearLog ( ) nsIMsgFilter createFilter ( AString name ) void ensureLogFile ( ) void flushLogIfNecessary ( ) nsIMsgFilter getFilterAt ( PRUint32 filterIndex ) nsIMsgFilter getFilterNamed ( AString filterName ) void insertFilterAt ( PRUint32 filterIndex , nsIMsgFilter filter ) PRBool matchOrChangeFilterTarget ( ACString oldUri , ACString newUri , PRBool caseInsensitive ) void moveFilter ( nsIMsgFilter filter , nsMsgFilterMotionValue motion ) void moveFilterAt ( PRUint32 filterIndex , nsMsgFilterMotionValue motion ) void parseCondition ( nsIMsgFilter filter , char* condition ) void removeFilter ( nsIMsgFilter filter ) void removeFilterAt ( PRUint32 filterIndex ) void saveToDefaultFile ( ) void saveToFile ( nsIOutputStream stream ) void setFilterAt ( PRUint32 filterIndex , nsIMsgFilter filter ) void writeBoolAttr ( nsMsgFilterFileAttribValue attrib , PRBool value , nsIOutputStream stream ) void writeIntAttr ( nsMsgFilterFileAttribValue attrib , PRInt32 value , nsIOutputStream stream ) void writeStrAttr ( nsMsgFilterFileAttribValue attrib , char* value , nsIOutputStream stream ) void writeWstrAttr ( nsMsgFilterFileAttribValue attrib , PRUnichar* value , nsIOutputStream stream )

void applyFiltersToHdr ( nsMsgFilterTypeType filterType , nsIMsgDBHdr msgHdr , nsIMsgFolder folder , nsIMsgDatabase db , char* headers , PRUint32 headerSize , nsIMsgFilterHitNotify listener , nsIMsgWindow msgWindow , nsILocalFile messageFile )

Arguments:
filterType
msgHdr
folder
db
headers
headerSize
listener
msgWindow
messageFile

void clearLog ( )

nsIMsgFilter createFilter ( AString name )

Arguments:
name

void ensureLogFile ( )

void flushLogIfNecessary ( )

nsIMsgFilter getFilterAt ( PRUint32 filterIndex )

Arguments:
filterIndex

nsIMsgFilter getFilterNamed ( AString filterName )

Arguments:
filterName

void insertFilterAt ( PRUint32 filterIndex , nsIMsgFilter filter )

Arguments:
filterIndex
filter

PRBool matchOrChangeFilterTarget ( ACString oldUri , ACString newUri , PRBool caseInsensitive )

Arguments:
oldUri
newUri
caseInsensitive

void moveFilter ( nsIMsgFilter filter , nsMsgFilterMotionValue motion )

Arguments:
filter
motion

void moveFilterAt ( PRUint32 filterIndex , nsMsgFilterMotionValue motion )

Arguments:
filterIndex
motion

void parseCondition ( nsIMsgFilter filter , char* condition )

Arguments:
filter
condition

void removeFilter ( nsIMsgFilter filter )

Arguments:
filter

void removeFilterAt ( PRUint32 filterIndex )

Arguments:
filterIndex

void saveToDefaultFile ( )

void saveToFile ( nsIOutputStream stream )

Arguments:
stream

void setFilterAt ( PRUint32 filterIndex , nsIMsgFilter filter )

Arguments:
filterIndex
filter

void writeBoolAttr ( nsMsgFilterFileAttribValue attrib , PRBool value , nsIOutputStream stream )

Arguments:
attrib
value
stream

void writeIntAttr ( nsMsgFilterFileAttribValue attrib , PRInt32 value , nsIOutputStream stream )

Arguments:
attrib
value
stream

void writeStrAttr ( nsMsgFilterFileAttribValue attrib , char* value , nsIOutputStream stream )

Arguments:
attrib
value
stream

void writeWstrAttr ( nsMsgFilterFileAttribValue attrib , PRUnichar* value , nsIOutputStream stream )

Arguments:
attrib
value
stream

References

This interface is the type of the following properties:

nsIMsgFilter.filterList

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

nsIMsgFilterService.CancelFilterList, nsIMsgFilterService.CloseFilterList, nsIMsgFilterService.SaveFilterList, nsIMsgFilterService.applyFiltersToFolders, nsIMsgFolder.setFilterList, nsIMsgIncomingServer.configureTemporaryFilters, nsIMsgIncomingServer.setFilterList

This interface is returned from the following methods:

nsIMsgFilterService.OpenFilterList, nsIMsgFilterService.getTempFilterList, nsIMsgFolder.getFilterList, nsIMsgIncomingServer.getFilterList

Reference documentation is generated from Mozilla's source.