nsIMsgFilterList

IID:08ecbcb4-0493-11d3-a50a-0060b0fc04b7
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 char* arbitraryHeaders

nsIFileSpec defaultFile

readonly PRUint32 filterCount

nsIMsgFolder folder

PRBool loggingEnabled

nsIOutputStream logStream

readonly char* 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 ) void clearLog ( ) nsIMsgFilter createFilter ( PRUnichar* name ) void ensureLogFile ( ) void flushLogIfNecessary ( ) nsIMsgFilter getFilterAt ( PRUint32 filterIndex ) nsIMsgFilter getFilterNamed ( PRUnichar* filterName ) void insertFilterAt ( PRUint32 filterIndex , nsIMsgFilter filter ) PRBool matchOrChangeFilterTarget ( char* oldUri , char* 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 ( nsIOFileStream stream ) void setFilterAt ( PRUint32 filterIndex , nsIMsgFilter filter ) void writeBoolAttr ( nsMsgFilterFileAttribValue attrib , PRBool value , nsIOFileStream stream ) void writeIntAttr ( nsMsgFilterFileAttribValue attrib , PRInt32 value , nsIOFileStream stream ) void writeStrAttr ( nsMsgFilterFileAttribValue attrib , char* value , nsIOFileStream stream ) void writeWstrAttr ( nsMsgFilterFileAttribValue attrib , PRUnichar* value , nsIOFileStream stream )

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

Arguments:
filterType
msgHdr
folder
db
headers
headerSize
listener
msgWindow

void clearLog ( )


nsIMsgFilter createFilter ( PRUnichar* name )

Arguments:
name

void ensureLogFile ( )


void flushLogIfNecessary ( )


nsIMsgFilter getFilterAt ( PRUint32 filterIndex )

Arguments:
filterIndex

nsIMsgFilter getFilterNamed ( PRUnichar* filterName )

Arguments:
filterName

void insertFilterAt ( PRUint32 filterIndex , nsIMsgFilter filter )

Arguments:
filterIndex
filter

PRBool matchOrChangeFilterTarget ( char* oldUri , char* 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 ( nsIOFileStream stream )

Arguments:
stream

void setFilterAt ( PRUint32 filterIndex , nsIMsgFilter filter )

Arguments:
filterIndex
filter

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

Arguments:
attrib
value
stream

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

Arguments:
attrib
value
stream

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

Arguments:
attrib
value
stream

void writeWstrAttr ( nsMsgFilterFileAttribValue attrib , PRUnichar* value , nsIOFileStream 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.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com